root/docs/Ethna/ETHNA_DOCUMENTATION_HOWTO

Revision 10912, 2.1 kB (checked in by mumumu, 8 months ago)

- added howto documentation and skelton, smartdoc binary.

Line 
1Ethna Documentation Howto.
2
3ここでは、Ethna のドキュメントを編集する方法を
4記しています。
5
6- 概要
7
8ドキュメントのフォーマットは SmartDoc を使います。
9これは HTMLライクな文法で覚えやすく、文書も分割
10可能で分担作業も可能であると判断したため採用した
11ものです。
12
13http://www.smartdoc.jp
14
15- さあ始めよう
16
171. まずは、あなたのマシン環境にJavaをインストールする必要
18があります。http://java.sun.com からダウンロードしてインス
19トールしてください。
20
212. SmartDoc のインストール
22
23smartdoc-bin ディレクトリに最新のSmartDocバイナリが入って
24いますので、以下のコマンドを実行し、指示に従ってインストール
25してください
26
27以下、Linux でのインストール例を示します。
28sdoc コマンドに実行権限をつけるのを忘れないように！
29
30$ cd smartdoc-bin
31# java -jar beta.zip
32
33# java -jar beta.zip
34Install directory [default: /usr/local/lib/sdoc]:
35Command directory [default: /usr/local/bin]:
36Java memory size option [default: -Xmx128M]:
37
38[Configuration]
39Install directory = /usr/local/lib/sdoc
40Command directory = /usr/local/bin
41Java memory size option = -Xmx128M
42
43Type "yes" to install, "no" to re-enter, "exit" to exit
44> yes
45Extract archives...
46Generate script...
47  script = /usr/local/bin/sdoc
48Done.
49# chmod +x /usr/local/bin/sdoc
50
513. 文書を編集しよう
52
53文書ファイルは .sdoc という拡張子をつけて保存します。
54このファイルは src 以下に置かれています。
55以下にSmartdocのマニュアルがありますので、随時参照
56しつつ編集してみてください。
57
58また、文書のエンコーディングはUTF-8とします。
59
60http://www.asahi-net.or.jp/~dp8t-asm/java/tools/SmartDoc/preview/beta/index.html
61
624. 実際に文書を生成する
63
64sdoc ファイルから実際のマニュアルを生成するには、sdoc
65コマンドを使います。必ず srcディレクトリで実行して下さい！
66
67$ cd src
68$ sdoc hoge/bar.sdoc
Note: See TracBrowser for help on using the browser.