zine_brewer 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2142217e4515907dcab2b950fc41cb21ba8a886ec04daa5d4ac4cdc6acc6bfbb
-  data.tar.gz: 1333a38a15cc0b2189ff63b891c8a28a40282705a212283f4e5fa6990d6ac5e6
+  metadata.gz: 9e62a6723f599bd021bf2ef6bd77c0f0dd1b94d5734bde6ce9690f5e68a73ea7
+  data.tar.gz: c0b6398e7913c871406407209d1741aecba85be6ef844717d209433382c47a3a
 SHA512:
-  metadata.gz: b4d750d74c7b68d461c9ca1c42fa74d35abe4c51ff9101cd78d1a2efd8a79a188a25542253ddbef1f2fb2e2c46bcad736d81ce36a0f22347f16e24fb44427fa2
-  data.tar.gz: 7882f6378598a4714d51f26d7cd3ec0710b79ecf06eb63c7b7793df275693fafc25956ec5e7014e9cfaa8924a329e3a53755fc132abcc76996a7f9a05b9c19f3
+  metadata.gz: fb79dfc51977ac2f2187f775da2b86aa219edf0f3f91147f10854600704b3ec0cab0d704ca13b788850994c9d0a4e259ae4ca0aa33ef090a9e675fc8e21b22e7
+  data.tar.gz: 2f97dec08ffed8d6fe34b558c4a939799ebf120a5a581cbbc47867107355e10c64f23b345c209257d451fdbbac79c2c28214839d0be4f04c48748fbe94f395cf

data/README.md

@@ -83,7 +83,7 @@ ZineBrewerで扱う原稿は「ヘッダー」と「本文」に分かれます
 
 ヘッダーと本文の境界には、本文ページの起こしを指示する`<%-- page -->`を記述します。
 
-**【注意】ヘッダーの最後に記述する`■記事ID■：0000`は、原則として記述必須です。**例外として、原稿を入れているフォルダの名前を記事ID（「1234」など）にしている場合には省略できます。
+**なお、ヘッダーの最後に記述する`■記事ID■：0000`は、原則として記述必須です。** 例外として、原稿を入れているフォルダの名前を記事ID（「1234」など）にしている場合には省略できます。
 
 上記例をZineBrewerで変換した場合、ヘッダーは次のように出力されます（proof/header.txt）。
 
@@ -108,6 +108,29 @@ ZineBrewerで扱う原稿は「ヘッダー」と「本文」に分かれます
 
 ### 本文
 
+#### ■ページの起こし
+
+**本文の各ページの先頭には、ページの起こしとして必ず`<%-- page -->`を記述してください。** 1ページ目の起こしは、ヘッダーとの境界にもなります。
+
+```
+（ヘッダー）
+……
+
+■記事ID■：1234
+
+<%-- page -->
+
+本文1ページ目
+
+<%-- page -->
+
+本文2ページ目
+
+<%-- page -->
+
+本文3ページ目
+```
+
 #### ■図の書き方
 
 図は「拡大なし」「拡大あり」「拡大あり（lightbox）」「ハイパーリンク」「プロフィール」の5種類を記述できます。いずれも`<<Fig-●>>`（●にはアルファベット**大文字**1字が入る）から書き出します。
@@ -243,6 +266,7 @@ src: fig.png    <--- 1234_fig.png と書いたのと同じになる
 
 ```
 （本文）
+……
 
 {%background-color:#e6e6e6; %padding:1em;}
 ===div
@@ -257,13 +281,142 @@ width: 450px
 
 #### ■画像回り込みの書き方
 
-divブロックの応用として、本文テキストの画像回り込み指定があります。スタイル指定と合わせて、次に用に記述します。
+本文テキストの画像回り込み指定は、画像と回り込ませる本文テキストとを、`===wraparound`と`==/wraparound`で挟んでやることで行えます。
+
+ただし、画像を右に置くか左に置くかの指定も必要です。画像の記述`<<Fig_●>>`の上に、画像を右に置く場合には`{:.imgR}`、左に置く場合には`{:.imgL}`と記述します。
+
+次の例では、画像を右に置き、その周りに本文テキストを回り込ませます。
+
+```
+（本文）
+……
+
+===wraparound
+
+{:.imgR}
+<<Fig_A>>
+src: 1234_fig.png
+width: 200px
+
+　回り込ませる本文テキスト〜
+==/wraparound
+```
+
+また、画像の周りに本文テキストを回り込ませないようにする場合には、本文テキストの各段落の上に`{:.ovh}`という記述を加えます。
+
+```
+（本文）
+……
+
+===wraparound
+
+{:.imgR}
+<<Fig_A>>
+src: 1234_fig.png
+width: 200px
+
+{:.ovh}
+　回り込ませない本文テキスト（段落1）〜
+
+{:.ovh}
+　回り込ませない本文テキスト（段落2）〜
+==/wraparound
+```
+
+#### ■脚注の書き方
+
+次のように、本文テキスト中の脚注を付けたい言葉などに`[^1]`などとアンカーを付け、脚注を置きたい場所に`[^1]: 〜`という形で脚注本体を書きます。脚注本体のコロンを忘れなく。脚注番号で使えるのは半角数字のみです。
 
 ```
+　ほら、ここに難しい専門用語[^1]が1つ。ここにも意味の分からない専門用語[^2]がもう1つ。
+
+　それからいろんな話がありつつ、この下に脚注を置きたいのなら、次のように記述します。
+
+[^1]: 難しい専門用語の意味。もちろん[リンク](https://www.example.com)も置けますよ。
+
+[^2]: 意味の分からない専門用語の意味。
+```
+
+なお、ZineBrewerでは、コラムに`footnotes`クラスを適用したスタイルで脚注本体を表示するようになっています。通常のコラムの形ではスカスカした見た目になってしまうので、追加CSSでスタイルを当てることをお勧めします。
+
+#### ■定義表の書き方
+
+定義リストの記述を`===dtable`〜`==/dtable`で挟むと、左に項目、右に内容のテーブル（表）ができます。
+
+例えば、次のように記述すると、
+
+```
+{:caption="イベント概要"}
+===dtable
+イベント名
+:  HRzine Day 2020 Autumn
+
+テーマ
+:  ニューノーマルが来た！〜人事・労務がいま整えるべきこと〜
+
+日時
+:  2020年10月21日(水) 13:00～18:35
+
+会場
+:  オンライン
+==/dtable
 ```
 
+次のように表示されます。
+
+![dtable](https://user-images.githubusercontent.com/24837059/94995269-32e6e680-05d8-11eb-86ed-074e650ff2eb.png)
+
 #### ■スタイルの書き方
 
+最後に、スタイルの記述方法を説明します。
+
+Kramdown（拡張Markdown）では、文字や段落にHTMLの属性を付けることができます。例えば、次のように記述すると、太字部分が赤色になり下線も引かれます。
+
+```
+ここは次の試験で**必ず出題する**{:style="color:red; text-decoration:underline;"}ところだから、しっかり勉強してきなさい。
+```
+
+これは、`**必ず出題する**{:style="color:red; text-decoration:underline;"}`という部分は、`<strong style="color:red; text-decoration:underline;">必ず出題する</strong>`と変換されるためです。
+
+ZineBrewerでは、styleのところをもう少し簡潔に書けるようにしてあります。style属性中の指定**一つひとつ**を、パーセント記号とセミコロンで括ります。
+
+```
+ここは次の試験で**必ず出題する**{:%color:red; %text-decoration:underline;}ところだから、しっかり勉強してきなさい。
+```
+
+また、太字にしないで、ただ赤字・下線引きにしたい場合には、次のように記述します。
+
+```
+ここは次の試験で[[必ず出題する]]{:%color:red; %text-decoration:underline;}ところだから、しっかり勉強してきなさい。
+```
+
+段落に対してスタイルを当てる場合には、段落の直前あるいは直後にスタイルを記述します。例えば、次のように記述すると、段落の背景に薄い赤色に敷くことができます（余白も少しとっています）。
+
+```
+{:%background-color:#ffe6e6; %padding:15px;}
+ここは次の試験で必ず出題するところだから、しっかり勉強してきなさい。
+```
+
+行頭の丸数字などを頭出し（ぶら下げ）したいことがあると思いますが、それは次のように記述します。
+
+```
+{:%padding-left:1em; %text-indent:-1em;}
+①このように書いてやると、「①」の部分だけ左につきだし、以降の文章が引っ込んだ形で表示できます。
+```
+
+![Hanging Indent](https://user-images.githubusercontent.com/24837059/94996073-59f3e700-05dd-11eb-87f7-8a16be840f6f.png)
+
+#### id属性、class属性、その他の属性
+
+Kramdown（拡張Markdown）の`{: }`の中には、次のようにしてid属性とclass属性を記述できます。
+
+```
+{:#id_1234 .footnotes}
+id属性は#、class属性は.を使って記述できます。
+```
+
+その他の属性はstyle以外、略記方法はありませんが、HTMLと同様に`{:rel="lightbox}"`とイコールを使った書き方にすれば、何でも指定できます。
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/zine_brewer/version.rb

@@ -1,3 +1,3 @@
 module ZineBrewer
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: zine_brewer
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Akinori Ichigo