<% Include("/hsphere/local/home/terraint/common.phps");%> Alexandria:CVS,Javadoc,ソースコード,ドキュメント管理システム - Alexandria Configuration
Alexandria

Alexandria

リファレンス

日本語訳 (Translations)

オリジナル

Workspace Definition

Alexandriaの主な設定ファイルは、workspace.xmlファイルです。 このファイルは、Alexandriaが使う全てのレポジトリの詳細を含んでいます。 各々のレポジトリには、Alexandriaが表示するモジュールのリストを含んでいます。

  • <workspace> - このworkspace.xml設定ファイルのルート要素
    • @version - Workspaceスキーマのバージョン番号
  • <repository> - このworkspaceで使用されるレポジトリを規定
    • @href - レポジトリの定義がある場所(URI)
  • <project> - このworkspaceに含まれるプロジェクト
    • @href - プロジェクトの定義がある場所(URI)
    • @tag - ビルドに使用されるレポジトリタグ要素名
  • <nav-page> - このworkspaceから生成されるナビゲーションページ
    • @style - スタイルシートのある場所(URI)
    • @out - 出力ファイル名
  • <build-sheet> - Antビルドの出力のフォーマット用のスタイルシート
    • @style - スタイルシートのある場所(URI)
  • <clog-sheet> - ログ更新履歴を出力するフォーマット用のスタイルシート
    • @style - スタイルシートのある場所(URI)
  • <blame-sheet> - Blameログのフォーマッティング用のスタイルシート
    • @style - スタイルシートのある場所(URI)
    • @size - Blameログ内に蓄積する項目数

Workspace定義の例:


<?xml version="1.0" encoding="ISO-8859-1"?>

<workspace version="0.2">
  <!-- Respository definitions -->
  <repository href="repositories/jakarta.apache.org.xml"/>
  <repository href="repositories/xml.apache.org.xml"/>

  <!-- Project definitions -->
  <project href="projects/Alexandria.xml"  tag="HEAD"/>
  <project href="projects/Jetspeed.xml"    tag="HEAD"/>
  <project href="projects/Ant.xml"         tag="HEAD"/>
  <project href="projects/Xalan.xml"       tag="HEAD"/>
  <project href="projects/Cocoon.xml"      tag="HEAD"/>
  <project href="projects/Cocoon.xml"      tag="xml-cocoon2"/>
  <project href="projects/Stylebook.xml"   tag="HEAD"/>
  <project href="projects/FOP.xml"         tag="HEAD"/>

  <!-- Navigation pages -->
  <nav-page style="xsl/links.xsl"          out="html/links.html"/>
  <nav-page style="xsl/right.xsl"          out="html/right.html"/>
  <nav-page style="xsl/top.xsl"            out="html/top.html"/>
  <nav-page style="xsl/left-basic.xsl"     out="html/left-basic.html"/>
  <nav-page style="xsl/left-advanced.xsl"  out="html/sidebar/content.js"/>

  <!-- Output style sheets -->
  <build-sheet style="xsl/blog.xsl" />
  <clog-sheet  style="xsl/clog.xsl" />
  <blame-sheet style="xsl/blame.xsl" size="50" />
</workspace>


Repository Definition

レポジトリ定義は、workspace内で使用されるソースコード定義に使われます。

  • <repository> - レポジトリ定義のルート要素
    • @name - workspace内でレポジトリを識別する為の名前
    • @type - レポジトリの種類(現在は、localもしくはCVSのみ)
  • <title> - レポジトリのタイトル
  • <root> - レポジトリのルートのある場所
  • <home-page> - レポジトリ用のホームページ(URL)
  • <password> - レポジトリに入るためのパスワード
  • <cvsweb> - レポジトリのweb view
  • <description> - レポジトリの説明

レポジトリ定義の例:

<?xml version="1.0" encoding="ISO-8859-1"?>

<repository name="jakarta.apache.org" type="cvs">
  <title>jakarta.apache.org</title>
  <root>:pserver:anoncvs@jakarta.apache.org:/home/cvspublic</root>
  <home-page>http://jakarta.apache.org/</home-page>
  <password>anoncvs</password>
  <cvsweb>http://jakarta.apache.org/cvsweb/index.cgi/</cvsweb>
  <description>The Jakarta Project Source Repository</description>
</repository>


Project Definition

プロジェクト定義は、workspace内で使用されるプロジェクトを規定します。

プロジェクト定義はプロジェクトの詳細を記述する為、プロジェクト定義が、ソースコード全体が必要とされる記述のあるAlexandriaとは別の場所である事は容易に想像できる事でしょう。一つのURLから、ビルドをダウンロードし、コードを設定する、というのが利用法として可能性が高いでしょう。

  • <project> - プロジェクト定義のルート要素
    • @repository - プロジェクトのソースコードを取ってくるレポジトリ
    • @opensource - ソースコードが一般公開されてよいものであるかどうか
  • <title> - プロジェクトのタイトル
  • <module> - レポジトリ内でプロジェクトを特定するためのモジュール名
  • <license> - このプロジェクトの頒布ライセンス
    • @href - ライセンス定義の場所
  • <description> - プロジェクトの説明
  • <javasrc> - このプロジェクト内のjavaソースコードのルートディレクトリ
  • <build> - このプロジェクトでのビルド定義
    • @file - このプロジェクトでの、Antビルドファイル名(デフォルトはbuild.xml)
    • @target - このプロジェクトでの、Antのターゲットディレクトリ(デフォルトはビルドファイル内のデフォルト値)
    • @classpath - このプロジェクトをビルドする際にAntが使うCLASSPATH
    • <arg> - ビルド時にAntが使用するパラメタ
      • @name - パラメタ名
      • @value - パラメタ値
  • <test> - このプロジェクトのtest定義
    • @file - このプロジェクトでのtestビルドのビルドファイル名
    • @target - このプロジェクトでのtestビルドのターゲットディレクトリ
    • @classpath - このプロジェクトのtestをビルドする際にAntが使うCLASSPATH
  • <arg> - testビルド時にAntが使用するパラメタ
    • @name - パラメタ名
    • @value - パラメタ値
  • <depend> - このworkspace内の他のプロジェクトへの依存関係の定義
    • @project - プロジェクト名
  • <option> - このworkspace内の他のプロジェクトへの依存関係の定義
    • @project - プロジェクト名
  • <jar> - このプロジェクトで出力されるjarファイルの定義
    • @name - jarファイル名
  • <project> - サブプロジェクトを定義するためネストされるプロジェクト名

プロジェクト定義の例:

<?xml version="1.0" encoding="ISO-8859-1"?>

<project repository="jakarta.apache.org" opensource="true">
  <title>Alexandria</title>
  <module>jakarta-alexandria</module>
  <license>ASL</license>
  <description>Internet content management system</description>
  <home-page>http://jakarta.apache.org/alexandria/</home-page>
  <javasrc>src/java</javasrc>
  <build file="build.xml">
    <arg name="build.dir" value="../build"/>
  </build>
</project>


AlexandriaResources.properties

レポジトリには直接関わりのないオプションが、AlexandriaResources.propertiesファイルで定義されます。

# Destination directory for JXR output
jxr.destination.directory=/var/www/html/content/html/jxr

# images for JXR.  These are actually copied over to the desired location so a
# file is required here.
jxr.image.file=content/html/file.gif
jxr.image.folder=content/html/folder.gif

# Directory where Alexandria does its CVS checkouts to.
cvs.checkout.directory=/var/www/html/content/cvs

# Size of blame history
blame.size=50



Copyright © 1999-2005, Apache Software Foundation
Translated into Japanese by Tetsuya Kitahata , powered by Terra-International, Inc.
<% orig();%>