* [gentoo-commits] gentoo commit in xml/htdocs/proj/ja/gdp/doc: doc-tipsntricks.xml
@ 2008-06-19 17:07 Naoaki Shindo (shindo)
0 siblings, 0 replies; 2+ messages in thread
From: Naoaki Shindo (shindo) @ 2008-06-19 17:07 UTC (permalink / raw
To: gentoo-commits
shindo 08/06/19 17:07:41
Modified: doc-tipsntricks.xml
Log:
sync to 1.25
Revision Changes Path
1.3 xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml?rev=1.3&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml?rev=1.3&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml?r1=1.2&r2=1.3
Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- doc-tipsntricks.xml 20 Jun 2005 13:36:01 -0000 1.2
+++ doc-tipsntricks.xml 19 Jun 2008 17:07:40 -0000 1.3
@@ -1,84 +1,72 @@
<?xml version='1.0' encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml,v 1.2 2005/06/20 13:36:01 idani Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml,v 1.3 2008/06/19 17:07:40 shindo Exp $ -->
-<guide link="doc-tipsntricks.xml">
+<guide link="/proj/ja/gdp/doc/doc-tipsntricks.xml">
<title>ドキュメント開発のTips & Tricks</title>
+
<author title="Author">
- <mail link="swift@gentoo.org">Sven Vermeulen</mail>
+ <mail link="neysx@gentoo.org">Xavier Neys</mail>
</author>
-<author title="Editor">
- <mail link="neysx@gentoo.org">Xavier Neys</mail>
+<author title="Author">
+ <mail link="swift@gentoo.org">Sven Vermeulen</mail>
</author>
<author title="翻訳">
<mail link="ikeda@cs.comp.kyutech.ac.jp">池田 健吾</mail>
</author>
+<author title="翻訳">
+ <mail link="shindo@gentoo.gr.jp">シンドウナオアキ</mail>
+</author>
+
<abstract>
-Gentooドキュメント開発者の開発時間を短縮(あるいは、より延長:)するtips & tricksです。
+Gentooドキュメント開発者の開発時間を短縮するtips & tricksです。
</abstract>
<license/>
-<version>0.15</version>
-<date>2005-04-08</date>
-<!-- Original revision: 1.10 -->
+<version>2</version>
+<date>2007-03-08</date>
+<!-- Original revision: 1.25 -->
+
<chapter>
-<title>ローカル環境の設定</title>
+<title>Webサイトにあるファイルをチェックアウトする</title>
<section>
-<title>貢献者のためのローカル環境</title>
+<title>anonymous CVSを使う</title>
<body>
<p>
-ドキュメント開発のためだけに、専用のディレクトリを作成してください。
-例として<path>~/work/gentoo/doc</path>というディレクトリを作成します。
-このディレクトリの中に、(最新の)英語ドキュメントを保持するためのサブディレクトリ(例えば<path>en/</path>)を作成します。
-</p>
+翻訳作業に参加する方は<uri link="http://anoncvs.gentoo.org/">anonymous
+CVS サーバー</uri>を使ってください。Gentoo開発者が使うオフィシャルなCVSと同じファイルが格納されています。anonymous CVS リポジトリは１時間毎に更新されます。</p>
<p>
-最新の英語ドキュメントのtarballをダウンロードしてください。
-</p>
+ドキュメント開発のためだけに、専用のディレクトリを作成してください。そしてWebサイトのファイルをチェックアウトしてください。</p>
-<pre caption="英語ドキュメントのダウンロード">
-# <i>wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-en.tar.bz2</i>
+<pre caption="Webサイトのファイルをチェックアウトする">
+$ <i>cvs -d :pserver:anonymous@anoncvs.gentoo.org/var/cvsroot co gentoo/xml</i>
</pre>
<p>
-ドキュメントを<path>en/</path>に展開してください。
-これであなたは英語ドキュメントの最新のスナップショットを手に入れました。
-
-
-スナップショットを更新したい場合は、毎回tarballをダウンロードすることになりますが、<path>?passthru=1</path>をURLに追加してドキュメントを見ることもできます。
-
-例えば、次のようにします。
-</p>
+リポジトリのコピーを更新するためには <path>gentoo/xml</path>ディレクトリで<c>cvs update -dP</c> を実行してください。</p>
-<pre caption="英語ドキュメントの更新">
-# <i>wget http://www.gentoo.org/doc/en/alsa-guide.xml?passthru=1 -O alsa-guide.xml</i>
-</pre>
+</body>
+</section>
+<section>
+<title>Gentoo 開発者向けの活動用リポジトリ</title>
+<body>
<p>
-ドキュメントの翻訳作業を手助けしたい場合、
-最新版の母国語ドキュメントを保持するディレクトリ(訳注：例えばja/)を作成してください。
+もし、まだ<c>gentoo</c>モジュールをチェックアウトしていなければ、チェックアウトしてください:
</p>
-<pre caption="母国語ドキュメントのスナップショットをダウンロード">
-# <i>mkdir </i><comment>${LANG}</comment>
-# <i>cd </i><comment>${LANG}</comment>
-# <i>wget http://www.gentoo.org/dyn/doc-snapshots/docs-latest-</i><comment>${LANG}</comment><i>.tar.bz2</i>
-# <i>tar xvjf docs-latest-*.tar.bz2</i>
+<pre caption="gentoo モジュールのチェックアウト">
+$ <i>export CVSROOT=</i><comment><your nick></comment><i>@cvs.gentoo.org:/var/cvsroot</i>
+$ <i>cvs co gentoo/xml</i>
</pre>
<p>
-ドキュメントを更新したいときは必ずまず最初に、<path>${LANG}/</path>からルートディレクトリ(<path>~/work/gentoo/doc</path>)へドキュメントをコピーするようにしてください。
-コピーしたバージョンを修正するようにしましょう。
-パッチを作成するために、オリジナルのバージョンを保持する必要があります。
-</p>
-
-<pre caption="更新用パッチの作成">
-# <i>diff -uNt </i><comment>${LANG}</comment><i>/alsa-guide.xml alsa-guide.xml</i> > alsa-guide.diff
-</pre>
+リポジトリのコピーを更新するのは、<path>gentoo/xml</path> ディレクトリで<c>cvs update -dP</c>を実行してください。</p>
</body>
</section>
@@ -87,75 +75,64 @@
<body>
<p>
-個々のバージョン間の違いを提供するために<uri link="/cgi-bin/viewcvs.cgi">オンラインCVSリポジトリ</uri>を利用することができます。
-中心的な英語リポジトリは、<uri link="/cgi-bin/viewcvs.cgi/en/?root=doc&sortby=date">すべて利用可能</uri>です。
-また、オンラインCVSリポジトリは一時間ごとに更新されます。
-</p>
+個別のバージョン間の違い提供するために私たちの<uri link="http://sources.gentoo.org/">オンライン CVS リポジトリ</uri>を利用することができます。中心的な英語版リポジトリは、<uri link="http://sources.gentoo.org/gentoo/xml/htdocs/doc/en/">すべて利用可能です。</uri>. オンラインCVSは一時間毎に更新されます。</p>
</body>
</section>
+</chapter>
+<chapter>
+<title>ローカル環境をセットアップする</title>
<section>
-<title>開発者用のローカルリポジトリ</title>
+<title>gorgのインストール</title>
<body>
<p>
-Gentoo専用の作業ディレクトリを作成してください。
-例えば、<path>~/work/gentoo/doc</path>とします。
-それからCVSスナップショットを置くための、<path>cvs/</path>というサブディレクトリを作成してください。
-</p>
+私たちの GuideXML ドキュメントは<uri link="http://gentoo.neysx.org/mystuff/gorg/gorg.xml">www-servers/gorg</uri>パッケージによりHTMLに変換されます。これをインストールしてください。</p>
-<pre caption="CVSスナップショットの入手">
-# <i>mkdir cvs; cd cvs/</i>
-# <i>export CVSROOT=</i><comment><your nick></comment><i>@cvs.gentoo.org:/var/cvsroot</i>
-# <i>cvs co doc</i>
-</pre>
+<note>
+<c>gorg-0.6.3</c>以上をインストールしてください。使っているアーキテクチャによってはkeywordが必要かもしれません。</note>
<p>
-CVSスナップショットを更新するために、
-<path>cvs/doc</path>ディレクトリで<c>cvs update -dP</c>を実行してください
-</p>
+<uri link="http://gentoo.neysx.org/mystuff/gorg/gorg.xml">gorgのホームページ</uri>にしたがって、設定してください。CVSリポジトリをチェックアウトしたディレクトリ(<path>.../gentoo/xml/htdocs</path>)をWebルートとして設定する必要がありますその他のパラメーターは
+<uri link="http://www.gentoo.org">www.gentoo.org</uri>
+のローカルコピーを提供したい場合に有効です。</p>
</body>
</section>
-</chapter>
-<chapter>
-<title>GuideXMLのテスト</title>
<section>
-<title>環境テスト</title>
+<title>XML環境をセットアップする</title>
<body>
<p>
-まず、<path>guide.xsl</path>，
-<path>main.css</path>といくつかの画像を置く<path>test/</path>ディレクトリを作成してください。
+私たちのドキュメントが使うDTDがどこで見つけられるのかシステムが知らなくてはなりません。rootになり<path>/etc/xml/catalog</path> に次の行を追加してください:
</p>
-<pre caption="テスト環境の作成">
-# <i>mkdir test</i>
-# <i>cd test</i>
-# <i>mkdir css images</i>
-# <i>wget -P css/ http://www.gentoo.org/css/main.css</i>
-# <i>wget -P images/ http://www.gentoo.org/images/gbot-s.gif \
- http://www.gentoo.org/images/gridtest.gif \
- http://www.gentoo.org/images/gtop-s.jpg \
- http://www.gentoo.org/images/line.gif \
- http://www.gentoo.org/images/netraverse-gentoo.gif</i>
+<pre caption="/etc/xml/catalog 追加行">
+<rewriteURI uriStartString="/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/>
</pre>
+<note>
+CVSからチェックアウトしたDTDへのパスへ書き換えてもかまいません。</note>
+
<p>
-<path>guide.xsl</path>の特製バージョンは、<uri link="http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl">SwifT's webspace</uri>で入手可能です。
-このバージョンは、ローカルシステム上でのGuideXMLからHTMLへの変換に対応しています。
+もし<path>/etc/xml/catalog</path>が空か何もエントリーがない状態であれば、
+<c><rewriteURI></c>エレメントを<c><catalog></c>の<e>内側</e>に
+<e>挿入</e>する必要があります:
</p>
-<pre caption="guide.xslのダウンロード">
-# <i>wget http://dev.gentoo.org/~swift/gentoo/downloads/guide.xsl</i>
+<pre caption="最低限の/etc/xml/catalog">
+<?xml version="1.0"?>
+<!DOCTYPE catalog PUBLIC "-//OASIS//DTD Entity Resolution XML Catalog V1.0//EN" "http://www.oasis-open.org/committees/entity/release/1.0/catalog.dtd">
+<catalog xmlns="urn:oasis:names:tc:entity:xmlns:xml:catalog">
+ <rewriteURI uriStartString="/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/>
+</catalog>
</pre>
-<p>
-最後に、<path>/etc/xml/catalog</path>を編集して次の行を追加します。
+<p>さらにいくつかのファイルでは<path>http://www.gentoo.org/dtd/guide.dtd</path>というurlのようにオンラインDTDを指定してもかまいません。これらの参照を書き換えてバリデーション中のネット越しのアクセス速度低下を避けることもできます:
</p>
-<pre caption="/etc/xml/catalogへの追加">
-<rewriteURI uriStartString="/dtd" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/>
+<pre caption="その他の /etc/xml/catalog への追加行">
+<rewriteURI uriStartString="http://www.gentoo.org/dtd/" rewritePrefix="<i>/usr/portage/metadata/dtd/</i>"/>
</pre>
</body>
@@ -165,236 +142,145 @@
<body>
<p>
-Gentooガイドをテストするためには、まず正しいXMLを使っているかどうかを確認しましょう。
+Gentooガイドをテストするために、まず正しい(valid)XMLを使用しているかどうかチェックするために<c>xmllint</c> (<c>dev-libs/libxml2</c>にある)を使いましょう:
</p>
-<pre caption="ガイドの正当性を確認するためにxmllintを使う">
-# <i>xmllint --valid --noout alsa-guide.xml</i>
+<pre caption="GuideXMLの正当性確認(validation)のためxmllintを使う">
+$ <i>xmllint --valid --noout alsa-guide.xml</i>
</pre>
<p>
-<c>xmllint</c>が目に見える形で何も返さない場合、そのファイルには（少なくともXMLタグに関しては）エラーがありません。
-次に、そのファイルをHTMLに変換する必要があります。
-<c>xsltproc</c>は、そのための変換ツールです。
+xmllintが目に見える形で何も返さない場合、そのファイルの構造は正当(valid)です。次にHTMLに変換する必要があります:
</p>
<pre caption="HTMLへの変換">
-# <i>xsltproc --novalid test/guide.xsl alsa-guide.xml > test/alsa-guide.html</i>
+$ <i>gorg < alsa-guide.xml > alsa-guide.html</i>
</pre>
<p>
-エラーが無ければ、結果として出力されたドキュメントを見るために<uri>file:///home/user/work/gentoo/doc/test/alsa-guide.html</uri>へブラウザを案内しましょう。
-エラーがあれば、動作するまでガイドを修正しましょう。
-</p>
+もし何もエラーがなければ、ブラウザで<path>alsa-guide.html</path>を開き、変換結果のドキュメントをみてみましょう。エラーがあれば、動作するまでガイドを修正しましょう。</p>
+
+<note>
+ハンドブックの章では、他の章へのリンクは生成されないかもしれません。
+なぜならオンラインでのハンドブックアクセスはマスターファイルを経由しておこなわれ、<c>chap</c>と<c>part</c>パラメーターによるからです。</note>
</body>
</section>
<section>
-<title>Gentooハンドブックのテスト</title>
+<title>Gentoo Web差異とのローカルコピーをブラウズする</title>
<body>
<p>
-Gentooハンドブックは章に分かれています。
-ある章を処理するには、必須の<path>hb-</path>ファイル(例：<path>hb-install-about.xml</path>)と<path>handbook-x86.xml</path>ファイルを利用する必要があります。
-それから<c>xsltproc</c>に、オンラインハンドブックに目を通している間に見られる同じ名前のパラメータ、すなわち<c>part</c>や<c>chap</c>を渡さなければいけません。
-例えば、<path>hb-install-about.xml</path>の正当性を確かめるには以下を実行してください。
-</p>
-
-<pre caption="hb-install-about.xmlの正当性の確認">
-# <i>xmllint --valid --noout handbook-x86.xml</i>
-# <i>xmllint --valid --noout hb-install-about.xml</i>
-# <i>xsltproc --stringparam part 1 --stringparam chap 1 test/guide.xsl handbook-x86.xml > test/hb-install-about.html</i>
-</pre>
+GentooのWebサイトをCVSからチェックアウトしているので、ローカルコピーをブラウズするためにgorgを使うこともできます。もしGentooと同じフロントページにしたい場合は、<uri link="http://gentoo.neysx.org/mystuff/gorg/gorg.xml">gorgのホームページ</uri>で説明されているとおりにニュースインデックスをダウンロードしているかどうか確認してください。</p>
</body>
</section>
</chapter>
<chapter>
-<title>axkit setupの使用</title>
+<title>よくある質問</title>
<section>
+<title>ファイルをUTF-8に変換するにはどうしたらいいですか？</title>
<body>
<p>
-<uri>http://www.gentoo.org</uri>で実行しているのと同じようなaxkit setupを好んで使うドキュメント開発者もいます。
-これと同じような設定にするためのポインタをいくつか紹介します。
-</p>
-
-<warn>
-axkitは、特にlibxml2といった利用するパッケージのバージョンにとても注意しなければならないようです。
-下に記述した設定は動作することが知られています。
-パッケージの組み合わせがこれと違うと壊れる可能性があります。
-</warn>
+あなたの助けとなるツールは数多くあります。有名なものには<c>app-text/recode</c>があります。他にも<c>sys-libs/glibc</c>の一部分である<c>iconv</c>といったものもあります。</p>
<p>
-まず、必須のパッケージをインストールしてください。
-</p>
-
-<pre caption="必須パッケージの特定バージョンをemergeする">
-<comment>(パッケージがPortageで利用可能かどうかテストします)</comment>
-# <i>emerge -vp =dev-libs/libxml2-2.6.17 =dev-libs/libxslt-1.1.12 \
-=dev-perl/AxKit-1.6.1 =dev-perl/XML-XPath-1.13 =dev-perl/XML-LibXML-1.58 \
-=dev-perl/XML-LibXSLT-1.57 =dev-perl/XML-Parser-2.34 =net-www/apache-1.3.33</i>
-
-These are the packages that I would merge, in order:
-
-Calculating dependencies ...done!
-[ebuild R ] dev-libs/libxml2-2.x.17 -debug -ipv6 +python +readline 0 kB
-[ebuild R ] dev-libs/libxslt-1.1.12 +crypt +python 0 kB
-[ebuild R ] dev-perl/AxKit-1.6.1 +gnome 0 kB
-[ebuild R ] dev-perl/XML-XPath-1.13 0 kB
-[ebuild R ] dev-perl/XML-LibXML-1.58 0 kB
-[ebuild R ] dev-perl/XML-LibXSLT-1.57 0 kB
-[ebuild R ] dev-perl/XML-Parser-2.34 0 kB
-[ebuild R ] net-www/apache-1.3.33 +pam 0 kB
-
-<comment>(パッケージのインストール)</comment>
-# <i>emerge =dev-libs/libxml2-2.6.17 =dev-libs/libxslt-1.1.12 \
-=dev-perl/AxKit-1.6.1 =dev-perl/XML-XPath-1.13 =dev-perl/XML-LibXML-1.58 \
-=dev-perl/XML-LibXSLT-1.57 =dev-perl/XML-Parser-2.34 =net-www/apache-1.3.33</i>
-</pre>
+Recodeの使い方はとても簡単です。ドキュメントに使われている現在の文字コードと、ドキュメントの文字コードをどれに変換するかをRecodeに伝えます。</p>
<p>
-それから、次の設定ファイルを編集します。
+例えば、ISO-8859-15(Latin-9としても知られています)からUTF-8へ変換するためには、次のように使います:
</p>
-<pre caption="/etc/apache/conf/commonapache.conf">
-<comment>(内側)</comment>
-<IfModule mod_dir.c>
- <comment>(index.xmlをリストに追加してください)</comment>
- DirectoryIndex index.xml index.html index.php index.php3 index.shtml index.cgi index.pl index.htm Default.htm default.htm
-</IfModule>
-
-<comment>(次の行を追加してください)</comment>
-<IfDefine PERL>
- LoadModule perl_module extramodules/libperl.so
-# AddModule mod_perl.c
- PerlModule AxKit
- SetHandler perl-script
- PerlHandler Apache::AxKit::StyleChooser::PathInfo AxKit
- AddHandler axkit .xml .xsp
- AxAddPlugin Apache::AxKit::StyleChooser::QueryString
- AxAddXSPTaglib AxKit::XSP::Util
- AxAddXSPTaglib AxKit::XSP::IfParam
- AxAddXSPTaglib AxKit::XSP::Param
- AxAddStyleMap application/x-xsp Apache::AxKit::Language::XSP
- AxAddStyleMap text/xsl Apache::AxKit::Language::LibXSLT
- <AxStyleName "#default">
- AxAddProcessor text/xsl /xsl/guide.xsl
- </AxStyleName>
- <AxStyleName printable>
- AxAddProcessor text/xsl /xsl/guide-print.xsl
- </AxStyleName>
-</IfDefine>
-
-<comment>(内側)</comment>
-<IfModule mod_alias.c>
- Alias /icons/ /var/www/localhost/icons/
-<comment>(次の行のコメントを外してください)</comment>
- #Alias /doc /usr/share/doc
+<pre caption="ファイルを再変換する">
+<comment>(l9 = ISO-8859-15, u8 = UTF-8)</comment>
+$ <i>recode l9..u8 file.xml</i>
</pre>
-<pre caption="/etc/conf.d/apache">
-<comment>(オプションのリストに-D PERLを追加してください)</comment>
-APACHE_OPTS="-D PERL"
-</pre>
+</body>
+</section>
+</chapter>
-<p>
-そして、DTDやスタイルシートを含むドキュメントファイルを<path>/var/www/localhost/htdocs/</path>へコピーしてください。
-<path>css/</path>、<path>doc/</path>、<path>dtd/</path>、<path>images/</path>、<path>xsl/</path>ディレクトリが必要になります。
-Gentoo開発者は、シンボリックリンクからCVSのローカルコピーへコピーできます。
-他の貢献者は、<uri link="http://www.gentoo.org/cgi-bin/viewcvs.cgi/xml/htdocs/?root=gentoo">viewCVS</uri>インタフェースからファイルをダウンロードする必要があるでしょう。
-</p>
+<chapter>
+<title>ドキュメント提出に関するTips</title>
+<section>
+<title><guide> タグが正しいことを確認する</title>
+<body>
<p>
-あとは、apacheサーバを起動するだけです。
-</p>
+<guide link> 属性がガイドの正しい場所を指しているか確認してください。大抵は<path>/doc/${LANG}/filename.xml</path>です。もし、翻訳ドキュメントの場合は、常にドキュメントへの絶対パス(たとえば<path>/doc/${LANG}/</path>)を指定してください。もし、<c>guide</c> や <c>book</c> DTDを使うようなドキュメントを書いた場合、<path>/doc/${LANG}/filename.xml</path> や <path>filename.xml</path>が使えるかもしれません。大抵の場合、GDPは前者の指定を推奨します。</p>
-<pre caption="apacheの起動">
-# <i>/etc/init.d/apache start</i>
-# <comment>(ブート時に自動的に起動したい場合はapacheをランレベルに追加してください)</comment>
-# <i>rc-update add apache default</i>
-</pre>
-
-<p>
-ワークステーションにaxkitをインストールした場合、ブラウザに<uri>http://your_server/doc/en/</uri>あるいは単に<uri>http://localhost/doc/en/</uri>と入力してください。
-アクセスログは<path>/var/log/apache/access_log</path>、エラーログは<path>/var/log/apache/error_log</path>で確認できます。
-</p>
+</body>
+</section>
+<section>
+<title>リンクを確認する</title>
+<body>
-<note>
-Mozillaユーザは、localhostを利用する際に<uri>about:config</uri>ページで<c>keyword.enabled</c>を<c>false</c>に設定する必要があるかもしれません。
-</note>
+<p>
+<e>かならず</e> ドキュメントのすべてのハイパーリンクを確認してください。翻訳ドキュメントの場合、他の翻訳ドキュメントへのリンクはどれも存在するファイルを指していることを確認してください。</p>
</body>
</section>
+<section>
+<title>タブのチェック</title>
+<body>
-</chapter>
+<p>
+GuideXMLではタブは必要がある場合(たとえばドキュメントがユーザーにタブを使うよう指示している場合)を除いて絶対に禁止です。タブに関してドキュメントをチェックするには、<c>grep "CTRL+V<TAB>" file.xml</c>を実行してください。<c>grep</c>の出力結果はすべて修正してください。</p>
-<chapter>
-<title>よくある質問</title>
+</body>
+</section>
<section>
-<title>ファイルをUTF-8に変換するにはどうしたらいいですか？</title>
+<title>Bugzilla</title>
<body>
<p>
-あなたの助けとなるツールは数多くあります。
-有名なものには<c>app-text/recode</c>がありますし、他にも<c>sys-libs/glibc</c>の一部分である<c>iconv</c>なんてのもあります。
-</p>
+一旦ドキュメントの作成を終えたら、<uri link="http://bugs.gentoo.org/enter_bug.cgi?product=Documentation">Bugzilla</uri>を使ってドキュメントチームへドキュメントを提出してください。プラットフォームや<c>emerge info</c>の出力、arch、再現手順などの情報については気にする必要はありません。もし、ドキュメントを翻訳した場合は、
+<uri link="http://bugs.gentoo.org/enter_bug.cgi?product=Doc%20Translations">ドキュメント翻訳</uri> コンポーネントをバグ情報のなかで選んでください。また、翻訳についてなんらか助けになるサマリーを次のような好ましい形で含めてください: "[fr] New translation: /doc/fr/gnupg-user.xml"。<b>[fr]</b> の部分を翻訳言語に合わせた2文字で置き換えてください。</p>
<p>
-Recodeの使い方はとても簡単です。ドキュメントに使われている現在の文字コードと、ドキュメントの文字コードをどれに変換するかをRecodeに教えます。
-</p>
+デフォルトでは<mail>docs-team@gentoo.org</mail> がバグをアサインしますので、任命者欄を変更する必要はありません。</p>
<p>
-例えば、ISO-8859-15(Latin-9としても知られています)からUTF-8へ変換するために利用することができます。
-</p>
-
-<pre caption="ファイルを再変換する">
-<comment>(l9 = ISO-8859-15, u8 = UTF-8)</comment>
-$ <i>recode l9..u8 file.xml</i>
-</pre>
+バグには"プレーンテキスト(text/plain)"でファイルやパッチを添付してください。たとえ<path>.xml</path>を提出する場合でも、"XMLソース(application/xml)"をえらば<e>ないでください。</e> パッチの場合は"Patch"オプションをチェックしてくださいtarballでのドキュメント提出はしないでください。それぞれのドキュメントやパッチを個別に添付してください。</p>
</body>
</section>
</chapter>
<chapter>
-<title>一般に危険な人為的ミス</title>
+<title>一般的または危険な間違い</title>
<section>
<title>Gentooハンドブックがすべてのアーキテクチャに対応する点を忘れている</title>
<body>
<p>
-
-<path>[gentoo]/xml/htdocs/doc/en/handbook</path>内のファイルで名前の末尾が"-<arch>.xml"でないものは、すべてのハンドブックで読み込まれます。
-つまりこの場合、ファイルに記載されている内容はすべてクロスアーキテクチャでなければいけません。
-</p>
+<path>[gentoo]/xml/htdocs/doc/en/handbook</path> 内のファイルで名前の末尾が"-<arch>.xml"でないものは、すべてのハンドブックで読み込まれます。
+つまりこの場合、ファイルに記載されている内容はすべてアーキテクチャに共通でなければいけません。</p>
<p>
-自分のアーキテクチャに関して修正が必要で、そのようなファイルにこれを掲載する必要がある場合、これを解決するには、まず<c>gentoo-doc@gentoo.org</c>に問い合わせるとよいでしょう。
-他のアーキテクチャのユーザが、より困難な修正をしなくて済む方法があるかもしれません。
-</p>
+もし、アーキテクチャ固有な点について修正する必要がある場合や、そういった事柄をフ文書内に書き留めておく必要があると感じた場合、これを解決するには、まず<c>gentoo-doc@gentoo.org</c>に問い合わせるとよいでしょう。他のアーキテクチャのユーザーに手間をとらせずに済む方法があるかもしれません。</p>
</body>
</section>
<section>
- <title>バージョンや日付を進めない、もしくは間違った方法で進めている</title>
+<title>バージョンや日付を進めない、もしくは間違った方法で進めている</title>
<body>
<p>
-ポリシーに従って、(ほぼ実質的な)変更があったときにはバージョンや日付を進め<e>なければいけません</e>。
-バージョンはさほど重要ではありませんが(ただ、忘れた場合にはSwifTに殺されるでしょうね)、日付は、ドキュメントが最後に変更された時間をユーザに教えてくれます。
-</p>
+ポリシーに従って、(ほぼ実質的に)何らか変更があったときにはバージョンや日付を進め<e>なければいけません</e>。バージョンはさほど重要ではありませんが(ただ、忘れた場合にはSwifTにこっぴどく怒られるでしょうね)、日付によりユーザーはドキュメントが最後に変更された時間を知ります。</p>
<p>
-ハンドブックを更新するとき、変更したファイルの日付とバージョンだけ進めます。
-実際に中身を変更しない限り、handbook-<e>ARCH</e>.xmlを進めないでください。
-</p>
+もし<e>内容</e>(指示やコード例など)の変更した場合は、バージョンをあげなくてはいけません。
+<e>内容に関連しない</e>(打ち間違いやGuideXMLの修正など)の変更では、ふつうバージョンは上げる必要はありません。</p>
<p>
-他によくある間違いは、十進数であるかのようにバージョン番号を更新してしまうことです。
-<c>3.9</c>は、<c>3.10</c>ではなく<c>4.0</c>もしくは<c>3.91</c>とするべきです。
-</p>
+ハンドブックを更新した場合は、変更したファイルの日付とバージョンだけを更新してください。handbook-<e>ARCH</e>.xmlの内容を実質的に変更しない限り、このファイルの更新をしないでください。</p>
+
+<p>
+他によくある間違いは、十進数であるかのようにバージョン番号を更新してしまうことです。これは違います。<c>3.9</c>の次は<c>3.10</c>にしなければいけません。<c>4.0</c>でも
+<c>3.91</c>でもありません。</p>
</body>
</section>
--
gentoo-commits@lists.gentoo.org mailing list
^ permalink raw reply [flat|nested] 2+ messages in thread
* [gentoo-commits] gentoo commit in xml/htdocs/proj/ja/gdp/doc: doc-tipsntricks.xml
@ 2008-06-19 18:01 Naoaki Shindo (shindo)
0 siblings, 0 replies; 2+ messages in thread
From: Naoaki Shindo (shindo) @ 2008-06-19 18:01 UTC (permalink / raw
To: gentoo-commits
shindo 08/06/19 18:01:30
Modified: doc-tipsntricks.xml
Log:
fixed typo
Revision Changes Path
1.4 xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml
file : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml?rev=1.4&view=markup
plain: http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml?rev=1.4&content-type=text/plain
diff : http://sources.gentoo.org/viewcvs.py/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml?r1=1.3&r2=1.4
Index: doc-tipsntricks.xml
===================================================================
RCS file: /var/cvsroot/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml,v
retrieving revision 1.3
retrieving revision 1.4
diff -u -r1.3 -r1.4
--- doc-tipsntricks.xml 19 Jun 2008 17:07:40 -0000 1.3
+++ doc-tipsntricks.xml 19 Jun 2008 18:01:30 -0000 1.4
@@ -1,7 +1,7 @@
<?xml version='1.0' encoding="UTF-8"?>
<!DOCTYPE guide SYSTEM "/dtd/guide.dtd">
-<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml,v 1.3 2008/06/19 17:07:40 shindo Exp $ -->
+<!-- $Header: /var/cvsroot/gentoo/xml/htdocs/proj/ja/gdp/doc/doc-tipsntricks.xml,v 1.4 2008/06/19 18:01:30 shindo Exp $ -->
<guide link="/proj/ja/gdp/doc/doc-tipsntricks.xml">
<title>ドキュメント開発のTips & Tricks</title>
@@ -167,7 +167,7 @@
</body>
</section>
<section>
-<title>Gentoo Web差異とのローカルコピーをブラウズする</title>
+<title>Gentoo のWebサイトのローカルコピーをブラウズする</title>
<body>
<p>
--
gentoo-commits@lists.gentoo.org mailing list
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2008-06-19 18:01 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2008-06-19 17:07 [gentoo-commits] gentoo commit in xml/htdocs/proj/ja/gdp/doc: doc-tipsntricks.xml Naoaki Shindo (shindo)
-- strict thread matches above, loose matches on Subject: below --
2008-06-19 18:01 Naoaki Shindo (shindo)
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox