NEPLg2 Standard Library - README - Gloss,Nest 拡張Markdown 説明と例
Web Playground
Web Playground

Gloss,Nest 拡張かくちょうMarkdown 説明せつめいれい

この文書ぶんしょは、Gloss と Nest を追加ついかした Markdown の記法きほうを、この拡張かくちょうMarkdown自身じしん説明せつめいします。

拡張子かくちょうし .n.md


目次もくじ

  • 概要がいよう
  • Gloss

- ruby(漢字かんじみ)
- gloss(日本語にほんごEnglish
- 多言語たげんごgloss(Abβ
- ......数式すうしき保護ほご

  • Nest(見出みだしで区切くぎる)

- 基本きほん規則きそく
- break 規則きそく## / --- / ;;;
- Nest のれい

  • 設計せっけいかんがえかた(AST 前提ぜんてい
  • 実装じっそうしゃむけ注意ちゅうい曖昧あいまいさをらす)
  • テンプレート

概要がいよう

この拡張かくちょうは、つぎの 2つを Markdown に追加ついかします。

1. Gloss:日本語にほんごEnglish のように、本文ほんぶん文字もじちいさな注釈ちゅうしゃくならべます
2. Nest:見出みだし(#######)で区切くぎり、せつにします


改行

による改行ではなくて、 で改行です
.n.mdで改行されていたら改行して表示されるし、 と書かれていても改行して表示します

Gloss

ruby([漢字/かんじ]

ruby は [漢字/かんじ]かたちです。

  • [私/わたし]は[漢字/かんじ][交/ま]じりの[文/ぶん]を[書/か]く
  • [東/ひがし][京/きょう]へ[行/い]く
  • [微分/びぶん][係数/けいすう]

ruby の規則きそく

  • [漢字/かんじ] のように、/ひだり表示ひょうじされる本文ほんぶん/みぎが ruby(み)です
  • かな・カタカナ・数字すうじ記号きごうには ruby をけません(ruby は「漢字かんじみ」を想定そうていします)
  • ruby は、gloss のなかでもそとでもけます

gloss({[日本語/にほんご]/English}

gloss は {[日本語/にほんご]/English}かたちです。

  • {[微分/びぶん][係数/けいすう]/derivative}{[接線/せっせん]/tangent}かたむきをあらわ
  • {カルボン[酸/さん]/carboxylic acid}{[弱酸/じゃくさん]/weak acid} として {[水溶液/すいようえき]/aqueous solution}{[電離/でんり]/ionize} しやすい

gloss の意味いみ

A{B/b}Cくと、本文ほんぶんABC としてめて、Bしたbちいさく表示ひょうじされます。

  • 本文ほんぶん(base):ABC
  • 注釈ちゅうしゃく(note):b

多言語たげんごgloss({A/b/β}

gloss は 3つ以上いじょう言語げんごかさねられます。

  • {[台/たい][湾/わん]/台灣/Táiwān}へ[行/い]く
  • [来年/らいねん]、{アテネ/Αθήνα/Athens}を[訪/おとず]れる[予定/よてい]だ
  • {トルストイ/Лев Николаевич Толстой/Tolstoy}の[小説/しょうせつ]を[読/よ]む

注意ちゅうい

  • base の文字もじは 1つの言語げんごそろえるのが推奨すいしょうです(安定あんていします)
  • ruby は base のなかにもけます(たとえば {Kyoto/[京/きょう][都/と]}

......数式すうしき保護ほご

$...$$$...$$内側うちがわは gloss / ruby として解釈かいしゃくしません。

  • [酸素/さんそ]$\\mathrm{O_2}$・[珪素/けいそ]$\\mathrm{Si}$・[鉄/てつ]$\\mathrm{Fe}$
  • $\\text{[地表/ちひょう]} のように、数式すうしきなか[/]{/} があっても、Gloss/ruby になりません

Nest(見出みだしで区切くぎる)

基本きほん規則きそく

Nest は、見出みだし(#######)が地点ちてんから、つぎの見出みだしや break までを 1つのせつ(section)としてまとめます。

  • ##したにある ### は、##せつになります
  • おなふかさの見出みだしがると、おなおや兄弟きょうだいせつになります
  • もっとあさ見出みだしがると、ふかせつじます

break 規則きそく## / --- / ;;;

この拡張かくちょうでは、つぎが Nest を break(区切くぎる / じる)します。

1) より高位こうい見出みだし(たとえば ##

  • ###途中とちゅう##たら、###(およびそれよりふかせつ)は全部ぜんぶじます
  • あたらしい ##せつはじまります

2) ---(Thematic break)

  • ---水平線すいへいせんとして表示ひょうじされます
  • そのあと、Nest を 1だんだけじます(;;;おなじ “1だん close”)
  • ----のように、-が3つよりおおいものは、ただの水平線すいへいせんとしてあつかいます Nestに干渉かんしょうしません

3) ;;;(Section break)

  • ;;;表示ひょうじしません(せつじる命令めいれいだけ)
  • Nest を 1だんだけじます
  • 2だんじたいなら ;;; を 2かい きます

Nest のれい

せつA(##

この段落だんらくは A のなかです。

せつA-1(###

A-1 のなかです。

;;;
A-1 を 1だんじたので、ここからは A のなかもどります。

せつA-2(###

A-2 のなかです。


---水平線すいへいせんとしてのこり、そのあと A-2 を 1だんじます。
なので、ここは A のなかです。

せつB(##

##ると A(および A の)はじて、B がはじまります。

せつB-1(###

B-1 のなかです。

せつB-1-a(####

B-1-a のなかです。

せつC(##

ここで B-1-a / B-1 / B が全部ぜんぶじて、C がはじまります。


設計せっけいかんがえかた(AST 前提ぜんてい

この拡張かくちょうは、変換へんかん(HTMLなど)と分離ぶんりして、まず AST をつくることを想定そうていします。

AST のれい概略がいりゃく

  • Document

- Section(level=2, heading="A")
- Paragraph(...)
- Section(level=3, heading="A-1")
- Paragraph(...)
- Paragraph(...) # after ;;;
- Section(level=3, heading="A-2")
- Paragraph(...)
- ThematicBreak # ---
- Paragraph(...) # after ---
- Section(level=2, heading="B")
- ...


実装じっそうしゃむけ注意ちゅうい

曖昧あいまいさをらす推奨すいしょう

この拡張かくちょうは Markdown の方言ほうげんなので、実装じっそう簡単かんたんにするため、つぎを推奨すいしょうします。

  • 見出みだしは ATX(#)だけを使つかう(Setext は使つかわない)
  • ---単独たんどくぎょうだけを水平線すいへいせんとしてあつか
  • ;;;単独たんどくぎょうだけを break としてあつか
  • \\{ \\/ のような 簡単かんたんげ(escape)を用意よういする

テンプレート

あたらしい文書ぶんしょくときは、これを複製ふくせいして使つかってください。

題名だいめい##

用語ようごterm導入どうにゅうする。

しょうせつ###

[例/れい]微分びぶん係数けいすうderivative{[接線/せっせん]/tangent}

ここからおやせつもどる。


ここで水平線すいへいせん+ 1だん close。

べつ題名だいめい##

つぎせつ