[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
developers/htdocs.xml: 1.27 -> 1.34

Subject: developers/htdocs.xml: 1.27 -> 1.34
From: kano@na.rim.or.jp (OKANO Takayoshi)
To: www-changes-ja@jp.NetBSD.org
Date: Thu, 23 Mar 2006 22:36:12 +0900 (JST)
Message-Id: <200603231336.WAA76030@shell.rim.or.jp>
Delivered-To: mailing list www-changes-ja@jp.netbsd.org
Mailing-List: contact www-changes-ja-help@jp.netbsd.org; run by ezmlm-idx
以下のページの更新をしました。ツッコミをお願いします。

developers/htdocs.xml: 1.27 -> 1.34

金曜日までに異議がなければ、 commit します。

以下、訳と原文の差分です。

--- developers/htdocs.xml.orig	2006-03-23 22:34:38.000000000 +0900
+++ developers/htdocs.xml	2006-03-23 22:34:38.000000000 +0900
@@ -5,10 +5,10 @@
 
 <webpage id="ja-developers-htdocs">
 <config param="desc" value="htdocsを編集する"/>
-<config param="cvstag" value="$NetBSD: htdocs.xml,v 1.27 2005/07/19 12:50:56 rpaulo Exp $"/>
+<config param="cvstag" value="$NetBSD: htdocs.xml,v 1.34 2006/03/18 15:13:57 kano Exp $"/>
 <!-- Based on english version: -->
-<!-- NetBSD: htdocs.xml,v 1.27 2005/07/19 12:50:56 rpaulo Exp   -->
-<config param="rcsdate" value="$Date: 2005/07/19 12:50:56 $"/>
+<!-- NetBSD: htdocs.xml,v 1.34 2006/03/18 15:13:57 kano Exp   -->
+<config param="rcsdate" value="$Date: 2006/03/18 15:13:57 $"/>
 <head>
 <title>htdocsを編集する</title>
 </head>
@@ -49,10 +49,14 @@
 	<filename role="pkg">textproc/docbook-xsl</filename>
 	&gt;= 1.68.1 および
 	<filename role="pkg">textproc/docbook-website</filename>
-	&gt;= 2.5.0 が必要です
-	(<filename role="pkg">meta-pkgs/netbsd-www</filename> 1.3
+	&gt;= 2.6.0nb1 が必要です
+	(<filename role="pkg">meta-pkgs/netbsd-www</filename> 1.4
 	が依存していますが、これより前のバージョンではもっと古いバージョンの
-	docbook-xsl も許容していました)。
+	ツールも許容しており、問題がある場合があります)。
+	なお、 LOCALBASE および PKG_SYSCONFBASE の値は
+	htdocs の makefile でも使われているため、これらの変数値を
+	<filename>/etc/mk.conf</filename> で変更する場合は、
+	BSD_PKG_MK で保護され<emphasis>ない</emphasis>形で定義してください。
     </listitem>
     <listitem>CVSROOTを指定通りに設定し、
 	<para><programlisting>cvs checkout htdocs</programlisting></para> を実行してください。
@@ -125,7 +129,9 @@
     <command>xsltproc</command> が独自に ID 属性を生成して、
     <code>.html</code> ファイルを再生成する度に
     ID 属性が更新されることがないようにするためです。
-    また、 <quote>&amp;</quote> は <quote>&amp;amp;</quote> に置きかえてください。
+    また、 <quote>&amp;</quote> は <quote>&amp;amp;</quote> に、
+    <filename>/sys</filename> は <filename>/usr/src/sys</filename> に、
+    適宜置きかえてください。
 </para>
 <para>
     ある HTML タグを、等価な XML に変換する方法がわからない場合は、
@@ -166,7 +172,7 @@
     をインストールしておく必要があります。これらは <filename
     role="pkg">meta-pkgs/netbsd-www</filename>
     に含まれています。
-    <filename role="pkg">meta-pkgs/netbsd-www</filename> のバージョンが 1.3
+    <filename role="pkg">meta-pkgs/netbsd-www</filename> のバージョンが 1.4
     であることを確認してください。
 </para>
 <para>
@@ -262,11 +268,141 @@
 
 </sect2>
 
+<sect2 id="structure">
+<title>web サイト全体の構造はどうなっているか?</title>
+
+<sect3 id="structure-overview">
+<title>概観</title>
+
+	<para></para>
+
+</sect3>
+
+<sect3 id="structure-directories">
+<title>各ディレクトリーの役割は?</title>
+
+	<variablelist>
+
+	<varlistentry><term><filename>share/mk</filename></term>
+	<listitem><para>ソースファイルからの
+	web ページの構築を自動化するための
+	&man.make.1; の基盤があります。</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>share/xml</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>share/xsl</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	</variablelist>
+
+</sect3>
+
+<sect3 id="structure-files">
+<title>各ファイルの役割は?</title>
+
+	<variablelist>
+
+	<varlistentry><term><filename>Makefile</filename></term>
+	<listitem><para>そのディレクトリーの内容の説明が書かれています。
+	通常は、<varname>SUBDIR</varname> および <varname>XMLDOCS</varname>
+	の各変数を定義してから、適切なパスを使って
+	<filename>htdocs/share/mk/web.site.mk</filename> ファイルを
+	<command>.include</command> しています。</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>*.xml</filename></term>
+	<listitem><para>一つの HTML ページに対応するソースコードが、
+	<quote>DocBook Website</quote> 形式で書かれている
+	XML ファイルです。</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>layout.xml</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>autolayout.xml</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	</variablelist>
+
+</sect3>
+
+<sect3 id="structure-maintainer">
+<title>各ファイルの保守担当者は?</title>
+
+	<para><filename>htdocs</filename> のファイルの一部は、
+	他のプロジェクトと共有されており、 &os; プロジェクト外で活発に保守されています。
+	ファイルの変更時に何を検討する必要があるかについては、
+	以下の一覧が参考になるでしょう。</para>
+
+	<variablelist>
+
+	<varlistentry><term><filename>share/mk</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>share/xml</filename>, <filename>share/xsl</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	</variablelist>
+
+</sect3>
+
+</sect2>
+
 <sect2 id="specific">
 <title>特定のエリアへ追加する</title>
 
 <sect3 id="adding-gallery-entries">
-<title>'NetBSDを稼働させているサイト' のギャラリーを追加する</title>
+<title><quote>NetBSDを稼働させているサイト</quote> のギャラリーを追加する</title>
 <para>
 <ulink url="../../gallery/addsite.html" origlink="../gallery/addsite.html">htdocs/gallery/addsite.html</ulink>ページから送信された
 <code>NETBSD GALLERY ADDITION</code> 電子メールを受け取った場合は、こうします:
@@ -286,6 +422,16 @@
 </para>
 </sect3>
 
+<sect3 id="adding-gallery-screenshots">
+<title><quote>NetBSD in action</quote> のギャラリーに追加する</title>
+<para>
+できれば、スクリーンショットにはそれが
+&os; システムのものであることが簡単にわかるような内容を含めてください。
+簡単な方法は、 X 端末で
+<command>uname -a</command> コマンドの出力を表示しておくことです。
+</para>
+</sect3>
+
 <sect3 id="adding-news-items">
 <title>ニュースの項目を追加する</title>
 <para>
Index: developers/htdocs.xml
===================================================================
RCS file: /cvsroot/htdocs/developers/htdocs.xml,v
retrieving revision 1.27
retrieving revision 1.34
diff -u -r1.27 -r1.34
--- developers/htdocs.xml	19 Jul 2005 12:50:56 -0000	1.27
+++ developers/htdocs.xml	18 Mar 2006 15:13:57 -0000	1.34
@@ -5,8 +5,8 @@
 
 <webpage id="developers-htdocs">
 <config param="desc" value="Editing htdocs"/>
-<config param="cvstag" value="$NetBSD: htdocs.xml,v 1.27 2005/07/19 12:50:56 rpaulo Exp $"/>
-<config param="rcsdate" value="$Date: 2005/07/19 12:50:56 $"/>
+<config param="cvstag" value="$NetBSD: htdocs.xml,v 1.34 2006/03/18 15:13:57 kano Exp $"/>
+<config param="rcsdate" value="$Date: 2006/03/18 15:13:57 $"/>
 <head>
 <title>Editing htdocs</title>
 </head>
@@ -45,10 +45,14 @@
 	least <filename role="pkg">textproc/docbook-xsl</filename> 
 	&gt;= 1.68.1 and
 	<filename role="pkg">textproc/docbook-website</filename> 
-	&gt;= 2.5.0 (automatically
-	required by <filename role="pkg">meta-pkgs/netbsd-www</filename> 
-	1.3, but earlier
-	versions also accepted earlier versions of docbook-xsl).
+	&gt;= 2.6.0nb1 (automatically
+	required by <filename role="pkg">meta-pkgs/netbsd-www</filename>
+	1.4, but earlier versions accepted earlier revisions of
+	required tools, which may not appropriate).  Please note that
+	any special LOCALBASE or PKG_SYSCONFBASE settings in
+	<filename>/etc/mk.conf</filename> should <emphasis>not</emphasis>
+	be protected by BSD_PKG_MK as their values are used by the htdocs
+	makefiles.
     </listitem>
     <listitem>Set your CVSROOT as indicated and run
       <para><programlisting>cvs checkout htdocs</programlisting></para>
@@ -120,8 +124,10 @@
     as well as each <code>&lt;table&gt;</code> tag:  this will prevent
     <command>xsltproc</command> to generate an ID
     itself, which would require an update of the resulting <code>.html</code>
-    file after each regeneration.  Also remember to replace each
-    <quote>&amp;</quote> with <quote>&amp;amp;</quote>.
+    file after each regeneration. Also remember to replace each
+    <quote>&amp;</quote> with <quote>&amp;amp;</quote> and
+    <filename>/sys</filename> with <filename>/usr/src/sys</filename>
+    where applicable.
 </para>
 <para>
     If you are unsure how to convert a given HTML tag to the XML equivalent,
@@ -164,7 +170,7 @@
     role="pkg">meta-pkgs/netbsd-www</filename>.
     Please make sure that you have <filename 
     role="pkg">meta-pkgs/netbsd-www</filename> version
-    1.3.
+    1.4.
 </para>
 <para>
     To regenerate, just run
@@ -258,11 +264,142 @@
 
 </sect2>
 
+<sect2 id="structure">
+<title>How is the whole web site structured?</title>
+
+<sect3 id="structure-overview">
+<title>Overview</title>
+
+	<para></para>
+
+</sect3>
+
+<sect3 id="structure-directories">
+<title>What are the individual directories for?</title>
+
+	<variablelist>
+
+	<varlistentry><term><filename>share/mk</filename></term>
+	<listitem><para>Contains the &man.make.1; infrastructure to
+	automatize the generation of the web pages from the source
+	files.</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>share/xml</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>share/xsl</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	</variablelist>
+
+</sect3>
+
+<sect3 id="structure-files">
+<title>What are the individual files for?</title>
+
+	<variablelist>
+
+	<varlistentry><term><filename>Makefile</filename></term>
+	<listitem><para>Contains a description of the directory's
+	contents. Usually it suffers to define the variables
+	<varname>SUBDIR</varname> and <varname>XMLDOCS</varname>, and
+	then <command>.include</command> the file
+	<filename>htdocs/share/mk/web.site.mk</filename> using the
+	appropriate path.</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>*.xml</filename></term>
+	<listitem><para>XML files should contain the source code for a
+	single HTML page, in the <quote>DocBook Website</quote>
+	format.</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>layout.xml</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>autolayout.xml</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	</variablelist>
+
+</sect3>
+
+<sect3 id="structure-maintainer">
+<title>Who maintains the individual files?</title>
+
+	<para>Some files in <filename>htdocs</filename> are shared with
+	other projects, and are actively maintained outside the &os;
+	project. The following list gives some hints about what needs to
+	be considered when changing files.</para>
+
+	<variablelist>
+
+	<varlistentry><term><filename>share/mk</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename>share/xml</filename>, <filename>share/xsl</filename></term>
+	<listitem><para>[TODO]</para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	<varlistentry><term><filename></filename></term>
+	<listitem><para></para></listitem></varlistentry>
+
+	</variablelist>
+
+</sect3>
+
+</sect2>
+
 <sect2 id="specific">
 <title>Adding to specific areas</title>
 
 <sect3 id="adding-gallery-entries">
-<title>Adding to the 'Sites running NetBSD' gallery</title>
+<title>Adding to the <quote>Sites running NetBSD</quote> gallery</title>
 <para>
 If you have a <code>NETBSD GALLERY ADDITION</code> email from the <ulink
 url="../gallery/addsite.html">htdocs/gallery/addsite.html</ulink> page:
@@ -282,6 +419,16 @@
 </para>
 </sect3>
 
+<sect3 id="adding-gallery-screenshots">
+<title>Adding to the <quote>NetBSD in action</quote> gallery</title>
+<para>
+If possible, a screenshot should contain some easily recognizable visual
+indication that it was made on a &os; system. A common way to do this is
+by showing an X terminal that displays the output of the
+<command>uname -a</command> command.
+</para>
+</sect3>
+
 <sect3 id="adding-news-items">
 <title>Adding News Items</title>
 <para>
@@ -332,7 +479,7 @@
   &lt;sect3 id="link-name&gt;
   &lt;title&gt;XX Mon XXX - FREEFORM TITLE&lt;/title&gt;
   &lt;para&gt;
-    Entry text goes here.  Manual pages can be refered to as <quote>&amp;man.command.X;</quote>,
+    Entry text goes here.  Manual pages can be referred to as <quote>&amp;man.command.X;</quote>,
     email addresses as &lt;email&gt;full@address&lt;/email&gt;.
   &lt;para&gt;
   &lt;/sect3&gt;</programlisting>
@@ -370,7 +517,7 @@
     <listitem><emphasis>date</emphasis> - Normally as YEAR.MONTH.DATE</listitem>
     <listitem><emphasis>title</emphasis> - Freeform (short) text title</listitem>
     <listitem><emphasis>body of item</emphasis> - Freeform text for the entry.
-        Can span mutltiple lines and may use HTML tags and links.</listitem>
+        Can span multiple lines and may use HTML tags and links.</listitem>
     </itemizedlist>
 </listitem>
 </orderedlist>
Prev by Date: CVS commit: htdocs
Next by Date: Documentation/wscons/index.xml: 1.1 -> 1.6
Prev by thread: Ports/evbmips/index.xml: 1.3 -> 1.4
Next by thread: Documentation/wscons/index.xml: 1.1 -> 1.6
Index(es):
- Date
- Thread