livedoor wiki記法で書かれたテキストをHTMLに変換するツールです。windows版のバイナリファイルをここで公開しました。リンク先を開いて「download」をクリックするとダウンロードできます。

方針
  • できるだけ多くのエラーを発見する
  • 設定ファイルによる記法の変更可能性
  • 他のUNIXコマンドと調和する
  • HTMLが生成されるまでの時間は遅くない

できるだけ多くのエラーを発見する

Wiki記法を使うのを躊躇する理由として、記法が間違っていても黙ったまま出力すること、あるいは"||="で閉じていないなどの誤りを見つけたときエラーを出して変換を止めてしまうことでした。ぼくはそれを改善しようと思い、記法として正しくないと思われる部分をエラーとして出力します。また"||="がないときは、"=||"まで戻って解析し直してHTMLに変換します。
またユーザーを混乱させるエラーメッセージは出さないようにします。復帰不可能な場合は変換を停止します。こうすることで、一つの文章を書く過程で変換する回数は減り、ユーザーは文章を書くことに集中することができます。

設定ファイルによる記法の変更可能性

parserのロジックを変更することはできませんが、リストを"-"にするのでなく"*"にするとか、
リンクを"[テキスト](url)"に変更するといったことをwikiファイルの置かれたフォルダに"wiki2html.ini"
という設定ファイルを置くことでユーザーが自由に変更することができます。ダウンロードしたファイルを解凍すると
、README.mdと同じフォルダにMarkdown風にカスタマイズするための"wiki2html.ini"が入っているので、参考にしてください。

ただし解析の実装をしやすくする目的で違った命令は必ず1文字目は違った文字にしなければならないという制限があるので、
気をつけてください。

Markdown風にカスタマイズした例

他のUNIXコマンドと調和する

デフォルトでは標準出力する

生成されたhtmlを他のプログラムの入力として引き渡すことができます。
wiki2html FILE | someCommand ..

標準入力を受け付ける

標準入力からwiki記法で書かれたテキストを受け取り、htmlに変換して標準出力します。
たとえばcatを使った例では次のようになります。
cat FILE1 FILE2 FILE3.. | wiki2html

その他のオプション

lオプション
生成元のファイルのあるディレクトリに"error.log"を作ってエラー情報をそこに書き込みます。
oオプション
ファイルに書き込みます。ファイル名は*.txtの場合、*.htmlになります。
fオプション
テキストファイルとしての読みやすさのためにいれた改行コードなどを消してlivedoor wiki用のファイル*.wikiを作ります。

Windows環境での利用

Windowsではterapadと連携して使うことを想定しています。

インストール

ここからダウンロードしたファイルを解凍してください。 下記のファイルが解凍されますので、適当なフォルダに置いて、wiki2html.exeを実行してください。
  • wiki2html.exe
  • README.md
  • doc
docフォルダには記法に関する説明が書かれたファイルreference.txtがあります。alldoc.batをダブルクリックすると、README.html, reference.htmlが生成されます。

terapadの設定

wiki2htmlはUTF-8で改行コードLFを想定していますので、
terapadの"表示>オプション"を選んで、次のように設定します。

wiki2htmlにパスが通っているとして、terapadの"ツール>ツールの設定"から次のように設定します。
下の画像では"Ctrl+I"でwiki2htmlが起動します。

デモ

コメントをかく


「http://」を含む投稿は禁止されています。

利用規約をご確認のうえご記入下さい

管理人/副管理人のみ編集できます