[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
developers/htdocs.xml: 1.9 -> 1.10
以下のページの更新をしました。ツッコミをお願いします。
developers/htdocs.xml: 1.9 -> 1.10
水曜日までに異議がなければ、 commit します。
> revision 1.10
> date: 2004/11/28 20:27:25; author: jschauma; state: Exp; lines: +9 -55
> Update to reflect reality with new TOC generation.
以下、訳と原文の差分です。
--- developers/htdocs.xml.orig 2006-02-28 02:10:57.000000000 +0900
+++ developers/htdocs.xml 2006-02-28 02:10:57.000000000 +0900
@@ -9,51 +9,15 @@
<webpage id="ja-htdocs">
<config param="desc" value="htdocsを編集する"/>
-<config param="cvstag" value="$NetBSD: htdocs.xml,v 1.9 2004/11/27 23:00:53 jschauma Exp $"/>
+<config param="cvstag" value="$NetBSD: htdocs.xml,v 1.10 2004/11/28 20:27:25 jschauma Exp $"/>
<!-- Based on english version: -->
-<!-- NetBSD: htdocs.xml,v 1.9 2004/11/27 23:00:53 jschauma Exp -->
-<config param="rcsdate" value="$Date: 2004/11/27 23:00:53 $"/>
+<!-- NetBSD: htdocs.xml,v 1.10 2004/11/28 20:27:25 jschauma Exp -->
+<config param="rcsdate" value="$Date: 2004/11/28 20:27:25 $"/>
<head>
<title>htdocsを編集する</title>
</head>
-<sect1 id="editing-htdocs">
-
-<itemizedlist>
- <listitem>
- <ulink url="#general">General notes on htdocs</ulink>
- <itemizedlist>
- <listitem><ulink url="#who-can-edit">Who can edit htdocs</ulink></listitem>
- <listitem><ulink url="#what-is-required">What is required to edit htdocs</ulink></listitem>
- <listitem><ulink url="#validate-html">Validate your HTML</ulink></listitem>
- <listitem><ulink url="#netbsd-org">NetBSD.org naming scheme</ulink></listitem>
- <listitem><ulink url="#dotlist-files">What are .list files?</ulink></listitem>
- <listitem><ulink url="#convert-to-xml">Converting to XML</ulink></listitem>
- <listitem><ulink url="#dotxml-files">Processing .xml (docbook-website) files</ulink></listitem>
- <listitem><ulink url="#moving-files">Renaming or moving files</ulink></listitem>
- <listitem><ulink url="#flaglinks">What is the reasoning behind the flag links with empty.gif?</ulink></listitem>
- <listitem><ulink url="#webserver">How do the pages get to the web server, and when?</ulink></listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <ulink url="#specific">Adding to specific areas</ulink>
- <itemizedlist>
- <listitem><ulink url="#adding-news-items">Adding News Items</ulink></listitem>
- <listitem><ulink url="#adding-events">Adding Events</ulink></listitem>
- <listitem><ulink url="#adding-mailinglists">Adding to/editing the MailingLists page</ulink></listitem>
- <listitem><ulink url="#consultants">Consultants for hire</ulink></listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- 関連ドキュメンテーション:
- <itemizedlist>
- <listitem><ulink url="announce.html">ニュース記事の手引き</ulink></listitem>
- <listitem><ulink url="translate.html">htdocs の翻訳</ulink></listitem>
- </itemizedlist>
- </listitem>
-</itemizedlist>
-
-<html:hr/>
+<sect1 id="editing-htdocs" role="toc">
<sect2 id="general">
<title>htdocsに関する一般事項</title>
@@ -197,11 +161,10 @@
www@ メーリングリストに遠慮なく助けを求めていただいて結構です。
</para>
<para>
- 目次を自動生成する場合は、 Makefile で目次の深さを (たとえば)
- <code>TOC_LEVEL=3</code> のように指定する必要があります。
- 目次に含めたくない節がある場合は、その節に
- <code>role=<quote><emphasis>NotInToc</emphasis></quote></code> 属性をつけることができます。
- <programlisting><sect2 id="not-in-toc" role="NotInToc"></programlisting>
+ 目次を自動生成する場合は、以下のコードを含めておきます。
+ <programlisting><sect1 role="toc"></programlisting>
+ これを含めておくと、すべての <code><sect2></code> に、
+ その配下の <code><sect3></code> がぶら下がった形の目次が生成されます。
</para>
<para>
ファイルを XML に変換した後は、そのファイルを <code>htdocs/layout.xml</code>
@@ -360,11 +323,7 @@
<title>変更項目を付け加えるには:</title>
<orderedlist>
<listitem>htdocs/Changes/index.xml を編集します</listitem>
-<listitem>目次に以下のような形式の行を追加します
-<programlisting>
- <listitem><ulink url="#link-name">XX Mon XXX - FREEFORM TITLE</ulink></listitem></programlisting>
-</listitem>
-<listitem>目次より後の、適切な節に、以下のような形式で項目の本体を追加します
+<listitem>適切な節に、以下のような形式で項目の本体を追加します
<programlisting>
<sect3 id="link-name>
<title>XX Mon XXX - 自由形式のタイトル (<ulink url="#monXXXX">top</ulink>)</title>
@@ -376,10 +335,6 @@
</listitem>
<listitem>'<code>make</code>' を実行します。</listitem>
</orderedlist>
-<para>
-(www チームでは、目次の生成を自動化して項目追加が簡単にできるようにするため、
-作業中です。)
-</para>
</sect4>
<sect4 id="adding-links">
Index: developers/htdocs.xml
===================================================================
RCS file: /cvsroot/htdocs/developers/htdocs.xml,v
retrieving revision 1.9
retrieving revision 1.10
diff -u -r1.9 -r1.10
--- developers/htdocs.xml 27 Nov 2004 23:00:53 -0000 1.9
+++ developers/htdocs.xml 28 Nov 2004 20:27:25 -0000 1.10
@@ -9,49 +9,13 @@
<webpage id="htdocs">
<config param="desc" value="Editing htdocs"/>
-<config param="cvstag" value="$NetBSD: htdocs.xml,v 1.9 2004/11/27 23:00:53 jschauma Exp $"/>
-<config param="rcsdate" value="$Date: 2004/11/27 23:00:53 $"/>
+<config param="cvstag" value="$NetBSD: htdocs.xml,v 1.10 2004/11/28 20:27:25 jschauma Exp $"/>
+<config param="rcsdate" value="$Date: 2004/11/28 20:27:25 $"/>
<head>
<title>Editing htdocs</title>
</head>
-<sect1 id="editing-htdocs">
-
-<itemizedlist>
- <listitem>
- <ulink url="#general">General notes on htdocs</ulink>
- <itemizedlist>
- <listitem><ulink url="#who-can-edit">Who can edit htdocs</ulink></listitem>
- <listitem><ulink url="#what-is-required">What is required to edit htdocs</ulink></listitem>
- <listitem><ulink url="#validate-html">Validate your HTML</ulink></listitem>
- <listitem><ulink url="#netbsd-org">NetBSD.org naming scheme</ulink></listitem>
- <listitem><ulink url="#dotlist-files">What are .list files?</ulink></listitem>
- <listitem><ulink url="#convert-to-xml">Converting to XML</ulink></listitem>
- <listitem><ulink url="#dotxml-files">Processing .xml (docbook-website) files</ulink></listitem>
- <listitem><ulink url="#moving-files">Renaming or moving files</ulink></listitem>
- <listitem><ulink url="#flaglinks">What is the reasoning behind the flag links with empty.gif?</ulink></listitem>
- <listitem><ulink url="#webserver">How do the pages get to the web server, and when?</ulink></listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- <ulink url="#specific">Adding to specific areas</ulink>
- <itemizedlist>
- <listitem><ulink url="#adding-news-items">Adding News Items</ulink></listitem>
- <listitem><ulink url="#adding-events">Adding Events</ulink></listitem>
- <listitem><ulink url="#adding-mailinglists">Adding to/editing the MailingLists page</ulink></listitem>
- <listitem><ulink url="#consultants">Consultants for hire</ulink></listitem>
- </itemizedlist>
- </listitem>
- <listitem>
- Related Documentation:
- <itemizedlist>
- <listitem><ulink url="announce.html">News story guidelines</ulink></listitem>
- <listitem><ulink url="translate.html">Translating htdocs</ulink></listitem>
- </itemizedlist>
- </listitem>
-</itemizedlist>
-
-<html:hr/>
+<sect1 id="editing-htdocs" role="toc">
<sect2 id="general">
<title>General notes on htdocs</title>
@@ -192,12 +156,11 @@
feel free to ask on the www@ list for help.
</para>
<para>
- If you want an autogenerated TOC, you will need to set the depth of the
- TOC you would like by specifing <code>TOC_LEVEL=3</code> (for example)
- in the Makefile. If you wish to exclude sections from the TOC, you can
- give them a <code>role=<quote><emphasis>NotInToc</emphasis></quote></code>
- attribute:
- <programlisting><sect2 id="not-in-toc" role="NotInToc"></programlisting>
+ If you want an autogenerated TOC, you will need to include the following
+ code:
+ <programlisting><sect1 role="toc"></programlisting>
+ This will generate a TOC listing all <code><sect2></code>s with a
+ bulleted list of its <code><sect3></code>s.
</para>
<para>
After converting a file to XML, remember to add it to the
@@ -356,12 +319,7 @@
<title>To add a change entry:</title>
<orderedlist>
<listitem>Edit htdocs/Changes/index.xml</listitem>
-<listitem>Add a line in the TOC of the form
-<programlisting>
- <listitem><ulink url="#link-name">XX Mon XXX - FREEFORM TITLE</ulink></listitem></programlisting>
-</listitem>
-<listitem>Further below, in the right section, add the actual entry of the
-form
+<listitem>In the right section, add the entry of the form
<programlisting>
<sect3 id="link-name>
<title>XX Mon XXX - FREEFORM TITLE (<ulink url="#monXXXX">top</ulink>)</title>
@@ -373,10 +331,6 @@
</listitem>
<listitem>Run '<code>make</code>'</listitem>
</orderedlist>
-<para>
-(The www team is working on simplifying this by automating the TOC
-generation.)
-</para>
</sect4>
<sect4 id="adding-links">