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

== 記法の種類

 * 段落（本文）
 * 見出し（章・節・項・段・小段）※5レベルまで←段の下の正式な呼称が不明
 * コラム（見出しの変形）※基本的に正式サポートはcolumnのみ
 * 各種リスト（箇条書き、番号つき箇条書き、用語リスト）※ただし、用語リストは構文および動作がわかりにくいので非推奨
 * 各種タグ（ブロックつき・ブロックなし）
 * 各種インライン
 * 著者用タグ（プリプロセッサ）

== 記法の用法

 * ブロックの入れ子は不可
 * インラインの入れ子は不可
 * ブロック内でのインラインの使用は可
 * インラインのエスケープには@<raw>を使う
 * ブロックのエスケープは困難なので、行頭ではないところに書くか、全角／／にしておいて後で置換するなどの対処をユーザ自身にしてもらう

=== 記法の課題（非互換）

 * ブロック内での段落の使用は許すか？
    * 現状ではLATEXBuilderは可、HTMLBuilderは不可
    * quoteブロック、leadブロックでは使えるようにしたい ※後方互換性を破壊する、ブロック名によって処理が違う(listとleadでの違いなど)のがややこしいといった問題あり。
 * listブロックやemlistブロック、cmdブロック内でのインラインは許すか？
    * 現状ではLATEXBuilderでは不可、HTMLBuilder、IDGXMLBuilder、TOPBuilderでは可 ※LaTeXでどうするかについてのみ検討課題
    * LaTeXはvarbatim環境を使っているので無理？？ ←alltt環境に変更、検証中

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

 * HTML(レイアウトを使用しない場合のHTMLのバージョンはXHTML1.1) ※iPadのiBooksをリファレンスプラットフォームに。変なところはあるものの、現時点では一番まっとうなビューア
 * LaTeX(dvipdfmxでPDFに変換)
 * IDGXML (Adobe InDesign CS2以降向けXML形式)
 * (TOPBuilder記法？) ※ほぼプレインテキスト化したい場合の形式。HTML/IDGXMLに遅れてのサポート
 * (EWB記法←サポートする・できる？) ←捨てよう

== 利用できるタグ記法

全フォーマットで原則サポートしている（べき）基本記法と、それ以外の拡張記法に分ける。
(基本はHTMLBuilderとLATEXBuilderの実装状況から判断)←kmutoはHTMLBuilderとIDGXMLBuilderをコアコンポーネントと位置付けている。

=== 基本

 * =〜=====
 * *、1.、:
 * lead(read)
 * list
 * emlist
 * cmd
 * table
 * quote
 * image

 * footnote

 * flushright  ※LaTeX対応済み
 * source  ※LaTeX対応済み
 * listnum  ※LaTeX対応済み
 * emlistnum  ※LaTeX対応済み

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

=== 拡張

==== 準基本

基本化への開発を重点的に進める。

 * noindent  ※HTML非対応 ←IDGXMLでは頻度が高く、HTMLでもCSSで対処できるので、基本に近い拡張
 * box(insn)  ※LaTeX非対応
 * indepimage ※LaTeX非対応
 * label  ※HTMLで<a id="..." />で対応。hrefをサポートするならこの基本化は必須
 * raw    ※LaTeX非対応
 * tsize  ※LaTeX非対応←いずれほしくなる気もする。mm単位

==== 基本化の難しそうなもの・時間のかかりそうなもの
<commit_msg>fix comment about LATEXBuilder<commit_after>= 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]〜=====[nonum] 番号が標準で付くレベルでの番号なし見出し
 * raw

=== 拡張

==== 準基本

基本化への開発を重点的に進める。

 * noindent  ※HTML非対応 ←IDGXMLでは頻度が高く、HTMLでもCSSで対処できるので、基本に近い拡張
 * box(insn)  ※LaTeX非対応
 * indepimage ※LaTeX非対応
 * label  ※HTMLで<a id="..." />で対応。hrefをサポートするならこの基本化は必須
 * tsize  ※LaTeX非対応←いずれほしくなる気もする。mm単位

==== 基本化の難しそうなもの・時間のかかりそうなもの

{'fraction_non_alphanumeric': 0.12323727774371551, 'fraction_numerical': 0.0030656039239730227, 'mean_word_length': 6.606060606060606, 'pattern_counts': {'":': 0, '<': 7, '<?xml version=': 0, '>': 7, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '3674894', 'n_tokens_mistral': 2533, 'n_tokens_neox': 2454, 'n_words': 155}