Workbook User Guide

原稿の記法

Workbookの原稿の記法は、いくつかの例外と拡張表記法を除けば、HTMLとほとんど変わりません（これらの割り当ては暫定的なもので、将来変更される可能性があります）。

タイトルと見出し

head/title

head/titleはタイトル（書名）です（これは奥付のためのものです。スタイルを付けないでください）。 

<head>
  <title>Foo Tutorial</title>
</head>

head/meta

head/metaでメタ情報を設定できます（例えばname="author" content="John Doe", name="date" content="2038-02-31"）。 

<head>
  <meta name="author" content="John Doe"/>
</head>

h1 .. h6

h1は書名（タイトル）です（これは大扉のためのもので、スタイルを設定しても構いません）。 

<h1><em>Foo</em> Tutorial</h1>

h2 is chapter, h3 section, h4 subsection, ...

ブロックおよびインラインのテキスト

p

pは段落です。class="continued"で1行目のインデントが抑制されます。 

<p>First paragraph.</p>
<p>Second paragraph.</p>
<p class="continued">Second paragraph continued.</p>

First paragraph.

Second paragraph.

Second paragraph continued.

address, blockquote, div

address, blockquote, divはHTMLと同じ意味です。 

<address>info@example.org</address>
<blockquote>
  <p>If you do not think about the future, you cannot have one.
                -- John Galsworthy</p>
</blockquote>
<div> does not do much without class specified.</div>
info@example.org

If you do not think about the future, you cannot have one. -- John Galsworthy

div does not do much without class specified.

pre

preは整形済みのコードブロックで、通常はタイプライタフォントで出力されます。 

<pre>#include &lt;stdio.h&gt;

int main(void) {
    printf("hello, world\n");
    return 0;
}</pre>
#include <stdio.h>

int main(void) {
    printf("hello, world\n");
    return 0;
}

abbr, acronym

abbrとacronymはそのtitleが脚注として挿入されます。 

<abbr title="World Wide Web">WWW</abbr> is an abbreviation while 
<acronym title="radio detecting and ranging">rader</acronym> 
is an acronym.

WWW is an abbreviation while rader is an acronym.

br

brは改行です。おかしなところでエラーが出る原因になるので、濫用は避けてください。 

First line<br/> and the second line.

First line
and the second line.

cite

citeは参考文献の引用です。title属性が参照用のキーになります。 

<cite title="doe2000">John Doe, "Foo Bar"</cite>

John Doe, "Foo Bar"

code

codeインラインのプログラムコードです。通常はタイプライタフォントで出力されます。 

function <code>foo()</code>.

function foo().

dfn

dfnは自動的に索引項目を生成します。classにnoindextermを指定すれば抑制されます。 

<dfn>HTML</dfn> stands for Hypertext Markup language.

HTML stands for Hypertext Markup language.

em

emは強調です。strongはさらに強い強調です。 

<em>emphasized</em> or <strong>strong</strong>.

emphasized or strong.

kbd

kbdはユーザ入力です（通常は強調されタイプライタフォントで出力される）。sampはコンピュータからの出力です（通常はタイプライタフォントで出力される）。 

Type <kbd>echo foo</kbd> at the terminal.

Type echo foo at the terminal.

q

qはインラインでの引用です。 

She say <q>Good bye</q>,  I say <q>Hello</q>.

She say Good bye, I say Hello.

span

spanは、指定したclassに応じていろいろな仕事をします。 

<span class="indexterm" title="attribute"><a class="indexterm">class</a></span> is used for expanding features.

class is used for expanding features.

a (with scheme)

a href="http://..."はURLを脚注として挿入します。 

See <a href="http://example.org/">Example.org</a>.

See Example.org.

a (with fragment)

a href="#..."は相互参照を挿入します。 

We will discuss the meaning of foo <a href="#sec-foo">later</a>.

We will discuss the meaning of foo later.

id

* id="..."は相互参照先や文書取り込み先を識別するための印です。 

<p id="sec-foo">Foo is a sample name of anything.</p>

Foo is a sample name of anything.

var

varは変数で、通常italic（イタリック）で出力されます。 

Variable <var>fname</var> refers to a filename.

Variable fname refers to a filename.

del

delは削除（打ち消し線）でinsは挿入（下線）です。 

<del>Deleted</del> and <ins>inserted</ins>.

Deleted and inserted.

Lists

リスト(dl, ul, ol)はHTMLと同じです。ただしあまり深くネストさせないでください。

dl

dlは定義リストです。複数の用語に1つの説明文が対応する書き方はまだサポートされていません。 

<dl>
  <dt>running head</dt>
  <dt>running title</dt>
  <dd>A heading printed at the top of every (other) page of a book.</dd>
  <dt>date</dt>
  <dd>Specific time that can be named.</dd>
  <dd>A person with whom you are dating.</dd>
  <dd>Fruit of the date palm.</dd>
</dl>
running head
running title
A heading printed at the top of every (other) page of a book.
date
Specific time that can be named.
A person with whom you are dating.
Fruit of the date palm.

サポートされていないもの

グラフィックス

サポートされている形式

注意：カラーはまだサポートされていません。今のところサポートされているのはグレースケール画像のみです。

rxvt screenshot
rxvt screenshot

Rxvtのスクリーンショット（PNG(前者)とJPEG(後者)）。

img

img src="..."はインラインのグラフィックスです。 

<img src="booklogo-small.eps" alt="book logo"/>Book logo.

book logoBook logo.

div class="figure"

div class="figure"は浮動する図版になります。 div class="figure" / p class="caption"はキャプションです。 

<div class="figure" id="fig-photo">
  <img src="tritonia-lusitania-1935.jpg"
       alt="J. Peress' 1-atm dive suit, Tritonia"
       width="640px"/>
  <p class="caption">
    J. Peress' 1-atm dive suit, Tritonia, explored the Lusitania wreck in 1935.
  </p>
</div>
J. Peress' 1-atm dive suit, Tritonia

J. Peress' 1-atm dive suit, Tritonia, explored the Lusitania wreck in 1935.

表

表のサポートは暫定的なものです。可能なら表は使わないでください。いつだって表はドローツールで描いて図版として挿入できます。 

<table summary="table comparison">
  <caption>Comparison of tables.</caption>
  <tr><th></th><th>float</th><th>caption</th><th>nestable</th></tr>
  <tr><th>HTML table</th><td>no</td><td>yes</td><td>yes</td></tr>
  <tr><th>LaTeX tabular</th><td>no</td><td>no</td><td>yes</td></tr>
  <tr><th>LaTeX table</th><td>yes</td><td>yes</td><td>no</td></tr>
</table>
Comparison of tables.
floatcaptionnestable
HTML tablenoyesyes
LaTeX tabularnonoyes
LaTeX tableyesyesno

数式表現

数式表現はMathMLを利用してサポートされています。名前空間の識別子を忘れずに追加してください。

数式（ブロック） 

<math xmlns="http://www.w3.org/1998/Math/MathML" 
      display="block" id="eqn-block">
  <mfrac>
    <mrow><mi>d</mi></mrow>
    <mrow><mi>d</mi><mi>x</mi></mrow>
  </mfrac>
  <msubsup><mo>&int;</mo><mi>a</mi><mi>x</mi></msubsup>
  <mi>f</mi>
  <mfenced>
    <msup><mi>x</mi><mrow><mo>&prime;</mo></mrow></msup>
  </mfenced>
  <mi>d</mi><msup><mi>x</mi><mo>&prime;</mo></msup>
  <mo>=</mo>
  <mi>f</mi><mfenced><mi>x</mi></mfenced>
</math>
d dx ∫ax f x′ dx′ = fx

数式（インライン） 

<p>The same <a href="#eqn-block">equation</a> can be placed inline: 
  <math xmlns="http://www.w3.org/1998/Math/MathML" 
      id="eqn-inline">
    <mfrac>
      <mrow><mi>d</mi></mrow>
      <mrow><mi>d</mi><mi>x</mi></mrow>
    </mfrac>
    <msubsup><mo>&int;</mo><mi>a</mi><mi>x</mi></msubsup>
    <mi>f</mi>
    <mfenced>
      <msup><mi>x</mi><mrow><mo>&prime;</mo></mrow></msup>
    </mfenced>
    <mi>d</mi><msup><mi>x</mi><mo>&prime;</mo></msup>
    <mo>=</mo>
    <mi>f</mi><mfenced><mi>x</mi></mfenced>
  </math> as well.</p>

The same equation can be placed inline: d dx ∫ax f x′ dx′ = fx as well.

æ‹¡å¼µ

前付・本文・付録・後付

div class="frontmatter"は前付の始まりを示します。前付では一般に、セクション見出しには番号が付かず、ノンブルにはローマ数字（時計数字）が使われます。

div class="mainmatter"はここで前付が終わり本文が始まることを示します。

div class="appendix"はここで通常の章が終わり付録が始まることを示します。付録は通常の章とは別立てでセクション番号が振られます（例：第1章と付録Aなど）。

div class="backmatter"はここで本文が終わり後付が始まることを示します。 

<div class="frontmatter"/>

Frontmatter (title, colophon, dedication, foreword, preface, acknowledgments, table of contents, etc)

<div class="mainmatter"/>

Chapters

<div class="appendix"/>

Appendices

<div class="backmatter"/>

Backmatter (index, etc.)

目次

div class="toc"は目次を挿入します。 

<div class="toc"/>

索引

div class="index"は索引を挿入します。 

<div class="index"/>

a class="indexterm"は索引項目を作ります。 

<a class="indexterm">some term</a>

some term

span class="indexterm" title="key@parent" / a class="indexterm" title="key@child" は特定のキーとエントリと階層を持った索引項目を作ります。 

<span class="indexterm" title="parent@parent"><a class="indexterm" title="zzz@some term">
  some term
</a></span>

some term

ファイルの取り込み

aにincludeクラスが指定されていると外部ファイルを取り込みます。

脚注

aは脚注を表すのにも使われます。

a href="#foo" class="footnotemark"は脚注記号を挿入します。 ul class="footnotes" / li class="footnotetext"は脚注のテキストです。 

<p>
  Footnote <a href="#fn-fnmark" class="footnotemark">marks</a> and
  footnote <a href="#fn-fntext" class="footnotemark">texts</a> must be in pairs.
</p>
<ul class="footnotes">
  <li class="footnotetext" id="fn-fnmark">Footnote mark.</li>
  <li class="footnotetext" id="fn-fntext">Footnote text.</li>
</ul>

Footnote marks and footnote texts must be in pairs.

翻訳サポート

原稿の要素を出力に含めるかどうかはxml:lang属性に基づいて取捨選択できます。これは翻訳プロジェクトで便利です。

* xml:lang="..."で言語を設定します。 

<p>
  <span xml:lang="en">English text.</span>
  <span xml:lang="ja">日本語のテキスト。</span>
</p>

日本語のテキスト。