"梓" Doxia site module の使い方

Maven artifact repository の設定

"梓" Doxia site module は，つくば文庫の Maven リポジトリで配布されています。

使用する際には，Maven プラグインが "梓" Doxia site module への依存を解決できるようにする必要があります。

つくば文庫の Maven リポジトリを登録するには POM の pluginRepositories 構成にリポジトリ情報を追加します。

Example:

  <pluginRepositories>
    <pluginRepository>
      <id>maven.tsukuba-bunko.org</id>
      <name>Tsukuba Bunko Maven artifact repository</name>
      <url>http://maven.tsukuba-bunko.org/repository</url>
    </pluginRepository>
  </pluginRepositories>


Doxia の構成

次に，Doxia に対して azusa-doxia-module を参照するように設定する必要があります。

azusa-doxia-module を登録するには POM の plugin 構成で，maven-site-plugin に対して依存を追加します。

Example:

  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <dependencies>
          <dependency>
            <groupId>org.tsukuba-bunko.azusa</groupId>
            <artifactId>azusa-doxia-module</artifactId>
            <version>0.1.0</version>
          </dependency>
        </dependencies>
      </plugin>
    </plugins>
  </build>


"梓" ドキュメントの作成

"梓" ドキュメントは，site ソースディレクトリの下の azusa ディレクトリに配置します。

+- src/
   +- site/
      +- azusa/
      |  +- index.txt
      |
      +- xdoc/
      |  +- other.xml
      |
      +- fml/
      |  +- general.fml
      |  +- faq.fml
      |
      +- site.xml

拡張子は ".txt" です。

"梓" ドキュメントのテキストフォーマットについては，「"梓"テキストフォーマット」を参照してください。


サイト生成

後は通常の maven-site-plugin のゴールを実行することで HTML が生成されます。