wiki:Vine-manual

Version 10 (modified by yasumichi, 10 years ago) (diff)

--

新 Vine-manual 構想

ドキュメントの追加を容易にするためにパッケージの構成変更を行う。

ツール類

Vine-manual-base

共通的に使う画像、スタイルシートなど。また、マニュアルを登録するコマンド、目次を更新するコマンドも用意。

Vine-manual/Vine-manual-base

vine-manual-build

Docbook XML から静的な HTML を作成するラッパースクリプト

vine-manual-skel

新しくマニュアルを作成する際に雛形となるディレクトリを作成できる。

  1. vine-hoge-guide のようなディレクトリを作成
  2. 上記ディレクトリ内でコマンドを叩くと次のようなファイルを作成する。
  • Makefile.am (サブディレクトリにも作成)
  • images/Makefile.am
  • configure.ac
  • vine-hoge-guide.omf.in

(vine-manual-build)に統合するかも。

ドキュメントのパッケージ構成

idの重複等をできるかぎり避けるため、マニュアル毎にパッケージを作成し、 /usr/share/doc/Vine-manual/hoge-guide のようなディレクトリに静的 HTML をインストールする。

基本は、yelp 用のファイルをインストールする。サブパッケージとして静的HTMLを vine-manual-build により生成し、格納する。

vine-install-guide

インストールガイド (task-* には含めない?)

vine-desktop-guide

Vine Linux デスクトップユーザーガイド

vine-cui-guide

Vine Linux CUI ユーザーガイド

vine-emacs-guide

Emacs 活用ガイド

vine-making-rpm

RPMパッケージの作成方法

vine-developers-guide

Vine Linux 開発者ガイド (task-*には含めない?)

vine-documentation-guide

Vine Linux マニュアル作成ガイド(task-*には含めない?)

task-vine-manual

すべてのマニュアルをインストールするためのバーチャルパッケージ

その他

Web への展開例

今のところ、DocumentRoot? が、/var/www/vinelinux.org/ であると決め打ち。配置先に書き込み権限がない場合、make install* は、sudo で実行してください。

vine-manual-base

$ ./configure --enable-web
$ make
$ make install

/var/www/vinelinux.org/docs/vine6/{css,images} にスタイルシート、画像が配置される。

vine-manual-build

rpm パッケージをインストール

ドキュメント類

(2011/07/08現在、svn で vine-install-guide, vine-desktop-guide のみ実施可能)

$ ./configure --enable-web
$ make figuresdir=/var/www/vinelinux.org/docs/vine6/(パッケージ名から vine- を除去)/figures install
$ cd help
$ vine-manual-build -i /docs/vine6/images -c /docs/vine6/css/vine.css -w package-name.xml
$ make xmldir=/var/www/vinelinux.org/docs/vine6/(パッケージ名から vine- を除去) install-html

package-name は、パッケージ名に置き換えてください。