2. 全体の構造

2.1 最も簡単なサンプル

最も簡単な body.txt (原稿)のフォーマットは以下のようなものでしょう。

  # 最も簡単なサンプル
  Sec1: top 最も簡単なサンプル

  本文はこれだけ

一行目の # ではじまる行はコメントとみなされます。
Sec1: のように Sec に続いて数字、そのあとに : がつく行は章レベルを示します。その後ろに HTML ファイル名となるキーワード、章タイトルがつきます。

一番最初の章のキーワードとして top という名前を選んでいますが、結果的にこれが画面右半分に自動的に最初に開かれるページの HTML ファイル名 _top.html になります。一番最初の章の HTML ファイル名はもともとの index.html ファイルにハードコード(固定的に記述)されていますので、つまりここの top という名前は変えない方が良いでしょう。(変えるときは index.html とセットでどうぞ。)

2.2 ヘッダについて

HTML ファイルは上に書いてあった原稿の内容だけでなく、body.txtmkdocs.sh がおいてあるディレクトリと同じ階層にある以下の四つのファイルの内容を集めてできあがります。それぞれの中に HTML の TITLE タグの内容などが埋まっていますので、適宜このあたりを変更すると良いでしょう。

mkdocs_chead.dat画面左側の目次欄(_cotents.html)の前半
mkdocs_ctail.datその後半
mkdocs_bhead.dat画面右側の本文欄(_cotents.html)の前半
mkdocs_btail.datその後半

また、同様にトップページとなる index.html が RESOURCES ディレクトリ以下にありますので、ここも適宜修正すると良いでしょう。

そのほか、スタイルシートやボタンアイコンなどが RESOURCES ディレクトリには含まれています。


Yutaka Yasuda (yasuda@bakkers.gr.jp)