Was kann ich mit den YAML-Header-Optionen in Pandoc steuern?

Nur durch Zufall habe ich ein Beispiel-Dokument mit dem toc: true Linie in Ihr YAML-header-Optionen in einer Markdown-Datei verarbeitet werden, die von Pandoc. Und die Pandoc docs nicht erwähnt, diese option zu Steuern Inhaltsverzeichnis Verwendung des YAML-header. Darüber hinaus sehe ich etwas willkürliche Linien im Beispiel-Dokumente auf die gleiche Pandoc readme-Website.

Wichtigste Frage:

  • Was Pandoc-Optionen sind verfügbar Verwendung des YAML-header?

Meta-Frage:

  • Was bestimmt die zur Verfügung Pandoc-Optionen, die verfügbar sind, um mit Hilfe des YAML-header?

Hinweis: mein workflow ist die Verwendung von Markdown-Dateien (.md) und verarbeiten Sie durch Pandoc um PDF-Dateien. Es ist hierarchisch organisiert Manuskript schreiben mit Mathematik. Wie:

pandoc --standalone --smart \
    --from=markdown+yaml_metadata_block \
    --filter pandoc-citeproc \
    my_markdown_file.md \
    -o my_pdf_file.pdf

InformationsquelleAutor der Frage Kalin | 2014-10-16

  1. 21

    Tatsächlich, es ist alles in Pandoc ist HANDBUCH. Speziell:

    Vorlagen können Variablen enthalten.

    Beispielsweise in Ihren HTML -Vorlagekönnten Sie schreiben:

    <title>$title$</title>

    Diese template-Variablen kann festgelegt werden, mit der --variable=KEY[:VAL] option.

    Jedoch, Sie sind außerdem aus dem Dokument-Metadaten, die in der turn, können Sie entweder mit der --metadata=KEY[:VAL] option oder mit der YAML Metadaten-block (oder YAML-Datei):

    Metadaten aus den Bereichen der YAML-Objekt und Hinzugefügt, um alle vorhandenen Dokument-Metadaten. Metadaten enthalten können Listen und Objekte (geschachtelte willkürlich), sondern alle string-Skalare interpretiert werden, als markdown. [...]

    Deine Frage zu beantworten: die Vorlage bestimmt, welche Felder in der YAML Metadaten-block einen Effekt haben. Anzeigen, zum Beispiel die latex-Vorlage:

    $ pandoc -D latex

    Sehen einige Variablen, die automatisch festgelegt werden, die von pandoc, siehe Handbuch. Schließlich, anderen Verhaltensweisen, die von pandoc (wie markdown-Erweiterungen, etc) kann nur eingestellt werden als Kommandozeilen-Optionen.

    InformationsquelleAutor der Antwort mb21

  2. 12

    Es ist eine ziemlich lange Liste, die Sie durchsuchen können, durch ausführen man pandoc in die Befehlszeile und navigieren Sie zum "Variablen, die von pandoc" - Bereich unter "VORLAGEN".

    Oben auf die Liste umfasst die folgenden, unter vielen anderen Optionen:

    Variables set by pandoc
   Some variables are set automatically by pandoc.  These vary somewhat depending  on  the
   output format, but include metadata fields as well as the following:

   title, author, date
          allow identification of basic aspects of the document.  Included in PDF metadata
          through LaTeX and ConTeXt.  These can be set through a pandoc title block, which
          allows for multiple authors, or through a YAML metadata block:

                 ---
                 author:
                 - Aristotle
                 - Peter Abelard
                 ...

   subtitle
          document subtitle; also used as subject in PDF metadata

   abstract
          document summary, included in LaTeX, ConTeXt, AsciiDoc, and Word docx

   keywords
          list  of  keywords  to  be  included in HTML, PDF, and AsciiDoc metadata; may be
          repeated as for author, above

   header-includes
          contents specified by -H/--include-in-header (may have multiple values)

   toc    non-null value if --toc/--table-of-contents was specified

   toc-title
          title of table of contents (works only with EPUB and docx)

   include-before
          contents specified by -B/--include-before-body (may have multiple values)

   include-after
          contents specified by -A/--include-after-body (may have multiple values)

   body   body of document

    ``

    InformationsquelleAutor der Antwort denten

  3. 3

    Können Sie finden Sie in der Dokumentation von pandoc für einen Anhaltspunkt: http://pandoc.org/getting-started.html

    Aber genau wissen, wo es verwendet wird, können Sie nach Vorlagen, die Quellen von pandoc: https://github.com/jgm/pandoc-templates

    Beispielsweise für die html5-Ausgabe ist die Datei: https://github.com/jgm/pandoc-templates/blob/master/default.html5

    Hier ist ein Abschnitt des Codes:

    <title>$if(title-prefix)$$title-prefix$ - $endif$$pagetitle$</title>

    Wie Sie sehen können hat title-prefix und pagetitle.

    Können Sie schauen Sie die Dokumentation, aber die beste Lösung ist die Suche nach dem source-code der version, die Sie verwenden.

    InformationsquelleAutor der Antwort Eduardo Santana

Schreibe einen Kommentar