vfm-mdbp-vscode READMEMDBP(MarkDown-Book-Preview)は書籍の原稿作成に適したMarkdownプレビューの機能拡張です。 Vivliostyle Viewerと組み合わせて書籍の体裁で表示し、原稿データをInDesign向けのXMLファイルとして書き出す機能を持ちます。 MarkdownパーサーをVFM(Vivliostyle Flavored Markdown)に変更したバージョンです。 https://vivliostyle.github.io/vfm/#/ja/vfm https://github.com/vivliostyle/vfm Features
事前準備
Frontmatterの例
How to Use
Start Server / Stop Serverプレビュー用のLive Serverを起動/終了します。 Open HTML previewCSSを適用したHTMLをVivliostyleを使わずに表示します。ページ区切りを気にせずに原稿を書きたいときに使います。 Open Vivliostyle PreviewVivliostyleを使って書籍風に表示します。 PDFの印刷PDFを出力したい場合は、Webブラウザ側の印刷機能を利用します。Chromeを利用する場合は、「送信先」を「PDFに保存」、「余白」を「なし」、「背景のグラフィック」をオンにしてください。 Generate Merged PDF(テスト機能)Vivliostyle CLIを使ってHTMLを連結して書き出します(事前にVivliostyle CLIのインストールが必要な機能です)。 vivliostyle.config.jsというファイルを作業フォルダ内のルートに作って、読み込みhtmlファイルを指定する必要があります。 vivliostyle.config.jsの例
Vivliostyle CLIの仕様ではentryセクションにMarkdownファイルも指定できますが、VFMでのHTML変換しか行われないため、MDBPが処理している部分が反映されません。MDBPが生成したHTMLファイルを指定するのを推奨します。 Export InDesign XML(未テスト)InDesignの[構造]パネルで読み込み可能なXMLファイルを書き出します。XMLタグを任意のスタイルとマッピング可能です。また、画像のリンクを活かした自動配置、InDesign上のスクリプトと組み合わせた表の自動作成が可能です。 置換リスト置換リストは 以下の置換リストは「@div クラス名」と「@divend」で囲んだ範囲を、div要素に置換します。また、ハイフンで生成する水平線は改ページ指定として処理します。
画像のトリミングIT書でスクリーンショットは欠かせません。いちいちグラフィックスソフトでトリミングしたり、拡大縮小率を厳密に指定するのは手間なので、画像ファイル名のあとに簡単な指示を入れることで、指定できるようにしました。
倍率以外のパラメータは省略可能です。幅と高さは省略時なりゆき、シフト量は0となります。 その他ゲタ文字〓を使用して連番を自動生成できます。 postManipulate(後操作)機能Markdownの記述を簡単にするために、デザイン都合でHTML構造を自動変更する機能を追加しました。h2見出しと直後のp要素を、装飾用の<div:secheader>~</div>で囲むといった操作を行えます。jQueryに似た機能を持つcheerioというライブラリを利用しています。 操作内容は_postManipurate.jsonというファイルに「セレクタ」「メソッド」「パラメータ」を指定する形にしているので、プロジェクトごとに設定変更が可能です。
Vivliostyle CLIのサポート(v0.1.5より追加)コマンドパネルより、mdbp-vscode: Open Viviostyle Preview CLIを選択すると、Vivliostyle CLIによるプレビューを利用できます。 Node.jsとVivliostyle CLIのインストールが別途必要ですが、原稿フォルダにViewerを用意したり(ViewerのバージョンはVivliostyle CLIのバージョンに依存)、サーバーを起動したりする必要がなくなります。 https://docs.vivliostyle.org/ja/vivliostyle-cli vivliostyle.config.jsを用いた複数ファイル書き出しも可能になりました。 Requirements
Known Issues
Release NotesUsers appreciate release notes as you update your extension. 0.1.10空のp要素をムリヤリ削除する処理を追加。 0.1.9CLIからPDFを出力する際に、原稿のファイル名をPDFファイル名に使用する 0.1.8実験的なソースコードの連番機能。 コードの前に次の形式で書くと、直後のpre > code内を改行コードで分割し、
VFMがv2になってsection要素の扱いが変わったときに、修正の必要がある。 0.1.7コマンドパレットでオリジナルのMDBPと混同しないようコマンドのカテゴリ名を変更 0.1.6Vivliostyle CLIを利用したPDF書き出しを追加 0.1.5プレビュー更新をmdbp-vscode 0.1.5に合わせて修正 0.1.0最初のリリース (c)libroworks.co.jp http://libroworks.co.jp/ |