2018年10月
日 月 火 水 木 金 土
  1 2 3 4 5 6
7 8 9 10 11 12 13
14 15 16 17 18 19 20
21 22 23 24 25 26 27
28 29 30 31      

最近のトラックバック

最近買った本(Amazon.co.jp)

広告(Amazon.co.jp)

広告(Google AdSense)

@niftyが提供する
無料ブログはココログ！
無料ブログはココログ

カテゴリー「Java」の3件の記事

2011年9月19日 (月)

Eclipse入門: 日本語APIドキュメントをローカル環境、及び、ホバー表示で使用する。

目次

はじめに
日本語APIドキュメントのインストール
ダウンロード
インストール
MergeDocのインストール
ダウンロード
インストール
Mergedocの使用方法
起動方法
操作方法
マージしたソースコードのインストール
Eclipseの設定
ドキュメントの参照先の変更
動作確認

はじめに

以前「Android入門： Androidの開発環境を作成する。(Linux/Windows対応版)」という記事で、日本語化プラグインPleiadesを使用してEclipseを日本語化する方法を説明した。PleiadesではEclipseのメニューやダイアログ、及び、エディタ上でJavaの標準APIのクラスやメソッドにカーソルを合わせてShift+F2を押下したときに表示されるドキュメントが日本語化される。

しかし、このドキュメントについてはインターネット上にあるJDKの日本語APIドキュメントを参照しているため、インターネットに接続していない環境では表示できない。また、エディタ上でJavaの標準APIのクラスやメソッドにマウスカーソルを合わせるとそれらの説明がホバー表示されるが、取得元のJDKのソースコードのコメントが英語で記述されているため、表示される説明も英語のままとなる。

そこで今回は、日本語APIドキュメントをローカルから参照する方法、及び、ホバー表示を日本語化する方法について説明する。

使用環境

  • Windows 7 Professional SP1

  • Ubuntu 11.04 Desktop 日本語Remix

  • JDK 6 update 27

  • Eclipse 3.7 Indigo + Pleiades 1.3.3

日本語APIドキュメントのインストール

日本語APIドキュメントをローカル環境にインストールする方法を説明する。インターネット上の日本語APIドキュメントについては、OracleのJavaのドキュメントページから[API]をクリックするとバージョンと言語ごとにドキュメントをまとめたページに遷移するので、例えば、[JDK Programmer Guides/6]の[Japanese]をクリックすれば、JDK 6の日本語APIドキュメントが参照できる。EclipseにPleiadesをインストールするとJavadocの参照先が英語版からこちらの日本語版に変更される。尚、現時点ではJDK 7の日本語APIドキュメントは準備されていない。

ダウンロード

日本語APIドキュメントをローカル環境で使用するには、これらのファイルをまとめてダウンロードする必要がある。しかし、Javaのダウンロードページから[Java SE 6 Documentation]の[Download]をクリックしドキュメントのダウンロードページに遷移しても英語版のアーカイブしか見当たらない。

というわけで、OracleとSunのサイトをあちこち探してみたが、以前は用意されていた日本語APIドキュメントのアーカイブが何処にも見当たらない。それらしいリンクをクリックしても英語版のページに飛ばされるだけである。どうやらサイトがリニューアルされたさいに行方不明になってしまったようだ。

いろいろ検索した結果、2chのプログラム板のJavaスレッドの書き込みから何とか無事にアーカイブを入手することができた。44さんありがとう！！因みにファイル名は以下の通りである。また、以降ファイルをダウンロードしたディレクトリを<download_dir>とする。

jdk-6u21-docs-ja.zip

また、複数バージョンのJDKをインストールして使い分けている場合、そのバージョンにあった日本語APIドキュメントのアーカイブが必要となる。updateのバージョンが異なる程度では殆ど問題ないが、メジャーバージョンが異なるとAPIの構成も異なるため問題が発生する。

2011/10/02追記：上記スレッドは過去ログ倉庫に落ちてしまったので、以下に該当部分を転載する。

http://hibari.2ch.net/test/read.cgi/tech/1312958339/41-44
42 名前：デフォルトの名無しさん[] 投稿日：2011/08/14(日) 11:26:57.48
Java6 の Javadoc 日本語ってダウンロードできなくなったの？
ja のリンクや言語の選択すらできん

43 名前：デフォルトの名無しさん[sage] 投稿日：2011/08/14(日) 11:38:29.02
所詮はオラクルがやることだからな

44 名前：デフォルトの名無しさん[sage] 投稿日：2011/08/14(日) 13:58:54.51
Oracleは正直よくわからん。
http://bit.ly/p8j9OL
jdk-6u21-docs-ja.zip

インストール

特にインストーラーなどは用意されていないので、ダウンロードしたアーカイブを対応するVersionの<java_home>にコピー、及び、展開する。尚、以降JDKがインストールされたディレクトリを<java_home>とする。

Linuxの場合

  1. アーカイブを<java_home>にコピーする。

    $ sudo cp <download_dir>/jdk-6u21-docs-ja.zip /opt/jdk1.6.0_27/

  2. unzipを使用してアーカイブを<java_home>の下に展開する。

    $ cd /opt/jdk1.6.0_27/
$ sudo unzip jdk-6u21-docs-ja.zip

Windowsの場合

  1. 管理所特権でコマンドプロンプトを起動する。

    ツールバーの[スタート] ボタンをクリックする。→[検索] ボックスに「コマンド」と入力する。→結果一覧で [コマンド プロンプト] を右クリックし、[管理者として実行] を選択する。

  2. アーカイブを<java_home>にコピーする。

    > copy <download_dir>/jdk-6u21-docs-ja.zip "C:\Program Files\Java\jdk1.6.0_27\"

  3. 7-zipなどのファイルアーカイバを使用してアーカイブを<java_home>の下に展開する。

    > c:
> cd "\Program Files\Java\jdk1.6.0_27"
> "C:\Program Files\7-Zip\7z.exe" x jdk-6u21-docs-ja.zip

MergeDocのインストール

MergeDocはJDKのソースコードと日本語APIドキュメントをマージするツールである。MergeDocを使用してソースコードのコメントを日本語化すれば、標準APIのホバー表示だけでなくソースコードを参照したときのコメントも日本語化されることになる。

尚、MorgeDocのダウンロードページには「Eclipse 3.2 以降ではホバー表示は API ドキュメント HTML ソースから取得できるようになったため、ホバー表示のみを使用する場合は、MergeDoc は不要です。」とあるが、現状のEclipseではホバー表示の内容はソースコード→APIドキュメントの順番に検索されるため、ソースコードの参照とホーバー表示の日本語化を両立させるにはやはりMergedocが必要となる。

ダウンロード

MergeDocは日本語化プラグインのPleiadesと同じMergeDoc Projectのサイトで配布されている。MergeDoc Projectのトップページから左側のメニューの[MergeDoc / Javadoc 日本語化]をクリックするとMorgeDocのダウンロードページに遷移するので、「ダウンロード」から「MergeDoc本体」の最新版である[Version 2.1.4]をダウンロードする。尚、アーカイブのファイル名は以下の通り。また、以降ファイルをダウンロードしたディレクトリを<download_dir>とする。

mergedoc.zip

インストール

特にインストーラーなどは用意されていないので、ダウンロードしたアーカイブを適当なディレクトリに展開する。

Linuxの場合

ホームディレクトリの下にディレクトリmergedocを作成し、unzipを使用してアーカイブをその中に展開する。

$ cd
$ mkdir mergedoc
$ cd mergedoc
$ unzip <download_dir>/mergedoc.zip

Windowsの場合

C:\optの下にディレクトリmergedocを作成し、7-zipなどのファイルアーカイバを使用してアーカイブをその中に展開する。

> c:
> cd \opt
> mkdir mergedoc
> cd mergedoc
> "C:\Program Files\7-Zip\7z.exe" x <download_dir>\mergedoc.zip

Mergedocの使用方法

Mergedocを使用してJDKのソースコードと日本語APIドキュメントをマージする方法を説明する。

起動方法

MergedocはJavaアプリケーションのため、javaコマンドを使用して起動する。尚、-serverオプションを付けると処理が高速になるらしい。

Linuxの場合

$ cd ~/mergedoc
$ java -server -jar mergedoc.jar

Windowsの場合

> c:
> cd \opt\mergedoc
> java -server -jar mergedoc.jar

操作方法

Mergedocの操作方法について説明する。

  1. Mergedocが起動したら「基本設定」の以下の項目に値を設定する。

    • APIドキュメントディレクトリ

      日本語APIドキュメントを格納しているディレクトリを設定する。具体的にはpackage-listファイルがあるディレクトリとなる。また、エンコーディングの設定は「EUC-JP」とする。

    • 入力ソースアーカイブファイル

      Javaのソースコードのアーカイブを設定する。また、元のソースコードにはASCII以外の文字は含まれていないのでエンコーディングの設定は意味がないが、とりあえず「UTF-8」とする。

    • 出力ソースアーカイブファイル

      マージしたソースコードを出力する新規のアーカイブファイルを設定する。また、エンコーディングの設定は「UTF-8」とする。

    Linuxの場合

    以降<user_home>はユーザーのホームディレクトリとする。

    APIドキュメントディレクトリ /opt/jdk1.6.0_27/docs/ja/api EUC-JP
    入力ソースアーカイブファイル /opt/jdk1.6.0_27/src.zip UTF-8
    出力ソースアーカイブファイル <user_home>/src_ja_utf8.zip UTF-8

    Windowsの場合

    APIドキュメントディレクトリ C:\Program Files\Java\jdk1.6.0_27\docs\ja\api EUC-JP
    入力ソースアーカイブファイル C:\Program Files\Java\jdk1.6.0_27\src.zip UTF-8
    出力ソースアーカイブファイル C:\opt\src_ja_utf8.zip UTF-8

    また、「詳細設定」はデフォルトのままどの項目もチェックなしとする。

  2. [実行]ボタンを押下して、マージ処理を開始する。途中コンソールに以下のような警告がいくつか表示されるが、無視しても特に問題ないようだ。

    WARN  Comment - <コード名> 行数調整不可のためマージ出来ませんでした。
WARN  JavaBuffer - Javadoc コメントの後のシグネチャを取得できませんでした。

  3. マージが終了したら、[終了]ボタンを押下してアプリケーションを終了する。

マージしたソースコードのインストール

マージしたソースコードのアーカイブを<java_home>に移動する。

Linuxの場合

  • アーカイブを<java_home>に移動する。

    $ sudo mv <user_home>/src_ja_utf8.zip /opt/jdk1.6.0_27/

Windowsの場合

  1. 管理所特権でコマンドプロンプトを起動する。

    ツールバーの[スタート] ボタンをクリックする。→[検索] ボックスに「コマンド」と入力する。→結果一覧で [コマンド プロンプト] を右クリックし、[管理者として実行] を選択する。

  2. アーカイブを<java_home>に移動する。

    > move C:\opt\src_ja_utf8.zip "C:\Program Files\Java\jdk1.6.0_27\"

Eclipseの設定

インストールした日本語APIドキュメント、及び、マージしたソースコードのアーカイブをEclipseから使用する方法について説明する。

ドキュメントの参照先の変更

Eclipseの設定で、以下のJREシステム・ライブラリーの「Javadoc ロケーション」、及び、「ソース添付」項目をローカル環境の日本語APIドキュメント、及び、マージしたソースコードのアーカイブに変更する。

  • <java_home>/jre/lib/resources.jar

  • <java_home>/jre/lib/rt.jar

  • <java_home>/jre/lib/jsse.jar

  • <java_home>/jre/lib/jce.jar

  • <java_home>/jre/lib/charsets.jar

また、複数バージョンのJDKをインストールして使い分けている場合、JDK毎に同様の設定が必要となる。

  1. Eclipseのウィンドウメニューから[設定]を選択する。

  2. 設定ダイアログで、左側の一覧の[Java]を展開し、[インストール済の JRE]を選択する。

  3. 「インストール済のJRE」の一覧から「jdk1.6.0_27」を選択し、[編集]ボタンを押下する。

  4. JREの編集ダイアログで、「JREの編集JREシステム・ライブラリー」から「<java_home>/jre/lib/resources.jar」を選択し、[javadoc ロケーション]ボタンを押下する。

    Javadocダイアログが表示される。デフォルトでは「Javadoc URL (例 ～)」ラジオボタンが選択され、「Javadoc ローケーション・パス」にインターネット上の日本語APIドキュメントのURLが設定されている。

    Javadoc ローケーション・パス http://java.sun.com/javase/ja/6/docs/ja/api/

  5. Javadocダイアログで、「アーカイブ内の Javadoc」ラジオボタンを選択し、「アーカイブ・パス」にローカル環境の日本語APIドキュメントのアーカイブのパス、「アーカイブファイル内のパス」に「docs/ja/api」を設定する。

    Linuxの場合

    アーカイブ・パス /opt/jdk1.6.0_27/jdk-6u21-docs-ja.zip
    アーカイブファイル内のパス docs/ja/api

    Windowsの場合

    アーカイブ・パス C:\Program Files\Java\jdk1.6.0_27\jdk-6u21-docs-ja.zip
    アーカイブファイル内のパス docs/ja/api

  6. [検証]ボタンを押下して以下の確認ダイアログが表示されることを確認する。

    Javadocの参照方法ロケーションの検証中
[!] ロケーションは有効のようです。ファイル'package-list'および'index.html'が検出されました。

    ただし、Windowsでは以下の警告ダイアログが表示される。

    Javadocの参照方法ロケーションの検証中
[!] Javadoc ロケーションは検証できません。

    どうやらEclipceの現バージョンではパスに空白が入っていると検証に失敗してしまうようだ。しかし、動作に問題は無いのでこのまま設定する。

  7. [OK]ボタンを押下して、Javadocダイアログをクローズする。

  8. JREの編集ダイアログで、「JREの編集JREシステム・ライブラリー」から「<パス名>/rt.jar」を選択し、[ソース添付]ボタンを押下する。

    ソース添付構成ダイアログが表示される。デフォルトでは「ローケーション・パス」に<java_home>の下のソースコードのアーカイブのパスが設定されている。

    Linuxの場合

    ローケーション・パス /opt/jdk1.6.0_27/src.zip

    Windowsの場合

    ローケーション・パス C:/Program Files/Java/jdk1.6.0_27/src.zip

  9. ソース添付構成ダイアログで、「アーカイブ・パス」にマージしたソースコードのアーカイブのパスを設定する。

    Linuxの場合

    ローケーション・パス /opt/jdk1.6.0_27/src_ja_utf8.zip

    Windowsの場合

    ローケーション・パス C:/Program Files/Java/jdk1.6.0_27/src_ja_utf8.zip

  10. [OK]ボタンを押下して、ソース添付構成ダイアログをクローズする。

  11. JREの編集ダイアログに戻るので、以下のライブラリの「Javadoc ロケーション」、及び、「ソース添付」も同様に変更する。

    rt.jar,jsse.jar,jce.jar,charsets.jar

  12. [完了]ボタンを押下して、JREの編集ダイアログをクローズする。

  13. [OK]ボタンを押下して、設定ダイアログをクローズする。

動作確認

設定が終わったら適当なソースに「String s;」と記述して、カーソルを合わせてShift+F2を押下する。内部Webブラウザーにドキュメントが表示されたら画面を右クリックしてプロパティを選択する。プロパティの「アドレス(URL)」が以下のようにローカル環境のアーカイブになっていれば、「Javadoc ロケーション」の設定は正しく行われている。

http://127.0.0.1:<ポート番号>/help/nftopic/jar:file:<java_home>/jdk-6u21-docs-ja.zip!/docs/ja/api/java/lang/String.html

また、「String s;」にマウスカーソルを合わせると表示されるホバー表示、及び、Ctrl+左クリックで表示されるソースコードのコメントが日本語化されていれば、「ソース添付」の設定は正しく行われている。

以上

2011/10/02、日本語APIドキュメントのダウンロードに追記した。

2011年9月19日 (月) Linux, Windows, Eclipse, Java | | コメント (0) | トラックバック (0)

2011年8月26日 (金)

Android入門： Androidの開発環境を作成する。(Linux/Windows対応版)

目次

はじめに
JDKのインストール
ダウンロード
インストール
環境変数の設定
Eclipseのインストール
ダウンロード
インストール
日本語化
SVNプラグインの追加
Android SDKのインストール
ダウンロード
インストール
SDKのダウンロード
ADT Pluginのインストール

はじめに

Androidアプリケーションを開発するには、オープンソースの統合開発環境であるEclipse、Android Developersで配布されているAndroid SDK、及び、Android Development Tools (ADT) Pluginなどが必要となる。この文書では、Linux環境、及び、Windows環境にAndroidの開発環境を作成する方法について説明する。

使用環境

  • Windows 7 Professional SP1

  • Ubuntu 11.04 Desktop 日本語Remix

  • JDK 6 update 27

  • Eclipse 3.7 Indigo + Pleiades 1.3.3

JDKのインストール

Eclipse、及び、Android SDKを使用するには、JAVAの開発環境のJDKが必要となる。ここではJDKのインストール方法について説明する。

尚、7/28にJDK 7がリリースされているが、現時点では安定していないため、JDK 6の最新版を使用する。

ダウンロード

OracleのJAVAのダウンロードページより環境に応じたインストーラーをダウンロードする。また、以降ファイルをダウンロードしたディレクトリを<download_dir>とする。

Linuxの場合

  1. JAVAのダウンロードページより、[Java SE 6 Update 27]→[JDK→Dawnload]を押下する。

  2. ライセンスに同意するため、「(o)Accept License Agreement」項目をチェックする。

  3. 一覧から次のLinux x86版の自己展開インストーラーをダウンローする。

    Product / File Description Java SE Development Kit 6 Update 27 Linux x86 - Self Extracting Installer
    Download jdk-6u27-linux-i586.bin

Windowsの場合

  1. JAVAのダウンロードページより、[Java SE 6 Update 27]→[JDK]→[Dawnload]を押下する。

  2. ライセンスに同意するため、「(o)Accept License Agreement」項目をチェックする。

  3. 一覧から次のWindows x86版のインストーラーをダウンローする。

    Product / File Description Java SE Development Kit 6 Update 27 Windows x86
    Download jdk-6u27-windows-i586.exe

インストール

インストーラーを実行し、適当なディレクトリにJDKをインストールする。以降このディレクトリを<java_home>とする。

Linuxの場合

  1. インストール先はディレクトリ/optの下とする。まずカレントディレクトリをこの下の変更する。

    $ cd /opt

  2. インストール先への書き込みは管理者権限が必要なため、自己展開インストーラーをsudoで実行する。

    $ sudo sh <download_dir>/jdk-6u27-linux-i586.bin
[sudo] password for user: ←管理者パスワードを入力する。

  3. インストールが成功すると以下のようなメッセージが表示されるので、[Enter]キーを押下してインストーラーを終了する。

    Java(TM) SE Development Kit 6 successfully installed.
Product Registration is FREE and includes many benefits:
  (中略)
Press Enter to continue..... ←[Enter]キーを押下する。

Done.

  4. Webブラウザが起動されJDKの登録画面が表示されるが、特に登録する必要はないため、そのままブラウザを終了する。

  5. その結果、以下のディレクトリにJDKがインストールされる。

    /opt/jdk1.6.0_27

Windowsの場合

  1. エクスプローラーからJDKのインストーラーを起動する。

  2. 起動画面で[次へ]ボタンを押下して、インストール機能の選択へ進む。

  3. インストール機能の選択で、「Java DB」のインストールの選択を解除する。

  4. インストール先については全てデフォルトのまま、[次へ]ボタンを押下する。

  5. インストールが成功するとJDKが正常にインストールされたことを示す画面が表示されるので、[完了]ボタンを押下してインストーラーを終了する。

  6. Webブラウザが起動されJDKの登録画面が表示されるが、特に登録する必要はないため、そのままブラウザを終了する。

  7. その結果、以下のディレクトリにJDKがインストールされる。

    C:\Program Files\Java\jdk1.6.0_27

環境変数の設定

JAVAアプリケーションがJDKのツール、及び、ライブラリを見つけられるように、環境変数JAVA_HOME、及び、PATHを設定する。

Linuxの場合

  1. ファイル~/.profileの末尾に以下の内容を追加する。

    $ vi ~/.profile
    # Java Development Kit
if [ -z "$JAVA_HOME" ] ; then
  JAVA_HOME="/opt/jdk1.6.0_27"; export JAVA_HOME
  PATH="$JAVA_HOME/bin:$PATH"
fi

  2. 変更を現在の環境に適用する。

    $ source ~/.profile

  3. 以下のコマンドを実行して、環境変数が正しく設定されていることを確認する。

    $ printenv
  :
JAVA_HOME=/opt/jdk1.6.0_27
  :
PATH=/opt/jdk1.6.0_27:(省略)

  4. 以下のコマンドを実行して、JDKのコマンドが実行できること、及び、バージョンが正しいことを確認する。

    $ java -version
java version "1.6.0_27"
Java(TM) SE Runtime Environment (build 1.6.0_27-b07)
Java HotSpot(TM) Client VM (build 20.2-b06, mixed mode, sharing)

Windowsの場合

  1. Windows 7/Vistaの場合、[コンピュータ]を右クリック→[プロパティ]→[システムの詳細設定]→[詳細設定]タブをクリック→[環境変数]ボタンを押下し、環境変数ダイアログを表示する。

  2. Windows XPの場合、[マイ コンピューター]を右クリック→[プロパティ]→[詳細設定]タブをクリック→[環境変数]ボタンを押下し、環境変数ダイアログを表示する。

  3. 「システム環境変数」項目の[新規]ボタンを押下し、新しいシステム変数ダイアログを表示する。

  4. 「変数名」と「変数値」に以下の値を入力し、[OK]ボタンを押下して環境変数ダイアログに戻る。

    変数名 JAVA_HOME
    変数値 C:\Program Files\Java\jdk1.6.0_27

  5. 環境変数ダイアログで、「システムの環境変数」一覧から環境変数Pathを選択し[編集]ボタンを押下する。

  6. システム変数の編集ダイアログがオープンされるので、環境変数Pathの値の先頭にJAVA_HOMEの実行ファイルパスを追加する。

    変数名 Path
    変数値 %JAVA_HOME%\bin;(元のPathの値)

  7. 以下のコマンドを実行して、環境変数が正しく設定されていることを確認する。

    > set
  :
JAVA_HOME=C:\Program Files\Java\jdk1.6.0_27
  :
PATH=C:\Program Files\Java\jdk1.6.0_27;(省略)

  8. 以下のコマンドを実行して、JDKのコマンドが実行できること、及び、バージョンが正しいことを確認する。

    > java -version
java version "1.6.0_26"
Java(TM) SE Runtime Environment (build 1.6.0_27-b07)
Java HotSpot(TM) Client VM (build 20.2-b06, mixed mode, sharing)

Eclipseのインストール

Eclipseは開発対象に応じていくつかのパッケージが用意されている。Androidアプリケーションの開発ではJAVAの開発環境が必要となるため、ここではEclipseのJAVA用のパッケージをインストールする。また、Linuxの場合、日本語化プラグインのPleiadesのインストール、及び、バージョン管理ツールのSVNプラグインのインストールについても説明する。Windowsの場合、MergeDoc Projectのサイトで日本語化済みのパッケージが配布されているので、こちらをインストールする。

ダウンロード

Linuxの場合、EclipseのサイトからEclipseのJava用のパッケージをダウンロードする。また、MergeDocのサイトから日本語化プラグインPleiadesをダウンロードする。Windowsの場合、MergeDoc ProjectのサイトでEclipseの日本語化済みパッケージが配布されているので、こちらをダウンロードする。また、以降ファイルをダウンロードしたディレクトリを<download_dir>とする。

Linuxの場合

  1. Eclipseのダウンロードページより、パッケージ一覧のヘッダーにある「Eclipse Indigo (3.7) Packages for」項目のドロップダウンリストから「Linux」を選択する。

  2. 「Eclipse IDE for Java Developers」パッケージ右側の[Linux 32 Bit]を押下して、ファイルを適当なディレクトリに保存する。

    eclipse-java-indigo-linux-gtk.tar.gz

  3. MergeDoc Projectのサイトより、「Pleiades 本体ダウンロード」の[1.3.3]を押下して、ファイルを適当なディレクトリに保存する。

    pleiades_1.3.3.zip

Windowsの場合

  1. MergeDoc Prjectのサイトより、「日本語 Eclipse / Pleiades All in One 日本語ディストリビューション (zip ファイル)」の[Eclipse 3.7 Indigo Pleiades All in One]ボタンを押下する。

  2. 「Pleiades All in One 日本語ディストリビューション (zip) ダウンロード」より、パッケージ一覧の[Java/Standard All in One (JRE なし)]の[Download]ボタンを押下して、ファイルを適当なディレクトリに保存する。

    pleiades-e3.7-java_20110704.zip

インストール

ダウンロードしたEclipseのパッケージをインストール先のディレクトリに展開する。Windowsの場合、日本語化済みのパッケージにはPleiadesの他にいくつかのプラグインが最初から含まれているため、展開されるファイルがLinuxの場合よりも多くなる。

Linuxの場合

  1. インストール先はホームディレクトリの下とする。ホームディレクトリにディレクトリeclipse-3.7-javaを作成する。

    $ cd
$ mkdir eclipse-3.7-java

  2. GNU tarを使用してパッケージを作成したディレクトリの下に展開する。

    $ cd eclipse-3.7-java
$ tar -xzvf <download_dir>/eclipse-java-indigo-linux-gtk.tar.gz

  3. パッケージを展開すると以下のようなディレクトリ構成となる。尚、以降<user_home>はユーザーのホームディレクトリとする。

    <user_home>/eclipse-3.7-java/
  eclipse/
    .eclipseproduct
    about.html
    about_files/
    artifacts.xml
    configuration/
    dropins/
    eclipse
    eclipse.ini
    epl-v10.html
    features/
    icon.xpm
    libcairo-swt.so
    notice.html
    p2/
    plugins/
    readme/

Windowsの場合

  1. インストール先はC:ドライブのディレクトリ\optの下とする。C:ドライブのルートにディレクトリoptを作成する。

    > C:
> cd \
> mkdir opt

  2. 7-zipなどのファイルアーカイバを使用してパッケージをディレクトリC:\optの下に展開する。

    > cd \opt
> "C:\Program Files\7-Zip\7z.exe" x <download_dir>\pleiades-e3.7-java_20110704.zip

  3. パッケージを展開すると以下のようなディレクトリ構成となる。

    C:\opt\pleiades-e3.7-java\
  .metadata.default\
  eclipse\
    configuration\
    dropins\
    features\
    p2\
    plugins\
    readme\
    .eclipseproduct
    artifacts.xml
    eclipse.exe
    eclipse.exe -clean.cmd
    eclipse.exe startup.cmd
    eclipse.ini
    eclipsec.exe
    jad.exe

日本語化

Linuxの場合、日本語化プラグインのPleiadesをインストールする。Windowsの場合、日本語化済みのパッケージを使用するため、この作業は必要ない。

Linuxの場合

  1. ダウンロードしたPleiadesのパッケージを適当なディレクトリに展開する。この例ではホームディレクトリの下のディレクトリfooに展開している。

    $ cd
$ mkdir foo
$ cd foo
$ unzip <download_dir>/pleiades_1.3.3.zip

  2. 展開されたファイルのうちfeatures、pluginsディレクトリの中身を全て上記でインストールしたEclipseの同名のディレクトリにコピーする。

    $ mv features/* ~/eclipse-3.7-java/eclipse/features/
$ mv plugins/* ~/eclipse-3.7-java/eclipse/plugins/

  3. Eclipseの設定ファイル(eclipse.ini)の最終行に以下の記述を追加する。

    $ cd ~/eclipse-3.7-java/eclipse
$ vi eclipse.ini
    -javaagent:plugins/jp.sourceforge.mergedoc.pleiades/pleiades.jar

  4. 日本語化プラグインを初期化するため、-cleanオプションを付けてEclepseを起動する。

    $ ./eclipse -clean

  5. 初回起動時にワークスペースの場所を選択するダイアログが表示されるので、デフォルトのまま[OK]ボタンを押下する。

  6. Eclipseが起動されメニューなどが日本語化されていればPleiadesは正しくインストールされている。

SVNプラグインの追加

Linuxの場合、Eclipseにバージョン管理ツールのSVNプラグインを追加する。Windowsの場合、日本語化済みのパッケージにはSVNプラグインが含まれているため、この作業は必要ない。

Linuxの場合

  1. Eclipseより、ウィンドウメニュー→[設定]を選択する。

  2. 設定ダイアログがオープンされるので、[インストール/更新]→[使用可能なソフトウェア・サイト]を選択する。

  3. 使用可能なソフトウェア・サイトの一覧で、[追加]ボタンを押下する。

  4. サイトの追加ダイアログがオープンされるので、「名前」と「ロケーション」に以下の値を入力し、[OK]ボタンを押下する。

    名前 Subversive SVN Connectors
    ロケーション http://community.polarion.com/projects/subversive/download/eclipse/2.0/update-site/

  5. 設定ダイアログで、[OK]ボタンを押下する。

  6. ヘルプメニュー→[新規ソフトウェアのインストール]を選択する。

  7. インストールダイアログがオープンされるので、「作業対象」項目

    のドロップダウンリストから以下の項目を選択する。

    --全ての使用可能なサイト--

  8. 一覧が表示されたら、以下の項目のチェックボックスをOnにして、[次へ]ボタンを押下する。

    コラボレーション
  Subversive Revision Graph (オプション) (インキュベーション),0.7.9.I20110602-1700
  Subversive SVN 統合 Mylyn プロジェクト (オプション) (作業はインキュベーション),0.7.9.I20110602-1700
  Subversive SVN JDT 無視拡張 (オプション) (インキュベーション),0.7.9.I20110602-1700
  Subversive SVN チーム・プロバイダー (インキュベーション),0.7.9.I20110602-1700
Subversive SVN コネクター
  Subversive SVN コネクター,2.2.2.I20110715-1700
  SVNKit 1.3.5 実装 (オプション),2.2.2.I20110715-1700

  9. インストールされる項目の一覧が表示されるので、[次へ]ボタンを押下する。

  10. ライセンスのレビューダイアログが表示されるので、以下の項目をチェックして、[完了]ボタンを押下する。

    (o)使用条件の上項に同意します

  11. ソフトウェアのインストールダイアログが表示され、選択したプラグインがダウンロード、及び、インストールされる。尚、インストール中に以下の警告ダイアログが表示された場合、[OK]ボタンを押下してインストールを続行する。

    セキュリティー警告
[!] 警告:署名なしコンテンツを含むソフトウェアをインストールして
    います。このソフトウェアの真正性または妥当性を実証できません。
    インストールを続行しますか？

  12. インストールが終了し以下の選択ダイアログが表示されたら、[今はしない]ボタンを押下する。

    ソフトウェア更新
(?) インストール変更内容を有効にするには、Eclipseを再始動する必要が
    あります。再始動せずに、変更を適用することができますが、問題が
    発生する可能性があります。

  13. ファイルメニュー→[終了]を選択しEclipseを終了する。

  14. 日本語化プラグインを初期化するため、-cleanオプションを付けてEclepseを起動する。

    $ ./eclipse -clean

Android SDKのインストール

Android SDKのインストール方法を説明する。まず環境ごとのAndroid SDKの基本パッケージをインストールする。次に基本パッケージに含まれるAndroid SDK and AVD Managerを使用して、開発するのAndroid OSのVersionに対応したSDKのパッケージをインストールする。

ダウンロード

Andoroid DevelopersのサイトのダウンロードページからAndroid SDKの基本パッケージをダウンロードする。また、以降ファイルをダウンロードしたディレクトリを<download_dir>とする。

Linuxの場合

  • Android SDKのダウンロードページより、以下のパッケージをダウンロードする。

    Platform Linux (i386)
    Package android-sdk_r12-linux_x86.tgz

Windowsの場合

  • Android SDKのダウンロードページより、以下のパッケージをダウンロードする。

    Platform Windows
    Package android-sdk_r12-windows.zip

インストール

ダウンロードしたパッケージをインストール先のフォルダに展開する。以降このディレクトリを<android_sdk_home>とする。

Linuxの場合

  1. GNU tarを使用してパッケージをホームディレクトリの下に展開する。

    $ cd
$ tar -xzvf <download_dir>/android-sdk_r12-linux_x86.tgz

  2. パッケージを展開すると以下のようなディレクトリ構成となる。尚、以降<user_home>はユーザーのホームディレクトリとする。

    <user_home>/android-sdk-linux_x86/
  SDK Readme.txt
  add-ons/
  platforms/
  tools/

Windowsの場合

  1. 7-zipなどのファイルアーカイバを使用してパッケージをディレクトリC:\optの下に展開する。

    > c:
> cd \opt
> "C:\Program Files\7-Zip\7z.exe" x <download_dir>/android-sdk_r12-windows.zip

  2. パッケージを展開すると以下のようなディレクトリ構成となる。

    C:\opt\android-sdk-windows\
  add-ons\
  platforms\
  tools\
  SDK Manager.exe
  SDK Readme.txt

SDKのダウンロード

Android SDK and AVD Managerを使用して、開発対象のAndroid OSのVersionに対応したSDKのパッケージをダウンロードする。尚、回線速度にも拠るがこの処理は非常に時間がかかるため、ダウンロードするのは必要なパッケージのみに絞った方が良い。この例では、Version 2.1,2.2,2.3.3,3.1のみをダウンロードしている。

Linuxの場合

  1. <android_sdk_home>/toolsの下の以下のコマンドを実行し、Android SDK and AVD Managerを起動する。

    $ cd ~/android-sdk-linux_x86/tools
$ ./android

  2. 左のメニューで[Available Packages]を選択すると、「Packages available for download」一覧にインストール可能なパッケージの一覧が表示されるので、以下のパッケージを選択して[Install Selected]ボタンを押下する。

    Android Repository
  Android SDK platform-tools
  Documentation for Anfdroid SDK, API 13
  SDK Platform Android 3.1, API 12
  SDK Platform Android 2.3.3, API 10
  SDK Platform Android 2.2, API 8
  SDK Platform Android 2.1, API 7
  Samples for SDK API 12
  Samples for SDK API 10
  Samples for SDK API 8
  Samples for SDK API 7
Third party Add-ons
  Google Inc.(dl-ssl.google.com)
    Google APIs by Google Inc.,Android API 12
    Google APIs by Google Inc.,Android API 10
    Google APIs by Google Inc.,Android API 8
    Google APIs by Google Inc.,Android API 7

  3. Choose Packages to Installダイアログが表示されるので、「Accept All」ラジオボタンを選択して、[Install]ボタンを押下する。

  4. Installing Archivesダイアログが表示され、選択したパッケージがダウンロード、及び、インストールされる。

  5. インストールの最後に以下の警告ダイアログが表示されるので、[Yes]ボタンを押下してインストールを続行する。

    ADB Restart
(?) A package that depends on ADB has been updated.
    Do you want to restart ADB now

  6. インストールが終了したら[Close]ボタンを押下して、Installing Archivesダイアログを終了する。

  7. 左のメニューで[Installed packages]を選択すると、インストール済みのパッケージが表示されるので、内容を確認したらタイトルバーの(X)ボタンを押下してAndroid SDK and AVD Managerを終了する。

Windowsの場合

  1. <android_sdk_home>の下の以下のコマンドを実行し、Android SDK and AVD Managerを起動する。

    > cd C:\opt\android-sdk-windows
> SDK Manager.exe

  2. Choose Packages to Installダイアログが表示されるので、[Cancel]ボタンを押下してAndroid SDK and AVD Managerに戻る。ここで[OK]ボタンを押下すると全パッケージのダウンロードが始まってしまうので注意する。

  3. 左のメニューで[Available Packages]を選択すると、「Packages available for download」一覧にインストール可能なパッケージの一覧が表示されるので、以下のパッケージを選択して[Install Selected]ボタンを押下する。尚、Windows環境で実機を接続する場合、USBドライバが必要なのでGoogle USB Driver packageも選択すること。

    Android Repository
  Android SDK platform-tools
  Documentation for Anfdroid SDK, API 13
  SDK Platform Android 3.1, API 12
  SDK Platform Android 2.3.3, API 10
  SDK Platform Android 2.2, API 8
  SDK Platform Android 2.1, API 7
  Samples for SDK API 12
  Samples for SDK API 10
  Samples for SDK API 8
  Samples for SDK API 7
Third party Add-ons
  Google Inc.(dl-ssl.google.com)
    Google APIs by Google Inc.,Android API 12
    Google APIs by Google Inc.,Android API 10
    Google APIs by Google Inc.,Android API 8
    Google APIs by Google Inc.,Android API 7
    Google USB Driver package

  4. Choose Packages to Installダイアログが表示されるので、「Accept All」ラジオボタンを選択して、[Install]ボタンを押下する。

  5. Installing Archivesダイアログが表示され、選択したパッケージがダウンロード、及び、インストールされる。

  6. インストールの最後に以下の警告ダイアログが表示されるので、[Yes]ボタンを押下してインストールを続行する。

    ADB Restart
(?) A package that depends on ADB has been updated.
    Do you want to restart ADB now

  7. インストールが終了したら[Close]ボタンを押下して、Installing Archivesダイアログを終了する。

  8. 左のメニューで「Installed packages」を選択すると、インストール済みのパッケージが表示されるので、内容を確認したらタイトルバーの[X]ボタンを押下してAndroid SDK and AVD Managerを終了する。

ADT Pluginのインストール

Android Development Tools (ADT) Pluginのインストール方法について説明する。

  1. Eclipseを起動する。

    Linuxの場合

    $ cd ~/eclipse-3.7-java/eclipse
$ ./eclipse

    Windowsの場合

    $ c:
$ cd \opt\eclipse-3.7-java\eclipse
$ eclipse.exe

  2. Eclipseより、ウィンドウメニュー→[設定]を選択する。

  3. 設定ダイアログがオープンされるので、[インストール/更新]→[使用可能なソフトウェア・サイト]を選択する。

  4. 使用可能なソフトウェア・サイトの一覧で、[追加]ボタンを押下する。

  5. サイトの追加ダイアログがオープンされるので、「名前」と「ロケーション」項目に以下の値を入力し、[OK]ボタンを押下する。

    名前 ADT Plugin
    ロケーション https://dl-ssl.google.com/android/eclipse/

  6. 設定ダイアログで、[OK]ボタンを押下する。

  7. ヘルプメニュー→[新規ソフトウェアのインストール]を選択する。

  8. インストールダイアログがオープンされるので、「作業対象」のドロップダウンリストから以下の項目を選択する。

    ADT Plugin - https://dl-ssl.google.com/android/eclipse/

  9. 一覧が表示されたら、以下の項目のチェックボックスをOnにして、[次へ]ボタンを押下する。

    開発ツール
  Android DDMS
  Android 開発ツール
  Android Hierarchy Viewer
  Android Traceview

  10. インストールされる項目の一覧が表示されるので、[次へ]ボタンを押下する。

  11. ライセンスのレビューダイアログが表示されるので、以下の項目をチェックして、[完了]ボタンを押下する。

    (o)使用条件の上項に同意します

  12. ソフトウェアのインストールダイアログが表示され、選択したプラグインがダウンロード、及び、インストールされる。尚、インストール中に以下の警告ダイアログが表示された場合、[OK]ボタンを押下してインストールを続行する。

    セキュリティー警告
[!] 警告:署名なしコンテンツを含むソフトウェアをインストールして
    います。このソフトウェアの真正性または妥当性を実証できません。
    インストールを続行しますか？

  13. インストールが終了し以下の選択ダイアログが表示されたら、[今はしない]ボタンを押下する。

    ソフトウェア更新
(?) インストール変更内容を有効にするには、Eclipseを再始動する必要が
    あります。再始動せずに、変更を適用することができますが、問題が
    発生する可能性があります。

  14. ファイルメニュー→[終了]を選択しEclipseを終了する。

  15. 日本語化プラグインを初期化するため、-cleanオプションを付けてEclepseを起動する。

    Linuxの場合

    $ ./eclipse -clean

    Windowsの場合

    > eclipse.exe -clean.cmd

  16. Eclipseより、ウィンドウメニュー→[設定]を選択する。

  17. 設定ダイアログがオープンされるので、[Android]を選択する。

  18. 「Android 設定」の「SDKロケーション」項目に<android_sdk_home>を設定し、[OK]ボタンを押下する。

    Linuxの場合

    <user_home>/android-sdk-linux_x86

    Windowsの場合

    C:\opt\android-sdk-windows

  19. 設定ダイアログで、[OK]ボタンを押下する。

以上

2011/08/26 新規作成。
2011/08/27「開発マシンとAndroidデバイスの接続」を別記事に分割した。
2011/09/02 記事のカテゴリーを変更した。
2011/09/19 記事の誤字と間違いを修正した。

2011年8月26日 (金) Android, Linux, Windows, Eclipse, Java | | コメント (0) | トラックバック (0)

2011年8月24日 (水)

DocBook入門： DocBookで各種文書を作成する。

目次

はじめに
前準備
Apache FOPのインストール
ダウンロード
パッケージの展開
動作確認
DocBook XSL Stylesheetsのインストール
ダウンロード
インストール
DocBook文書の作成
DocBook文書からHTML文書の作成
スタイルシートの作成
Apache Xalan起動用スクリプトの作成
HTML文書の作成
DocBook文書からPDF文書の作成
設定ファイルの作成
スタイルシートの作成
PDF文書の生成
DocBook文書からEPUB文書の作成
スタイルシートの作成
EPUBファイルの作成
EPUBファイルの修正
EPUB文書の作成
参考文献

はじめに

DocBookは技術文書のための意味マークアップ言語である。当初はコンピュータのハードウェア、及び、ソフトウェアの技術文書を意図していたが、その他いろいろな文書を作成できる。

DocBookなら表示フォーマットに依存しない論理的な構造をもつ文書を作成できる。このような文書はオリジナルを修正せずにHTML、XHTML、EPUB、PDF、man pages、HTML Helpなどいろいろなフォーマットで出力できる。

現在のDocBookのバージョンは5.0で、RELAX NGスキーマで定義されたXMLで記述する。(他にはW3C XML スキーマ、Document Type Definition (DTD)スキーマを使用できるが、これらは標準ではない。)

DocBookはXML文書なので、一般的なテキストエディタで編集できる。DocBookは一般的なスキーマ言語でスキーマを提供しているので、スキーマによる補完が可能なXMLエディタならDocBookの補完もできる。いくつかグラフィカルなXMLエディタでは、ワードプロセッサのようにDocBookを編集できる。

DocBookは明確に定義されたスキーマに準拠するXML文書であるため、検証、及び、処理にXMLをサポートする一般的なツール、及び、プログラミング言語を使用できる。

DocBookファイルをいろいろなフォーマットの出力ファイルに変換するには、Extensible Stylesheet Language (XSL)という技術を使用する。これは次の三つの部分で構成される。

  • XSL Transformation (XSLT)

    XML文書を他のXML文書(XHTML、XSL-FOなど)、または、XML以外のフォーマット(HTML、Plain Textなど)に変換するためのXML言語。

  • XSL Formatting Objects (XSL-FO)

    ML文書を視覚的なフォーマット(PDF、その他の印刷可能なフォーマット)に変換するためのXML言語。

  • XML Path Language (XPath)

    XML言語ではないがXSLTでXML文書の特定の部分を指定するための言語構文。

この文書では、XSLTとXPathプロセッサの実装であるApache Xalan、XSL-FOプロセッサの実装であるApache FOP、及び、DocBook用のXSLスタイルシートであるDocBook XSL Stylesheetsについて、インストール、及び、基本的な使用方法を説明する。ただし、DocBook文書を編集するためのXMLエディタについては説明しない。

前準備

Apache Xalan、及び、Apache FOPはJAVAアプリケーションのため、実行するにはJAVAの実行環境(JRE)、または、開発キット(JDK)が必要となる。よって、必要に応じてJAVAのJRE、または、JDKをインストールしておく。尚、7/28にJRE/JDK 7がリリースされているが、現時点では安定していないため、JRE/JDK 6の最新版を使用すること。

Windows環境では、7-zipなどのzip形式に対応したファイルアーカイバを用意する。

PDF文書を表示するために適当なビューワーを用意する。Linux環境ではEvince、Windows環境ではAdobe Readerなど。

EPUB文書を表示するために適当なビューワーを用意する。Linux環境ではFBReader、Windows環境ではAdobe Digital Editionsなど。

Apache FOPのインストール

Apache Xalanは、XSLTとXPathの実装の一つでApache Xalan Projectにより開発されている。また、Apache FOPは、XSL-FO プロセッサの実装の一つでApache XML Graphics Projectにより開発されている。

Apache FOPのパッケージにはApache Xalanが含まれているため、ここではApache-FOPのインストール方法を説明する。

ダウンロード

ダウンロードサイトから最新版のバイナリパッケージをダウンロードする。Binary DownloadのFOP Distribution mirrorリンクからミラーサイト一覧に移動できるので、適当なミラーサイトから以下のパッケージをダウンロードする。

<mirror-top>/xmlgraphics/fop/binaries/
    fop-1.0-bin.zip

パッケージの展開

ダウンロードしたパッケージを適当なディレクトリに展開する。以降このディレクトリを<fop-home>とする。

Linuxの場合

unzipを使用してパッケージを以下のディレクトリに展開する。

$ sudo unzip fop-1.0-bin.zip -d /opt/

Windowsの場合

7-zipなどのファイルアーカイバを使用してパッケージを以下のディレクトリに展開する。

> "C:\Program Files\7-Zip\7z.exe" x -oC:\opt\ fop-1.0-bin.zip

動作確認

Apache FOPでサンプルファイル(readme.fo)を画面に表示する。これにより、ビューワーが起動されReadmeが表示されれば、Apache FOPは正しくインストールされている。

Linuxの場合

コマンドプロンプトから<fop-home>ディレクトリに移動して、以下のコマンドを実行する。

$ cd /opt/fop-1.0
$ ./fop -fo examples/fo/basic/readme.fo -awt

Windowsの場合

コマンドプロンプトから<fop-home>ディレクトリに移動して、以下のコマンドを実行する。

> cd C:\opt\fop-1.0
> fop -fo examples/fo/basic/readme.fo -awt

DocBook XSL Stylesheetsのインストール

DocBook文書を他のフォーマットに変換するには、フォーマットに応じたXSLスタイルシートが必要となる。ここではThe DocBook Projectから配布されているDocBook XSL Stylesheetsを使用する。

ダウンロード

ダウンロードサイトから最新版のパッケージをダウンロードする。現時点では以下のパッケージが最新版となる。尚、ファイル名の"ns"はNamespace対応版という意味である。DocBook Ver.5.0以降ではこちらを使用する。

http://sourceforge.net/projects/docbook/files/docbook-xsl-ns/1.76.1/
  docbook-xsl-ns-1.76.1.zip

インストール

ダウンロードしたパッケージを適当なディレクトリに展開する。パッケージの中には、install.shなどのインストール用のスクリプトがあるが今回は使用しない。

Linuxの場合

unzipを使用してパッケージを以下のディレクトリに展開する。

$ sudo unzip docbook-xsl-ns-1.76.1.zip -d /opt/

Windowsの場合

7-zipなどのファイルアーカイバを使用してパッケージを以下のディレクトリに展開する。

> "C:\Program Files\7-Zip\7z.exe" x -oC:\opt\ docbook-xsl-ns-1.76.1.zip

DocBook文書の作成

テキストエディタを使用して、sample.xmlファイルを以下の内容で作成する。このとき、保存時の文字コードは必ずUTF-8とすること。例えば、Windowsのメモ帳であればファイルメニュー→名前を付けて保存で文字コードを選択できる。尚、改行コードはLF、CR+LFどちらでも問題ない。

<?xml version="1.0" encoding="utf-8"?>
<article version="5.0" xmlns="http://docbook.org/ns/docbook">
  <info>
    <title>DocBook文書から各種文書を作成する。</title>
  </info>
  <section>
    <title>Sample 1</title>
    <para>Hello World!</para>
  </section>
  <section>
    <title>サンプル2</title>
    <para>こんにちは世界！</para>
  </section>
</article>

DocBook文書からHTML文書の作成

Apache XalanとXSLスタイルシートを使用して、DocBook文書からHTML文書を作成する方法を説明する。

スタイルシートの作成

HTML文書用のXSLスタイルシートを作成する。実際には最初に予めインストールしたDocBook XSLのHTML用のスタイルシートを読み込み、その後変更するパラメータのみを記述する。

Linuxの場合

テキストエディタを使用して、docbook_html_linux.xslファイルを以下の内容で作成する。

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version='1.0' xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:import href="file:///opt/docbook-xsl-ns-1.76.1/html/docbook.xsl"/>
  <xsl:output method="html" encoding="utf-8" indent="yes"/>
  <xsl:param name="l10n.gentext.default.language">ja</xsl:param>
</xsl:stylesheet>

Windowsの場合

テキストエディタを使用して、docbook_html_windows.xslファイルを以下の内容で作成する。

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version='1.0' xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:import href="file:///C:/opt/docbook-xsl-ns-1.76.1/html/docbook.xsl"/>
  <xsl:output method="html" encoding="utf-8" indent="yes"/>
  <xsl:param name="l10n.gentext.default.language">ja</xsl:param>
</xsl:stylesheet>

各パラメータの意味は以下の通り。

  • 3行目

    DocBook XSLのHTML用のスタイルシートを読み込む。

  • 4行目

    出力形式をHTML、エンコーディングをUTF-8、及び、出力結果をインデントする。

  • 5行目

    自動生成される文字列を日本語仕様とする。これにより、"Table of Contents"や"Chapter"などが"目次"や"章"などの日本語で出力される。

Apache Xalan起動用スクリプトの作成

DocBook文書からHTML文書を生成するにはApache Xalanを使用する。ただし、コマンド実行する度に長いCLASSPATHなどを毎回タイプするのは面倒なので、まずは起動用のスクリプトを作成する。

Linuxの場合

<fop-home>ディレクトリの下にxalanスクリプトを以下の内容で作成する。

$ cd /opt/fop-1.0
$ sudo vi xalan
#!/bin/sh
#
# Excecute Xalan-Java.
#
FOP_HOME=`dirname $0`

LOCALCLASSPATH=

DIRLIBS=${FOP_HOME}/lib/*.jar
for i in ${DIRLIBS}
do
    if [ "$i" != "${DIRLIBS}" ] ; then
      if [ -z "$LOCALCLASSPATH" ] ; then
        LOCALCLASSPATH=$i
      else
        LOCALCLASSPATH=$LOCALCLASSPATH:"$i"
      fi
    fi
done

java -cp $LOCALCLASSPATH org.apache.xalan.xslt.Process $@
$ sudo chmod a+x xalan

Windowsの場合

<fop-home>ディレクトリの下にxalan.cmdスクリプトを以下の内容で作成する。

@echo off
rem
rem Excecute Xalan-Java.
rem
SETLOCAL ENABLEDELAYEDEXPANSION

set LOCAL_FOP_HOME=%~dp0
set LIBDIR=%LOCAL_FOP_HOME%\lib

for %%i in (%LIBDIR%\*.jar) do set LOCALCLASSPATH=!LOCALCLASSPATH!;%%i

java -cp %LOCALCLASSPATH% org.apache.xalan.xslt.Process %*

ENDLOCAL

HTML文書の作成

xalanスクリプトからApache Xalanを実行し、XML文書(sample.xml)にスタイルシートを適用してHTML文書(sample.html)を作成する。

Linuxの場合

コマンドラインから以下のコマンドを実行する。

$ /opt/fop-1.0/xalan -xsl docbook_html_linux.xsl -in sample.xml -out sample.html

Windowsの場合

コマンドラインから以下のコマンドを実行する。

> C:\opt\fop-1.0\xalan.cmd -xsl docbook_html_windows.xsl -in sample.xml -out sample.html

以下に作成されたHTML文書をWEBブラウザで表示した結果を示す。

図1 HTML文書の表示例

Sample_html

DocBook文書からPDF文書の作成

Apache FOPとXSLスタイルシートを使用して、DocBook文書からPDF文書を作成する方法を説明する。

設定ファイルの作成

Apache FOPはデフォルトではPDF出力時に日本語フォントを検索しないため、そのままではPDF文書の日本語が全て#記号に化けてしまう。Apache FOPに日本語フォントを検索させるため、fop_fonts.xconfファイルを以下の内容で作成し実行時に指定する。

<?xml version="1.0" encoding="utf-8"?>
<fop version="1.0">
  <renderers>
    <renderer mime="application/pdf">
      <fonts>
        <auto-detect/>
      </fonts>
    </renderer>
  </renderers>
</fop>

パラメータの意味は以下の通り。

  • 6行目

    PDF出力時にOSにインストールされているフォントを自動検出する。

スタイルシートの作成

XSL-FO文書用のXSLスタイルシートを作成する。実際には最初に予めインストールしたDocBook XSLのXSL-FO用のスタイルシートを読み込み、その後変更するパラメータのみを記述する。

Linuxの場合

テキストエディタを使用して、docbook_fo_linux.xslファイルを以下の内容で作成する。

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version='1.0' xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:import href="file:///opt/docbook-xsl-ns-1.76.1/fo/docbook.xsl"/>
  <xsl:param name="l10n.gentext.default.language">ja</xsl:param>
  <xsl:param name="ulink.show" select="0"/>
  <xsl:param name="paper.type">A4</xsl:param>
  <xsl:param name="hyphenate">false</xsl:param>
  <xsl:param name="title.font.family">TakaoExGothic</xsl:param>
  <xsl:param name="body.font.family">TakaoExMincho</xsl:param>
  <xsl:param name="monospace.font.family">TakaoMincho</xsl:param>
</xsl:stylesheet>

Windowsの場合

テキストエディタを使用して、docbook_fo_windows.xslファイルを以下の内容で作成する。

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version='1.0' xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:import href="file:///C:/opt/docbook-xsl-ns-1.76.1/fo/docbook.xsl"/>
  <xsl:param name="l10n.gentext.default.language">ja</xsl:param>
  <xsl:param name="ulink.show" select="0"/>
  <xsl:param name="paper.type">A4</xsl:param>
  <xsl:param name="hyphenate">false</xsl:param>
  <xsl:param name="title.font.family">MS PGothic</xsl:param>
  <xsl:param name="body.font.family">MS PMincho</xsl:param>
  <xsl:param name="monospace.font.family">MS Mincho</xsl:param>
</xsl:stylesheet>

各パラメータの意味は以下の通り。

  • 3行目

    DocBook XSLのXSL-FO用のスタイルシートを読み込む。

  • 4行目

    自動生成される文字列を日本語仕様とする。これにより"Table of Contents"や"Chapter"などが"目次"や"章"などの日本語で出力される。

  • 5行目

    デフォルトではリンクを設定した文字列の直後にリンク先のURIが展開されるが、これを抑制する。

  • 6行目

    出力サイズをA4とする。

  • 7行目

    ハイフネーションを無効にする。日本語を使用する場合、実行時にハイフネーションのエラーが出るのでそれを抑制する。

  • 8行目

    タイトルのフォントを指定する。Linuxの場合、TakaoExゴシック、Windowsの場合、MS Pゴシックとする。

  • 9行目

    本文のフォントを指定する。Linuxの場合、TakaoEx明朝、Windowsの場合、MS P明朝とする。

  • 10行目

    プログラムリストなどの等倍フォントを指定する。Linuxの場合、Takao明朝、Windowsの場合、MS明朝とする。

PDF文書の生成

Apache FOPを実行し、XML文書(sample.xml)にスタイルシートを適用してPDF文書(sample.pdf)を作成する。

内部的には、まずApache XalanとXSLスタイルシートを使用して、DocBook文書からXSL-FO文書が作成される。さらにApache FOPにより、XSL-FO文書からPDF文書が作成される。今回の例ではこの動作は一連で実行されるが、個別に実行することもできる。

Linuxの場合

コマンドラインから以下のコマンドを実行する。

$ /opt/fop-1.0/fop -c fop_fonts.xconf -xsl docbook_fo_linux.xsl -xml sample.xml -pdf sample.pdf

Windowsの場合

コマンドラインから以下のコマンドを実行する。

> C:\opt\fop-1.0\fop -c fop_fonts.xconf -xsl docbook_fo_windows.xsl -xml sample.xml -pdf sample.pdf

以下に作成されたPDF文書をAdobe Readerで表示した結果を示す。

図2 PDF文書の表示例

Sample_pdf

DocBook文書からEPUB文書の作成

Apache XalanとXSLスタイルシートを使用して、DocBook文書からEPUB文書を作成する方法を説明する。

スタイルシートの作成

EPUB文書用のXSLスタイルシートを作成する。実際には最初に予めインストールしたDocBook XSLのEPUB用のスタイルシートを読み込み、その後変更するパラメータのみを記述する。

Linuxの場合

テキストエディタを使用して、docbook_epub_linux.xslファイルを以下の内容で作成する。

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version='1.0' xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:import href="file:///opt/docbook-xsl-ns-1.76.1/epub/docbook.xsl"/>
  <xsl:output method="xml" encoding="utf-8" indent="yes"/>
  <xsl:param name="l10n.gentext.default.language">ja</xsl:param>
</xsl:stylesheet>

Windowsの場合

テキストエディタを使用して、docbook_epub_windows.xslファイルを以下の内容で作成する。

<?xml version="1.0" encoding="utf-8"?>
<xsl:stylesheet version='1.0' xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  <xsl:import href="file:///C:/opt/docbook-xsl-ns-1.76.1/epub/docbook.xsl"/>
  <xsl:output method="xml" encoding="utf-8" indent="yes"/>
  <xsl:param name="l10n.gentext.default.language">ja</xsl:param>
</xsl:stylesheet>

各パラメータの意味は以下の通り。

  • 3行目

    DocBook XSLのEPUB用のテンプレートを読み込む。

  • 4行目

    出力形式をXML、エンコーディングをUTF-8、及び、出力結果をインデントする。

  • 5行目

    自動生成される文字列を日本語仕様とする。これにより"Table of Contents"や"Chapter"などが"目次"や"章"などの日本語で出力される。

EPUBファイルの作成

xalanスクリプトからApache Xalanを実行し、XML文書(sample.xml)にスタイルシートを適用してEPUB文書の中身となるファイルを作成する。尚、xalanスクリプトについては、上記「Apache Xalan起動用スクリプトの作成」を参照すること。

Linuxの場合

コマンドラインから以下のコマンドを実行する。

$ /opt/fop-1.0/xalan -xsl docbook_epub.xsl -in sample.xml

Windowsの場合

コマンドラインから以下のコマンドを実行する。

> C:\opt\fop-1.0\xalan.cmd -xsl docbook_epub.xsl -in sample.xml

これにより、XML文書(sample.xml)から以下のフォルダ、及び、ファイルが作成される。

META-INF/
  container.xml
OEBPS/
  ar01s02.html
  content.opf
  index.html
  toc.ncx

EPUBファイルの修正

作成されたファイルはこのままEPUB文書にアーカイブするとAdobe Digital Editionsでは日本語が文字化けするため、OEBPSフォルダの下の全てのHTMLファイルのhtml要素にxml:lang="ja"属性を追加する。

修正前

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
    :

修正後

<?xml version="1.0" encoding="utf-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xml:lang="ja" xmlns="http://www.w3.org/1999/xhtml">
    :

Linuxの場合

コマンドラインから以下のコマンドを実行する。

$ find OEBPS -name '*.html' | xargs sed -i -e's/^<html/<html xml:lang="ja"/'

Windowsの場合

PowerShellのコマンドラインから以下のコマンドを実行する。(実際には一行で入力すること。)

> powershell
PS> gci -r -i *.html OEBPS|
  %{(gc -en UTF8 $_)|%{$_ -replace'^<html','<html xml:lang="ja"'}|sc -en UTF8 $_}

EPUB文書の作成

EPUB文書はEPUB Open Container Format (OCF)という形式で作成する。mimetypeファイルを以下の内容で作成し、META-INF、OEBPSフォルダ、及び、配下のファイルをOCF ZIPコンテナと呼ばれる形式にアーカイブする。このとき拡張子はepubとする。尚、mimetypeファイルをアーカイブするさいに、以下の条件を満たす必要がある。

  • mimetypeファイルはコンテナの最初のファイルであること。

  • mimetypeファイルの内容はapplication/epub+zipとし、余計な空白文字や制御文字を含めないこと。

  • mimetypeファイルは無圧縮、かつ、暗号化なしで、Local File HeaderにExtra Fieldが存在しないこと。

Linuxの場合

zipを使用してEPUB文書を作成する。

$ echo "application/epub+zip" > mimetype
$ zip -X0 sample.epub mimetype
$ zip -rX9 sample.epub META-INF OEBPS

Windowsの場合

7-zipなどのファイルアーカイバを使用してEPUB文書を作成する。ただし、7-zipではmimetypeファイルが先頭にならないため、epub文書の仕様を満たしていない。

> echo application/epub+zip > mimetype
> "C:\Program Files\7-Zip\7z.exe" a -tzip sample.epub mimetype -mx0
> "C:\Program Files\7-Zip\7z.exe" a -tzip sample.epub META-INF OEBPS -mx9

以下に作成されたPDF文書をAdobe Digital Editionsで表示した結果を示す。

図3 EPUB文書の表示例(ページ1)

Sample_epub_1

図4 EPUB文書の表示例(ページ2)

Sample_epub_2

参考文献

DocBook Wikipedia.

DocBook.org.

DocBook 5: The Definitive Guide.

DocBook XSL: The Complete Guide.

The DocBook Project.

The Apache Xalan Project.

Apache FOP.

EPUB Wikipedia.

International Digital Publishing Forum (IDPF) EPUB.

以上

2011/08/26 記事のタイトルを修正した。

2011/09/02 記事のカテゴリーを変更した。

2011/09/05 EPUB文書の作成の記述を修正した。

2011年8月24日 (水) Android, XML, DocBook, Java, XSL, Apache FOP, Apache Xalan | | コメント (1) | トラックバック (0)

その他のカテゴリー

Amazon Android Apache FOP Apache Xalan DocBook Eclipse Excel facebook Java LaTeX Linux Mozilla PowerShell Shell Script Smartphone Tablet TechLION TeX USP友の会 VBA Windows XML XSL アニメ・コミック 日記