nora_mark 0.2beta7 → 0.2beta8
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.travis.yml +1 -1
- data/README.md +149 -73
- data/Rakefile +1 -3
- data/bin/nora2html +1 -1
- data/emacs-mode/noramark-mode.el +497 -0
- data/example/koujin.nora +13 -0
- data/example/nora-simple.css +27 -2
- data/example/noramark-reference-ja.nora +446 -64
- data/example/noramark-reference-ja_00001.xhtml +485 -85
- data/lib/nora_mark.rb +5 -67
- data/lib/nora_mark/document.rb +89 -0
- data/lib/nora_mark/extensions.rb +26 -0
- data/lib/nora_mark/html/context.rb +2 -3
- data/lib/nora_mark/html/default_transformer.rb +151 -0
- data/lib/nora_mark/html/generator.rb +25 -149
- data/lib/nora_mark/html/paragraph_writer.rb +4 -4
- data/lib/nora_mark/html/tag_writer.rb +13 -10
- data/lib/nora_mark/node.rb +196 -72
- data/lib/nora_mark/node_set.rb +13 -0
- data/lib/nora_mark/node_util.rb +29 -16
- data/lib/nora_mark/parser.kpeg +210 -74
- data/lib/nora_mark/parser.kpeg.rb +1353 -401
- data/lib/nora_mark/parser.rb +1 -1
- data/lib/nora_mark/transformer.rb +35 -10
- data/lib/nora_mark/version.rb +1 -1
- data/nora_mark.gemspec +3 -2
- data/spec/node_spec.rb +280 -0
- data/spec/nora_mark_spec.rb +1189 -1025
- data/spec/spec_helper.rb +2 -0
- data/spec/transformer_spec.rb +37 -0
- metadata +27 -6
- data/lib/nora_mark/html/writer_selector.rb +0 -24
- data/lib/nora_mark/node_builder.rb +0 -18
|
@@ -5,59 +5,80 @@
|
|
|
5
5
|
<link rel="stylesheet" type="text/css" href="nora-simple.css" />
|
|
6
6
|
<link rel="stylesheet" type="text/css" href="nora-simple-ja.css" />
|
|
7
7
|
</head>
|
|
8
|
-
<body>
|
|
9
|
-
<section><h1 id='heading_index_1'>NoraMark Manual</h1>
|
|
8
|
+
<body><section><h1 id='heading_index_1'>NoraMark Manual</h1>
|
|
10
9
|
<div class='pgroup'><p><strong>(作成中・記述は未完成です。)</strong></p>
|
|
11
10
|
</div>
|
|
12
11
|
<div class='pgroup'><p>NoraMarkは、EPUBで利用するXHTMLを生成するためのマークアップとしてデザインされました。次のような特徴があります。</p>
|
|
13
12
|
</div>
|
|
14
|
-
<ul><li
|
|
15
|
-
<li
|
|
16
|
-
<li
|
|
17
|
-
<li>生のHTML
|
|
18
|
-
<li
|
|
19
|
-
<li>文書構造に対する処理を追加できる</li>
|
|
20
|
-
<li>パース結果をXMLとして取得できる</li>
|
|
13
|
+
<ul><li>Markdownと同じように、プレーンテキストの原稿に近い最小限の記法です。</li>
|
|
14
|
+
<li>Markdownと異なり、マークアップ部分は通常のテキストと「違って」見えるようにデザインしています。これは、意識せずにマークアップを壊してしまうことを避けるためです。</li>
|
|
15
|
+
<li>マークアップに独自コマンドの追加ができる柔軟なカスタマイズ機能を用意しています。</li>
|
|
16
|
+
<li>生のHTML記法なしで、多くのタグを記述できます。</li>
|
|
17
|
+
<li>パース結果をXMLとして取得できます。</li>
|
|
21
18
|
</ul>
|
|
22
19
|
<section><h2 id='heading_index_2'>必要なもの</h2>
|
|
23
20
|
<ul><li>ruby 2.0以上</li>
|
|
24
21
|
</ul>
|
|
25
22
|
</section>
|
|
26
23
|
<section><h2 id='heading_index_3'>インストール方法</h2>
|
|
24
|
+
<section><h3 id='heading_index_4'>Gemfile</h3>
|
|
27
25
|
<div class='pgroup'><p>Gemfileに次のように書きます</p>
|
|
28
26
|
</div>
|
|
29
|
-
<pre><code>gem 'nora_mark' </code
|
|
27
|
+
<pre><code>gem 'nora_mark' </code>
|
|
28
|
+
</pre>
|
|
30
29
|
<div class='pgroup'><p>そして、</p>
|
|
31
30
|
</div>
|
|
32
|
-
<pre><code>$ bundle</code
|
|
33
|
-
|
|
34
|
-
</
|
|
35
|
-
<
|
|
31
|
+
<pre><code>$ bundle</code>
|
|
32
|
+
</pre>
|
|
33
|
+
</section>
|
|
34
|
+
<section><h3 id='heading_index_5'>直接インストール</h3>
|
|
35
|
+
<pre><code>gem install nora_mark</code>
|
|
36
|
+
</pre>
|
|
36
37
|
</section>
|
|
37
|
-
|
|
38
|
-
<section><
|
|
39
|
-
<
|
|
38
|
+
</section>
|
|
39
|
+
<section><h2 id='heading_index_6'>使い方</h2>
|
|
40
|
+
<section><h3 id='heading_index_7'>コマンドラインから</h3>
|
|
41
|
+
<pre><code>$ nora2html < source.nora > output.xhtml</code>
|
|
42
|
+
</pre>
|
|
40
43
|
<div class='pgroup'><p>入力はutf-8のみ受け付けます。日本語のテキストであれば、kconvオプションでうまくうごくかもしれません。</p>
|
|
41
44
|
</div>
|
|
42
|
-
<pre><code>$ nora2html --kconv < source.nora > output.xhtml</code
|
|
43
|
-
|
|
45
|
+
<pre><code>$ nora2html --kconv < source.nora > output.xhtml</code>
|
|
46
|
+
</pre>
|
|
47
|
+
<div class='pgroup'><p><strong>nora2htmlは、newpageコマンドを<code><hr /></code>タグに置き換え、すべてのページをひとつのxhtmlとして出力します</strong></p>
|
|
44
48
|
</div>
|
|
45
49
|
</section>
|
|
46
|
-
<section><h3 id='
|
|
50
|
+
<section><h3 id='heading_index_8'>コードから</h3>
|
|
47
51
|
<pre class='code-ruby' data-code-language='ruby'><code>require 'nora_mark'
|
|
52
|
+
|
|
48
53
|
document = NoraMark::Document.parse(string_or_io, lang: 'ja')
|
|
49
|
-
document.html.write_as_files</code
|
|
54
|
+
document.html.write_as_files</code>
|
|
55
|
+
</pre>
|
|
50
56
|
</section>
|
|
57
|
+
<section><h3 id='heading_index_9'>Emacs Lisp noramark-mode</h3>
|
|
58
|
+
<div class='pgroup'><p>Emacs用のメジャーモードを提供するnoramark-mode.elを用意しています。現在のところ、font-lockによるsyntax highlight機能と、outline-minor-modeのサポートを提供しています。</p>
|
|
59
|
+
</div>
|
|
60
|
+
<ol><li>normark-mode.elをEmacsのload-pathが通った場所に配置してください。</li>
|
|
61
|
+
<li><code>~/.emacs.d/init.el</code>に次の記述をしてください。</li>
|
|
62
|
+
</ol>
|
|
63
|
+
<pre class='code-emacs-lisp' data-code-language='emacs-lisp'><code>(require 'noramark-mode)
|
|
64
|
+
(setq auto-mode-alist (cons '("\\.nora$" . noramark-mode) auto-mode-alist))
|
|
65
|
+
(setq auto-mode-alist (cons '("-nora\\.txt$" . noramark-mode) auto-mode-alist))</code>
|
|
66
|
+
</pre>
|
|
51
67
|
</section>
|
|
52
|
-
|
|
53
|
-
<section><
|
|
68
|
+
</section>
|
|
69
|
+
<section><h2 id='heading_index_10'>マークアップ</h2>
|
|
70
|
+
<section><h3 id='heading_index_11'>通常のテキスト</h3>
|
|
54
71
|
<div class='pgroup'><p>単なるテキストもHTMLに変換されます。</p>
|
|
55
72
|
</div>
|
|
73
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
56
74
|
<pre>吾輩は猫である。名前はまだ無い。
|
|
57
75
|
どこで生れたかとんと見当けんとうがつかぬ。何でも薄暗いじめじめした所でニャーニャー泣いていた事だけは記憶している。
|
|
58
76
|
＜中略＞
|
|
59
77
|
この書生の掌の裏うちでしばらくはよい心持に坐っておったが、しばらくすると非常な速力で運転し始めた。
|
|
78
|
+
|
|
60
79
|
ふと気が付いて見ると書生はいない。たくさんおった兄弟が一疋ぴきも見えぬ。</pre>
|
|
80
|
+
</div>
|
|
81
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
61
82
|
<pre class='code-html' data-code-language='html'><code><div class='pgroup'>
|
|
62
83
|
<p>吾輩は猫である。名前はまだ無い。</p>
|
|
63
84
|
<p>どこで生れたかとんと見当けんとうがつかぬ。何でも薄暗いじめじめした所でニャーニャー泣いていた事だけは記憶している。</p>
|
|
@@ -66,27 +87,61 @@ document.html.write_as_files</code></pre>
|
|
|
66
87
|
</div>
|
|
67
88
|
<div class='pgroup'>
|
|
68
89
|
<p>ふと気が付いて見ると書生はいない。たくさんおった兄弟が一疋ぴきも見えぬ。</p>
|
|
69
|
-
</div></code
|
|
70
|
-
|
|
71
|
-
|
|
90
|
+
</div></code>
|
|
91
|
+
</pre>
|
|
92
|
+
</div>
|
|
93
|
+
<div class='pgroup'><p>改行ごとに<code><p></code>要素がつくられます。空行で区切られると<code><div class='pgroup'></code>がつくられます。</p>
|
|
72
94
|
</div>
|
|
73
|
-
<
|
|
74
|
-
|
|
95
|
+
<div class='pgroup'><p>言語が日本語(ja)以外の場合は、次のようになります。</p>
|
|
96
|
+
</div>
|
|
97
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
98
|
+
<pre>Lorem ipsum dolor sit amet, consectetur adipisicing elit,
|
|
99
|
+
sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
|
|
100
|
+
|
|
75
101
|
Ut enim ad minim veniam, quis nostrud exercitation </pre>
|
|
102
|
+
</div>
|
|
103
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
76
104
|
<pre class='code-html' data-code-language='html'><code><p>Lorem ipsum dolor sit amet, consectetur adipisicing elit, <br />sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. </p>
|
|
77
|
-
<p>Ut enim ad minim veniam, quis nostrud exercitation</p></code
|
|
105
|
+
<p>Ut enim ad minim veniam, quis nostrud exercitation</p></code>
|
|
106
|
+
</pre>
|
|
107
|
+
</div>
|
|
108
|
+
<div class='pgroup'><p>後述のparagraph_styleでもこの振る舞いを切り替えることができます。</p>
|
|
109
|
+
</div>
|
|
78
110
|
</section>
|
|
79
|
-
<section><h3 id='
|
|
80
|
-
<div class='pgroup'><p>NoraMark
|
|
111
|
+
<section><h3 id='heading_index_12'>明示的なブロック</h3>
|
|
112
|
+
<div class='pgroup'><p>NoraMarkでは、<code><コマンド> {</code> ではじまり、<code>}</code> のみの行で終わる範囲を明示的なブロックとみなします。</p>
|
|
81
113
|
</div>
|
|
114
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
82
115
|
<pre>d.column {
|
|
83
116
|
この部分は、divで囲まれます。
|
|
84
117
|
}</pre>
|
|
118
|
+
</div>
|
|
119
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
85
120
|
<pre class='code-html' data-code-language='html'><code><div class="column">
|
|
86
121
|
<div class="pgroup">
|
|
87
122
|
<p>この部分は、divで囲まれます。</p>
|
|
88
123
|
</div>
|
|
89
|
-
</div></code
|
|
124
|
+
</div></code>
|
|
125
|
+
</pre>
|
|
126
|
+
</div>
|
|
127
|
+
<div class='pgroup'><p>このように、コマンドにはclassを指定することができます。</p>
|
|
128
|
+
<p>同じように、idの指定も可能です。</p>
|
|
129
|
+
</div>
|
|
130
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
131
|
+
<pre>d#the_column.column {
|
|
132
|
+
この部分は、divで囲まれます。
|
|
133
|
+
}</pre>
|
|
134
|
+
</div>
|
|
135
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
136
|
+
<pre class='code-html' data-code-language='html'><code><div id="the_column" class="column">
|
|
137
|
+
<div class="pgroup">
|
|
138
|
+
<p>この部分は、divで囲まれます。</p>
|
|
139
|
+
</div>
|
|
140
|
+
</div></code>
|
|
141
|
+
</pre>
|
|
142
|
+
</div>
|
|
143
|
+
<div class='pgroup'><p>クラス・IDの指定は、多くのコマンドで同じように利用できます。</p>
|
|
144
|
+
</div>
|
|
90
145
|
<div class='pgroup'><p>定義済みの明示的ブロックのコマンドは、次のものがあります。</p>
|
|
91
146
|
</div>
|
|
92
147
|
<dl><dt>d</dt>
|
|
@@ -100,113 +155,458 @@ Ut enim ad minim veniam, quis nostrud exercitation </pre>
|
|
|
100
155
|
</div>
|
|
101
156
|
<div class='pgroup'><p>未定義のコマンドの場合は、対応する名前のタグを生成します。</p>
|
|
102
157
|
</div>
|
|
158
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
103
159
|
<pre>blockquote {
|
|
104
160
|
山路を登りながら、こう考えた。
|
|
105
161
|
智に働けば角が立つ。情に棹させば流される。意地を通せば窮屈だ。とかくに人の世は住みにくい
|
|
106
162
|
}</pre>
|
|
163
|
+
</div>
|
|
164
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
107
165
|
<pre class='code-html' data-code-language='html'><code><blockquote>
|
|
108
166
|
<div class='pgroup'>
|
|
109
167
|
<p>山路を登りながら、こう考えた。</p>
|
|
110
168
|
<p>智に働けば角が立つ。情に棹させば流される。意地を通せば窮屈だ。とかくに人の世は住みにくい</p>
|
|
111
169
|
</div>
|
|
112
|
-
</blockquote></code
|
|
170
|
+
</blockquote></code>
|
|
171
|
+
</pre>
|
|
172
|
+
</div>
|
|
173
|
+
<section><h4 id='heading_index_13'>Preformat block</h4>
|
|
174
|
+
<div class='pgroup'><p>整形済みブロックは、次のように指定します。</p>
|
|
175
|
+
</div>
|
|
176
|
+
<div class='pre'><p class='caption'>形式1</p>
|
|
177
|
+
<pre><code>pre {
|
|
178
|
+
format 1 : 整形済みの内容
|
|
179
|
+
}</code>
|
|
180
|
+
</pre>
|
|
181
|
+
</div>
|
|
182
|
+
<div class='pre'><p class='caption'>形式2</p>
|
|
183
|
+
<pre><code>pre {//
|
|
184
|
+
format 2: 整形済みの内容
|
|
185
|
+
//}</code>
|
|
186
|
+
</pre>
|
|
187
|
+
</div>
|
|
188
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
189
|
+
<pre class='code-html' data-code-language='html'><code><pre>
|
|
190
|
+
format 1 : 整形済みの内容
|
|
191
|
+
</pre>
|
|
192
|
+
<pre>
|
|
193
|
+
format 2 : 整形済みの内容
|
|
194
|
+
</pre></code>
|
|
195
|
+
</pre>
|
|
196
|
+
</div>
|
|
197
|
+
<div class='pgroup'><p>また、次のように書くことで整形済みコードを作ることもできます。</p>
|
|
198
|
+
</div>
|
|
199
|
+
<div class='pre'><p class='caption'>形式1</p>
|
|
200
|
+
<pre><code>code {
|
|
201
|
+
整形済みコード
|
|
202
|
+
}</code>
|
|
203
|
+
</pre>
|
|
204
|
+
</div>
|
|
205
|
+
<div class='pre'><p class='caption'>形式2</p>
|
|
206
|
+
<pre><code>code {//
|
|
207
|
+
整形済みコード
|
|
208
|
+
//}</code>
|
|
209
|
+
</pre>
|
|
210
|
+
</div>
|
|
211
|
+
<div class='pre'><p class='caption'>形式3</p>
|
|
212
|
+
<pre><code>```
|
|
213
|
+
整形済みコード
|
|
214
|
+
```</code>
|
|
215
|
+
</pre>
|
|
216
|
+
</div>
|
|
217
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
218
|
+
<pre class='code-html' data-code-language='html'><code><pre></code>
|
|
219
|
+
整形済みコード
|
|
220
|
+
</code></pre></code>
|
|
221
|
+
</pre>
|
|
222
|
+
</div>
|
|
223
|
+
<section><h5 id='heading_index_14'>code languageの指定</h5>
|
|
224
|
+
<div class='pgroup'><p>code languageの指定をすることができます。</p>
|
|
225
|
+
</div>
|
|
226
|
+
<div class='pre'><p class='caption'>形式1</p>
|
|
227
|
+
<pre><code>code {//ruby
|
|
228
|
+
puts "Hello, World."
|
|
229
|
+
//}</code>
|
|
230
|
+
</pre>
|
|
231
|
+
</div>
|
|
232
|
+
<div class='pre'><p class='caption'>形式2</p>
|
|
233
|
+
<pre><code>```ruby
|
|
234
|
+
puts "Hello, World."
|
|
235
|
+
```</code>
|
|
236
|
+
</pre>
|
|
237
|
+
</div>
|
|
238
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
239
|
+
<pre class='code-html' data-code-language='html'><code><pre class='code-ruby' data-code-language='ruby'><code>
|
|
240
|
+
puts "Hello, World."
|
|
241
|
+
</code></pre></code>
|
|
242
|
+
</pre>
|
|
243
|
+
</div>
|
|
113
244
|
</section>
|
|
114
|
-
<section><
|
|
115
|
-
<div class='
|
|
245
|
+
<section><h5 id='heading_index_15'>キャプションの指定</h5>
|
|
246
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
247
|
+
<pre>code(ソースコードはこちら) {
|
|
248
|
+
puts 'Hello, World'
|
|
249
|
+
}</pre>
|
|
250
|
+
</div>
|
|
251
|
+
<div class='pgroup'><p>または、こんな書き方もできます。</p>
|
|
252
|
+
</div>
|
|
253
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
254
|
+
<pre>```(ソースコードはこちら)
|
|
255
|
+
puts 'Hello, World'
|
|
256
|
+
```</pre>
|
|
257
|
+
</div>
|
|
258
|
+
<div class='pgroup'><p>こんな風になります。</p>
|
|
259
|
+
</div>
|
|
260
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
261
|
+
<pre class='code-html' data-code-language='html'><code><div class='pre'>
|
|
262
|
+
<p class='caption'>原稿はこちら</p>
|
|
263
|
+
<pre><code>
|
|
264
|
+
puts 'Hello, World'
|
|
265
|
+
</code></pre>
|
|
266
|
+
</div></code>
|
|
267
|
+
</pre>
|
|
268
|
+
</div>
|
|
269
|
+
</section>
|
|
270
|
+
</section>
|
|
271
|
+
</section>
|
|
272
|
+
<section><h3 id='heading_index_16'>インラインコマンド</h3>
|
|
273
|
+
<div class='pgroup'><p>インラインコマンドは、原則として次の形式をしています。</p>
|
|
116
274
|
</div>
|
|
117
275
|
<pre>[<コマンド>{内容}]</pre>
|
|
118
276
|
<div class='pgroup'><p>定義済みのインラインコマンドには、次のものがあります。</p>
|
|
119
277
|
</div>
|
|
120
278
|
<dl><dt>l</dt>
|
|
121
|
-
<dd><div class='pgroup'><p
|
|
279
|
+
<dd><div class='pgroup'><p>リンクを定義します。</p>
|
|
122
280
|
</div>
|
|
123
|
-
<pre>[l(http://github.com/skoji/noramark){NoraMarkのレポジトリ}]</pre
|
|
124
|
-
<
|
|
125
|
-
<
|
|
281
|
+
<pre>[l(http://github.com/skoji/noramark){NoraMarkのレポジトリ}]</pre>
|
|
282
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
283
|
+
<pre class='code-html' data-code-language='html'><code><a href='http://github.com/skoji/noramark'>NoraMarkのレポジトリ</a></code>
|
|
284
|
+
</pre>
|
|
126
285
|
</div>
|
|
127
|
-
|
|
286
|
+
</dd>
|
|
287
|
+
<dt>sp</dt>
|
|
288
|
+
<dd><div class='pgroup'><p>spanを定義します。</p>
|
|
289
|
+
</div>
|
|
290
|
+
<pre>[sp.note{spanの中にはいる}]</pre>
|
|
291
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
292
|
+
<pre class='code-html' data-code-language='html'><code><span class='note">spanの中に入る</span></code>
|
|
293
|
+
</pre>
|
|
294
|
+
</div>
|
|
295
|
+
</dd>
|
|
128
296
|
<dt>img</dt>
|
|
129
|
-
<dd><div class='pgroup'><p
|
|
297
|
+
<dd><div class='pgroup'><p>画像を定義します。このコマンドにはブレースのセクションがありません。</p>
|
|
298
|
+
</div>
|
|
299
|
+
<pre>[img(img/some_image.jpg,alternate text)]</pre>
|
|
300
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
301
|
+
<pre class='code-html' data-code-language='html'><code><img src='img/some_image.jpg' alt='alternate text' /></code>
|
|
302
|
+
</pre>
|
|
130
303
|
</div>
|
|
131
|
-
|
|
304
|
+
</dd>
|
|
132
305
|
<dt>tcy</dt>
|
|
133
|
-
<dd><div class='pgroup'><p>class tcyのspan
|
|
306
|
+
<dd><div class='pgroup'><p>class tcyのspanを定義します。縦書きにおける縦中横のスタイルをあてることを想定しています。</p>
|
|
134
307
|
</div>
|
|
135
|
-
<pre>FM TOWNSが登場してからすでに[tcy{25}]年がたった。</pre
|
|
308
|
+
<pre>FM TOWNSが登場してからすでに[tcy{25}]年がたった。</pre>
|
|
309
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
310
|
+
<pre class='code-html' data-code-language='html'><code><p>FM TOWNSが登場してからすでに<span class='tcy'>25</span>年がたった。</p></code>
|
|
311
|
+
</pre>
|
|
312
|
+
</div>
|
|
313
|
+
</dd>
|
|
136
314
|
<dt>ruby</dt>
|
|
137
|
-
<dd><div class='pgroup'><p
|
|
315
|
+
<dd><div class='pgroup'><p>ルビをマークアップします。</p>
|
|
316
|
+
</div>
|
|
317
|
+
<pre>[ruby(とんぼ){蜻蛉}]の[ruby(めがね){眼鏡}]はみずいろめがね</pre>
|
|
318
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
319
|
+
<pre class='code-html' data-code-language='html'><code><p><ruby>蜻蛉<rp>(</rp><rt>とんぼ</rt><rp>)</rp></ruby>の<ruby>眼鏡<rp>(</rp><rt>めがね</rt><rp>)</rp></ruby>はみずいろめがね</p></code>
|
|
320
|
+
</pre>
|
|
321
|
+
</div>
|
|
322
|
+
</dd>
|
|
323
|
+
<dt>code</dt>
|
|
324
|
+
<dd><div class='pgroup'><p>インラインでコードをマークアップします。中はMarkupとして解釈しません。<code>`</code> (バッククオート)で囲む方法と、<code>[code{}]</code>を使う方法があります。</p>
|
|
325
|
+
</div>
|
|
326
|
+
<pre>`puts "Hello, World."` and [code{puts "Hello, World."}]</pre>
|
|
327
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
328
|
+
<pre class='code-html' data-code-language='html'><code><p><code>puts "Hello, World.</code> and <code>puts "Hello, World.</code> </p></code>
|
|
329
|
+
</pre>
|
|
138
330
|
</div>
|
|
139
|
-
|
|
331
|
+
</dd>
|
|
140
332
|
</dl>
|
|
333
|
+
<div class='pgroup'><p>ただし<code>[code{}]</code>の形式ではたとえば</p>
|
|
334
|
+
</div>
|
|
335
|
+
<pre><code>[code{ [ruby(とんぼ){蜻蛉}] }]</code>
|
|
336
|
+
</pre>
|
|
337
|
+
<div class='pgroup'><p>と書くと、蜻蛉の後ろにある<code>}]</code>でcodeコマンドは終了してしまうため、次のような変換結果となります。</p>
|
|
338
|
+
</div>
|
|
339
|
+
<pre class='code-html' data-code-language='html'><code><p><code>[ruby(とんぼ){蜻蛉</code>}]</p></code>
|
|
340
|
+
</pre>
|
|
141
341
|
</section>
|
|
142
|
-
<section><h3 id='
|
|
342
|
+
<section><h3 id='heading_index_17'>行コマンド</h3>
|
|
143
343
|
<div class='pgroup'><p>行コマンドは1行を占有し、次の形式をしています。</p>
|
|
144
344
|
</div>
|
|
145
345
|
<pre><コマンド>:内容</pre>
|
|
146
346
|
<div class='pgroup'><p>定義済みの行コマンドには、次のものがあります。</p>
|
|
147
347
|
</div>
|
|
148
|
-
<
|
|
149
|
-
<
|
|
348
|
+
<div class='pgroup'><p>;: p {</p>
|
|
349
|
+
<p>パラグラフをマークアップします。クラスやIDを付加する目的で使うことを想定しています。</p>
|
|
350
|
+
</div>
|
|
351
|
+
<pre>p.caution: 用量に注意してご利用ください。</pre>
|
|
352
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
353
|
+
<pre class='code-html' data-code-language='html'><code><p class='caution'>用量に注意してご利用ください。</p></code>
|
|
354
|
+
</pre>
|
|
150
355
|
</div>
|
|
151
|
-
<
|
|
152
|
-
<
|
|
153
|
-
<dd><div class='pgroup'><p>divでラップされたimgをマークアップする。</p>
|
|
356
|
+
<dl><dt>image</dt>
|
|
357
|
+
<dd><div class='pgroup'><p>figureでラップされたimgをマークアップします。</p>
|
|
154
358
|
</div>
|
|
155
|
-
<pre>image(
|
|
359
|
+
<pre>image(path-to-image/img.jpg, 代替テキスト): イメージのキャプション</pre>
|
|
360
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
361
|
+
<pre class='code-html' data-code-language='html'><code><figure class='img-wrap'>
|
|
362
|
+
<img src='path-to-image/img.jpg' alt='代替テキスト' />
|
|
363
|
+
<figcaption>イメージのキャプション</figcaption>
|
|
364
|
+
</figure></code>
|
|
365
|
+
</pre>
|
|
366
|
+
</div>
|
|
367
|
+
</dd>
|
|
156
368
|
<dt>newpage</dt>
|
|
157
|
-
<dd><div class='pgroup'><p
|
|
369
|
+
<dd><div class='pgroup'><p>新規ページを作成します。この位置XHTMLファイルが区切られ、新たなXHTMLが生成されます。</p>
|
|
158
370
|
</div>
|
|
159
|
-
<pre>newpage:</pre
|
|
371
|
+
<pre>newpage:</pre>
|
|
372
|
+
</dd>
|
|
160
373
|
</dl>
|
|
161
374
|
</section>
|
|
162
|
-
<section><h3 id='
|
|
163
|
-
<section><h4 id='
|
|
164
|
-
<pre
|
|
165
|
-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
375
|
+
<section><h3 id='heading_index_18'>リスト</h3>
|
|
376
|
+
<section><h4 id='heading_index_19'>箇条書き</h4>
|
|
377
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
378
|
+
<pre>* *ではじまる行は、箇条書きになります
|
|
379
|
+
* 空行があくまで、箇条書きがつづきます。
|
|
380
|
+
|
|
381
|
+
* 空行があくと、あらたな箇条書きになります。
|
|
382
|
+
* さらに、
|
|
383
|
+
** *を続けるとネストされます。</pre>
|
|
384
|
+
</div>
|
|
385
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
386
|
+
<pre class='code-html' data-code-language='html'><code><ul><li>*ではじまる行は、箇条書きになります。</li>
|
|
387
|
+
<li>空行があくまで、箇条書きがつづきます。。</li>
|
|
171
388
|
</ul>
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
389
|
+
<ul><li>空行があくと、あらたな箇条書きになります。</li>
|
|
390
|
+
<li>さらに、
|
|
391
|
+
<ul> <li>*を続けるとネストされます。</li></ul>
|
|
392
|
+
</li>
|
|
393
|
+
</ul></code>
|
|
394
|
+
</pre>
|
|
395
|
+
</div>
|
|
396
|
+
</section>
|
|
397
|
+
<section><h4 id='heading_index_20'>番号つきリスト</h4>
|
|
398
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
399
|
+
<pre>1. 数字.ではじまる行は、番号つきリストになる。
|
|
400
|
+
2. 空行があくまで、リストがつづく。
|
|
401
|
+
|
|
402
|
+
3. 空行があくと、あらたなリストになる。
|
|
403
|
+
10. 先頭の数字にかかわらず、1から順に番号がふられる。</pre>
|
|
404
|
+
</div>
|
|
405
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
406
|
+
<pre class='code-html' data-code-language='html'><code><ol><li>数字.ではじまる行は、番号つきリストになる。 </li>
|
|
180
407
|
<li>空行があくまで、リストがつづく。</li>
|
|
181
408
|
</ol>
|
|
182
409
|
<ol><li>空行があくと、あらたなリストになる。</li>
|
|
183
410
|
<li>先頭の数字にかかわらず、1から順に番号がふられる。</li>
|
|
184
|
-
</ol>
|
|
185
|
-
|
|
411
|
+
</ol></code>
|
|
412
|
+
</pre>
|
|
413
|
+
</div>
|
|
414
|
+
<div class='pgroup'><p>番号つきリストのネストはサポートしていませんが、どうしてもやりたい場合は次のような方法もあります。</p>
|
|
415
|
+
</div>
|
|
416
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
417
|
+
<pre><code>ol {
|
|
418
|
+
li: 第一の要素
|
|
419
|
+
li {
|
|
420
|
+
ここはネストしたい。
|
|
421
|
+
ol {
|
|
422
|
+
li: ネストします。
|
|
423
|
+
}
|
|
424
|
+
li: 第三の要素
|
|
425
|
+
}
|
|
426
|
+
}</code>
|
|
427
|
+
</pre>
|
|
428
|
+
</div>
|
|
186
429
|
</section>
|
|
187
|
-
<section><h4 id='
|
|
188
|
-
<
|
|
430
|
+
<section><h4 id='heading_index_21'>定義リスト</h4>
|
|
431
|
+
<div class='pgroup'><p>定義リストには、二種類の書き方があります。</p>
|
|
432
|
+
</div>
|
|
433
|
+
<section><h5 id='heading_index_22'>1行の定義</h5>
|
|
434
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
435
|
+
<pre>;: それがし : 名前がわからない，または名前を隠して人や物事をさす語。
|
|
436
|
+
;: それがしかれがし : 不定称。二人以上の人に対し，名を知らなかったり，名を省略していうときに用いる語。</pre>
|
|
437
|
+
</div>
|
|
438
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
439
|
+
<pre class='code-html' data-code-language='html'><code><dl>
|
|
440
|
+
<dt>それがし</dt>
|
|
441
|
+
<dd>名前がわからない，または名前を隠して人や物事をさす語。</dd>
|
|
442
|
+
<dt>それがしかれがし</dt>
|
|
443
|
+
<dd>不定称。二人以上の人に対し，名を知らなかったり，名を省略していうときに用いる語。</dd>
|
|
444
|
+
</dl></code>
|
|
445
|
+
</pre>
|
|
446
|
+
</div>
|
|
189
447
|
</section>
|
|
190
|
-
<section><h5 id='
|
|
448
|
+
<section><h5 id='heading_index_23'>複数行の定義</h5>
|
|
449
|
+
<div class='pgroup'><p>説明が長い場合は、複数行の形式で書けます。この場合、説明部分は段落になります。</p>
|
|
450
|
+
</div>
|
|
451
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
452
|
+
<pre>;: それがし {
|
|
453
|
+
名前がわからない，または名前を隠して人や物事をさす語。
|
|
454
|
+
}
|
|
455
|
+
;: それがしかれがし {
|
|
456
|
+
不定称。二人以上の人に対し，名を知らなかったり，名を省略していうときに用いる語。
|
|
457
|
+
}</pre>
|
|
458
|
+
</div>
|
|
459
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
460
|
+
<pre class='code-html' data-code-language='html'><code><dl>
|
|
461
|
+
<dt>それがし</dt>
|
|
462
|
+
<dd><div class="pgroup"><p>名前がわからない，または名前を隠して人や物事をさす語。</p></div></dd>
|
|
463
|
+
<dt>それがしかれがし</dt>
|
|
464
|
+
<dd><div class="pgroup"><p>不定称。二人以上の人に対し，名を知らなかったり，名を省略していうときに用いる語。</p></div></dd>
|
|
465
|
+
</dl></code>
|
|
466
|
+
</pre>
|
|
467
|
+
</div>
|
|
191
468
|
</section>
|
|
192
469
|
</section>
|
|
193
470
|
</section>
|
|
194
|
-
<section><h3 id='
|
|
195
|
-
<section><h4 id='
|
|
471
|
+
<section><h3 id='heading_index_24'>見出し</h3>
|
|
472
|
+
<section><h4 id='heading_index_25'>単独の見出し</h4>
|
|
473
|
+
<div class='pgroup'><p>h1からh6が用意されています。そのまま、<h1> タグに変換されます。</p>
|
|
474
|
+
</div>
|
|
475
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
476
|
+
<pre>h1: 単独の見出し
|
|
477
|
+
ここに本文</pre>
|
|
478
|
+
</div>
|
|
479
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
480
|
+
<pre class='code-html' data-code-language='html'><code><h1>単独の見出し</h1>
|
|
481
|
+
<div class='pgroup'>
|
|
482
|
+
<p>ここに本文</p>
|
|
483
|
+
</div></code>
|
|
484
|
+
</pre>
|
|
485
|
+
</div>
|
|
486
|
+
</section>
|
|
487
|
+
<section><h4 id='heading_index_26'>セクションを生成する見出し</h4>
|
|
488
|
+
<div class='pgroup'><p>Markdown風の # をつかった見出しも使えます。この見出しは、sectionを生成します。</p>
|
|
489
|
+
</div>
|
|
490
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
491
|
+
<pre># 見出し
|
|
492
|
+
本文</pre>
|
|
493
|
+
</div>
|
|
494
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
495
|
+
<pre class='code-html' data-code-language='html'><code><section>
|
|
496
|
+
<h1>見出し</h1>
|
|
497
|
+
<div class='pgroup'>
|
|
498
|
+
<p>本文</p>
|
|
499
|
+
</div>
|
|
500
|
+
</section></code>
|
|
501
|
+
</pre>
|
|
502
|
+
</div>
|
|
503
|
+
<div class='pgroup'><p>入れ子にもできます。sectionの範囲は適切に判断されます。</p>
|
|
504
|
+
</div>
|
|
505
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
506
|
+
<pre># 見出し
|
|
507
|
+
本文
|
|
508
|
+
## 小見出し
|
|
509
|
+
次の本文
|
|
510
|
+
# 新しい章
|
|
511
|
+
新しい章の本文</pre>
|
|
512
|
+
</div>
|
|
513
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
514
|
+
<pre class='code-html' data-code-language='html'><code><section>
|
|
515
|
+
<h1>見出し</h1>
|
|
516
|
+
<div class='pgroup'>
|
|
517
|
+
<p>本文</p>
|
|
518
|
+
</div>
|
|
519
|
+
<section>
|
|
520
|
+
<h2>小見出し</h2>
|
|
521
|
+
<div class='pgroup'>
|
|
522
|
+
<p>次の本文</p>
|
|
523
|
+
</div>
|
|
524
|
+
</section>
|
|
525
|
+
</section>
|
|
526
|
+
<section>
|
|
527
|
+
<h1>新しい章</h1>
|
|
528
|
+
<div class='pgroup'>
|
|
529
|
+
<p>新しい章の本文</p>
|
|
530
|
+
</div>
|
|
531
|
+
</section></code>
|
|
532
|
+
</pre>
|
|
533
|
+
</div>
|
|
534
|
+
<div class='pgroup'><p>明示的に範囲を指定したセクションをつくることもできます。</p>
|
|
535
|
+
</div>
|
|
536
|
+
<div class='pre'><p class='caption'>原稿</p>
|
|
537
|
+
<pre># 第一のセクション
|
|
538
|
+
ここは第一のセクション
|
|
539
|
+
## 第二のセクション {
|
|
540
|
+
ここは第二のセクション
|
|
541
|
+
}
|
|
542
|
+
ここは再び第一のセクション</pre>
|
|
543
|
+
</div>
|
|
544
|
+
<div class='pre'><p class='caption'>変換結果</p>
|
|
545
|
+
<pre class='code-html' data-code-language='html'><code><section>
|
|
546
|
+
<h1>第一のセクション</h1>
|
|
547
|
+
<div class='pgroup'>
|
|
548
|
+
<p>ここは第一のセクション</p>
|
|
549
|
+
</div>
|
|
550
|
+
<section>第二のセクション</h1>
|
|
551
|
+
<div class='pgroup'>
|
|
552
|
+
<p>ここは第二のセクション</p>
|
|
553
|
+
</div>
|
|
554
|
+
</section>
|
|
555
|
+
<div class='pgroup'>
|
|
556
|
+
<p>ここは再び第一のセクション</p>
|
|
557
|
+
</div>
|
|
558
|
+
</section></code>
|
|
559
|
+
</pre>
|
|
560
|
+
</div>
|
|
196
561
|
</section>
|
|
197
|
-
<section><h4 id='heading_index_20'>セクションを生成する見出し</h4>
|
|
198
562
|
</section>
|
|
563
|
+
<section><h3 id='heading_index_27'>Frontmatter</h3>
|
|
564
|
+
<div class='pgroup'><p>各ページごとにYAML frontmatterでメタデータを記載できます。</p>
|
|
565
|
+
</div>
|
|
566
|
+
<div class='pre'><p class='caption'>Frontmatterの例</p>
|
|
567
|
+
<pre><code>---
|
|
568
|
+
title: ページのタイトル
|
|
569
|
+
stylesheets: [reset.css, default.css]
|
|
570
|
+
lang: ja
|
|
571
|
+
paragraph_style: default
|
|
572
|
+
---</code>
|
|
573
|
+
</pre>
|
|
574
|
+
</div>
|
|
575
|
+
<div class='pgroup'><p><code>title</code>, <code>stylesheets</code>, <code>lang</code>はそれぞれXHTMLのheaderにかかれます。<code>paragraph_style</code>は、HTML生成時の段落スタイル指示ができます。</p>
|
|
576
|
+
</div>
|
|
199
577
|
</section>
|
|
200
|
-
<section><h3 id='heading_index_21'>Frontmatter</h3>
|
|
201
578
|
</section>
|
|
579
|
+
<section><h2 id='heading_index_28'>カスタマイズ</h2>
|
|
580
|
+
<section><h3 id='heading_index_29'>生成ルール追加</h3>
|
|
202
581
|
</section>
|
|
203
|
-
<section><
|
|
204
|
-
<section><h3 id='heading_index_23'>生成ルール追加</h3>
|
|
582
|
+
<section><h3 id='heading_index_30'>木構造の操作</h3>
|
|
205
583
|
</section>
|
|
206
|
-
<section><h3 id='
|
|
584
|
+
<section><h3 id='heading_index_31'>コマンドの書式</h3>
|
|
585
|
+
<div class='pgroup'><p><span class='note'>(加筆修正予定)</span></p>
|
|
586
|
+
</div>
|
|
587
|
+
<div class='pre'><p class='caption'>コマンド</p>
|
|
588
|
+
<pre>コマンド名[id][class][パラメータ][名前付きパラメータ]</pre>
|
|
589
|
+
</div>
|
|
590
|
+
<div class='pgroup'><p>具体的には、たとえば次のような形をしています。</p>
|
|
591
|
+
</div>
|
|
592
|
+
<div class='pre'><p class='caption'>具体例</p>
|
|
593
|
+
<pre>div#id1#id2.class1.class2(parameter1, parameter2)[named_parameter: 1, named_parameter 2]</pre>
|
|
594
|
+
</div>
|
|
595
|
+
<ul><li>コマンド名は英字ではじまり、英数字とハイフン、アンダースコアからなります。</li>
|
|
596
|
+
<li>idは、#からはじまり、英数字とハイフン、アンダースコアからなります。複数続けることができます。</li>
|
|
597
|
+
<li>classは、.からはじまり、英数字とハイフン、アンダースコアからなります。複数続けることができます。</li>
|
|
598
|
+
</ul>
|
|
599
|
+
<ul><li>パラメータは<code>()</code>で囲まれています。カンマで区切られた領域ごとに、独立したパラメータになります。</li>
|
|
600
|
+
<li>パラメータの内容は、NoraMarkのマークアップとしてパースされます。</li>
|
|
601
|
+
</ul>
|
|
602
|
+
<ul><li>名前付きパラメータは<code>[]</code>で囲まれていて、カンマで区切られた次の形式をしています。<ul><li>名前: パラメータ</li>
|
|
603
|
+
</ul>
|
|
604
|
+
</li>
|
|
605
|
+
<li>名前は英字ではじまり、英数字とハイフン、アンダースコアからなります。名前付きパラメータの内容は、NoraMarkのマークアップとしてはパースされません。</li>
|
|
606
|
+
</ul>
|
|
207
607
|
</section>
|
|
208
608
|
</section>
|
|
209
|
-
<section><h2 id='
|
|
609
|
+
<section><h2 id='heading_index_32'>XML生成</h2>
|
|
210
610
|
</section>
|
|
211
611
|
</section>
|
|
212
612
|
</body>
|