倭マン's BLOG

くだらない日々の日記書いてます。 たまにプログラミング関連の記事書いてます。 書いてます。

Forrest を使ってみる (2) : プロジェクトの設定

今回はプロジェクトの設定を行います(一覧)。 扱うのは

${ForrestSite}/src/documentation/skinconf.xml

で設定できる内容です。

skinconf.xml で設定できる内容はたくさんありますが、個人的に使いそうなものをピックアップ。

  • プロジェクト名・グループ名を設定する
  • PDF ファイル(を自動生成する URL)へのリンクを削除する
  • セクション名、ページ目次の設定をする

これらの他に、ページ内の各部分の色を設定したりもできますが、今回は無視。 そのうち余裕があれば。

プロジェクト名・グループ名を設定する


プロジェクト名やグループ名などは必須の設定項目。 名前の他に URL も設定しておきましょう。 必須項目を表にすると下表のようになります:

設定項目 skinconf.xml 内での XPath 下記での例
プロジェクト名 skinconfig/project-name/text() Waman World
プロジェクトの URL skinconfig/project-url/text() http://www5.ocn.ne.jp/~coast/
グループ名 skinconfig/group-name/text() org.waman
グループの URL skinconfig/group-url/text() http://d.hatena.ne.jp/waman/

これらの設定は、具体的には以下のようにします(skinconf.xml):

<project-name>Waman World</project-name>
<project-url>http://www5.ocn.ne.jp/~coast/</project-url>

<group-name>org.waman</group-name>
<group-url>http://d.hatena.ne.jp/waman/</group-url>

PDF ファイル(を自動生成する URL)へのリンクを削除する


静的サイトを生成する場合には、あまり不必要なファイルを生成したくないので、PDF ファイルへのリンクを除去して、これらが生成されないようにしておくと効率的です。

この設定をするためには、skinconf.xml ファイルの skinconfig/disable-pdf-link/text() の値(テキスト)を「true」に設定します:

<disable-pdf-link>true</disable-pdf-link>

セクション名、ページ目次の設定をする


他にも、ページ内のセクションの表示形式 (skinconfig/headings/@type) やページ内のセクションを集めて自動的に作成される目次の表示形式 (skinconfig/toc/@*) などを設定することができます。

<toc max-depth="2" min-sections="1" location="page"/>
<!-- Heading types can be clean|underlined|boxed  -->
<headings type="boxed"/>

ちなみに、セクションの表示形式は clean(文字のみ)、underlined(下線)、boxed(囲み)の3つの値を指定できます。