読者です 読者をやめる 読者になる 読者になる

Drafts

@cm3 の草稿置場 / 少々Wikiっぽく使っているので中身は適宜追記修正されます。

オンライン出版論文フォーマットとしての AsciiDoc の可能性

HTMLセントリック論文パブリッシング - Drafts に書いたように HTML セントリックにすればいいと思っているので、その前は Markdown でも AsciiDoc でも良いんだけれど、AsciiDoc がどのくらい適切かいろいろ考えてみた

Markdown の圧倒的知名度と MultiMarkdown の知名度の低さ、他の選択肢

Markdown でも論文書けるよと言った時には、脚注や相互参照などの機能をいろいろ付加したバージョン、具体的には MultiMarkdown や Pandoc Markdown などを指していることが多い。そうなると、google trends などを見ても分かるように AsciiDoc だって健闘している。

ドキュメントシステムはこれを使え2015年版を見て Re:VIEW を知った。開発はとても活発だが、海外での知名度が AsciiDoc にかなり劣るし、検索性の問題で trends による比較はできない。他にLightweight markup language - Wikipedia, the free encyclopedia あたりから見てみても Textile や reStructuredText 、MediaWiki あたりが他の候補かな。

マークアップの思想的なもの

機械にやさしいマークアップが人間にやさしいマークアップ

人間にやさしいので書いて、機械用に自動変換する。それってもともと機械にやさしいのではないかと言われればそう。でも、スピードの問題とかは気にしない。人間の執筆段階は時間や日単位なので、変換の数秒などはプレビューが適当にできれば十分であり、組版状態までカンマ秒でインタラクティブにできる必要はない。

陰か陽か

文系の老齢の執筆者も想定しているので、筆者に陽に書かせるのは補助環境を使ってもらわないと難しい。AsciiDoc のレベルでも GUI のエディターは必須。Markdown でも要るかも。でも WYSIWYG # WYSIWYGに対する非難- Wikipediaで議論されているように、WYSIWYGではいけない。そこをうまくするエディターを作れればいいし、Wikipedia はそうなっているとこの節は主張している。

制約か拡張か

独自拡張がどのように埋め込めるかだけ規定をしっかりしないといけない。基本的にはリソースへの外部リンクを考えている。内部埋め込みはビデオとかはウリになりそうだから対応してもいいんじゃないかと思うけれど。上限は HTML の仕様。例えば AsciiDoc なら Chapter 21. Macros の機能によってその上限と同等までの拡張が担保される。HTMLセントリックにしているかぎり、他のフォーマットへの変換は気にしなくていい。

エスケープを少なくできているか

これは Re:VIEW が圧倒的に強いな

コメント

これは僕は行志向のアノテーションツールで代替している。それも開発段階なのでイマイチな策かもしれないけれど、AsciiDoc なら

////
複数行コメント
////

の記法が使える。

表や入れ子というマークアップが苦手なもの

エディターおよびプレビューのツール

プレビューにはこの js が使えそう。すでにこれを使った CMS hubpress.ioがあって、HubPressで手間をかけずにAsciiDocでかけるブログを作っちゃおう | ぴんくいろにっき で紹介されている。

今回は WordPress の利用も考えているが、つい最近 WordPress の Plugin も開発されはじめたようだ。

その他参考