BlankTar

about | blog | works | photo

Linariaフォーマットの仕様

Linariaの書き方についての仕様です。
予備知識なしでも一応読めるはずですが、HTMLの知識があるとより分かりやすいと思います。

このドキュメントはLinaria風に書いていますが、正確なLinariaではありません。ご注意。
本来のLinaria形式のものは[こちら](document.txt)をご覧ください。

変換ツールの<linaria.py>については[こちら](usage.html)をご覧ください。

-- Linariaとは

テキストのまま書いて、テキストのまま読むことを前提とした軽量マークアップ言語みたいなものです。 正しくマークアップすることよりも自然に書けるのを重視しているので、正確にはマークアップ言語じゃないかもですが。 「HTML5に変換可能で、かつ自然に読み書きできる形式」、といっても良いかもしれません。 元々は日記を書くために使っていたフォーマットを整理しなおしたものですが、色んなものに使えると思います。 章立てて書くのに適しているので、メモ書きとか、議事録とかに向いているかも。

-- 基本的な書き方

大体はご覧のとおりです。 テキストファイル全体を一つの文書(HTML5で言うところのarticle)として、その中に章(HTML5のsection)を作ります。 なお、一番上の行はタイトルとしてマークアップされるので、本文には含まれません。 Linariaが使うインデントは全て半角スペース4つか、タブ文字ひとつです。 半角スペース4つを使うと、タイトルと本文の間が一文字分ずれて見やすいので、可能な限りスペースを推奨します。

-- 段落

空行を段落の切れ目として認識します。 段落1 ここはひとつ目の段落です ここも同じ段落です 段落2 ここはふたつ目の段落です

-- 章

章は -- タイトル 文章 文章 みたいな形式の通常の章と p.s. タイトル 文章 文章 みたいな形式の追記があります。 正確には追記は章(section)ではなくて、HTML5に変換するとarticle要素としてマークアップされます。

-- 箇条書き

また、章と同じような見た目で 1. その一 文章 文章 2. そのに 文章 とすると、箇条書きをする事ができます。 上記の文はHTML5でいう <ol> <li>その一</li> <p> 文章<br /> 文章<br /> </p> <li>そのに</li> <p> 文章<br /> </p> </ol> と同等です。(見やすいようにインデントしていますが、実際はされません。)

-- ver1.1での追加

バージョン1.1から a. そのいち b. そのに A. 文章 B. 文章 の形式を使うことが可能になりました。 HTMLに変換しても同等の記号が使用されます。 なお、z以降は使えませんので注意してください。

-- 整形済みテキスト

HTMLで言うpre要素。 章、箇条書き以外の場所インデントされると、整形済みテキストとして扱います。 この場合、その行にある要素はすべて無視されます。 空行を挟んでもひとつの整形済みテキストとして認識されます。 整形済みテキストを使っても、HTML要素を直に書くことは出来ないので注意してください。

-- 引用

HTMLで言うblockquote。 > この文は引用です。 > 複数行書くことも可能です このように書くと、引用としてマークアップすることが可能です。 ただし、 >> 文章 のような形式は認められないので注意してください。 引用の中で引用を使いたい場合は > > 文章 としてください。

-- 意味付け

文字列の左右を記号で囲むと、その文字列に意味をもたせることができます。 HTMLでいうインライン要素みたいなもの。 しつこく使うと見辛くなるので、ほどほどに。 ちなみに、閉じのない括弧とかがあると、行末までと認識します。 という訳で行を跨ぐことはできません。注意。

-- ver1.4での変更

' と " は閉じを省略することが出来なくなりました。 英語でdon'tみたいに書くことが出来るようにするための変更です。 まあ、同じ行に複数回現れれば意味が無いですが・・・。

-- ver1.5での変更

' と " に加えて、 < の閉じも省略できなくなりました。

-- 弱い強調

「」 '' ‘’ これらの記号で囲むと、その文は弱く強調されます。 台詞や大事な意味のある文などに。 HTMLのem要素に変換されます。 例: 魔王「おお、勇者よ。死んでいないとは情けない。」

-- 強い強調

"" “” これらの記号で囲むと、その文は強く強調されます。 特に重要な意味を持つ文なんかにどうぞ。 HTMLのstrong要素に変換されます。 例: 冷凍都市に住む妄想人類諸君に告ぐ、"我々は酔っ払った!"

-- ver1.5での追加

上記二つの記号で囲むことに加え、一文字づつスペースを入れることでも強調できるようになりました。 強 調 さ れ る 文 章 のように使用出来ます。 また、スペースを複数に増やすと、その分だけ強調のレベルがあがります。

-- 補足

() () これらの記号で囲むと、その文は補足として認識されます。 HTMLのsmall要素に変換されます。 例: ノートパソコン(ウルトラブックとかじゃなくて、ネットブック)が好きだ。

-- 用語

<> <> これらの記号で囲むと、その文は特別な用語になります。 一般的でない専門用語などに。 HTMLのdfn要素に変換されます。 例: この文書は<Linaria>のフォーマットについて説明しています。

-- リンク

[文字列](URL) という形式の文があった場合、HTMLの <a href="URL">文字列</a> に変換されます。 URLは相対パスを指定することも可能です。 文字列の中に別の意味付けを入れ子にすることも可能です。 ただし、文字列、URL共に省略することはできません。

-- メディアリンク(バージョン1.5で追加

[IMG:代替文字列](URL) という形式のリンクを書くことで、画像へのリンクを張ることができます。 HTMLでは <a href="URL"><img src="URL" alt="代替文字列" /></a> と等価になります。 また、 [AUDIO:代替文字列](URL) という形式で書くと、音声へのリンクを、 [VIDEO:代替文字列](URL) という形式で書けば、映像へのリンクを張ることができます。 これらは、HTML5のメディアタグを使用します。

-- 余談 - Linariaの名前の由来

上にもちらっと書きましたが、元々は日記用のフォーマットなので、"日常。"という名前で作っていました。 で、パーサーを作ろうって思って、日本語だと扱いが面倒なので英語名を"daily"に決定。 待てよ、daily? 一日草? アンブレラ? つまり姫金魚草? という飛び飛びな発想で"Linaria"に。 という感じの<スワロウテイル人工少女販売処>ネタでした。 "'揚羽かわいいよ揚羽。'"