2020年7月3日金曜日

ドキュメント

event_note7月 03, 2020 editBy sbin forumNo comments

ドキュメント

ドキュメントのソースは基本的にテキストが良い。
長い間 ネタの種 を使ってテキストを書いていて、最大の問題は検索が弱かった。
普段はテキストで、マニュアル的資料はTeXが基本になっていた。TeX と言っても正確には EWB で作り出す LaTeX の世界。
もう Markdown で良いのではと思う

Markdown との相性

Markdown 記法は思っていたより相性が良い。基本的にテキストで書くのと変わらない。ちょうど参考資料を残す機会があったので Markdown で書いてみた。
参考資料なので最終的な出力まで試してみた。
結果はとても素晴らしい汎用性があった。

VScode で Markdown

vscode 上で Markdown を扱うには、 Makrkdown all in one の拡張機能を入れて置けば効率よく書ける。書くと同時に Preview できる。
Markdown 関連のパッケージは
  • Markdown All in ONE
  • Markdown PDF
  • Markdown TOC
  • VScode pandoc
  • Image Paste
が必要で、その他 Windows 版の
  • Pandoc
  • Tex Live 2019 ~
  • Ralpha Image Resizer
などがあると良い。
Markdown TOC があるとセクション番号や目次を自動で作成できる。TOC の作成には VScode のファイルEOLを auto から \n に変更する必要があった。
普段使いであれば、 Markdown TOC をやったあと Markdown PDF で作業が完了する。
編集中は、Image Paste によって画の貼り付けを行う。集めたホルダーから、タイムスタンプ名で文書フォルダーにコピーしてきて Markdown ファイルに貼り付けてくれる。右クリックで PDF 作成もできますが、WORDにも変換できる。
WORDの場合は右クリックから VScode pandocの DOCX を選び変換する。貼り付けた画像は、変換時に自動的にリサイズしてくれる。


Pandoc To TeX

最初はノウハウが不足していて残念な状態だった。
色々変換してみるとEWBが懐かしい。少し真剣に取り組んでみた。
PowerShell から叩いても良いですが、VScode-Pandoc から変換できるようにしてみた。Pandoc から PDF を作る場合は TeX が必須なので TeX Live 2020 を入れた。
Pandoc: Pdf Opt String
-N -f markdown+ignore_line_breaks+footnotes+definition_lists
-V CJKmainfont=HiraMaruProN-W4 -V titlepage=true -V toc-own-page=true
-F pandoc-crossref --table-of-contents --toc-depth=4 --pdf-engine=lualatex
–template eisvogel --highlight-style tango
Pandoc: HTML Opt String
-N -f markdown+ignore_line_breaks+footnotes+definition_lists
-V CJKmainfont=HiraMaruProN-W4 -V titlepage=true -V toc-own-page=true
-F pandoc-crossref --table-of-contents --toc-depth=4 --pdf-engine=lualatex
–template myhtml --highlight-style tango
これでPDFとHTMLに変換できるようになった。折角なのでワードの Docx の場合も
Pandoc: Docx Opt String
–standalone --reference-doc=reference.docx
残念ながら Libreoffice の変換は組み込まれてないので PowerShell から叩く。
pandoc vstest.md -t odt -o sample.odt --standalone --reference-doc=reference.odt

pandoc vstest.md -t docx -o sample.docx --standalone --reference-doc=reference.docx
docx も odt も体裁を設定したファイルを用意して参照変換している。フォントも含めて思った通りに
出力された。

コピペ

以上を SackEdit に貼り付けてみた。

0 comments:

コメントを投稿