ソーステキスト形式

私のアプローチの重要な点は、オープンなテキスト形式を使用するという考え方です。私の場合は、自作のXMLボキャブラリを使用しています。HTMLとほぼ似ていますが、私の書籍にとって意味のある追加タグがあります。私は常にセマンティックマークアップのファンでした。出力の書式ではなく、意味に従ってテキストにマークアップするのです。例えば、私が時々行うことの一つに、定義する際にフレーズを太字にするというものがあります。これは、読者が用語の定義を探している場合、ページをスキャンすることで迅速に見つけることができるため、行っています。

しかし、そのマークアップを行う際に、<b>や<bold>のようなタグは使用せず、セマンティックタグ<term>を使用します。そして、変換コードで用語を太字のテキストに変換するように決定します。

書式ではなくセマンティクスに集中することを強制するため、このようにしています。また、変換中に他の便利な機能も提供します。用語を変換する際には、太字にするだけでなく、出力にインデックス用のマーカーを挿入することもできます。

知っている多くの人がテキスト文書のアイデアを気に入っていますが、XMLを嫌っています。XMLの入力がぎこちない、あるいはタグが読みやすさを妨げるという人もいます。ここで人気のある代替案はマークダウンで、これは意図的にプレーンテキストで読みやすく、書きやすく設計されています。XMLの方が柔軟性が高いためXMLを好んでいます。好きなタグ（この書籍専用の特殊なタグを含む）を導入し、プロセスにスムーズに組み込むことができます。

他に遭遇したソース形式として、Docbook XMLボキャブラリを使用するものがあります。Docbookは、特に長文文書のための標準的なXMLボキャブラリです。いくつかの利点がありますが、タグが冗長で邪魔だと感じています。また、Docbookを採用すると、独自のセマンティックタグを使用できなくなります。

長い歴史を持つ別のテキスト選択肢としてLaTeXがありますが、試したことはありません。

変換ターゲット

ソース文書を出力に変換するために、後で説明する変換ツールチェーンを使用します。そのツールチェーンの直接的なターゲットはDocbookです。ソース文書形式としてはDocbookを好んでいませんが、変換ターゲットとしては非常に優れています。テキストをDocbookに取り込めば、Docbookを様々な形式（HTML、PDF、ePubなど）に変換できる多くのOSSツールがあります。これらのツールを私のツールチェーン全体に簡単に組み込むことができるため、1つのコマンドでこれらの形式の任意の組み合わせを生成できます。

初期の段階では、書籍に取り組む際に通常はHTML出力を利用します。レビュー担当者と書籍を共有したい場合は、PDFまたはePubを生成します。私の出版社（ピアソン）はDocbookファイルを受け取り、それらを彼らの出版プロセスに送ります。

変換ツールチェーン

Docbookを生成するツールチェーンは、Rubyで自作した一連のスクリプトです。これらは、書籍テキストを形成する一連のXMLファイルと、参考文献やライブコードディレクトリなどの参照ファイルを取り込み、Docbook出力を生成します。

これらは変換ルールとして構成されているため、トランスフォーマが「term」タグを検出すると、適切なDocbook要素（インデックス情報を含む）を出力することがわかります。新しいタグを追加する場合は、そのための新しいハンドラーメソッドを追加するだけで、出力がすぐに表示されます。このツールチェーンは、私のウェブサイトで使用しているものと非常に似ていますが、主な違いは、ウェブサイトのツールチェーンが出力をHTMLではなくDocbookに出力することです。

編集

このアプローチの良い点は、任意のテキストエディタを使用して執筆できることです。私のお気に入りのテキストエディタはEmacsで、EmacsにはXML文書を編集するための非常に優れたモード（NXMLモード）があるのが特に便利です。私が見た多くのXMLエディタは、階層的データ構造のシリアライゼーションとしてのXMLを対象としており、マークアップされたテキストには適していません。NXMLモードはテキストマークアップに非常に適しているため、私にとってうまく機能します。他の機能の中でも、RNCスキーマファイルを使用してエディタをスキーマ認識にすることができます。

コードインポート

コードの自動インポートは、私のツールチェーンの非常に重要な部分です。好きなように整理された通常のプログラムコードで作業できます。書籍にコード断片として取り込みたいコード領域を示すために、コメントで囲まれたマーカーを配置するだけです。次に、ファイル名と断片をラベル付きで指定するXML要素を作成します。ツールチェーンを実行すると、コードがライブファイルからDocbook出力に抽出されます。

グラフィック

グラフィックは、テキストエディタで編集を行わない唯一の分野です。現在、図表の作成にはOmniGraffle（Mac専用）に依存しています。OmniGraffleは、書籍制作に必要な様々な形式（png、epsなど）にエクスポートできます。私のスクリプトツールチェーンはAppleのスクリプト機能を使用して、必要に応じてファイルを自動的に再エクスポートするため、図表を変更したときにエクスポートすることを覚える必要はありません。

バージョン管理

他のプログラマーと同様に、バージョン管理を非常に重視しています。『P of EAA』を始めた頃はCVSを使用していましたが、それ以降はSVN、Mercurial、gitを使用してきました。バージョン管理システムは、他の人と共同作業を行う際に特に役立ちます。コードと同じアプローチを使用して、執筆内容を同期させることができます。

書籍が制作段階に入ると、出版社のピアソンと協力して、リポジトリ内の元のソースファイルで作業することに慣れているコピーエディタ、インデクサ、その他の制作スタッフを利用しています。