既にあるマニュアルを編集する手順- GLOBALBASE PROJECT | POWERD BY HIROHISA MORI

GLOBALBASEマニュアル集 >> マニュアル環境とマニュアルの書き方 >> 既にあるマニュアルを編集する手順
2007-11-04版

既にあるマニュアルを編集する手順

著者:　森　洋久 / joshua＠globalbase.org 　※　

* 概要
* この作業の前提となるシステム用件
* [ステップ1] CVSのチェックアウト
* [ステップ2] マニュアルを編集する
* [ステップ3] コンパイル
* [ステップ4] HTMLおよびPDFの確認
* [ステップ5] HTMLの公開
* [ステップ6] CVSチェックイン

概要

既にあるマニュアルを編集し、それを公開マニュアルに反映させる方法です。

▲ページトップへ戻る

この作業の前提となるシステム用件

本手順は、ソースコードの開発環境をそろえていることを前提としています。以下のファイルの保存場所などは、sourceforge.jpのCVSからコミットしたワークエリアに対する操作を説明しています。sourceforge.jpからのCVSの取得方法等については、文献「GLOBALBASEの開発」を参照してください。

▲ページトップへ戻る

[ステップ1] CVSのチェックアウト

CVSはチェックアウト出来ているでしょうか。チェックアウトする場合は、


% cvs co gbs -P gbs

とします。

[注意] チェックイン／チェックアウトはワークエリアのルートで行う必要があります。

▲ページトップへ戻る

[ステップ2] マニュアルを編集する

gbs/doc/xml/src/xmlの中のファイルを編集します。編集は、文献「マニュアル環境とマニュアルの書き方」に従ってください。なお、図表の編集は、「マニュアル文章に図や表を挿入する方法」を参照してください。

▲ページトップへ戻る

[ステップ3] コンパイル

マニュアルのコンパイルを実行します。


% cd gbs/doc/xml
% mmake

エラーが発生した場合は、エラーに対処してください。発生エラーのリファレンスは、「mmake時エラーリファレンス」です。

▲ページトップへ戻る

[ステップ4] HTMLおよびPDFの確認

生成結果を確認します。ディレクトリ、gbs/doc/xml/man/pdf 内にPDFファイルがあります。gbs/doc/xml/man/html内にHTMLファイルがあります。これらが正しく生成されているかどうか確認します。

▲ページトップへ戻る

[ステップ5] HTMLの公開

現時点では、HTMLの公開は基本的に森洋久が行います。しかし、ここで公開方法について述べます。gbs/doc/xml/man/htmlのディレクトリはCVSにコミットされているディレクトリでもあります。従って、これをそのまま公開すると、CVSという名前の制御ディレクトリまで公開されてしまいます。これを取り除く必要があります。取り除く方法は、


% cd gbs/doc/xml
% ./make.html.sh

という、取り除き用のスクリプト make.html.sh を実行します。これを実行すると、CVSといったディレクトリが取り除かれた公開用ディレクトリ、gbs/doc/xml/man/manが出来ます。このディレクトリを所定のWWWサーバへアップしてください。

[メモ] GLOBALBASEの公式マニュアルページは、http://www.globalbase.org/globalbase/man/ja-index.html ですが、基本的に、このディレクトリを他の場所へアップロードすると他の場所でも公開可能です。しかしその場合検索エンジンの窓は変更しておかないと、検索結果は、かならず公式ホームページへ飛ぶことになります。

▲ページトップへ戻る

[ステップ6] CVSチェックイン

最後に編集したファイルをCVSへチェックインします。開発したソースコードなどがある場合は、一緒にチェックイン出来ます。


% cvs commit -m "manual" gbs

[注意] チェックイン／チェックアウトはワークエリアのルートで行う必要があります。

▲ページトップへ戻る

$GLOBALBASE��AI[v\[XE\tgEFAxvOSOURCEFORGE.JP��QBĂ܂B$