これは、Ubuntu Online、Fedora Online、Windowsオンラインエミュレーター、MACOSオンラインエミュレーターなどの複数の無料オンラインワークステーションのXNUMXつを使用してOnWorks無料ホスティングプロバイダーで実行できるコマンドpandocです。
プログラム:
NAME
pandoc-一般的なマークアップコンバータ
SYNOPSIS
パンドック[オプション] [入力ファイル] ...
DESCRIPTION
Pandocは、あるマークアップ形式から別の形式に変換するためのHaskellライブラリです。
このライブラリを使用するコマンドラインツール。 Markdown、CommonMark、PHPMarkdownを読み取ることができます
Extra、GitHub-Flavored Markdown、および(サブセット)Textile、reStructuredText、HTML、LaTeX、
MediaWikiマークアップ、TWikiマークアップ、Haddockマークアップ、OPML、Emacs Orgモード、DocBook、txt2tags、
EPUB、ODT、Word docx; プレーンテキスト、Markdown、CommonMark、PHPMarkdownを書くことができます
Extra、GitHub-Flavored Markdown、reStructuredText、XHTML、HTML5、LaTeX(ビーマーを含む)
スライドショー)、ConTeXt、RTF、OPML、DocBook、OpenDocument、ODT、Word docx、GNU Texinfo、
MediaWikiマークアップ、DokuWikiマークアップ、Haddockマークアップ、EPUB(v2またはv3)、FictionBook2、テキスタイル、
groffのマニュアルページ、Emacs Orgモード、AsciiDoc、InDesign ICML、およびSlidy、Slideous、DZSlides、
reveal.jsまたはS5HTMLスライドショー。 また、LaTeXが搭載されているシステムでPDF出力を生成することもできます。
ConTeXt、またはwkhtmltopdfがインストールされます。
Pandocの拡張バージョンのMarkdownには、脚注、表、フレキシブルの構文が含まれています
順序付きリスト、定義リスト、フェンスで囲まれたコードブロック、上付き文字と下付き文字、
取り消し線、メタデータブロック、自動目次、埋め込みLaTeX数学、引用、
HTMLブロック要素内のマークダウン。 (これらの機能強化については、以下で説明します
PandocのMarkdownは、markdown_strict入力または出力形式を使用して無効にできます。)
正規表現を使用するMarkdownをHTMLに変換するためのほとんどの既存のツールとは対照的に
置換、pandocはモジュラー設計です:それは解析するリーダーのセットで構成されています
特定の形式のテキストで、ドキュメントのネイティブ表現と一連の
このネイティブ表現をターゲット形式に変換するライター。 したがって、
入力または出力形式では、リーダーまたはライターを追加するだけで済みます。
pandocによるドキュメントの中間表現は、多くのドキュメントよりも表現力が低いためです。
それが変換するフォーマット、すべての間の完全な変換を期待するべきではありません
フォーマットと他のすべて。 Pandocは、
ドキュメントですが、マージンサイズなどのフォーマットの詳細はありません。 そして、いくつかのドキュメント要素、
複雑なテーブルなどは、pandocの単純なドキュメントモデルに適合しない場合があります。 その間
pandocのMarkdownからすべての形式への変換は、完璧を目指しています。
pandocのMarkdownよりも表現力のあるフォーマットは不可逆であると予想されます。
使い方 パンドック
ない場合 入力ファイル が指定されている場合、入力はから読み取られます stdin。 それ以外の場合は、 入力ファイル
連結され(それぞれの間に空白行があります)、入力として使用されます。 出力はに行きます (Linuxで言うところのstdout) by
デフォルト(ただし、 (Linuxで言うところのstdout) odt、docx、epub、およびepub3の出力では無効になっています
フォーマット)。 ファイルに出力するには、-oオプションを使用します。
pandoc -o 出力.html 入力.txt
デフォルトでは、pandocは、適切なスタンドアロンドキュメントではなく、ドキュメントフラグメントを生成します
ヘッダーとフッター。 スタンドアロンドキュメントを作成するには、-sまたは--standaloneフラグを使用します。
pandoc -s -o 出力.html 入力.txt
スタンドアロンドキュメントの作成方法の詳細については、以下のテンプレートを参照してください。
ファイルの代わりに、絶対URIを指定できます。 この場合、pandocは
HTTPを使用したコンテンツ:
pandoc -f html-tマークダウン http://www.fsf.org
複数の入力ファイルが指定されている場合、pandocはそれらすべてを(空白行で)連結します
それらの間)解析する前に。 この機能は、次のようなバイナリ入力形式では無効になっています
EPUB、odt、およびdocx。
入力と出力の形式は、コマンドラインオプションを使用して明示的に指定できます。
入力形式は、-r / -readまたは-f / -fromオプションを使用して指定でき、出力
-w / -writeまたは-t / -toオプションを使用してフォーマットします。 したがって、マークダウンからhello.txtを変換するには
LaTeXには、次のように入力できます。
pandoc -f markdown-tラテックスhello.txt
hello.htmlをHTMLからMarkdownに変換するには:
pandoc -f html-tマークダウンhello.html
サポートされている出力形式は、以下の-t / -toオプションの下にリストされています。 サポートされている入力
フォーマットは、以下の-f / -fromオプションの下にリストされています。 最初の、テキスタイル、ラテックス、
およびhtmlリーダーは完全ではありません。 解析されない構造がいくつかあります。
入力または出力形式が明示的に指定されていない場合、pandocはそれを推測しようとします
入力ファイル名と出力ファイル名の拡張子から。 したがって、たとえば、
pandoc -o hello.tex hello.txt
hello.txtをMarkdownからLaTeXに変換します。 出力ファイルが指定されていない場合(
出力はに行きます (Linuxで言うところのstdout))、または出力ファイルの拡張子が不明な場合は、出力形式
デフォルトはHTMLになります。 入力ファイルが指定されていない場合(入力が stdin)、または
入力ファイルの拡張子が不明な場合、入力形式は次のようになります。
明示的に指定されていない限り、マークダウン。
Pandocは、入力と出力の両方にUTF-8文字エンコードを使用します。 あなたの地元の場合
文字エンコードはUTF-8ではないため、iconvを介して入力と出力をパイプする必要があります。
iconv -t utf-8 入力.txt | パンドック | iconv -f utf-8
一部の出力形式(HTML、LaTeX、ConTeXt、RTF、OPML、DocBook、
Texinfo)、文字エンコードに関する情報はドキュメントヘッダーに含まれています、
これは、-s / -standaloneオプションを使用した場合にのみ含まれます。
作成 a PDF
PDFを作成するには、拡張子が.pdfの出力ファイルを指定します。 デフォルトでは、pandocは
LaTeXを使用してPDFに変換します。
pandoc テスト.txt -o テスト.pdf
PDFを作成するには、LaTeXエンジンをインストールする必要があります(以下の--latex-engineを参照)。
そして、次のLaTeXパッケージが利用可能であることを前提としています:amsfonts、amsmath、lm、
ifxetex、ifluatex、eurosym、listings(-listingsオプションが使用されている場合)、fancyvrb、
longtable、booktabs、graphicxおよびgrffile(ドキュメントに画像が含まれている場合)、hyperref、
ulem、geometry(geometry変数が設定されている)、setspace(linestretchを使用)、およびbabel
(lang付き)。 LaTeXエンジンとしてxelatexまたはlualatexを使用するには、fontspecが必要です。
xelatexは、mathspec、polyglossia(langを使用)、xecjk、およびbidi(dir変数を使用)を使用します
セットする)。 可能な場合はアップクォートとマイクロタイプのパッケージが使用され、csquotesが使用されます
テンプレートに追加された場合、またはヘッダーファイルに含まれている場合のスマート句読点。 The
natbib、biblatex、bibtex、およびbiberパッケージは、オプションで引用に使用できます
レンダリング。 これらは、TeXLiveの最近のすべてのバージョンに含まれています。
または、pandocでConTeXtまたはwkhtmltopdfを使用してPDFを作成することもできます。 これを行うには、
以前と同様に、拡張子が.pdfの出力ファイルですが、-tcontextまたは-thtml5をに追加します。
コマンドライン。
PDF出力は、LaTeXの変数(LaTeXが使用されている場合)と変数を使用して制御できます
ConTeXtの場合(ConTeXtが使用されている場合)。 wkhtmltopdfが使用されている場合、変数margin-left、
margin-right、margin-top、margin-bottom、およびpapersizeは、出力に影響します。
--css。
OPTIONS
オプション
-f FORMAT, -r FORMAT, --from =FORMAT, --read=FORMAT
入力形式を指定します。 FORMAT ネイティブ(ネイティブHaskell)、json(JSONバージョンの
ネイティブAST)、markdown(pandocの拡張Markdown)、markdown_strict(元の
unextended Markdown)、markdown_phpextra(PHP Markdown Extra)、markdown_github
(GitHub-Flavored Markdown)、commonmark(CommonMark Markdown)、textile(Textile)、
rst(reStructuredText)、html(HTML)、docbook(DocBook)、t2t(txt2tags)、docx
(docx)、odt(ODT)、epub(EPUB)、opml(OPML)、org(Emacs Orgモード)、mediawiki
(MediaWikiマークアップ)、twiki(TWikiマークアップ)、haddock(Haddockマークアップ)、またはlatex
(ラテックス)。 + lhsがmarkdown、rst、latex、またはhtmlに追加された場合、入力は次のようになります。
読み書きのできるHaskellソースとして扱われます:以下のLiterateHaskellのサポートを参照してください。 マークダウン
構文拡張は、+ EXTENSIONを追加することで個別に有効または無効にできます
または-EXTENSIONをフォーマット名に追加します。 したがって、たとえば、
markdown_strict + footnotes + definition_listsは脚注と
定義リストが有効になっていて、markdown-pipe_tables + hard_line_breaksはpandocのものです
パイプテーブルなしで、ハード改行を使用したマークダウン。 PandocのMarkdownを参照してください。
以下に、拡張子とその名前のリストを示します。
-t FORMAT, -w FORMAT, --to =FORMAT, --write =FORMAT
出力形式を指定します。 FORMAT ネイティブ(ネイティブHaskell)、json(JSONバージョン)にすることができます
ネイティブASTの)、プレーン(プレーンテキスト)、マークダウン(pandocの拡張マークダウン)、
markdown_strict(元の拡張されていないMarkdown)、markdown_phpextra(PHP Markdown
Extra)、markdown_github(GitHub-Flavored Markdown)、commonmark(CommonMark
Markdown)、rst(reStructuredText)、html(XHTML)、html5(HTML5)、latex(LaTeX)、
ビーマー(LaTeXビーマースライドショー)、コンテキスト(ConTeXt)、男(groff man)、mediawiki
(MediaWikiマークアップ)、dokuwiki(DokuWikiマークアップ)、テキスタイル(テキスタイル)、org(Emacs Org
モード)、texinfo(GNU Texinfo)、opml(OPML)、docbook(DocBook)、opendocument
(OpenDocument)、odt(OpenOfficeテキストドキュメント)、docx(Word docx)、haddock(Haddock
マークアップ)、rtf(リッチテキスト形式)、epub(EPUB v2ブック)、epub3(EPUB v3)、fb2
(FictionBook2 e-book)、asciidoc(AsciiDoc)、icml(InDesign ICML)、slidy(Slidy HTML
およびjavascriptスライドショー)、slideous(Slideous HTMLおよびjavascriptスライドショー)、
dzslides(DZSlides HTML5 + javascriptスライドショー)、revealjs(reveal.js HTML5 +
javascriptスライドショー)、s5(S5 HTMLおよびjavascriptスライドショー)、または
カスタムluaライター(下記のカスタムライターを参照)。 odt、epub、およびepub3に注意してください
出力は送信されません (Linuxで言うところのstdout); 出力ファイル名は、を使用して指定する必要があります
-o /-outputオプション。 + lhsがマークダウンに追加された場合、rst、latex、beamer、html、
またはhtml5の場合、出力はリテラシーのあるHaskellソースとしてレンダリングされます。リテラシーを参照してください。
以下のHaskellサポート。 マークダウン構文拡張機能は、個別に有効にすることも、
説明されているように、フォーマット名に+ EXTENSIONまたは-EXTENSIONを追加すると無効になります
上記の-fの下。
-o FILE, --output =FILE
出力をに書き込む FILE (Linuxで言うところのstdout)。 場合 FILE は-、出力はに行きます (Linuxで言うところのstdout).
(例外: 出力形式が odt、docx、epub、または epub3 の場合、stdout への出力は
無効。)
--data-dir =DIRECTORY
pandocデータファイルを検索するユーザーデータディレクトリを指定します。 このオプションが
指定しない場合、デフォルトのユーザーデータディレクトリが使用されます。 これは、Unixでは次のとおりです。
$ HOME / .pandoc
Windows XPの場合:
C:\ Documents And Settings \ USERNAME \ Application Data \ pandoc
およびWindowsVista以降の場合:
C:\ Users \ USERNAME \ AppData \ Roaming \ pandoc
システムのデフォルトのユーザーデータディレクトリは、
pandoc--versionの出力。 reference.odt、reference.docx、epub.css、templates、
このディレクトリに配置されたslidy、slideous、またはs5ディレクトリは、pandocの
通常のデフォルト。
--bash-完了
bash完了スクリプトを生成します。 pandocでbashの完了を有効にするには、これを追加します
.bashrcに:
eval "$(pandoc --bash-completion)"
-詳細
詳細なデバッグ出力を提供します。 現在、これはPDF出力でのみ効果があります。
-v、 - バージョン
印刷版。
-NS、 - 助けて
使用法メッセージを表示します。
リーダー オプション
-NS、 --parse-raw
翻訳不可能なHTMLコードとLaTeX環境を生のHTMLまたはLaTeXとして解析します。
それらを無視する代わりに。 HTMLおよびLaTeX入力にのみ影響します。 生のHTMLは
Markdown、reStructuredText、HTML、Slidy、Slideous、DZSlides、reveal.js、
およびS5出力。 生のLaTeXは、Markdown、reStructuredText、LaTeX、および
ConTeXt出力。 デフォルトでは、読者は翻訳不可能なHTMLコードを省略します
およびLaTeX環境。 (LaTeXリーダーは翻訳不可能なLaTeXを通過します
コマンド、-Rが指定されていない場合でも。)
-NS、 - 頭いい
活字で正しい出力を生成し、ストレートクォートをカーリークォートに変換します。
---ダッシュに、-ダッシュに、...楕円に。 ノーブレークスペースは
「Mr.」などの特定の略語の後に挿入されます。 (注:このオプションは選択されています
--no-tex-ligaturesを除き、出力形式がlatexまたはcontextの場合は自動的に
使用されている。 ラテックスの入力には影響しません。)
-古いダッシュ
スマート ダッシュを解析するための pandoc <= 1.8.2.1 の動作を選択します。
はen-dashであり、-はem-dashです。 このオプションは、
テキスタイル入力。
--base-header-level =数
ヘッダーの基本レベルを指定します(デフォルトは1)。
--indented-code-classes =クラス
インデントされたコードブロックに使用するクラスを指定します(perl、numberLines、
haskell。 複数のクラスは、スペースまたはコンマで区切ることができます。
--default-image-extension =EXTENSION
画像パス/ URLに拡張子がない場合に使用するデフォルトの拡張子を指定します。 この
異なる種類を必要とするフォーマットに同じソースを使用できます
画像。 現在、このオプションはMarkdownおよびLaTeXリーダーにのみ影響します。
--filter =実行可能
後にpandocASTを変換するフィルターとして使用する実行可能ファイルを指定します
入力は解析され、出力が書き込まれる前に行われます。 実行可能ファイルはJSONを読み取る必要があります
stdinからstdoutにJSONを書き込みます。 JSONはpandoc独自の形式にする必要があります
JSON入力と出力。 出力フォーマットの名前がフィルターに渡されます
最初の引数として。 したがって、
pandoc --filter ./caps.py-tラテックス
に相当します
pandoc -t json | ./caps.pyラテックス| pandoc -f json-tラテックス
後者の形式は、フィルターのデバッグに役立つ場合があります。
フィルタは任意の言語で記述できます。 Text.Pandoc.JSON は toJSONFilter にエクスポートします
Haskellでのフィルターの作成を容易にします。 フィルタを書きたい人
pythonは、PyPIからインストール可能なモジュールpandocfiltersを使用できます。 もあります
PHP、perl、およびjavascript /node.jsのpandocフィルターライブラリ。
なお、 実行可能 作業中ではなく、ユーザーのPATHで検索されます
ディレクトリ(ディレクトリが提供されていない場合)。 作業中にスクリプトを実行したい場合
ディレクトリでは、ファイル名の前に。を付けます。/.
-M キー[=VAL], --metadata =キー[:VAL]
メタデータ フィールドを設定する キー 値に VAL。 コマンドラインで指定された値
ドキュメントで指定された値をオーバーライドします。 値はYAMLブール値として解析されます
または文字列値。 値が指定されていない場合、値はブール値として扱われます
本当。 --variableと同様に、-metadataを使用するとテンプレート変数が設定されます。 しかし、とは異なり
--variable、-metadataは、基になるドキュメントのメタデータに影響します(
フィルタからアクセスでき、一部の出力形式で印刷される場合があります)。
- ノーマライズ
読んだ後、ドキュメントを正規化します。隣接するStrまたはEmph要素をマージします。
例として、繰り返されるスペースを削除します。
-NS、 --preserve-タブ
タブをスペースに変換するのではなく、保持します(デフォルト)。 これに注意してください
リテラル コード スパンとコード ブロックのタブにのみ影響します。 通常のテキストのタブ
スペースとして扱われます。
--tab-stop =数
タブごとのスペースの数を指定します(デフォルトは4)。
--track-changes = accept | require | all
MSWord「トラック」によって生成された挿入と削除をどうするかを指定します
変更」機能。受け入れ(デフォルト)、すべての挿入を挿入し、すべてを無視します
削除。 拒否はすべての削除を挿入し、挿入を無視します。 すべてが両方に入れます
挿入と削除、挿入と削除のクラスを持つスパンにラップ、
それぞれ。 作者と変更時刻が含まれています。 すべてが便利です
スクリプティング:特定のレビュー担当者、たとえば、または特定の前の変更のみを受け入れる
日にち。 このオプションは、docxリーダーにのみ影響します。
--extract-media =DIR
docxまたはepubコンテナに含まれる画像やその他のメディアをパスに抽出します
DIR、必要に応じて作成し、ドキュメント内の画像参照を調整して、
抽出されたファイルを指します。 このオプションは、docxとepubにのみ影響します
読者。
作家 オプション
-s、 -スタンドアロン
適切なヘッダーとフッターを使用して出力を生成します(スタンドアロンHTMLなど、
LaTeX、またはRTFファイル、フラグメントではありません)。 このオプションはPDF用に自動的に設定されます。
epub、epub3、fb2、docx、およびodtの出力。
--template =FILE
FILE 生成されたドキュメントのカスタムテンプレートとして。 --standaloneを意味します。
テンプレート構文の説明については、以下のテンプレートを参照してください。 拡張子がない場合
指定すると、ライターに対応する拡張子が追加されるため、
--template = specialは、HTML出力用のspecial.htmlを探します。 テンプレートがない場合
見つかった場合、pandocはユーザーデータのtemplatesサブディレクトリでそれを検索します
ディレクトリ(--data-dirを参照)。 このオプションを使用しない場合、デフォルトのテンプレート
出力形式に適したものが使用されます(-D / -print-default-templateを参照)。
-V キー[=VAL], -変数=キー[:VAL]
テンプレート変数を設定します キー 値に VAL でドキュメントをレンダリングするとき
スタンドアロンモード。 これは通常、-templateオプションが使用されている場合にのみ役立ちます
pandocはで使用される変数を自動的に設定するため、カスタムテンプレートを指定します
デフォルトのテンプレート。 いいえの場合 VAL が指定されている場合、キーには値が与えられます
真。
-D FORMAT, --print-default-template =FORMAT
出力用のシステムデフォルトテンプレートを印刷します FORMAT。 (のリストについては、-tを参照してください。
可能 FORMATs。)ユーザーデータディレクトリ内のテンプレートは無視されます。
--print-default-data-file =FILE
システムのデフォルトデータファイルを印刷します。 ユーザーデータディレクトリ内のファイルは無視されます。
--dpi =数
ピクセルからへの変換のdpi(dots per inch)値を指定します
インチ/センチメートルおよびその逆。 デフォルトは96dpiです。 技術的には、正しい
用語はppi(ピクセル/インチ)になります。
--wrap = [auto | none | reserved]
テキストが出力でどのようにラップされるかを決定します(レンダリングされたものではなく、ソースコード
バージョン)。 auto(デフォルト)を使用すると、pandocは行を列に折り返そうとします
--columnsで指定された幅(デフォルトは80)。 なしの場合、pandocは行を折り返しません
まったく。 保存を使用すると、pandocはラッピングを保存しようとします
ソースドキュメント(つまり、ソースに非セマンティック改行がある場合は、
出力でも非セマンティック改行になります)。
-ノーラップ
--wrap = noneの非推奨の同義語。
--columns =数
行の長さを文字で指定します(テキストの折り返し用)。 これはにのみ影響します
レンダリングされたページのレイアウトではなく、生成されたソースコード。
--toc、 - 目次
自動生成された目次を含めます(または、ラテックスの場合は、
コンテキスト、および最初に、出力ドキュメントでコンテキストを作成するための命令)。 この
オプションは、man、docbook、slidy、slideous、s5、docx、またはodtの出力には影響しません。
--toc-depth =数
目次に含めるセクションレベルの数を指定します。 The
デフォルトは3です(これは、レベル1、2、および3のヘッダーが
内容)。
-ハイライトなし
言語の場合でも、コードブロックとインラインの構文の強調表示を無効にします
属性が与えられます。
--highlight-style =スタイル
ハイライトされたソースコードで使用される色付けスタイルを指定します。 オプションは
ピグメント(デフォルト)、ケイト、モノクロ、エスプレッソ、ゼンバーン、ハドック、タンゴ。
pandocでの構文の強調表示の詳細については、構文の強調表示を参照してください。
を参照してください。
-H FILE, --include-in-header =FILE
の内容を含める FILE、逐語的に、ヘッダーの終わりに。 これを使用できます、
たとえば、HTMLドキュメントに特別なCSSまたはjavascriptを含めるため。 このオプション
ヘッダーに複数のファイルを含めるために繰り返し使用できます。 かれらは〜だろう
指定された順序に含まれます。 --standaloneを意味します。
-B FILE, --include-before-body =FILE
の内容を含める FILE、逐語的に、ドキュメント本文の先頭(例:
後にHTMLのタグ、またはLaTeXの\ begin {document}コマンド)。 これはできます
HTMLドキュメントにナビゲーションバーまたはバナーを含めるために使用されます。 このオプションは
複数のファイルを含めるために繰り返し使用されます。 それらは注文に含まれます
指定。 --standaloneを意味します。
-A FILE, --include-after-body =FILE
の内容を含める FILE、逐語的に、ドキュメント本文の最後(
HTMLのタグ、またはLaTeXの\ end {document}コマンド)。 このオプションは
複数のファイルを含めるために繰り返し使用されます。 それらは注文に含まれます
指定。 --standaloneを意味します。
オプション 影響 特定の 作家
-自己完結型
データを使用して、外部依存関係のないスタンドアロンHTMLファイルを作成します。
リンクされたスクリプト、スタイルシート、画像、およびビデオのコンテンツを組み込みます。 The
結果のファイルは、外部を必要としないという意味で「自己完結型」である必要があります
ファイルがあり、ブラウザによって正しく表示されるネットアクセスがありません。 このオプションは機能します
html、html5、html + lhs、html5 + lhs、s5、を含むHTML出力形式でのみ
slidy、slideous、dzslides、およびrevealjs。 スクリプト、画像、スタイルシート
絶対URLがダウンロードされます。 相対URLにあるものは、
作業ディレクトリ(最初のソースファイルがローカルの場合)またはベースからの相対ディレクトリ
URL(最初のソースファイルがリモートの場合)。 制限:ロードされるリソース
JavaScriptを介して動的に組み込むことはできません。 結果として、
--self-containedは--mathjaxおよび一部の高度な機能(例:
ズームまたはスピーカーノート)は、オフラインの「自己完結型」のreveal.jsスライドでは機能しない場合があります
ショー。
--html-q-tags
HTMLの引用符にはタグを使用します。
--ASCII
出力にはASCII文字のみを使用してください。 現在、HTML出力でのみサポートされています
(このオプションが選択されている場合、UTF-8 の代わりに数値エンティティを使用します)。
-参照リンク
Markdownまたは
reStructuredText。 デフォルトでは、インラインリンクが使用されます。
--atx-ヘッダー
Markdownおよびasciidoc出力でATXスタイルのヘッダーを使用します。 デフォルトでは使用します
レベル1〜2のsetextスタイルのヘッダー、次にATXヘッダー。
-章
LaTeX、ConTeXt、および DocBook の出力では、最上位のヘッダーを章として扱います。 いつ
LaTeXドキュメントクラスは、レポート、ブック、または回想録に設定されています。このオプションは暗黙的です。
ビーマーが出力形式の場合、最上位のヘッダーは\ part {..}になります。
-NS、 --番号セクション
LaTeX、ConTeXt、HTML、またはEPUB出力のセクション見出しに番号を付けます。 デフォルトでは、
セクションには番号が付けられていません。 クラスに番号が付けられていないセクションには番号が付けられません。
--number-sectionsが指定されている場合でも。
--number-offset =数[,数,...]
HTML出力のセクション見出しのオフセット(他の出力形式では無視されます)。 ザ
最初の番号はトップレベルヘッダーのセクション番号に追加され、XNUMX番目の番号は
第XNUMXレベルのヘッダーなど。 したがって、たとえば、最初のトップレベルが必要な場合
ドキュメントのヘッダーに「6」の番号を付けるには、-number-offset = 5を指定します。 もしあなたの
ドキュメントは、「2」の番号を付けたいレベル1.5ヘッダーで始まり、指定します
--number-offset = 1,4。 デフォルトでは、オフセットは0です。 --number-sectionsを意味します。
--no-tex-合字
引用符、アポストロフィ、ダッシュ( `... '、
`` .. ''、-、---)LaTeXまたはConTeXtの書き込みまたは読み取り時。 LaTeXを読む際に、解析する
文字 `、 '、および-引用のために合字を解析するのではなく、文字通り
マークとダッシュ。 LaTeXまたはConTeXtを作成する際は、Unicode引用符を印刷して
標準のASCIITeXに変換するのではなく、文字通りダッシュ文字
合字。 注:通常、LaTeXおよびConTeXtでは--smartが自動的に選択されます
出力しますが、-no-tex-ligaturesが選択されている場合は、明示的に指定する必要があります。 もしも
ソースで文字通りの中引用符、ダッシュ、省略記号を使用すると、
--smartなしで--no-tex-ligaturesを使用したい。
-リスト
LaTeXコードブロックのリストパッケージを使用する
-私、 - 増分
スライドショーのリストアイテムを段階的に(XNUMXつずつ)表示します。 デフォルトは
リストを一度に表示するため。
--slide-level =数
指定されたレベルのヘッダーがスライドを作成することを指定します(beamer、s5、
slidy、slideous、dzslides)。 階層内のこのレベルより上のヘッダーは、
スライドショーをセクションに分割します。 このレベルより下のヘッダーは小見出しを作成します
スライド内。 デフォルトでは、の内容に基づいてスライドレベルを設定します
資料; スライドショーの構成を参照してください。
--section-div
セクションをラップするタグ(またはHTML5のタグ)、および識別子をに添付します
囲み(また)ヘッダー自体ではなく。 ヘッダーを参照
以下の識別子。
--email-obfuscation = none | javascript | reference
HTMLドキュメント内のmailto:リンクを難読化する方法を指定します。 葉なし
mailto:リンクはそのままです。 javascriptは、javascriptを使用してそれらを難読化します。
参照は、文字をXNUMX進数またはXNUMX進数として出力することにより、それらをわかりにくくします。
文字参照。 デフォルトはjavascriptです。
--id-prefix =STRING
HTMLで自動生成されたすべての識別子に追加するプレフィックスを指定し、
DocBook出力、およびMarkdown出力の脚注番号。 これは
他に含まれるフラグメントを生成するときに重複する識別子を防ぐ
ページ
-T STRING, --title-prefix =STRING
指定 STRING HTMLに表示されるタイトルの先頭のプレフィックスとして
ヘッダー(ただし、HTML本文の先頭に表示されるタイトルには含まれません)。
--standaloneを意味します。
-c URL, --css =URL
CSSスタイルシートへのリンク。 このオプションを繰り返し使用して、含めることができます
複数のファイル。 それらは指定された順序で含まれます。
--reference-odt =FILE
指定されたファイルを、ODTを作成する際のスタイル参照として使用します。 最良の結果を得るには、
参照ODTは、pandocを使用して作成されたODTの修正バージョンである必要があります。
参照ODTの内容は無視されますが、そのスタイルシートは
新しいODT。 コマンドラインで参照ODTが指定されていない場合、pandocは
ユーザーデータディレクトリ内のファイルreference.odtの場合(--data-dirを参照)。 これが
どちらも見つからない場合は、適切なデフォルトが使用されます。
--reference-docx =FILE
指定されたファイルを、docxファイルを作成する際のスタイル参照として使用します。 最高のために
結果として、参照docxは、生成されたdocxファイルの修正バージョンである必要があります。
pandocを使用します。 参照docxの内容は無視されますが、そのスタイルシート
およびドキュメントのプロパティ(余白、ページサイズ、ヘッダー、フッターなど)が使用されます
新しいdocxで。 コマンドラインで参照docxが指定されていない場合は、pandoc
ユーザーデータディレクトリでファイルreference.docxを検索します(--data-dirを参照)。
これも見つからない場合は、適切なデフォルトが使用されます。 次のスタイル
pandocで使用されます:[段落]通常、本文、最初の段落、コンパクト、タイトル、
サブタイトル、著者、日付、要約、参考文献、見出し1、見出し2、見出し3
見出し4、見出し5、見出し6、ブロックテキスト、脚注テキスト、定義用語、
定義、キャプション、テーブルキャプション、画像キャプション、図、キャプション付きの図、目次
見出し; [文字]デフォルトの段落フォント、本文テキスト文字、逐語文字、
脚注リファレンス、ハイパーリンク; [テーブル]通常のテーブル。
--epub-stylesheet =FILE
指定されたCSSファイルを使用してEPUBのスタイルを設定します。 スタイルシートが指定されていない場合、
pandocは、ユーザーデータディレクトリでファイルepub.cssを検索します(--data-dirを参照)。
そこに見つからない場合は、適切なデフォルトが使用されます。
--epub-cover-image =FILE
指定された画像をEPUBカバーとして使用します。 画像は
幅と高さが1000px未満。 マークダウンソースドキュメントでは、
YAMLメタデータブロックでカバー画像を指定することもできます(以下のEPUBメタデータを参照)。
--epub-metadata =FILE
指定されたXMLファイルでEPUBのメタデータを探します。 ファイルには次のものが含まれている必要があります
ダブリンコア要素のシリーズ。 例えば:
クリエイティブコモンズ
es-AR
デフォルトでは、pandocには次のメタデータ要素が含まれます。 (から
ドキュメントのタイトル)、 (ドキュメントの作成者から)、 (から
文書の日付(ISO 8601形式である必要があります)、 (言語から
変数、または設定されていない場合はロケール)、および(a
ランダムに生成されたUUID)。 これらのいずれかは、内の要素によってオーバーライドされる可能性があります
メタデータファイル。
注:ソースドキュメントがMarkdownの場合、ドキュメント内のYAMLメタデータブロックは次のことができます
代わりに使用してください。 以下のEPUBメタデータを参照してください。
--epub-embed-font =FILE
指定したフォントをEPUBに埋め込みます。 このオプションを繰り返して埋め込むことができます
複数のフォント。 ワイルドカードも使用できます。たとえば、DejaVuSans-*。ttfです。
ただし、コマンドラインでワイルドカードを使用する場合は、必ずワイルドカードをエスケープするか、
ファイル名全体を一重引用符で囲み、
シェル。 埋め込みフォントを使用するには、次のような宣言を追加する必要があります。
CSSに従います(--epub-stylesheetを参照):
@ font-face {
フォントファミリー:DejaVuSans;
フォントスタイル:普通。
フォントの太さ:通常。
src:url( "DejaVuSans-Regular.ttf");
}
@ font-face {
フォントファミリー:DejaVuSans;
フォントスタイル:普通。
フォント重量:太字;
src:url( "DejaVuSans-Bold.ttf");
}
@ font-face {
フォントファミリー:DejaVuSans;
フォントスタイル:斜体;
フォントの太さ:通常。
src:url( "DejaVuSans-Oblique.ttf");
}
@ font-face {
フォントファミリー:DejaVuSans;
フォントスタイル:斜体;
フォント重量:太字;
src:url( "DejaVuSans-BoldOblique.ttf");
}
body {font-family: "DejaVuSans"; }
--epub-chapter-level =数
EPUBを個別の「チャプター」ファイルに分割するヘッダーレベルを指定します。
デフォルトでは、レベル1ヘッダーでチャプターに分割されます。 このオプションは影響するだけです
章やセクションの方法ではなく、EPUBの内部構成
ユーザーに表示されます。 章のファイルが大きすぎると、一部のリーダーが遅くなる可能性があります。
したがって、レベル1のヘッダーが少ない大きなドキュメントの場合は、チャプターを使用することをお勧めします。
レベル2または3。
--latex-engine = pdflatex | lualatex | xelatex
PDF出力を生成するときは、指定されたLaTeXエンジンを使用してください。 デフォルトはpdflatexです。
エンジンがPATHにない場合は、エンジンのフルパスが指定されている可能性があります
ページ をご覧ください
--latex-engine-opt =STRING
指定された文字列をlatex-engineへのコマンドライン引数として使用します。 使用する場合
複数回、引数はそれらの間にスペースを入れて提供されます。 ないことに注意してください
重複するオプションのチェックが行われます。
引用 レンダリング
-参考文献=FILE
ドキュメントのメタデータの参考文献フィールドを次のように設定します FILE、任意の値をオーバーライドします
メタデータに設定し、pandoc-citeprocを使用して引用を処理します。 (これは
--metadata bibliography = FILE --filter pandoc-citeprocと同等です。)-natbibの場合
または--biblatexも提供され、pandoc-citeprocは使用されないため、これは同等になります
--metadata bibliography = FILEに。 この引数を複数回指定すると、それぞれ
FILE 参考文献に追加されます。
--csl =FILE
ドキュメントのメタデータのcslフィールドを次のように設定します FILE、で設定された値をオーバーライドする
メタデータ。 (これは--metadata csl = FILEと同等です。)このオプションは
pandoc-citeprocに関連します。
--citation-abbreviations =FILE
ドキュメントのメタデータのcitation-abbreviationsフィールドを次のように設定します FILE、オーバーライド
メタデータに設定されている値。 (これは
--metadata citation-abbreviations = FILE。)このオプションは、
pandoc-citeproc。
--natbib
LaTeX出力の引用にはnatbibを使用します。 このオプションは、
pandoc-citeprocフィルターまたはPDF出力付き。 これは、
bibtexで処理できるLaTeXファイル。
--ビブラテックス
LaTeX出力の引用にはbiblatexを使用します。 このオプションは、
pandoc-citeprocフィルターまたはPDF出力付き。 これは、
bibtexまたはbiberで処理できるLaTeXファイル。
数学 レンダリング in HTML
-m [URL], --latexmathml [=URL]
LaTeXMathMLを使用して、埋め込まれたTeX数学をHTML出力に表示します。 ザ URL ポイントする必要があります
LaTeXMathML.jsロードスクリプトに。 もし URL 提供されていない、へのリンク
LaTeXMathMLのホームページにあるLaTeXMathML.jsが挿入されます。
--mathml [=URL]
TeX mathをMathMLに変換します(docbook、html、html5)。 スタンドアロンで
html出力、小さなjavascript(または、 URL 提供されます)
MathMLを一部のブラウザで表示できるようにするために挿入されます。
--jsmath [=URL]
jsMathを使用して、埋め込まれたTeX数学をHTML出力に表示します。 The URL を指す必要があります
jsMathロードスクリプト(例:jsMath / easy / load.js); 提供されている場合は、リンクされます
スタンドアロンHTMLドキュメントのヘッダーにあります。 もし URL 提供されていない、リンクなし
jsMathロードスクリプトに挿入されます。 その後、提供するのは作者次第です
HTMLテンプレート内のそのようなリンク。
--mathjax [=URL]
MathJaxを使用して、埋め込まれたTeX数学をHTML出力に表示します。 The URL を指す必要があります
MathJax.js ロード スクリプト。 もし URL 提供されていない、MathJaxCDNへのリンク
挿入されます。
--グラッドテックス
TeX数学をHTML出力のタグ。 これらはその後、によって処理することができます
gladTeXは、タイプセット式の画像へのリンクを生成します。
--mimetex [=URL]
mimeTeXCGIスクリプトを使用してTeX数学をレンダリングします。 もしも URL 指定されていません。
スクリプトが/cgi-bin/mimetex.cgiにあると想定しています。
--webtex [=URL]
TeX数式を画像に変換する外部スクリプトを使用してTeX数式をレンダリングします。
数式は、指定されたURLと連結されます。 もしも URL 指定されていません、
Google ChartAPIが使用されます。
--カテックス[=URL]
KaTeXを使用して、埋め込まれたTeX数学をHTML出力に表示します。 The URL を指す必要があります
katex.jsロードスクリプト。 もし URL 提供されていない場合、KaTeXCDNへのリンクは次のようになります。
挿入されました。
--katex-stylesheet =URL
この URL katex.cssスタイルシートを指す必要があります。 このオプションが指定されていない場合、
KaTeXCDNへのリンクが挿入されます。 このオプションは意味しないことに注意してください
--katex。
オプション for ラッパー スクリプト
--ダンプ引数
コマンドライン引数に関する情報を (Linuxで言うところのstdout)、次に終了します。 このオプション
主にラッパースクリプトでの使用を目的としています。 出力の最初の行
-oオプションまたは-(の場合)で指定された出力ファイルの名前が含まれます
(Linuxで言うところのstdout))出力ファイルが指定されていない場合。 残りの行には
コマンドライン引数(XNUMX行にXNUMXつずつ、表示される順序)。 これらはしません
通常のpandocオプションとその引数を含めますが、オプションは含めます
行末の-区切り文字の後に表示されます。
--ignore-args
コマンドライン引数を無視します(ラッパースクリプトで使用するため)。 通常のpandocオプション
無視されません。 したがって、たとえば、
pandoc --ignore-args -o foo.html -s foo.txt --- e latin1
に相当します
pandoc -o foo.html -s
TEMPLATES
-s / -standaloneオプションを使用すると、pandocはテンプレートを使用してヘッダーとフッターを追加します
自立文書に必要な資料。 デフォルトのテンプレートを表示するには
使用済み、入力するだけ
pandoc -D *フォーマット*
コラボレー FORMAT 出力フォーマットの名前です。 カスタムテンプレートは、を使用して指定できます
--templateオプション。 特定のシステムのデフォルトテンプレートを上書きすることもできます
出力フォーマット FORMAT ファイルtemplates / default。* FORMAT *をユーザーデータに入れることによって
ディレクトリ(上記の--data-dirを参照)。 例外: odt出力の場合は、
default.opendocumentテンプレート。 PDF出力の場合は、default.latexテンプレートをカスタマイズします。
テンプレートには variables、任意の情報を含めることができます
ファイル内のポイント。 変数は、YAMLメタデータブロックを使用してドキュメント内で設定できます。
これらは、-V / -variableオプションを使用してコマンドラインで設定することもできます。
このようにして、同じ名前のメタデータフィールドをオーバーライドします。
Variables セッションに by パンドック
一部の変数は、pandocによって自動的に設定されます。 これらは、
出力形式ですが、メタデータフィールドと次のものが含まれます。
タイトル、 著者、 date
ドキュメントの基本的な側面の識別を可能にします。 PDFメタデータに含まれています
LaTeXおよびConTeXtを介して。 これらは、pandocタイトルブロックを介して設定できます。
複数の作成者を許可するか、YAMLメタデータブロックを介して:
---
著者:
-アリストテレス
-ピエール・アベラール
...
字幕
HTML、EPUB、LaTeX、ConTeXt、およびWorddocxに含まれるドキュメントのサブタイトル。 レンダリング
LaTeXでは、beamerなどの\ subtitleをサポートするドキュメントクラスを使用する場合のみ
またはKOMA-Scriptシリーズ(scrartcl、scrreprt、scrbook)。
抽象的な
LaTeX、ConTeXt、AsciiDoc、およびWorddocxに含まれるドキュメントの概要
キーワード
HTML、PDF、およびAsciiDocメタデータに含まれるキーワードのリスト。 多分
上記の著者について繰り返した
ヘッダー-含む
-H / -include-in-headerで指定されたコンテンツ(複数の値を持つ場合があります)
TOC --toc / -table-of-contentsが指定された場合はnull以外の値
目次タイトル
目次のタイトル(EPUBとdocxでのみ機能します)
含める-前
-B / -include-before-bodyで指定されたコンテンツ(複数の値を持つ場合があります)
インクルード-アフター
-A / -include-after-bodyで指定されたコンテンツ(複数の値を持つ場合があります)
ボディ ドキュメントの本文
メタ json
ドキュメントのすべてのメタデータのJSON表現
言語 variables
長い BCP 47に準拠したコードを使用して、ドキュメントの主要言語を識別します
(例:enまたはen-GB)。 一部の出力形式では、pandocはそれをに変換します
追加の変数babel-lang、polyglossia-langに格納されている適切な形式
(LaTeX)およびcontext-lang(ConTeXt)。
lang属性(BCP 47の値)を持つネイティブpandocスパンおよびdivを使用できます
その範囲で言語を切り替えます。
他の言語
YAMLメタデータのドキュメントで使用されている他の言語のリスト
BCP47。例:otherlangs:[en-GB、fr]。 これは自動的に生成されます
すべてのスパンとdivのlang属性からですが、オーバーライドできます。 現在
生成されたbabel-otherlangsおよび
polyglossia-otherlangs変数。 LaTeXライターはポリグロシアコマンドを出力します
テキストですが、babel-newcommands変数には、それらへのマッピングが含まれています。
対応するバベル。
DIR ドキュメントの基本方向、rtl(右から左)またはltr
(左から右へ)。
双方向ドキュメントの場合、ネイティブpandocスパンとdir属性を持つdiv
(値rtlまたはltr)を使用して、一部の出力でベース方向をオーバーライドできます
フォーマット。 これは、最終レンダラー(たとえば、
ブラウザ(HTMLを生成する場合)は、Unicode双方向アルゴリズムをサポートします。
双方向ドキュメントにLaTeXを使用する場合、xelatexエンジンのみが完全に機能します
サポートされています(--latex-engine = xelatexを使用)。
Variables for スライド
すべてのreveal.jsを含む、pandocを使用したスライドショーの作成に使用できる変数
構成オプション。
スライド URL
SlidyドキュメントのベースURL(デフォルトは http://www.w3.org/Talks/Tools/Slidy2)
スライド URL
SlideousドキュメントのベースURL(デフォルトはslideous)
s5-url S5ドキュメントのベースURL(デフォルトはs5 / default)
Revealjs-url
reveal.jsドキュメントのベースURL(デフォルトはreveal.js)
テーマ、 colortheme、 fonttheme、 インナーテーマ、 アウターテーマ
LaTeXビーマードキュメントのテーマ
ナビゲーション
Beamerドキュメントのナビゲーションシンボルを制御します(ナビゲーションがない場合、デフォルトは空です
シンボル; 他の有効な値は、フレーム、垂直、および水平です)。
セクションタイトル
Beamerドキュメントの新しいセクションの「タイトルページ」を有効にします(デフォルト= true)。
Variables for ラテックス
LaTeX変数は、PDFを作成するときに使用されます。
ペーパーサイズ
用紙サイズ、例:レター、A4
フォントサイズ
本文のフォントサイズ(例:10pt、12pt)
ドキュメントクラス
ドキュメントクラス、例:記事、レポート、本、回想録
クラスオプション
ドキュメントクラスのオプション、たとえば片側。 複数のオプションで繰り返すことができます
ジオメトリパッケージのオプション、例:margin = 1in; 複数のオプションで繰り返すことができます
マージン左、 マージン右、 マージントップ、 マージンボトム
ジオメトリが使用されていない場合はマージンを設定します(そうでない場合、ジオメトリはこれらをオーバーライドします)
ラインストレッチ
setspaceパッケージを使用して行間隔を調整します(例:1.25、1.5)
フォントファミリー
pdflatexで使用するフォントパッケージ:TeX Liveには多くのオプションが含まれており、
LaTeXフォントカタログ。 デフォルトはLatinModernです。
フォントファミリーオプション
fontfamilyとして使用されるパッケージのオプション:例:fontfamilyがに設定されたosf、sc
mathpazoは、Palatinoに古いスタイルの数字と真のスモールキャップを提供します。 多分
複数のオプションで繰り返される
メインフォント、 sansfont、 モノフォント、 mathfont、 CJKメインフォント
xelatexまたはlualatexで使用するフォントファミリ:任意のシステムフォントの名前を取り、
fontspecパッケージを使用します。 CJKmainfontを使用する場合、xecjkパッケージに注意してください
利用可能である必要があります。
mainfontoptions、 sansfontoptions、 monofontoptions、 mathfontoptions、 CJKオプション
xelatexのmainfont、sansfont、monofont、mathfont、CJKmainfontで使用するオプション
とlualatex。 たとえば、fontspecを通じて利用可能なすべての選択肢を許可します。
OpenTypeの機能Numbers = OldStyle、Numbers = Proportional。 のために繰り返される可能性があります
複数のオプション。
フォンテンク
fontencパッケージ(pdflatexを使用)を介してフォントエンコーディングを指定できるようにします。
デフォルトはT1です(LaTeXフォントエンコーディングのガイドを参照)
カラーリンク
リンクテキストに色を追加します。 linkcolor、citecolor、
urlcolorまたはtoccolorが設定されています
linkcolor、 citecolor、 urlcolor、 トコカラー
内部リンク、引用リンク、外部リンク、および表のリンクの色
内容:事前定義されたLaTeXカラーのいずれかを使用します
リンクとしてのメモ
リンクを脚注として印刷します
インデント インデントにドキュメントクラス設定を使用します(それ以外の場合はデフォルトのLaTeXテンプレート)
インデントを削除し、段落間にスペースを追加します)
サブパラグラフ
(サブ)段落を次のように再定義するLaTeXテンプレートのデフォルトの動作を無効にします
セクション、一部のクラスでネストされた見出しの外観を変更
感謝 ドキュメントタイトルの後に確認の脚注の内容を指定します。
TOC 目次を含める(--toc / -table-of-contentsを使用して設定することもできます)
目次の深さ
目次に含めるセクションのレベル
lof、 たくさん
図のリスト、表のリストを含める
参考文献
参考文献の解決に使用する参考文献
ビブリオスタイル
--natbibおよび--biblatexとともに使用する場合の参考文献スタイル。
biblatexオプション
biblatexのオプションのリスト。
Variables for 環境
ペーパーサイズ
用紙サイズ(レター、A4、横向きなど)(ConTeXt用紙設定を参照)。 繰り返される可能性があります
複数のオプションの場合
レイアウト ページ余白とテキスト配置のオプション(ConTeXtレイアウトを参照)。 繰り返される可能性があります
複数のオプションの場合
マージン左、 マージン右、 マージントップ、 マージンボトム
レイアウトが使用されていない場合、余白を設定します (そうでない場合、レイアウトがこれらをオーバーライドします)。
フォントサイズ
本文のフォントサイズ(例:10pt、12pt)
メインフォント、 sansfont、 モノフォント、 数学フォント
フォントファミリー:任意のシステムフォントの名前を取ります(ConTeXtフォント切り替えを参照)
linkcolor、 コントラストカラー
ページの外側と内側のリンクの色(赤、青など)(ConTeXt Colorを参照)
リンクスタイル
リンクの書体スタイル(例:通常、太字、傾斜、太字傾斜、タイプ、キャップ、
小さい
インデント
段落のインデントを制御します。たとえば、yes、small、next(ConTeXtインデントを参照)。
複数のオプションで繰り返すことができます
空白
段落間の間隔、例:なし、小さい(setupwhitespaceを使用)
インターラインスペース
行間隔を調整します(例:4ex(setupinterlinespaceを使用))。 のために繰り返されるかもしれません
複数のオプション
ヘッダーテキスト、 フッターテキスト
実行中のヘッダーまたはフッターに配置されるテキスト(ConTeXtヘッダーおよびフッターを参照)。
異なる配置で最大XNUMX回繰り返すことができます
ページ番号
ページ番号のスタイルと場所(setuppagenumberingを使用)。 のために繰り返されるかもしれません
複数のオプション
TOC 目次を含める(--toc / -table-of-contentsを使用して設定することもできます)
lof、 たくさん
図のリスト、表のリストを含める
Variables for man ページ
マニュアルページのセクション番号
ヘッダ マニュアルページのヘッダー
フッター マニュアルページのフッター
調整の
テキストを左(l)、右(r)、中央(c)、または両方(b)の余白に調整します
ハイフネーション
true(デフォルト)の場合、ハイフンが使用されます
使い方 variables in テンプレート
変数名は、文字で始まる英数字、-、および_のシーケンスです。 A
$記号で囲まれた変数名は、その値に置き換えられます。 たとえば、
文字列$ title $ in
$ title $
ドキュメントのタイトルに置き換えられます。
テンプレートにリテラル$を書き込むには、$$を使用します。
テンプレートには条件が含まれる場合があります。 構文は次のとおりです。
$ if(変数)$
X
$ else $
Y
$ endif $
変数の値がnull以外の場合、これにはテンプレートにXが含まれます。 そうでなければそれは
Yを含めます。XとYは、有効なテンプレートテキストのプレースホルダーであり、次のように含めることができます。
補間された変数またはその他の条件。 $ else $セクションは省略できます。
変数が複数の値を持つことができる場合(たとえば、複数の作成者のドキュメントの作成者)、
$ for $キーワードを使用できます。
$ for(作成者)$
$ endfor $
オプションで、連続するアイテム間で使用する区切り文字を指定できます。
$ for(author)$$ author $$ sep $、$ endfor $
ドットを使用して、オブジェクトを値として受け取る変数のフィールドを選択できます。 そう、
たとえば、次の
$ author.name $($ author.affiliation $)
カスタムテンプレートを使用する場合は、pandocの変更に応じてテンプレートを修正する必要があります。 おすすめ
デフォルトテンプレートの変更を追跡し、カスタムテンプレートを変更します
によると。 これを行う簡単な方法は、pandoc-templatesリポジトリをフォークしてマージすることです。
各pandocリリース後の変更で。
PANDOC'S マークダウン
Pandocは、JohnGruberのMarkdownの拡張バージョンとわずかに改訂されたバージョンを理解しています
構文。 このドキュメントでは、標準のMarkdownとの違いに注意しながら、構文について説明します。
特に明記されていない限り、これらの違いはmarkdown_strictを使用することで抑制できます。
マークダウンの代わりにフォーマット。 + EXTENSIONをに追加することで拡張機能を有効にできます
フォーマット名であり、-EXTENSIONを追加して無効にします。 たとえば、markdown_strict + footnotesは
脚注が有効になっている厳密なMarkdown、markdown-footnotes-pipe_tablesはpandocの
脚注やパイプテーブルのない値下げ。
哲学
Markdownは、書きやすく、さらに重要なことに、読みやすいように設計されています。
Markdown 形式のドキュメントは、プレーン テキストとしてそのまま公開できる必要があります。
タグまたはフォーマット手順でマークアップされているように見えます。 -ジョン
グルーバー
この原則は、表、脚注、および
その他の拡張機能。
ただし、pandocの目的が元の目的と異なる点がXNUMXつあります。
マークダウンの。 Markdownは元々HTML生成を念頭に置いて設計されていましたが、
pandocは、複数の出力形式用に設計されています。 したがって、pandocは埋め込みを許可しますが
生のHTMLの場合、それはそれを思いとどまらせ、他の非HTML風の表現方法を提供します
定義リスト、表、数学、脚注などの重要なドキュメント要素。
段落
段落は、XNUMX行以上のテキストとそれに続くXNUMX行以上の空白行です。 改行
スペースとして扱われるため、段落を好きなようにリフローできます。 あなたがハードが必要な場合
改行、行末にXNUMXつ以上のスペースを入れてください。
拡張: エスケープされた_line_breaks
バックスラッシュの後に改行が続くことも、ハードラインブレイクです。 注:マルチラインおよびグリッドの場合
テーブルセル、これはハード改行を作成する唯一の方法です。
セルは無視されます。
ヘッダ
ヘッダーには、SetextとATXのXNUMX種類があります。
Setextスタイル ヘッダーの
setextスタイルのヘッダーは、「下線付き」のテキスト行であり、=記号の行があります(レベルの場合)
XNUMXつのヘッダー)または-記号(レベルXNUMXのヘッダーの場合):
レベルXNUMXヘッダー
==================
レベルXNUMXヘッダー
------------------
ヘッダーテキストには、強調などのインラインフォーマットを含めることができます(インラインフォーマットを参照してください。
下)。
ATXスタイル ヘッダーの
ATXスタイルのヘッダーは、XNUMX〜XNUMX個の#記号とXNUMX行のテキストで構成され、オプションでその後に続きます
任意の数の#記号によって。 行頭の#記号の数は
ヘッダーレベル:
##レベルXNUMXヘッダー
###レベルXNUMXヘッダー###
setextスタイルのヘッダーと同様に、ヘッダーテキストには次の書式を含めることができます。
#[リンク](/ url)と*強調*を備えたレベルXNUMXヘッダー
拡張: ヘッダーの前の空白
標準のMarkdown構文では、ヘッダーの前に空白行は必要ありません。 Pandocは
これが必要です(もちろん、ドキュメントの冒頭を除く)。 の理由
要件は、#が行の先頭に到達するのは非常に簡単であるということです。
事故(おそらく行の折り返しによる)。 たとえば、次のことを考慮してください。
私は彼らのアイスクリームのフレーバーのいくつかが好きです:
たとえば、#22、および#5。
ヘッダ 識別子
拡張: ヘッダー属性
ヘッダーには、この構文を含む行の終わりに属性を割り当てることができます。
ヘッダーテキスト:
{#identifier .class .class key = value key = value}
したがって、たとえば、次のヘッダーにはすべて識別子fooが割り当てられます。
#私のヘッダー{#foo}
##私のヘッダー## {#foo}
私の他のヘッダー{#foo}
---------------
(この構文はPHP Markdown Extraと互換性があります。)
この構文ではクラスとキー/値属性の割り当てが可能ですが、
ライターは通常、この情報のすべてを使用するわけではありません。 識別子、クラス、およびキー/値
属性は、HTMLおよびEPUBやslidyなどのHTMLベースの形式で使用されます。 識別子
LaTeX、ConTeXt、Textile、およびAsciiDocライターのラベルとリンクアンカーに使用されます。
--number-sectionsが番号付けされている場合でも、クラスに番号が付けられていないヘッダーには番号が付けられません。
指定。 属性コンテキスト内の単一のハイフン(-)は、.unnumberedと同等であり、
英語以外のドキュメントで推奨されます。 そう、
#私のヘッダー{-}
とちょうど同じです
#私のヘッダー{.unnumbered}
拡張: auto_identifiers
明示的に指定された識別子のないヘッダーには、自動的に割り当てられます
ヘッダーテキストに基づく一意の識別子。 ヘッダーから識別子を取得するには
テキスト、
・すべてのフォーマット、リンクなどを削除します。
・すべての脚注を削除します。
・アンダースコア、ハイフン、およびピリオドを除くすべての句読点を削除します。
・すべてのスペースと改行をハイフンに置き換えます。
・すべての英字を小文字に変換します。
・最初の文字までのすべてを削除します(識別子は数字で始まらない場合がありますまたは
句読点)。
・この後何も残っていない場合は、識別子セクションを使用してください。
したがって、たとえば、
ヘッダー識別子
─────────────────────────────────────────────────── ──────
HTMLのヘッダー識別子header-identifiers-in-html
*犬*?-*私の*家に? 犬-私の家の中
[HTML]、[S5]、または[RTF]? html-s5-または-rtf
3.アプリケーションアプリケーション
33セクション
これらのルールは、ほとんどの場合、ヘッダーから識別子を決定できるようにする必要があります
文章。 例外は、複数のヘッダーに同じテキストがある場合です。 この場合、最初の
上記のように識別子を取得します。 1番目は-XNUMXで同じ識別子を取得します
添付; -2のXNUMX番目。 等々。
これらの識別子は、によって生成された目次にリンクターゲットを提供するために使用されます
--toc | --table-of-contentsオプション。 また、XNUMXつからのリンクを簡単に提供できます
ドキュメントのセクションを別のセクションに。 たとえば、このセクションへのリンクは次のようになります。
この:
のセクションを参照してください
[ヘッダー識別子](#header-identifiers-in-html-latex-and-context)。
ただし、セクションへのリンクを提供するこの方法は、HTML、LaTeX、
およびConTeXt形式。
--section-divsオプションが指定されている場合、各セクションはdivでラップされます(または
セクション(--html5が指定されている場合)、および識別子は囲みに添付されます
(また)ヘッダー自体ではなくタグ。 これにより、セクション全体を
javascriptを使用して操作するか、CSSで異なる方法で処理します。
拡張: Implicit_header_references
Pandocは、ヘッダーごとに参照リンクが定義されているかのように動作します。 だから、代わりに
[ヘッダー識別子](#header-identifiers-in-html)
あなたは簡単に書くことができます
[ヘッダー識別子]
or
[ヘッダー識別子] []
or
[ヘッダー識別子に関するセクション] [ヘッダー識別子]
同じテキストのヘッダーが複数ある場合、対応する参照がリンクされます
最初のものだけに、明示的なリンクを使用して他のものにリンクする必要があります。
上述した。
通常の参照リンクと同様に、これらの参照では大文字と小文字が区別されません。
明示的なリンク参照定義は、常に暗黙的なヘッダー参照よりも優先されます。
したがって、次の例では、リンクは#fooではなくbarを指します。
#Foo
[foo]:バー
[foo]を参照してください
ブロック 引用
Markdownは、テキストのブロックを引用するために電子メールの規則を使用します。 ブロック引用はXNUMXつまたは
より多くの段落または他のブロック要素(リストやヘッダーなど)、各行
>文字とオプションのスペースが前に付きます。 (>は左から始める必要はありません
マージンですが、XNUMXスペースを超えてインデントしないでください。)
>これはブロック引用です。 この
>段落はXNUMX行あります。
>
> 1。これはブロック引用符内のリストです。
> 2番目の項目。
各ブロックの最初の行にのみ>文字を必要とする「怠惰な」形式は、
また許可されます:
>これはブロック引用です。 この
段落はXNUMX行あります。
> 1。これはブロック引用符内のリストです。
2番目の項目。
ブロック引用符に含めることができるブロック要素の中には、他のブロック引用符があります。
つまり、ブロック引用符はネストできます。
>これはブロック引用です。
>
>>ブロック引用符内のブロック引用符。
>文字の後にオプションのスペースが続く場合、そのスペースはの一部と見なされます
内容のインデントの一部ではなく、ブロック引用符マーカー。 したがって、置くために
ブロック引用符でインデントされたコードブロック。>の後にXNUMXつのスペースが必要です。
>コード
拡張: ブロック引用の前の空白
標準のMarkdown構文では、ブロック引用符の前に空白行は必要ありません。 Pandocは
これが必要です(もちろん、ドキュメントの冒頭を除く)。 の理由
要件は、>が行の先頭に到達するのは非常に簡単であるということです。
事故(おそらく行の折り返しによる)。 したがって、markdown_strict形式を使用しない限り、
以下は、pandocでネストされたブロック引用符を生成しません。
>これはブロック引用です。
>>ネストされています。
逐語的に (コード) ブロック
インデント コード ブロック
XNUMXつのスペース(またはXNUMXつのタブ)でインデントされたテキストのブロックは、逐語的なテキストとして扱われます。つまり、
特殊文字は特殊フォーマットをトリガーせず、すべてのスペースと改行はトリガーされます
保存されます。 例えば、
if(a> 3){
moveShip(5 *重力、DOWN);
}
最初の(XNUMXつのスペースまたはXNUMXつのタブ)インデントは、逐語的な部分とは見なされません
テキストであり、出力から削除されます。
注:逐語的なテキストの空白行は、XNUMXつのスペースで始める必要はありません。
フェンス付き コード ブロック
拡張: フェンスで囲まれたコードブロック
標準のインデントされたコードブロックに加えて、pandocはサポートします フェンスで囲まれた コードブロック。 これらは
XNUMXつ以上のチルダ(〜)の行で始まり、チルダの行で終わります。
少なくとも開始行と同じ長さ。 これらの行の間はすべてコードとして扱われます。 番号
インデントが必要です:
~~~~~~~
if(a> 3){
moveShip(5 *重力、DOWN);
}
~~~~~~~
通常のコードブロックと同様に、フェンスで囲まれたコードブロックは、周囲のテキストから次のように区切る必要があります。
空白行。
コード自体にチルダまたはバックティックの行が含まれている場合は、より長いチルダの行を使用してください
または開始時と終了時のバックティック:
~~~~~~~~~~~~~~~~
~~~~~~~~~~
チルダを含むコード
~~~~~~~~~~
~~~~~~~~~~~~~~~~
拡張: backtick_code_blocks
Fenced_code_blocksと同じですが、チルダ(〜)の代わりにバッククォート( `)を使用します。
拡張: フェンスで囲まれたコード属性
オプションで、次の構文を使用して、フェンスで囲まれたコードブロックまたはバックティックコードブロックに属性をアタッチできます。
~~~~ {#mycode .haskell .numberLines startFrom = "100"}
qsort [] = []
qsort(x:xs)= qsort(filter(<x)xs)++ [x] ++
qsort(フィルター(> = x)xs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ここで、mycodeは識別子、haskellとnumberLinesはクラス、startFromは
値が100の属性。一部の出力形式では、この情報を使用して構文を実行できます。
ハイライト。 現在、この情報を使用する出力形式はHTMLと
ラテックス。 出力形式と言語で強調表示がサポートされている場合は、コード
上のブロックは、番号付きの行で強調表示されます。 (どの言語であるかを確認するには
サポートされています。pandoc--versionを実行してください。)それ以外の場合、上記のコードブロックは次のように表示されます。
...
ショートカットフォームを使用して、コードブロックの言語を指定することもできます。
`` `haskell
qsort [] = []
`` `
これは次と同等です。
`` `{.haskell}
qsort [] = []
`` `
Fenced_code_attributes拡張機能が無効になっているが、入力にクラス属性が含まれている場合
コードブロックの場合、ファーストクラス属性はオープニングフェンスの後に次のように出力されます。
素朴な言葉。
すべての強調表示を防ぐには、-no-highlightフラグを使用します。 ハイライトスタイルを設定するには、
--highlight-styleを使用します。 ハイライトの詳細については、構文のハイライトを参照してください。
を参照してください。
LINE ブロック
拡張: ラインブロック
ラインブロックは、垂直バー(|)で始まり、その後にスペースが続く一連のラインです。
行への分割は、先頭のスペースと同様に、出力で保持されます。
それ以外の場合、行はMarkdownとしてフォーマットされます。 これは詩と
住所:
| リムリックパックは解剖学的に笑う
| かなり経済的な宇宙で。
| しかし、私が見た良いもの
| だからめったにきれいではない
| そして、きれいなものはめったにコミカルではありません
| 200メインストリート
| バークレー、CA 94718
行は必要に応じてハードラップできますが、継続行は
スペース。
| 閣下最も尊敬され、義にかなったサミュエルL.
巡査、ジュニア
| 200メインストリート
| バークレー、CA 94718
この構文はreStructuredTextから借用しています。
リスト
弾丸 lists
箇条書きは、箇条書きの項目のリストです。 箇条書きの項目は箇条書きで始まります
(*、+、または-)。 簡単な例を次に示します。
* XNUMX
* XNUMX
* 三つ
これにより、「コンパクト」リストが作成されます。 各アイテムが含まれる「緩い」リストが必要な場合
段落としてフォーマットし、項目の間にスペースを入れます。
* XNUMX
* XNUMX
* 三つ
弾丸は左マージンと同じ高さである必要はありません。 それらはXNUMX、XNUMX、またはインデントされている可能性があります
XNUMXつのスペース。 箇条書きの後には空白を付ける必要があります。
リストアイテムは、後続の行が最初の行(箇条書きの後)と同じ高さである場合に最もよく見えます。
*これが私の最初です
リストアイテム。
*そして私のXNUMX番目。
しかし、Markdownは「怠惰な」フォーマットも許可します。
*これが私の最初です
リストアイテム。
*そして私のXNUMX番目。
この XNUMX空間 ルール
リストアイテムには、複数の段落やその他のブロックレベルのコンテンツが含まれる場合があります。 でも、
後続の段落の前には空白行を置き、XNUMXつのスペースまたはタブをインデントする必要があります。
最初の段落を残りの段落と揃えると、リストの見栄えが良くなります。
* 第一段落。
続きました。
* XNUMX番目の段落。 インデントする必要があるコードブロック付き
XNUMXつのスペース:
{コード}
リストアイテムには、他のリストが含まれる場合があります。 この場合、前の空白行はオプションです。
ネストされたリストは、XNUMXつのスペースまたはXNUMXつのタブでインデントする必要があります。
*果物
+りんご
-マッキントッシュ
-レッドデリシャス
+梨
+桃
* 野菜
+ブロッコリー
+フダンソウ
上記のように、Markdownを使用すると、インデントする代わりに、リストアイテムを「怠惰に」書き込むことができます。
継続行。 ただし、リストに複数の段落または他のブロックがある場合
アイテムの場合、それぞれの最初の行をインデントする必要があります。
+怠惰な、怠惰な、リスト
項目。
+もうXNUMXつ; これは見える
悪いですが合法です。
XNUMX番目のXNUMX番目の段落
リストアイテム。
ご注意: 継続段落のXNUMXスペースの規則は、公式からのものですが
Markdown構文ガイド、リファレンス実装、Markdown.plはそれに続きません。 そう
著者がインデントした場合、pandocはMarkdown.plとは異なる結果を返します
XNUMXスペース未満の継続段落。
Markdown構文ガイドは、XNUMXスペースルールがに適用されるかどうかを明示していません を
リストアイテムのブロックレベルのコンテンツ。 段落とコードブロックについてのみ言及しています。 しかし、それは
ルールがすべてのブロックレベルのコンテンツ(ネストされたリストを含む)に適用されることを意味し、
pandocはそれをそのように解釈します。
順序付けられました lists
順序付きリストは、項目が列挙子で始まることを除いて、箇条書きと同じように機能します
弾丸ではなく。
標準のマークダウンでは、列挙子はXNUMX進数の後にピリオドとスペースが続きます。
番号自体は無視されるため、このリストに違いはありません。
1つ
2つ
3つ
そしてこれ:
5つ
7つ
1つ
拡張: ファンシーリスト
標準のマークダウンとは異なり、pandocでは順序付きリストアイテムを大文字でマークすることができます。
アラビア数字に加えて、小文字とローマ数字。 リストマーカーは
括弧で囲まれるか、単一の右括弧またはピリオドが続きます。 彼らはする必要があります
後続のテキストから少なくともXNUMXつのスペースで区切られ、リストマーカーが
ピリオド付きの大文字、少なくともXNUMXつのスペース。
fancy_lists拡張機能を使用すると、代わりに「#」を順序付きリストマーカーとして使用することもできます。
数字:
#。 XNUMX
#。 XNUMX
拡張: 開始番号
Pandocは、使用されるリストマーカーの種類と、開始番号にも注意を払います。
これらは両方とも、可能な場合は出力形式で保持されます。 したがって、次の
数字の後に9から始まる単一の括弧が続くリストを生成し、
小文字のローマ数字のサブリスト:
9)XNUMX番目
10)XNUMX番目
11)XNUMX番目
私。 サブワン
ii。 サブツー
iii。 サブスリー
Pandocは、異なるタイプのリストマーカーが使用されるたびに、新しいリストを開始します。 だから、
以下はXNUMXつのリストを作成します。
(2)XNUMXつ
(5)XNUMXつ
1。 四
* 五
デフォルトのリスト マーカーが必要な場合は、#. を使用します。
#。 XNUMX
#。 XNUMX
#。 三つ
定義 lists
拡張: Definition_lists
Pandocは、PHP Markdown Extraの構文を使用して、定義リストをサポートしています。
拡張機能
期間1
:定義1
*インラインマークアップ*を使用した用語2
:定義2
{一部のコード、定義2の一部}
定義2のXNUMX番目の段落。
各用語はXNUMX行に収まる必要があり、オプションで空白行が続く場合があり、
その後にXNUMXつ以上の定義が続きます。 定義はコロンまたはチルダで始まります。
XNUMXつまたはXNUMXつのスペースをインデントできます。
用語には複数の定義があり、各定義はXNUMXつ以上のブロックで構成されている場合があります
要素(段落、コードブロック、リストなど)、それぞれXNUMXつのスペースまたはXNUMXつのタブストップをインデントします。
定義の本文(コロンまたはチルダを除く最初の行を含む)
XNUMXつのスペースをインデントする必要があります。 ただし、他のMarkdownリストと同様に、「怠惰に」することができます
段落または他のブロック要素の先頭を除いて、インデントを省略します。
期間1
: 意味
怠惰な継続で。
定義のXNUMX番目の段落。
(上記の例のように)定義の前にスペースを残すと、
定義は段落として扱われます。 一部の出力形式では、これはより大きなものを意味します
用語/定義のペア間の間隔。 よりコンパクトな定義リストについては、スペースを省略してください
定義の前に:
期間1
~ 定義 1
期間2
~ 定義 2a
~ 定義 2b
定義リスト内の項目間にスペースが必要であることに注意してください。 (緩むバリアント
この要件は、「怠惰な」ハードラッピングを許可していませんが、次のようにアクティブ化できます
compact_definition_lists: 以下の Pandoc 以外の拡張機能を参照してください。)
番号が付けられました 例 lists
拡張: 例のリスト
特別なリスト マーカー @ は、連続番号の例に使用できます。 最初のリスト
@ マーカーの付いた項目には、「1」、次の「2」、というように番号が付けられます。
資料。 番号付きの例は、単一のリストに含まれる必要はありません。 @ を使用したそれぞれの新しいリスト
最後に停止した場所を取り上げます。 たとえば、次のようになります。
(@) 私の最初の例には番号 (1) が付けられます。
(@) 私の 2 番目の例には番号 (XNUMX) が付けられます。
例の説明。
(@) 私の 3 番目の例には番号 (XNUMX) が付けられます。
番号付きの例にはラベルを付けて、ドキュメントの他の場所で参照できます。
(@good) これは良い例です。
(@good) が示すように、...
ラベルには、英数字、アンダースコア、またはハイフンの任意の文字列を使用できます。
コンパクト と 緩い lists
Pandoc は、リストを含む一部の「エッジ ケース」で Markdown.pl とは異なる動作をします。
このソースを検討してください:
+最初
+ XNUMX 番目:
- 手数料
- ファイ
- 敵
+ サード
Pandoc はこれを「コンパクト リスト」に変換します ( 「First」、「Second」、
または "Third")、Markdown は"Second" と "Third" の周りのタグ (ただし "First" ではない)、
「Third」の周りに空白があるためです。 Pandoc は単純なルールに従います: テキストが
その後に空白行が続くと、段落として扱われます。 「Second」の後には
空行ではなく、段落として扱われません。 リストがあるという事実
の後に空白行が続くことは関係ありません。 (注: Pandoc は、
markdown_strict 形式を指定します。 この動作は公式と一致しています。
Markdown.pl とは異なりますが、Markdown 構文の説明)。
終了 a リスト
リストの後にインデントされたコード ブロックを置きたい場合はどうしますか?
- アイテムXNUMX
- 項目 XNUMX
{私のコードブロック}
問題! ここで、pandoc は (他の Markdown 実装と同様に) { my code block } を次のように扱います。
コード ブロックとしてではなく、項目 XNUMX の XNUMX 番目の段落。
項目 XNUMX の後にリストを「切り取る」には、インデントされていないコンテンツを挿入できます。
HTML コメント。どの形式でも目に見える出力は生成されません。
- アイテムXNUMX
- 項目 XNUMX
{私のコードブロック}
XNUMX つの大きなリストではなく XNUMX つの連続したリストが必要な場合は、同じトリックを使用できます。
1つ
2つ
3つ
1つ
2.ドス
3.トレス
水平な ルール
XNUMX つ以上の *、-、または _ 文字の行を含む行 (必要に応じて、
スペース) は、水平方向の罫線を生成します。
* * * *
---------------
テーブル類
XNUMX 種類のテーブルを使用できます。 最初の XNUMX 種類は、
Courier などの等幅フォント。 XNUMX 番目の種類は、比例間隔で使用できます
列を並べる必要がないためです。
拡張: テーブルキャプション
オプションで、4 種類のテーブルすべてにキャプションを付けることができます (
以下に例を示します)。 キャプションは、文字列 Table: (または単に :) で始まる段落です。
これは取り除かれます。 テーブルの前または後に表示されます。
拡張: シンプルテーブル
簡単なテーブルは次のようになります。
右 左 中央 デフォルト
------- ------ ---------- -------
12 12 12 12
123 123 123 123
1 1 1 1
表: 簡単なテーブル構文のデモ。
ヘッダーと表の行は、それぞれ XNUMX 行に収まる必要があります。 列の配置は、
その下の破線に対するヘッダー テキストの位置:
· 破線が右側のヘッダー テキストとぴったり重なっているが、ヘッダー テキストを超えている場合
左側では、列は右揃えです。
· 破線が左側のヘッダー テキストとぴったり重なっているが、それを超えている場合
右側では、列は左揃えです。
· 破線が両側のヘッダー テキストを超える場合、列は中央に配置されます。
· 破線が両側のヘッダー テキストと同じ高さになっている場合、デフォルトの配置は次のとおりです。
使用されます (ほとんどの場合、これは残されます)。
テーブルは空白行で終了するか、またはダッシュの行とその後に空白行が続く必要があります。
表の終わりに破線が使用されている場合、列ヘッダーは省略できます。 為に
例:
------- ------ ---------- -------
12 12 12 12
123 123 123 123
1 1 1 1
------- ------ ---------- -------
ヘッダーが省略されている場合、列の配置は最初の行に基づいて決定されます
テーブル本体の。 したがって、上記の表では、列は右、左、中央、および
それぞれ右揃え。
拡張: 複数行テーブル
複数行の表では、ヘッダーと表の行が複数行のテキストにまたがることができます (ただし、セルは
テーブルの複数の列または行にまたがるテーブルはサポートされていません)。 次に例を示します。
-------------------------------------------------- -----------
中央揃え デフォルト 右 左
ヘッダー 整列 整列 整列
----------- ------- --------------- ----------------- --------
最初の行 12.0 行の例
複数の行にまたがります。
5.0行目 XNUMX もう一つ。 ノート
間の空行
行。
-------------------------------------------------- -----------
表: これがキャプションです。 それもまた広がるかもしれない
複数行。
これらは単純なテーブルのように機能しますが、次の違いがあります。
· ヘッダー テキストの前にダッシュの行で始まる必要があります (ヘッダーが
省略)。
· それらは一列のダッシュで終わり、次に空白行で終わる必要があります。
· 行は空白行で区切る必要があります。
複数行のテーブルでは、テーブル パーサーは列の幅に注意を払い、
ライターは、出力でこれらの相対的な幅を再現しようとします。 だから、あなたがそれを見つけたら
出力の列が狭すぎるため、Markdown ソースで幅を広げてみてください。
複数行の表や単純な表では、ヘッダーを省略できます。
----------- ------- --------------- ----------------- --------
最初の行 12.0 行の例
複数の行にまたがります。
5.0行目 XNUMX もう一つ。 ノート
間の空行
行。
----------- ------- --------------- ----------------- --------
: これはヘッダーのない複数行のテーブルです。
複数行のテーブルに XNUMX 行しかない場合もありますが、その行をたどる必要があります
空白行 (およびテーブルを終了するダッシュの行) によって、またはテーブルは
単純なテーブルとして解釈されます。
拡張: グリッドテーブル
グリッド テーブルは次のようになります。
: サンプル グリッド テーブル。
+--------------+---------------+------------------ ---+
| | フルーツ | フルーツ価格 | 利点 |
+===============+===============+================= ===+
| | バナナ | $1.34 | - 組み込みラッパー |
| | | | | | - 明るい色 |
+--------------+---------------+------------------ ---+
| | オレンジ | オレンジ$2.10 | - 壊血病を治す |
| | | | | | - おいしい |
+--------------+---------------+------------------ ---+
=s の行は、ヘッダーをテーブル本体から分離します。
ヘッダーのないテーブル。 グリッド テーブルのセルには、任意のブロック要素 (複数の要素) を含めることができます。
段落、コード ブロック、リストなど)。 配置はサポートされておらず、セルもサポートされていません。
複数の列または行にまたがる。 グリッド テーブルは、Emacs テーブル モードを使用して簡単に作成できます。
拡張: パイプテーブル
パイプ テーブルは次のようになります。
| | 右 | 左 | 左 | デフォルト | センター |
|------:|:-----|-----------|:------:|
| | 12 | 12 | 12 | 12 |
| | 123 | 123 | 123 | 123 |
| | 1 | 1 | 1 | 1 |
: パイプ テーブル構文のデモ。
構文は PHP Markdown Extra テーブルと同じです。 パイプの始まりと終わり
文字はオプションですが、すべての列の間にパイプが必要です。 コロンは
列の配置は図のとおりです。 ヘッダーは省略できません。 ヘッダーのないテーブルをシミュレートするには、
空白のセルを含むヘッダーを含めます。
パイプは列の境界を示しているため、列を垂直方向に揃える必要はありません。
それらは上記の例にあります。 したがって、これは完全に正当な (醜い) パイプ テーブルです。
フルーツ| 価格
--|-----:
りんご|2.05
ナシ|1.37
オレンジ|3.09
パイプ テーブルのセルには、段落やリストなどのブロック要素を含めることはできません。
複数行にまたがることはできません。 パイプ テーブルに、印刷可能なコンテンツが
列幅より広い場合 (--columns を参照)、セルの内容は次のように折り返されます。
区切り線の幅によって決定される相対的なセル幅。
注: pandoc は、次の形式のパイプ テーブルも認識します。
Emacs の orgtbl-mode:
| | XNUMX つ | XNUMX |
|-----+------|
| | 私の| テーブル |
| | です | いいね |
違いは、| の代わりに + が使用されることです。 その他の orgtbl 機能はサポートされていません。
特に、デフォルト以外の列の配置を取得するには、上記のようにコロンを追加する必要があります。
ブロック
拡張: pandoc_title_block
ファイルが表題欄で始まる場合
% 題名
% 著者 (セミコロン区切り)
% 日にち
通常のテキストではなく、書誌情報として解析されます。 (これは、
たとえば、スタンドアロンの LaTeX または HTML 出力のタイトルに表示されます。) ブロックには、
タイトル、タイトルと著者、または XNUMX つの要素すべて。 著者を含めたいが、
タイトルがない場合、またはタイトルと日付はあるが著者がいない場合は、空白行が必要です。
%
% 著者
%私の肩書
%
% 15 年 2006 月 XNUMX 日
タイトルは複数の行を占める場合がありますが、継続行は先行スペースで開始する必要があります。
したがって:
%私の肩書
複数行で
ドキュメントに複数の著者がいる場合、著者は行頭に改行を付けて別の行に配置できます。
スペース、またはセミコロンで区切られた、またはその両方。 したがって、以下はすべて同等です。
% 著者 XNUMX
著者 XNUMX
% 著者 XNUMX; 著者 XNUMX
% 著者 XNUMX;
著者 XNUMX
日付は XNUMX 行に収まる必要があります。
XNUMX つのメタデータ フィールドにはすべて、標準のインライン形式 (斜体、リンク、
脚注など)。
タイトル ブロックは常に解析されますが、出力に影響するのは、
--standalone (-s) オプションが選択されています。 HTML 出力では、タイトルは XNUMX 回表示されます。
ドキュメント ヘッド -- これは、ブラウザのウィンドウの上部に表示されるタイトルです。
-- そして、ドキュメント本文の先頭に XNUMX 回。 ドキュメント ヘッドのタイトルは、次のことができます。
オプションのプレフィックスが付加されています (--title-prefix または -T オプション)。 本文中のタイトル
クラス「タイトル」のH1要素として表示されるため、抑制または再フォーマットできます
CSS。 タイトル プレフィックスが -T で指定され、ドキュメントにタイトル ブロックが表示されない場合、
タイトル プレフィックスは、HTML タイトルとして単独で使用されます。
man ページ ライターは、タイトル、man ページのセクション番号、およびその他のヘッダーとフッターを抽出します。
タイトル行からの情報。 タイトルは、タイトルの最初の単語と見なされます
オプションで、括弧内の (XNUMX 桁の) セクション番号で終了することもできます。
(タイトルと括弧の間にはスペースを入れないでください。)
追加のフッターおよびヘッダー テキストと見なされます。 単一のパイプ文字 (|) は、
フッター テキストをヘッダー テキストから分離するために使用されます。 したがって、
% パンドック(1)
タイトルが PANDOC でセクション 1 の man ページが生成されます。
% パンドック(1) Pandoc ユーザーマニュアル
フッターには「Pandoc User Manuals」もあります。
% パンドック(1) Pandoc ユーザーマニュアル | バージョン 4.0
ヘッダーには「バージョン 4.0」も含まれます。
拡張: yaml_metadata_block
YAML メタデータ ブロックは、XNUMX つのハイフン (---) の行で区切られた有効な YAML オブジェクトです。
上部に XNUMX つのハイフン (---) または XNUMX つのドット (...) の行が下部にあります。 YAML
メタデータ ブロックはドキュメントのどこにでも発生する可能性がありますが、先頭にない場合は、
空白行が前になければなりません。 ( pandoc が連結する方法のため、注意してください。
複数の入力ファイルが提供されている場合は、メタデータを別の YAML に保持することもできます
ファイルを作成し、Markdown ファイルとともに引数として pandoc に渡します。
pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o book.html
YAML ファイルが --- で始まり、--- または .... で終わることを確認してください)。
メタデータは YAML オブジェクトのフィールドから取得され、既存のすべてのフィールドに追加されます
ドキュメントのメタデータ。 メタデータには、(任意にネストされた) リストとオブジェクトを含めることができますが、すべて
文字列スカラーは Markdown として解釈されます。 名前がアンダースコアで終わるフィールド
pandoc によって無視されます。 (外部プロセッサによって役割が与えられる場合があります。)
ドキュメントには、複数のメタデータ ブロックが含まれる場合があります。 メタデータ フィールドが結合されます
スルー 左寄り 組合: XNUMX つのメタデータ ブロックが同じフィールドを設定しようとすると、
最初のブロックの値が取得されます。
pandoc を -t markdown とともに使用して Markdown ドキュメントを作成すると、YAML メタデータ ブロック
-s/--standalone オプションが使用されている場合にのみ生成されます。 すべてのメタデータは
ドキュメントの先頭に XNUMX つのブロックで表示されます。
YAML エスケープ規則に従う必要があることに注意してください。 したがって、たとえば、タイトルに
コロン、引用符で囲む必要があります。 パイプ文字 (|) を使用して、インデントされたブロックを開始できます
エスケープする必要なく、文字どおりに解釈されます。 このフォームは必須です
フィールドに空白行が含まれている場合:
---
title: 'これがタイトルです: コロンが含まれています'
著者:
- 名前: 著者一
所属: どこかの大学
- 名前: 著者 XNUMX
所属:ノーウェア大学
タグ: [無、無]
要約: |
これがアブストラクトです。
これは XNUMX つの段落で構成されています。
...
テンプレート変数は、メタデータから自動的に設定されます。 したがって、たとえば、
HTML を書くと、変数 abstract は HTML の Markdown に相当するものに設定されます。
抽象フィールド:
これがアブストラクトです。
これは XNUMX つの段落で構成されています。
注: デフォルト テンプレートの作成者変数は、単純なリストまたは文字列を想定しています。 に
例で構造化された作成者を使用すると、カスタム テンプレートが必要になります。 例えば:
$ for(作成者)$
$if(作者名)$
$著者名$$if(著者所属)$ ($著者所属$)$endif$
$ else $
$作者$
$ endif $
$ endfor $
バックスラッシュ エスケープ
拡張: all_symbols_escapable
コード ブロックまたはインライン コード内を除き、句読点またはスペース文字の前に
バックスラッシュは、通常は書式設定を示すものであっても、文字どおりに扱われます。
したがって、たとえば次のように書くと、
*\*こんにちは\**
XNUMXつが得られます
*こんにちは*
こんにちは
このルールは、標準の Markdown のルールよりも覚えやすいです。
バックスラッシュでエスケープする次の文字:
\`*_{}[]()>#+-.!
(ただし、markdown_strict 形式を使用すると、標準の Markdown ルールが使用されます。)
バックスラッシュでエスケープされたスペースは、非改行スペースとして解析されます。 TeX出力に表示されます
~ として、HTML および XML では \ または \ として。
バックスラッシュでエスケープされた改行 (つまり、行末のバックスラッシュ) が解析されます
ハードラインブレイクとして。 TeX 出力では \\ として、HTML では次のように表示されます。 . これは
XNUMX つを使用して強い改行を示す Markdown の「見えない」方法の優れた代替手段
行の末尾のスペース。
バックスラッシュのエスケープは、そのままのコンテキストでは機能しません。
スマート 句読点
拡張
--smart オプションが指定されている場合、pandoc は印刷上の正しい出力を生成します。
ストレート クォーテーションをカーリー クォーテーションに、--- エム ダッシュに、-- エン ダッシュに、そして ... に変換します。
楕円。 「Mr.」などの特定の略語の後には、改行なしのスペースが挿入されます。
注: LaTeX テンプレートまたは含まれているヘッダー ファイルが csquotes パッケージを呼び出す場合、
pandoc はこれを自動的に検出し、引用テキストに \enquote{...} を使用します。
列をなして 書式設定
強調
に 強調する 次のように、テキストを *s または _ で囲みます。
このテキストは_アンダースコアで強調_されており、これは
*アスタリスクで強調*されています。
二重の * または _ が生成します 強い 強調:
これは **強調** であり、__アンダースコア付き__です。
スペースで囲まれた、またはバックスラッシュでエスケープされた * または _ 文字は、強調をトリガーしません。
これは * 強調されていません * で、\*どちらでもない\*です。
拡張: intraword_underscores
_ は単語や識別子の中で使用されることがあるため、pandoc は _ を解釈しません。
強調マーカーとして英数字で囲まれています。 強調したい場合
単語の一部、* を使用:
実行可能*可能*、実行可能*不可能*。
三振
拡張: 三振
テキストのセクションを水平線で打ち消すには、~~ で始めて終わります。 したがって、
例えば、
これは~~削除されたテキストです~~
上付き文字 と 下付き文字
拡張: 上付き文字、 添字
上付き文字は、上付きテキストを ^ 文字で囲むことによって書くことができます。
下付き文字は、下付きテキストを ~ 文字で囲むことによって記述できます。 したがって、
例、
H~2~Oは液体です。 2^10^ は 1024 です。
上付き文字または下付き文字のテキストにスペースが含まれている場合、これらのスペースをエスケープする必要があります
バックスラッシュ付き。 (これは、誤って上付き文字や下付き文字を使用することを防ぐためです。
通常の ~ と ^ の使用) したがって、下付き文字に 'a cat' を含む文字 P が必要な場合は、
P~a cat~ ではなく、P~a\ cat~ を使用してください。
逐語的に
テキストの短いスパンを逐語的に作成するには、バッククォート内に置きます。
`>>=` と `>>` の違いは何ですか?
逐語的なテキストにバッククォートが含まれている場合は、XNUMX つのバッククォートを使用します。
これは文字どおりのバッククォート `` ` `` です。
(開始のバックティックの後と終了のバッククォートの前のスペースは無視されます。)
一般的なルールは、逐語スパンは連続するバッククォートの文字列で始まることです
(オプションでスペースが続きます)、同じ数のバッククォートの文字列で終わります
(オプションで前にスペースを入れます)。
バックスラッシュエスケープ (およびその他の Markdown コンストラクト) はそのままでは機能しないことに注意してください。
コンテキスト:
これは、バックスラッシュの後にアスタリスクを付けたものです: `\*`。
拡張: inline_code_attributes
フェンスで囲まれたコード ブロックと同じように、属性をそのままのテキストに付けることができます。
`<$>`{.haskell}
S キャップ
小文字を記述するには、HTML の span タグを使用できます。
小さな帽子
(セミコロンはオプションで、コロンの後にスペースがあってもかまいません。)
小文字をサポートする出力形式。
数学
拡張: tex_math_dollars
XNUMX つの $ 文字の間にあるものはすべて、TeX 数学として扱われます。 冒頭の $ には
そのすぐ右にスペース以外の文字があり、最後の $ にはスペース以外の文字が必要です
文字はそのすぐ左にあり、直後に数字を続けてはなりません。 したがって、
$20,000 と $30,000 は数学として解析されません。 何らかの理由でテキストを囲む必要がある場合
リテラルの $ 文字、それらをバックスラッシュでエスケープすると、数学の区切り文字として扱われません。
TeX 数学はすべての出力形式で出力されます。 レンダリング方法は出力によって異なります
フォーマット:
マークダウン、 ラテックス、 Emacs オルガン モード、 環境
$ 文字の間に逐語的に表示されます。
reStructuredText
解釈されたテキストの役割 :math: を使用してレンダリングされます。
AsciiDoc
latexmath:[...] としてレンダリングされます。
テックスインフォ
@math コマンド内でレンダリングされます。
グロフ man
$ なしで逐語的にレンダリングされます。
メディアウィキ、 DokuWiki
内部でレンダリングされますタグ。
テキスタイル
タグ内でレンダリングされます。
RTF、 OpenDocument、 ODT
可能であれば、Unicode 文字を使用してレンダリングされます。
文字通り現れる。
DocBook
--mathml フラグが使用されている場合、インライン方程式で MathML を使用してレンダリングされます。
または非公式タグ。 それ以外の場合は、可能であれば Unicode を使用してレンダリングされます
文字。
Docx OMML 数学マークアップを使用してレンダリングされます。
フィクションブック2
--webtex オプションを使用すると、数式は Google Charts を使用して画像としてレンダリングされます。
または他の互換性のある Web サービスをダウンロードし、電子書籍に埋め込んでください。 さもないと、
それらは逐語的に表示されます。
HTML、 スライディ、 DZスライド、 S5、 EPUB
数学が HTML でレンダリングされる方法は、選択したコマンドライン オプションによって異なります。
1. デフォルトでは、Unicode 文字を使用して可能な限り TeX 数学をレンダリングします。
RTF、DocBook、および OpenDocument 出力と同様です。 数式はスパン内に配置されます
class="math" を使用して、周囲とは異なるスタイルにすることができます
必要に応じてテキスト。
2. --latexmathml オプションを使用すると、TeX 数学が $ または $$ の間に表示されます。
クラス LaTeX のタグを付けます。 LaTeXMathML スクリプトは、
数式としてレンダリングするために使用されます。 (このトリックはすべてのブラウザーで機能するとは限りません。
しかし、それはFirefoxで動作します。 LaTeXMathML、TeX mathML をサポートしていないブラウザーでは、
$ 文字の間に逐語的に表示されます。)
3. --jsmath オプションを使用すると、TeX 数学がタグ内に配置されます (
インライン計算) またはクラス math を含むタグ (表示用 math)。 jsMath
スクリプトを使用してレンダリングします。
4. --mimetex オプションを使用すると、mimeTeX CGI スクリプトが呼び出されて
TeX 式ごとに画像を生成します。 これはすべてのブラウザで機能するはずです。 の
--mimetex オプションは、オプションの URL を引数として取ります。 URL が指定されていない場合は、
mimeTeX CGI スクリプトが /cgi-bin/mimetex.cgi にあると想定されます。
5. --gladtex オプションを使用すると、TeX 式はのタグ
HTML出力。 結果の htex ファイルは、gladTeX で処理できます。
これにより、各式の画像ファイルと、へのリンクを含む HTML ファイルが生成されます。
これらの画像。 したがって、手順は次のとおりです。
pandoc -s --gladtex myfile.txt -o myfile.htex
グラッドテックス -d myfile-images myfile.htex
# myfile.html と myfile-images に画像を生成します
6. --webtex オプションを使用すると、TeX 式は次のように変換されます。 タグ
数式を画像に変換する外部スクリプトにリンクします。 式
URL エンコードされ、提供された URL と連結されます。 URLがない場合
指定すると、Google Chart API が使用されます
(http://chart.apis.google.com/chart?cht=tx&chl=)。
7. --mathjax オプションを使用すると、\(...\) の間に TeX 数学が表示されます (
inline math) または \[...\] (display math 用) を使用し、class でタグを挿入します。
算数。 MathJax スクリプトを使用して、数式としてレンダリングします。
Raw HTML
拡張: raw_html
Markdown を使用すると、生の HTML (または DocBook) をドキュメントの任意の場所に挿入できます (例外を除く)。
<、>、および & は文字どおりに解釈されます)。 (技術的にはそうではありません
標準のMarkdownで許可されているため、拡張機能ですが、拡張機能になっているため、
必要に応じて無効にすることができます。)
生の HTML は、HTML、S5、Slidy、Slideous、DZSlides、EPUB、
マークダウン、およびテキスタイル出力、および他の形式での抑制。
拡張: markdown_in_html_blocks
標準の Markdown では、HTML の「ブロック」を含めることができます: バランスのとれた HTML のブロック
周囲のテキストから空白行で区切られたタグで、開始位置と終了位置は
左マージン。 これらのブロック内では、すべてが Markdown ではなく HTML として解釈されます。 それで
(例) * は強調を意味しません。
markdown_strict 形式が使用されている場合、Pandoc はこのように動作します。 しかし、デフォルトでは pandoc
HTML ブロック タグ間のマテリアルを Markdown として解釈します。 したがって、たとえば pandoc は
ターン
*XNUMX*
[リンク](http://google.com)
に
XNUMX
<a href="/http://google.com">リンク
一方、Markdown.pl はそれをそのまま保持します。
この規則には例外が XNUMX つあります。 and tags is not
マークダウンとして解釈されます。
この標準的な Markdown からの逸脱により、Markdown と HTML の混合が容易になるはずです。
ブロック要素。 たとえば、Markdown テキストのブロックを次のように囲むことができます。 タグ
Markdown として解釈されるのを妨げずに。
拡張: native_div
内部のコンテンツにネイティブの pandoc Div ブロックを使用するタグ。 ほとんどの場合、これは
markdown_in_html_blocks と同じ出力が得られますが、pandoc の記述が容易になります
ブロックのグループを操作するフィルター。
拡張: ネイティブスパン
タグ内のコンテンツには、ネイティブの pandoc Span ブロックを使用します。 ほとんどの場合、これ
raw_html と同じ出力が得られるはずですが、pandoc フィルターの書き込みが容易になります。
インラインのグループを操作します。
Raw TeX
拡張: 生テックス
生の HTML に加えて、pandoc では、生の LaTeX、TeX、および ConTeXt を
資料。 インライン TeX コマンドは保持され、変更されずに LaTeX に渡されます。
ConTeXt ライター。 したがって、たとえば、LaTeX を使用して BibTeX の引用を含めることができます。
この結果は \cite{jones.1967} で証明されました。
LaTeX 環境では、次のように注意してください。
\begin{表形式}{|l|l|}\hline
年齢と頻度 \\ \hline
18--25 & 15 \\
26--35 & 33 \\
36--45 & 22 \\ \hline
\ end {tabular}
開始タグと終了タグの間の内容は、生の LaTeX として解釈されます。
マークダウン。
Inline LaTeX は、Markdown、LaTeX、および ConTeXt 以外の出力形式では無視されます。
ラテックス マクロ
拡張: ラテックスマクロ
LaTeX 以外の出力形式の場合、pandoc は LaTeX の \newcommand と \renewcommand を解析します
定義を作成し、結果のマクロをすべての LaTeX 数学に適用します。 したがって、たとえば、
以下は、LaTeX だけでなく、すべての出力形式で機能します。
\newcommand{\tuple}[1]{\langle #1 \rangle}
$\タプル{a, b, c}$
LaTeX 出力では、 \newcommand 定義は変更されずにそのまま出力に渡されます。
リンク
Markdown では、いくつかの方法でリンクを指定できます。
オートマチック リンク
URL やメール アドレスを角かっこで囲むと、リンクになります。
<http://google.com>
<[メール保護]>
列をなして リンク
インライン リンクは、角括弧内のリンク テキストと、その後に続く URL で構成されます。
括弧。 (オプションで、URL の後に引用符で囲まれたリンク タイトルを続けることができます。)
これは [インライン リンク](/url) です。
タイトル](http://fsf.org 「ここをクリックして楽しい時間を過ごしてください!」)。
括弧で囲まれた部分と括弧で囲まれた部分の間にスペースを入れることはできません。 リンク
テキストには書式設定 (強調など) を含めることができますが、タイトルには含めることができません。
インライン リンクの電子メール アドレスは自動検出されないため、接頭辞を付ける必要があります。
mailto:
[私に書いて!](mailto:[メール保護])
参照 リンク
An 明白な 参照リンクには、リンク自体とリンク定義の XNUMX つの部分があります。
ドキュメントの他の場所 (リンクの前または後) に発生する可能性があります。
リンクは、角括弧内のリンク テキストと、それに続く角括弧内のラベルで構成されます。
(XNUMX つの間にスペースを入れることができます。) リンクの定義は、角かっこで囲まれたラベルで構成されます。
その後にコロンとスペースが続き、その後に URL が続き、オプションで (スペースの後に)
リンクのタイトルを引用符または括弧で囲みます。 ラベルは、として解析可能であってはなりません
引用 (引用拡張機能が有効になっていると仮定): 引用は優先されます
リンク ラベル。
ここではいくつかの例は、次のとおりです。
[私のラベル 1]: /foo/bar.html "私のタイトル、オプション"
[私のラベル 2]: /foo
[私のラベル 3]: http://fsf.org (フリーソフトウェア財団)
[my label 4]: /bar#special '単一引用符で囲まれたタイトル'
URL は、必要に応じて山かっこで囲むことができます。
[私のラベル 5]:http://foo.bar.baz>
タイトルは次の行に続く場合があります。
[私のラベル 3]: http://fsf.org
「フリーソフトウェア財団」
リンク ラベルでは大文字と小文字が区別されないことに注意してください。 したがって、これは機能します:
ここに[私のリンク][FOO]があります
[フー]: /bar/baz
で 暗黙 参照リンク、括弧の XNUMX 番目のペアは空です:
[私のウェブサイト][]を参照してください。
[私のウェブサイト]: http://foo.bar.baz
注: Markdown.pl および他のほとんどの Markdown 実装では、リンク定義を参照してください。
リスト項目やブロック引用符などのネストされた構造では発生しません。 パンドックリフト
この恣意的な制限。 したがって、以下はpandocでは問題ありませんが、
他のほとんどの実装:
>私のブロック[引用]。
>
> [引用]: /foo
拡張: ショートカット参照リンク
で ショートカット 参照リンク、XNUMX 番目の括弧のペアは完全に省略できます。
[私のウェブサイト] を参照してください。
[私のウェブサイト]: http://foo.bar.baz
内部 リンク
同じドキュメントの別のセクションにリンクするには、自動生成された
識別子 (ヘッダー識別子を参照)。 例えば:
[はじめに](#はじめに)を参照してください。
or
【はじめに】をご覧ください。
[はじめに]: #はじめに
内部リンクは現在、HTML 形式でサポートされています (HTML スライド ショーや
EPUB)、LaTeX、および ConTeXt。
画像
直前に ! が付くリンク画像扱いになります。 リンクテキストは
画像の代替テキストとして使用:
![la lune](lalune.jpg "月への航海")
![映画リール]
[映画リール]: movie.gif
拡張: 暗黙の数字
段落内に単独で出現する画像は、キャプション付きの図としてレンダリングされます。
(LaTeXではFigure環境、HTMLではdivに画像を配置します)
クラス キャプション付きの ap のキャプションと一緒に、クラス図を使用します。) 画像の alt
テキストがキャプションとして使用されます。
![キャプションです](/url/of/image.png)
通常のインライン画像が必要な場合は、それが唯一のものではないことを確認してください
段落。 これを行う XNUMX つの方法は、画像の後に改行しないスペースを挿入することです。
![この画像はフィギュアにはなりません](/url/of/image.png)\
拡張: リンク属性
リンクと画像に属性を設定できます。
インライン ![image](foo.jpg){#id .class width=30 height=20px}
および参照 ![image][ref] と属性。
[参照]: foo.jpg "任意のタイトル" {#id .class key=val key2="val 2"}
(この構文は、#id と .class のみが使用されている場合、PHP Markdown Extra と互換性があります。)
HTML と EPUB の場合、幅と高さを除くすべての属性 (ただし、srcset とサイズを含む)
そのまま通過します。 他のライターは、によってサポートされていない属性を無視します。
それらの出力形式。
画像の幅と高さの属性は特別に扱われます。 なしで使用する場合
単位はピクセルと見なされます。 ただし、以下のいずれかのユニット識別子
px、cm、mm、in、inch、% を使用できます。 数字の間にスペースを入れてはいけません
そしてユニット。 例えば:
![](file.jpg){ 幅=50% }
· サイズは、LaTeX などのページベースの形式で出力するためにインチに変換されます。
寸法は、HTML に似た形式で出力するためにピクセルに変換されます。 --dpi を使用する
インチあたりのピクセル数を指定するオプション。 デフォルトは 96dpi です。
· 通常、% 単位は、使用可能なスペースに対して相対的です。 たとえば、上記の例
にレンダリングします(HTML)、
\includegraphics[width=0.5\textwidth]{file.jpg} (LaTeX)、または
\externalfigure[file.jpg][width=0.5\textwidth] (ConTeXt)。
· 一部の出力形式には、クラス (ConTeXt) または一意の識別子 (LaTeX) の概念があります。
\caption)、またはその両方 (HTML)。
· 幅または高さの属性が指定されていない場合、フォールバックは画像を見ることです
解像度と、画像ファイルに埋め込まれた dpi メタデータ。
脚注
拡張: 脚注
Pandoc の Markdown では、次の構文を使用して脚注を使用できます。
ここに脚注参照[^1]と別のものがあります。[^longnote]
[^1]: ここに脚注があります。
[^longnote]: これは複数のブロックを持つものです。
後続の段落はインデントされていることを示します。
前の脚注に属します。
{ いくつかの.コード }
段落全体をインデントすることも、最初の段落だけをインデントすることもできます
ライン。 このように、複数段落の脚注は次のように機能します。
複数段落のリスト項目。
この段落はメモの一部ではありません。
インデントされていません。
脚注参照の識別子には、スペース、タブ、または改行を含めることはできません。 これらは
識別子は、脚注の参照を注釈自体と関連付けるためにのみ使用されます。 の中に
出力、脚注には順番に番号が付けられます。
脚注自体は文書の最後に配置する必要はありません。 彼らは現れるかもしれません
他のブロック要素 (リスト、ブロック引用符、テーブルなど) 内を除くどこでも。
拡張: inline_notes
インラインの脚注も使用できます (ただし、通常の注記とは異なり、脚注を含めることはできません)。
複数の段落)。 構文は次のとおりです。
ここにインライン ノートがあります。^[インライン ノートの方が書きやすいです。
識別子を選択して下に移動して入力する必要はありません
ノート。]
インラインと通常の脚注は自由に混在させることができます。
引用
拡張: 引用
外部フィルター pandoc-citeproc を使用して、pandoc は自動的に引用を生成し、
多くのスタイルの参考文献。 基本的な使い方は
pandoc --filter pandoc-citeproc myinput.txt
この機能を使用するには、参考文献ファイルを指定する必要があります。
YAML メタデータ セクションの参考文献メタデータ フィールド、または --bibliography コマンド ライン
口論。 複数の --bibliography 引数を指定するか、参考文献メタデータを設定できます
複数の参考文献ファイルを使用する場合は、フィールドを YAML 配列に変換します。 参考文献は
次のいずれかの形式があります。
フォーマットファイル拡張子
──────────────────────────────
BibLaTeX .bib
BibTeX .bibtex
コパック .copac
CSL JSON .json
CSL YAML .yaml
エンドノート .enl
EndNote XML .xml
ISI.wos
メドライン .medline
MOD .mods
リス.リス
.bib は、BibTeX ファイルと BibLaTeX ファイルの両方で使用できることに注意してください。 .bibtex を使用して強制する
BibTeX。
pandoc-citeproc --bib2json と pandoc-citeproc --bib2yaml は .json と
サポートされている任意の形式の .yaml ファイル。
フィールド内マークアップ: BibTeX および BibLaTeX データベースでは、pandoc-citeproc は以下のサブセットを解析します。
LaTeX マークアップ; CSL YAML データベースでは、pandoc Markdown; CSL JSON データベースでは、
HTML のようなマークアップ:
イタリック
...
大胆な
<スパン style="font-variant:small-caps;">... or ...
小文字
...
添字
...
上付き
<スパン class="nocase">...
フレーズがタイトルケースとして大文字にならないようにする
pandoc-citeproc -j および -y は、CSL JSON および CSL YAML 形式を相互変換します。
可能。
--bibliography または YAML を使用して参考文献ファイルを指定する代わりに
メタデータ フィールドの参考文献、引用データを参照に直接含めることができます
ドキュメントの YAML メタデータのフィールド。 フィールドには、YAML でエンコードされた配列が含まれている必要があります。
参照、例:
---
リファレンス:
- タイプ: 記事ジャーナル
id:ワトソンクリック1953
著者:
- 家族: ワトソン
与えられた: JD
- 家族:クリック
与えられた: FHC
発行済み:
日付部分:
--- 1953
- 4
- 25
タイトル:「核酸の分子構造:デオキシリボースの構造」
核酸」
title-short: 核酸の分子構造
コンテナタイトル: Nature
ボリューム:171
問題: 4356
ページ:737-738
DOI: 10.1038/171737a0
URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
言語: en-GB
...
(pandoc-citeproc --bib2yaml は、いずれかの参考文献ファイルからこれらを生成できます。
サポートされている形式)。
引用と参考文献は、引用スタイルでサポートされている任意のスタイルを使用してフォーマットできます
Zotero Style Repository にリストされている言語。 これらのファイルは、
--csl オプションまたは csl メタデータ フィールド。 デフォルトでは、pandoc-citeproc はシカゴを使用します。
Style author-date 形式のマニュアル。 CSL プロジェクトは、次の詳細情報を提供します。
スタイルの検索と編集。
引用を対応する参考文献エントリへのハイパーリンクにするには、追加します。
link-citations: YAML メタデータに当てはまります。
引用は角括弧の中に入れ、セミコロンで区切ります。 各引用は
「@」+データベースからの引用識別子で構成されるキーを持ち、
オプションで、プレフィックス、ロケーター、およびサフィックスがあります。 引用キーは
文字、数字、または _ であり、英数字、_、および内部の句読点文字を含めることができます
(:.#$%&-+?<>~/)。 ここではいくつかの例を示します。
何とか何とか[@ doe99、pp。33-35を参照してください。 また、@ smith04、チャップ。 1]。
何とか[@ doe99、pp。33-35、38-39、および* passim *]。
何とか[@ smith04; @ doe99]。
pandoc-citeproc は、CSL ロケール ファイル内のロケーター用語を検出します。 省略または
省略されていないフォームは受け入れられます。 en-US ロケールでは、ロケーター用語は次の言語で記述できます。
book、bk./bks. などの単数形または複数形。 チャプター、チャプター/チャップス。 桁、
col./cols.; 図、図/図。 フォリオ、フォリオ/フォルス。 番号、番号/番号; 行、l./ll.; ノート、
n./nn.; opus, op./opp.; ページ、p./pp。 段落、段落/段落。 一部、pt./pts.; セクション、
秒/秒; 副詞、sv/s.vv.; 詩、v./vv.; ボリューム、vol./vols.; ¶/¶¶; §/§§。 いいえ
ロケーター用語が使用される場合、「ページ」が想定されます。
@ の前のマイナス記号 (-) は、引用での著者の言及を抑制します。 これ
著者がテキストですでに言及されている場合に役立ちます。
スミスは何とか [-@smith04] と言います。
次のように、テキスト内引用を書くこともできます。
@ smith04は何とか言います。
@smith04 [p. 33]何とか言います。
スタイルが引用された作品のリストを必要とする場合、それは論文の最後に配置されます。
資料。 通常、適切なヘッダーでドキュメントを終了する必要があります。
最後の段落...
# 参考文献
参考文献は、このヘッダーの後に挿入されます。 番号付けされていないクラスは
セクションが番号付けされないように、このヘッダーに追加されます。
本文で実際に引用せずに参考文献に項目を含めたい場合
テキスト、ダミーの nocite メタデータ フィールドを定義して、そこに引用を配置できます。
---
通知: |
@アイテム1、@アイテム2
...
@item3
この例では、文書には item3 の引用のみが含まれますが、参考文献は
item1、item2、および item3 のエントリが含まれます。
LaTeX または PDF 出力の場合、natbib または biblatex を使用して参考文献をレンダリングすることもできます。 の
そのためには、上記の参考文献ファイルを指定し、--natbib または
--biblatex pandoc 呼び出しへの引数。 参考文献ファイルは、
それぞれの形式 (BibTeX または BibLaTeX) で。
詳細については、pandoc-citeproc の man ページを参照してください。
非汎ドック エクステンション
次の Markdown 構文拡張は、pandoc ではデフォルトで有効になっていませんが、有効になっている可能性があります。
+EXTENSION をフォーマット名に追加することで有効になります。ここで、EXTENSION はファイルの名前です。
拡大。 したがって、たとえば、markdown+hard_line_breaks はハード ライン付きの Markdown です。
休憩。
拡張: 先行空白行なしのリスト
段落の直後に、間に空白を入れずにリストを表示できるようにします。
拡張: ハードラインブレイク
段落内のすべての改行が、代わりにハード改行として解釈されるようにします。
スペース
拡張: 無視する_line_breaks
段落内の改行を、スペースやスペースとして扱われるのではなく、無視するようにします。
ハードラインブレイクとして。 このオプションは、東アジア言語で使用することを目的としています。
単語間にスペースは使用されませんが、テキストは読みやすくするために行に分割されます。
拡張: East_asian_line_breaks
段落内の改行を、スペースやスペースとして扱われるのではなく、無視するようにします。
XNUMX つの東アジアのワイド文字の間にハード改行が発生した場合。 これは
東アジア言語が混在するテキストでは、ignore_line_breaks よりも適切な選択です。
キャラクターとその他のキャラクター。
拡張: 絵文字
:smile: のようなテキスト絵文字を Unicode 絵文字として解析します。
拡張: tex_math_single_backslash
\( と \) の間のすべてがインライン TeX 数学として解釈されます。
\[ と \] の間は、表示 TeX 数学として解釈されます。 注:これの欠点
拡張子は、エスケープを排除することです ( および [.
拡張: tex_math_double_backslash
\\( と \\) の間のすべてがインライン TeX 数学として解釈されます。
\\[ と \\] の間は、表示 TeX 数学として解釈されます。
拡張: マークダウン属性
デフォルトでは、pandoc はブロックレベルのタグ内の素材を Markdown として解釈します。 これ
拡張機能は、次の場合に Markdown がブロック レベルのタグ内でのみ解析されるように動作を変更します。
タグには属性 markdown=1 があります。
拡張: mmd_title_block
ドキュメントの上部で MultiMarkdown スタイルのタイトル ブロックを有効にします。次に例を示します。
タイトル:私の肩書き
作者: ジョン・ドウ
日付:9月1、2008
コメント: これはサンプルの mmd タイトル ブロックです。
複数行にわたるフィールド。
詳細については、MultiMarkdown のドキュメントを参照してください。 pandoc_title_block または
yaml_metadata_block が有効になっている場合、mmd_title_block よりも優先されます。
拡張: 略語
PHP Markdown Extra 略語キーを解析します。
*[HTML]: ハイパーテキスト マークアップ言語
pandoc 文書モデルは略語をサポートしていないことに注意してください。
が有効になっている場合、略語キーは単純にスキップされます (次のように解析されるのではなく)。
段落)。
拡張: autolink_bare_uris
先のとがった中かっこ <...> で囲まれていない場合でも、すべての絶対 URI をリンクにします。
拡張: ascii_identifiers
auto_identifiers によって生成される識別子を純粋な ASCII にします。 アクセントは
アクセント付きのラテン文字が取り除かれ、非ラテン文字が省略されます。
拡張: mmd_link_attributes
リンクおよび画像参照のマルチマークダウン スタイルのキーと値の属性を解析します。 これ
拡張子を link_attributes 拡張子と混同しないでください。
これは multimarkdown 属性を持つ参照 ![image][ref] です。
[参照]: http://path.to/image 「画像タイトル」 width=20px height=30px
id=myId class="myClass1 myClass2"
拡張: mmd_header_identifiers
multimarkdown スタイルのヘッダー識別子を解析します (角括弧内、ヘッダーの後ですが、
ATX ヘッダーの末尾の # の前)。
拡張: コンパクト定義リスト
pandoc 1.12.x 以前の定義リスト構文を有効にします。 この構文は異なります
いくつかの点で、上記の定義リストの下にあるものから:
・定義リストの連続する項目間に空行は不要です。
· 「タイトな」または「コンパクトな」リストを取得するには、連続する項目間のスペースを省略します。 スペース
用語とその定義の間は何にも影響しません。
· 段落の遅延折り返しは許可されていません。定義全体を XNUMX つインデントする必要があります。
スペース
値下げ バリアント
pandoc の拡張 Markdown に加えて、次の Markdown バリアントがサポートされています。
markdown_phpextra (PHP 値下げ 追加)
脚注、pipe_tables、raw_html、markdown_attribute、fenced_code_blocks、
definition_lists、intraword_underscores、header_attributes、link_attributes、
略語、shortcut_reference_links。
markdown_github (GitHub フレーバー マークダウン)
pipe_tables、raw_html、tex_math_single_backslash、fenced_code_blocks、
auto_identifiers、ascii_identifiers、backtick_code_blocks、autolink_bare_uris、
intraword_underscores、三振、hard_line_breaks、絵文字、
ショートカット参照リンク。
マークダウン_mmd (マルチマークダウン)
Pipe_tables raw_html、markdown_attribute、mmd_link_attributes、raw_tex、
tex_math_double_backslash、intraword_underscores、mmd_title_block、脚注、
definition_lists、all_symbols_escapable、implicit_header_references、
auto_identifiers、mmd_header_identifiers、shortcut_reference_links。
マークダウン_厳密 (マークダウン.pl)
raw_html
拡張機能 フォーマット 他の より 値下げ
上記の拡張機能の一部は、Markdown 以外の形式で使用できます。
· auto_identifiers は、latex、rst、mediawiki、およびテキスタイルの入力で使用できます (および使用されます
デフォルト)。
・tex_math_dollars、tex_math_single_backslash、tex_math_double_backslashが使用可能
html入力あり。 (これは、MathJax を使用してフォーマットされた Web ページを読むのに便利です。
例。)
生産 スライド ショー WITH パンドック
pandoc を使用して、表示可能な HTML + JavaScript スライド プレゼンテーションを作成できます。
ウェブブラウザ経由。 これを行うには、S5、DZSlides、Slidy、Slideous、
または Reveal.js. LaTeX ビーマーを使用して PDF スライド ショーを作成することもできます。
簡単なスライド ショーの Markdown ソース、habits.txt は次のとおりです。
% 習慣
% ジョン・ドウ
% 22 年 2005 月 XNUMX 日現在
# 午前中に
## 起きる
- アラームをオフにする
- ベッドから出る
## 朝ごはん
- 卵を食べる
- コーヒーを飲む
# 夕方に
## 夕食
- スパゲッティを食べる
- ワインを飲む
------------------
![スパゲッティの写真](images/spaghetti.jpg)
## 寝る
- ベッドに入る
- 羊を数える
HTML/javascript スライド ショーを作成するには、次のように入力します。
pandoc -t フォーマット -s 習慣.txt -o 習慣.html
ここで、FORMAT は s5、slidy、slideous、dzslides、または Revealjs のいずれかです。
Slidy、Slideous、reveal.js、および S5 の場合、pandoc によって生成されたファイルは、
-s/--standalone オプションは、JavaScript と CSS ファイルへのリンクを埋め込みます。
相対パス s5/default (S5 の場合)、slideous (Slideous の場合)、reveal.js で利用可能
(reveal.js の場合)、または w3.org の Slidy Web サイト (Slidy の場合) にあります。 (これらのパスは、
slidy-url、slideous-url、releavejs-url、または s5-url 変数を設定することによって変更されました。 見る
上記のスライドの変数) DZSlides の場合、(比較的短い) javascript と css は次のとおりです。
デフォルトでファイルに含まれています。
すべての HTML スライド形式で、 --self-contained オプションを使用して単一のスライドを作成できます。
リンクを含む、スライドショーを表示するために必要なすべてのデータを含むファイル
スクリプト、スタイルシート、画像、およびビデオ。
ビーマーを使用して PDF スライド ショーを作成するには、次のように入力します。
パンドック -t ビーマーの習慣.txt -o 習慣.pdf
Reveal.js スライド ショーは、ファイルに印刷して PDF に変換することもできます。
ブラウザから。
構造化 スライド 表示する
デフォルトでは、 スライド レベル 従う階層の最上位のヘッダー レベルです。
ドキュメントのどこかで、別のヘッダーではなく、コンテンツによってすぐに。 例では
上記のように、レベル 1 ヘッダーの後には常にレベル 2 ヘッダーが続き、その後に次のヘッダーが続きます。
コンテンツなので、2 はスライド レベルです。 このデフォルトは、 --slide-level を使用してオーバーライドできます
オプションを選択します。
ドキュメントは、次の規則に従ってスライドに分割されます。
· 横罫線は常に新しいスライドを開始します。
· スライド レベルのヘッダーは、常に新しいスライドを開始します。
· ヘッダー 以下 階層内のスライド レベルはヘッダーを作成します 以内 スライド。
· ヘッダー 上記の. 階層内のスライド レベルは、「タイトル スライド」を作成します。
セクションのタイトルと、スライド ショーをセクションに分割するのに役立ちます。
· タイトル ページは、ドキュメントのタイトル ブロックがあれば、それから自動的に作成されます。
(ビーマーの場合、これはデフォルトでいくつかの行をコメントアウトすることで無効にすることができます
レンプレート。)
これらのルールは、さまざまなスタイルのスライド ショーをサポートするように設計されています。 そうしないと
スライドをセクションとサブセクションに構造化することに関心がある場合は、レベル 1 を使用できます
すべての各スライドのヘッダー。 (その場合、レベル 1 がスライド レベルになります。)
上記の例のように、スライド ショーをセクションに構成することもできます。
注: Reveal.js スライド ショーでは、スライド レベルが 2 の場合、XNUMX 次元レイアウトが
レベル 1 ヘッダーが水平方向に構築され、レベル 2 ヘッダーが構築されます。
垂直に。 セクション レベルのネストを深くすることはお勧めしません。
Reveal.js.
増分 lists
デフォルトでは、これらのライターは「一度に」表示するリストを作成します。 リストが必要な場合
段階的に (一度に XNUMX 項目ずつ) 表示するには、-i オプションを使用します。 あなたがしたい場合
デフォルトから逸脱する特定のリスト (つまり、
-i オプションと -i オプションを使用して一度に)、ブロック引用符で囲みます。
> - スパゲッティを食べる
> - ワインを飲む
このようにして、増分リストと非増分リストを XNUMX つのドキュメントに混在させることができます。
挿入する 一時停止
XNUMX つのドットを含む段落を含めることで、スライド内に「一時停止」を追加できます。
スペース区切り:
# 一時停止してスライド
一時停止前のコンテンツ
。 。 。
一時停止後のコンテンツ
スタイリング スライド
カスタマイズした CSS ファイルを配置することで、HTML スライドのスタイルを変更できます。
$DATADIR/s5/default (S5 の場合)、$DATADIR/slidy (Slidy の場合)、または $DATADIR/slideous (Slidy の場合)
ここで、$DATADIR はユーザー データ ディレクトリです (上記の --data-dir を参照)。 の
オリジナルは、pandoc のシステム データ ディレクトリ (通常は
$CABALDIR/pandoc-VERSION/s5/default)。 Pandoc はそこにないファイルを探します。
ユーザーデータディレクトリで見つけます。
dzslides の場合、CSS は HTML ファイル自体に含まれており、そこで変更することができます。
すべての Reveal.js 構成オプションは、変数を介して設定できます。 たとえば、テーマは次のことができます。
テーマ変数を設定して使用します。
-V テーマ=月
または、 --css オプションを使用してカスタム スタイルシートを指定できます。
ビーマー スライドのスタイルを設定するには、テーマ、colortheme、fonttheme、innertheme、および
-V オプションを使用した外部テーマ:
pandoc -t beamer Habits.txt -V テーマ:ワルシャワ -o Habits.pdf
ヘッダー属性はスライド属性に変わることに注意してください ( また) の
HTML スライド形式。個々のスライドのスタイルを設定できます。 ビーマーでは、唯一のヘッダー
スライドに影響する属性は allowframebreaks クラスです。
allowframebreaks オプションにより、コンテンツがいっぱいになると複数のスライドが作成される
フレーム。 これは、特に参考文献に推奨されます。
# 参照 {.allowframebreaks}
スピーカー ノート
Reveal.js は、スピーカー ノートを適切にサポートしています。 Markdown ドキュメントにメモを追加できます
したがって:
これは私のメモです。
- マークダウンを含めることができます
- このリストのように
ノート ウィンドウを表示するには、プレゼンテーションの表示中に s を押します。 メモはまだ
他のスライド形式ではサポートされていますが、メモはスライド自体には表示されません。
フレーム 属性 in プロジェクター
LaTeX [fragile] オプションをビーマーのフレームに追加する必要がある場合があります (
たとえば、minted 環境を使用する場合)。 これは、壊れやすいものを追加することで強制できます
スライドを紹介するヘッダーへのクラス:
# 壊れやすいスライド {.fragile}
ビーマー ユーザーズ ガイドのセクション 8.1 で説明されているその他のフレーム属性はすべて、
以下も使用できます: allowdisplaybreaks、allowframebreaks、b、c、t、environment、label、plain、
シュリンク。
作成 EPUB WITH パンドック
EPUB
--epub-metadata オプションを使用して EPUB メタデータを指定できますが、ソースが
ドキュメントが Markdown である場合、YAML メタデータ ブロックを使用することをお勧めします。 次に例を示します。
---
タイトル:
- タイプ: メイン
テキスト: 私の本
- タイプ: サブタイトル
text: メタデータの調査
作成者:
- 役割: 著者
テキスト: ジョン・スミス
- 役割: 編集者
文:サラ・ジョーンズ
識別子:
- スキーム: DOI
テキスト: doi:10.234234.234/33
出版社:マイプレス
権利: © 2007 John Smith, CC BY-NC
...
次のフィールドが認識されます。
識別子
文字列値、またはテキスト フィールドとスキームを持つオブジェクトのいずれか。 の有効な値
スキームは ISBN-10、GTIN-13、UPC、ISMN-10、DOI、LCCN、GTIN-14、ISBN-13、
法定預託番号、URN、OCLC、ISMN-13、ISBN-A、JP、OLCC。
タイトル 文字列値、またはフィールド file-as と type を持つオブジェクト、またはそのようなリストのいずれか
オブジェクト。 type の有効な値は、main、subtitle、short、collection、edition、
拡張されました。
クリエイター
文字列値、フィールド role、file-as、text を持つオブジェクト、またはリストのいずれか
そのようなオブジェクトの。 ロールの有効な値は MARC リレーターですが、pandoc は試行します
人間が読めるバージョン (「作成者」や「編集者」など) を
適切な印の関係者。
寄稿者
クリエーターと同じフォーマット。
date YYYY-MM-DD 形式の文字列値。 (年のみ必要です。)
他の一般的な日付形式の変換を試みます。
長い (または 遺産: 言語)
BCP 47 形式の文字列値。 次の場合、Pandoc はデフォルトでローカル言語に設定されます。
何も指定されていません。
テーマ
文字列値またはそのような値のリスト。
説明
文字列値。
type 文字列値。
形式でアーカイブしたプロジェクトを保存します. 文字列値。
関係
文字列値。
カバレッジ
文字列値。
権利 文字列値。
表紙画像
文字列値 (カバー画像へのパス)。
スタイルシート
文字列値 (CSS スタイルシートへのパス)。
ページ進行方向
ltr または rtl のいずれかです。 の page-progression-direction 属性を指定します
背骨要素。
リンク メディア
デフォルトでは、pandoc はリンクされたメディア (オーディオとビデオを含む) をダウンロードし、それを含めます。
EPUB コンテナで、完全に自己完結型の EPUB を生成します。 リンクしたい場合は
代わりに外部メディア リソースを使用するには、ソースで未加工の HTML を使用し、data-external="1" を
src 属性を持つタグ。 例えば:
<ソースソース="/http://example.com/music/toccata.mp3"
data-external="1" type="audio/mpeg">
読み書きができる ハスケル サポート
+lhs (または +literate_haskell) を適切な入力または出力形式に追加すると、
(入力または出力には markdown、markdown_strict、rst、または latex。ビーマー、html、または html5 には
出力のみ)、pandoc はドキュメントをリテラシーな Haskell ソースとして扱います。 この意味は
· Markdown 入力では、「鳥の足跡」セクションは、Haskell コードではなく、Haskell コードとして解析されます。
ブロック引用。 \begin{code} と \end{code} の間のテキストも同様に扱われます。
ハスケルコード。 ATX スタイルのヘッダーでは、「#」の代わりに文字「=」が使用されます。
· Markdown 出力では、クラス haskell とliterate を持つコード ブロックは、次を使用してレンダリングされます。
鳥の足跡、ブロック引用はスペース XNUMX つインデントされるため、インデントされません。
Haskell コードとして扱われます。 さらに、ヘッダーは setext スタイルでレンダリングされます (
ATX スタイル (「#」文字を使用) ではなく、下線) を使用します。 (これは、ghc が扱うためです。
行番号を導入するための列 1 の「#」文字。)
· 再構成されたテキスト入力では、「鳥の足跡」セクションが Haskell コードとして解析されます。
· 再構成されたテキスト出力では、クラス haskell のコード ブロックは、bird を使用してレンダリングされます
トラック。
· LaTeX 入力では、コード環境のテキストは Haskell コードとして解析されます。
· LaTeX 出力では、クラス haskell のコード ブロックはコード内でレンダリングされます。
環境。
· HTML 出力では、class haskell のコード ブロックは class でレンダリングされます
リテラシーハスケルと鳥の足跡。
例:
pandoc -f マークダウン+lhs -t html
Markdown 規則でフォーマットされたリテラシーな Haskell ソースを読み取り、通常の HTML を書き込みます
(鳥の足跡なし)。
pandoc -f マークダウン+lhs -t html+lhs
鳥の足跡に Haskell コードを含む HTML を書き込むので、次のようにコピーして貼り付けることができます。
識字率の高い Haskell ソース。
構文 ハイライト
Pandoc は、フェンスで囲まれたコード ブロック内の構文を、
言語名。 強調表示には Haskell ライブラリの highlighting-kate が使用されます。
HTML、Docx、および LaTeX/PDF 出力で動作します。 カラースキームは、
--highlight スタイルのオプション。 デフォルトの配色はピグメントで、
Python ライブラリ pygments で使用されるデフォルトの配色ですが、pygments は実際にはそうではありません
ハイライトに使っていました。
pandoc が認識する言語名のリストを表示するには、「pandoc --version」と入力します。
強調表示を無効にするには、 --no-highlight オプションを使用します。
CUSTOM ライター
Pandoc は、lua で記述されたカスタム ライターで拡張できます。 (Pandocにはluaが含まれています
インタプリタなので、lua を別途インストールする必要はありません。)
カスタム ライターを使用するには、出力の代わりに lua スクリプトへのパスを指定するだけです。
フォーマット。 例えば:
pandoc -t データ/サンプル.lua
カスタム ライターを作成するには、
パンドック文書。 必要に応じて変更できる文書化された例を取得するには
必要、する
pandoc --print-default-data-filesample.lua
作者
© 2006-2015 ジョン・マクファーレン ([メール保護])。 GPL、バージョン 2 または
大きい。 このソフトウェアは、いかなる種類の保証も行いません。 (完全な著作権については、著作権を参照してください。
著作権および保証に関する通知。)
寄稿者には、Aaron Wolen、Albert Krewinkel、Alexander Kondratskiy、Alexander が含まれます。
Sulfrian、Alexander V Vershilov、Alfred Wechselberger、Andreas Lööw、Andrew Dunning、
アントワーヌ・ラッター、水樹新、アルロ・オキーフ、アルチョム・カザック、ベン・ガマリ、ベニ
Cherniavsky-Paskin、Bjorn Buckwalter、Bradley Kuhn、Brent Yorgey、Bryan O'Sullivan、B.
スコット・ミシェル、カレブ・マクダニエル、カルヴィン・ベック、クリストファー・アケルマン、クリストファー・サウィッキ、
クレア・マクレー、クリント・アダムス、コナル・エリオット、クレイグ・S・ボスマ、ダニエル・バーゲイ、ダニエル・T.
スタール、デビッド・ラザール、デビッド・ロスリスバーガー、デニス・ラクサルデ、ダグラス・カルバート、ダグラス・F.
Calvert、Eric Kow、Eric Seidel、Florian Eitel、François Gannaz、Freiric Barral、Fyodor
シェレメチェフ、ガボール・パーリ、ギャビン・ビーティ、グレッグ・マスロフ、グレゴリー・バタイユ、グレッグ・ランドレット、
gwern、Gwern Branwen、Hans-Peter Deifel、Henry de Valence、Ilya V. Portnov、infinity0x、
ハイメ・マルキネス・フェランディス、ジェームズ・アスプネス、ジェイミー・F・オルソン、ヤン・ラレス、ジェイソン・ロナロ、ジェフ
アーノルド、ジェフ・ランゲン、イェンス・ピーターセン、ジェレミー・ボッビオ、ジェシー・ローゼンタール、J・ルイス・ミューア、ジョー
ヒレンブランド、ジョン・マクファーレン、ジョナス・スメドガード、ジョナサン・ドーハティ、ジョセフ・スヴェニングソン、
ホセ・ルイス・デュラン、ジュリアン・クレテル、ジャスティン・ボグナー、ケルシー・ハイタワー、コンスタンチン・ズドフ、
ラース=ドミニク・ブラウン、ルーク・プラント、マーク・セピエニエク、マーク・ライト、高橋正義、マテイ
コラー、マティアス・シェンナー、マシュー・ピカリング、マティアス・CM・トロファエス、マウロ・ビーグ、マックス
ボリングブローク、マックス・ライダール・アンダーセン、メリジン・フェルストラーテン、マイケル・スノイマン、マイケル・トンプソン、
MinRK、Nathan Gass、Neil Mayhew、Nick Bart、Nicolas Kaiser、Nikolay Yakimov、nkalvi、Paulo
谷本、ポール・リヴィエ、ピーター・ワン、フィリップ・オンブレダンヌ、フィリップ・アルデイ、プニート・チャガンティ、
ケルブ、ラルフ・ステファン、レカイ・オクタシュ、ロッドジャ・トラップ、ライアン・グルスコット、スコット・モリソン、セルゲイ
Trofimovich、Sergey Astanin、Shahbaz Youssefi、Shaun Attfield、shreevatsa.public、Simon
Hengel、Sumit Sahrawat、takahashim、thsutton、Tim Lin、Timothy Humphries、Todd Sifleet、
Tom Leese、Uli Köhler、Václav Zeman、Viktor Kronvall、Vincent、Wikiwide、および Xavier Olive。
Pandoc のソース コードとすべてのドキュメントは、次のサイトからダウンロードできます。http://pandoc.org>.
onworks.net サービスを使用して pandoc オンラインを使用する