Ethna Documentation Howto.

ここでは、Ethna のドキュメントを編集する方法を
記しています。

- 概要

ドキュメントのフォーマットは SmartDoc を使います。
これは HTMLライクな文法で覚えやすく、文書も分割
可能で分担作業も可能であると判断したため採用した
ものです。

http://www.smartdoc.jp

- さあ始めよう

1. まずは、あなたのマシン環境にJavaをインストールする必要
があります。http://java.sun.com からダウンロードしてインス
トールしてください。

2. SmartDoc のインストール

smartdoc-bin ディレクトリに最新のSmartDocバイナリが入って
いますので、以下のコマンドを実行し、指示に従ってインストール
してください

以下、Linux でのインストール例を示します。
sdoc コマンドに実行権限をつけるのを忘れないように！

$ cd smartdoc-bin
# java -jar beta.zip

# java -jar beta.zip
Install directory [default: /usr/local/lib/sdoc]:
Command directory [default: /usr/local/bin]:
Java memory size option [default: -Xmx128M]:

[Configuration]
Install directory = /usr/local/lib/sdoc
Command directory = /usr/local/bin
Java memory size option = -Xmx128M

Type "yes" to install, "no" to re-enter, "exit" to exit
> yes
Extract archives...
Generate script...
  script = /usr/local/bin/sdoc
Done. 
# chmod +x /usr/local/bin/sdoc

3. 文書を編集しよう

文書ファイルは .sdoc という拡張子をつけて保存します。
このファイルは src 以下に置かれています。
以下にSmartdocのマニュアルがありますので、随時参照
しつつ編集してみてください。

また、文書のエンコーディングはUTF-8とします。

http://www.asahi-net.or.jp/~dp8t-asm/java/tools/SmartDoc/preview/beta/index.html

4. 実際に文書を生成する

sdoc ファイルから実際のマニュアルを生成するには、sdoc
コマンドを使います。必ず srcディレクトリで実行して下さい！

$ cd src
$ sdoc hoge/bar.sdoc