[Codeigniter-users] ユーザガイド Sphinx への移行について

アーカイブの一覧に戻る

Kenji Suzuki kenji****@gmail*****
2011年 10月 6日 (木) 13:41:42 JST


Kenji です。


On Thu, 6 Oct 2011 13:12:58 +0900
Kenichi Ando <neo.k****@gmail*****> wrote:

> 安藤です。

> >> >> SphinxってPythonでできたユーザーガイド専用のwikiみたいな
> >> >> ものなんですね。
> >> >
> >> > そうですね。
> >> >
> >> > Sphix はドキュメンテーションツールで
> >> > http://sphinx-users.jp/doc11/
> >> >
> >> > 記述にはreStructuredText という Wiki での使われることのあるフォーマット
> >> > http://sphinx-users.jp/doc11/rest.html#rst-primer
> >> >
> >> > を使います。
> >>
> >> もしかしてCI日本ユーザ会のHPにインストール必須なんでしょうかね。
> >
> > いえ、いりませんよ。
> >
> > HTML ファイルをビルドするのに Sphinx が必要なだけですので、
> > ユーザ会サイトには、今までどおり HTML を置くだけです。
> 
> なるほど。
> よく考えると、各翻訳者ごとに自分でSphinxをインストールし、
> ビルドしたHTMLをコミットする流れになるのでしょうか?

いいえ。

HTML はリリース時にビルドするだけになると思います。


> そうすると、逆に敷居が上がらないでしょうか?

 
> 例えば、
> http://codeigniter.com/nightly_user_guide/
> 
> と置いているのは、ビルドのためなんでしょうかね。

自動的にビルドしたものを参照のために置いているということですね。

これを日本語版でもやろうとすると、サーバに Sphix が必要になりますね。


> もちろん普通にオンラインマニュアルとして使えますが。
> gitは今回のコンバートとビルドしたHTMLを配布用に管理して
> いるんでしょうかね。

HTML はなく、ソースファイルだけです。

 
> 1.現状の翻訳(英文)Sphinxを各マシンのSphinxに取り込む?
> 2.日本後の対訳を元に英文のSphinxを翻訳し、HTML化する
> 3.HTML化されたファイルを日本のgitで管理する
> 4.gitのファイルをベースにして、Sphinxに取り込み、ビルドする
> 5.配布物完成

必要なのは、まず、今、本家 GitHub にあるユーザガイドのソースファイルの
翻訳を用意し、ユーザ会 GitHub で管理することです。

例えば、

https://raw.github.com/EllisLab/CodeIgniter/develop/user_guide_src/source/changelog.rst

の日本語訳

user_guide_ja_src/source/changelog.rst

を用意するということですね。

翻訳作業としてはそれで完了です。


あとは、パッケージ作成時に HTML 化したユーザガイドを配布物に含めます。


// Kenji




Codeigniter-users メーリングリストの案内
アーカイブの一覧に戻る