Skip to content

Note for review format spec

takahashim edited this page Dec 1, 2010 · 10 revisions

ReVIEW記法について整理するためのメモ

記法の種類

  • 段落(本文)

  • 見出し(章・節・項・段・小段)※5レベルまで←段の下の正式な呼称が不明

  • コラム(見出しの変形)※基本的に正式サポートはcolumnのみ

  • 各種リスト(箇条書き、番号つき箇条書き、用語リスト)※ただし、用語リストは構文および動作がわかりにくいので非推奨

  • 各種タグ(ブロックつき・ブロックなし)

  • 各種インライン

  • 著者用タグ(プリプロセッサ)

記法の用法

  • ブロックの入れ子は不可

  • インラインの入れ子は不可

  • ブロック内でのインラインの使用は可(listブロック、cmdブロックでも可)

  • インラインのエスケープには@<raw>を使う

  • ブロックのエスケープは困難なので、行頭ではないところに書くか、全角//にしておいて後で置換するなどの対処をユーザ自身にしてもらう

記法の課題(非互換)

  • ブロック内での段落の使用は許すか?

    • 現状ではLATEXBuilderは可、HTMLBuilderは不可

    • quoteブロック、leadブロックでは使えるようにしたい ※後方互換性を破壊する、ブロック名によって処理が違う(listとleadでの違いなど)のがややこしいといった問題あり。

生成されるフォーマットについて

  • HTML(レイアウトを使用しない場合のHTMLのバージョンはXHTML1.1) ※iPadのiBooksをリファレンスプラットフォームに。変なところはあるものの、現時点では一番まっとうなビューア

  • LaTeX(dvipdfmxでPDFに変換)

  • IDGXML (Adobe InDesign CS2以降向けXML形式)

  • (TOPBuilder記法?) ※ほぼプレインテキスト化したい場合の形式。HTML/IDGXMLに遅れてのサポート

  • (EWB記法←サポートする・できる?) ←捨てよう

利用できるタグ記法

全フォーマットで原則サポートしている(べき)基本記法と、それ以外の拡張記法に分ける。基本はHTMLBuilder、IDGXMLBuider、LATEXBuilderで動作するようにする(少なくともエラーは起きないようにする)。

基本

  • 〜=====

  • 、1.、:

  • lead(read)

  • list

  • emlist

  • cmd

  • table

  • quote

  • image

  • footnote

  • flushright

  • source

  • listnum

  • emlistnum

  • [nonum]〜===== 番号が標準で付くレベルでの番号なし見出し

  • raw