ドキュメントのメタデータ周り about md2inao HOT 6 CLOSED

Markdown におけるメタデータの扱いですが、調べてみたところ、一応 MultiMarkdown という拡張にそういう仕様があるみたいです。

• http://hiltmon.com/blog/2012/06/18/markdown-metadata/

この辺。

Title:       |  
Subtitle:    |  
Project:     |  
Author:      Hilton Lipschitz  
Affiliation: Noverse LLC  
Web:         http://www.noverse.com  
Date:        June 18, 2012  

Your first paragraph starts here

と先頭から書いたところがメタデータ扱いになる。本文は一行空行が空いたところから。Marked というプレビューワー (僕も使ってます) なんかはちゃんとこれをメタデータ扱いして出力に含めないようにとかしてくれました。

なのでこの書式を使うのがいいかなと思います。

で、これ実際に inao フォーマットに書かれてる

章番号：3章（書籍や特集の場合）
連載回数：第5回（連載の場合）
タイトル：章のタイトルや連載の各回タイトル
キャッチ：章のキャッチや記事の各回キャッチ

これに良く似てるのですが、Marked で試したところメタデータのキーにマルチバイト文字を使うのはだめっぽいです。なので、キーは英語にしたものがいいと思います。

Chapter: 3
Serial: 5
Title: 章のタイトルや連載の各回タイトル
Subtitle: 章のキャッチや記事の各回キャッチ

ここから本文

こんな感じで書くと

# inao
章番号：3章
連載回数：第5回
タイトル：章のタイトルや連載の各回タイトル
キャッチ：章のキャッチや記事の各回キャッチ
ここから本文

や

# InDesign
<ParaStyle:章番号・連載回数>章番号：3章
<ParaStyle:章番号・連載回数>連載回数：第5回
<ParaStyle:タイトル>タイトル：章のタイトルや連載の各回タイトル
<ParaStyle:キャッチ>キャッチ：章のキャッチや記事の各回キャッチ
<ParaStyle:本文>ここから本文

に変換される、とかでどうでしょうか?

• キーの英語表記はこれで良いか
• sample ファイルにないメタデータで対応すべきものがあるか
• InDesign のところで「タイトル：章のタイトルや連載の各回タイトル」となってて「タイトル：」が冗長な感じがするけどこのままでいくか

といったところも確認お願いします。

from md2inao.

Author とか Email とか Github とか Twitter とかそういうのがありそう?

from md2inao.

おおーーー、すごい。
ありがとうございます！！

• キーの英語表記はこれで良いか

はい！

• sample ファイルにないメタデータで対応すべきものがあるか

InDesignのスタイル名として標準で用意しているものは他にはございません。

ただ、挙げていただようなものもここに書けたほうが、ご執筆者の方はうれしそうですね。

以下のようにしていただくというのはいかがでしょうか？
著者と監修以外は、任意の1バイト文字列がそのままinaoでもInDesignでも使われるイメージです。

# Markdown
Author :
Supervisor :
URL :
mail :
GitHub :
Twitter :

# inao
著者：
監修：
URL：
mail：
GitHub：
Twitter：

# InDesign
<ParaStyle:本文>著者：
<ParaStyle:本文>監修：
<ParaStyle:本文>URL：
<ParaStyle:本文>mail：
<ParaStyle:本文>GitHub：
<ParaStyle:本文>Twitter：

• InDesign のところで「タイトル：章のタイトルや連載の各回タイトル」となってて「タイトル：」が冗長な感じがするけどこのままでいくか

今のところ、現状のままのほうがありがたいです。

これらメタデータ周りは本文系とは別のテキストボックスに配置するものです。
現状の作業フローでは、InDesignを使うデザイナさんが、テキストを取り込んだあとにこれらを所定の位置にコピペで移動させる感じの作業が必要なので、具体的に表示されているほうが混乱しなさそうです。

from md2inao.

メタデータに対応しました。

Title: Markdown to Inao
Subtitle: Convert markdown text to Inao format
Chapter: 3
Serial: 5
Author: 伊藤 直也
Supervisor: 稲尾
URL: http://naoya.github.com/
mail: [email protected]
Github: naoya
Twitter: @naoya_ito

Hello, World

こんな感じの Markdown を入力するとテストできます。なお、本文との間に空白がない場合は上部をメタデータとはみなさないので注意してください。

from md2inao.

うおーーーーー、ありがとうございます！
動作も確認させていただきました。

from md2inao.

以下、関連Issue（備忘録）

#39

from md2inao.