Workbookユーザガイド

使い方

ワークフローは単純です。ただ原稿を用意してソフトウェアを実行するだけです。

  1. 原稿を用意する
  2. Workbookを実行してPDFを生成する

あとは好きなだけ原稿を編集してPDFを作り直せばよいのです。結果に満足したら、不要なファイルを片付けましょう。以降のセクションで具体的な操作方法を説明します。

原稿を準備する

Workbookが受け付ける原稿形式は、XHTMLによく似ています。技術的にはXHTML+MathMLのサブセットで、classやidやtitleやその他の属性で意味を補ったものです（いわゆるmicroformatsの一種）。

注意事項：

原稿は例えばこのようになります： 

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0//EN"
 "http://www.w3.org/TR/MathML2/dtd/xhtml-math11-f.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-type" content="application/xhtml+xml;"/>
    <meta name="author" content="John Doe"/>
    <meta name="date" content="2038-02-31"/>
    <title>Title</title>
  </head>
  <body>
    ...
  </body>
</html>

記法の詳細は記法のセクションを参照してください。

原稿からPDFを生成する

現時点での標準のUIはコマンドラインインタフェースです。

原稿ファイルがfoo.xhtmlだとしたら、workbook build foo.pdfとタイプすればPDFが生成されます。

配布物に含まれるテストデータで試せます。 

% cp /usr/share/doc/workbook ./
% cd workbook
% ls test/testdata.xhtml
test/testdata.xhtml
% workbook build test/testdata.pdf
...
% ls test/testdata.pdf
test/testdata.pdf
%

ファイルを片付ける

不要な中間ファイルを削除するには、workbook clean booknameとタイプします。 

% workbook clean test/testdata

PDFを含め、生成されたファイルをすべて削除するには、workbook distclean booknameとタイプします。 

% workbook distclean test/testdata

進んだ使い方

既存のHTML文書を原稿として使う

HTMLファイルとそれに付随する画像などをインポートするには、workbook import filenameとタイプします。 

% workbook import foo.html

ただしルールに沿って書かれたきれいなHTMLファイルしかインポートできません。この機能は非常に限定的なものです。

特定の言語だけを出力する

langsオプションを使うと、特定のxml:lang属性を持った要素（およびxml:lang属性を持たない要素）だけを出力できます。 

% workbook --langs="en" build test/testdata.pdf
% workbook --langs="all" build test/testdata.pdf

原稿に不正なxml:lang値があると意図しない結果になるのでご注意ください。

プロジェクトごとのユーザ設定

ユーザ設定ファイルを書き換えればプロジェクトごとの設定を変えられます（まだ実験的な機能です）。 

% workbook initproject .
% cp .book/html2latex.xsl.example .book/html2latex.xsl
% $EDITOR .book/html2latex.xsl

トラブルシューティング