Il s'agit de la commande pandoc qui peut être exécutée dans le fournisseur d'hébergement gratuit OnWorks en utilisant l'un de nos multiples postes de travail en ligne gratuits tels que Ubuntu Online, Fedora Online, l'émulateur en ligne Windows ou l'émulateur en ligne MAC OS
PROGRAMME:
Nom
pandoc - convertisseur de balisage général
SYNOPSIS
pandoc [Options] [fichier-entrée] ...
DESCRIPTION
Pandoc est une bibliothèque Haskell pour la conversion d'un format de balisage à un autre, et un
outil de ligne de commande qui utilise cette bibliothèque. Il peut lire Markdown, CommonMark, PHP Markdown
Extra, GitHub-Flavored Markdown et (sous-ensembles de) Textile, reStructuredText, HTML, LaTeX,
Balisage MediaWiki, balisage TWiki, balisage Haddock, OPML, mode Emacs Org, DocBook, txt2tags,
EPUB, ODT et Word docx ; et il peut écrire du texte brut, Markdown, CommonMark, PHP Markdown
Extra, GitHub-Flavored Markdown, reStructuredText, XHTML, HTML5, LaTeX (y compris beamer
diaporamas), ConTeXt, RTF, OPML, DocBook, OpenDocument, ODT, Word docx, GNU Texinfo,
Balisage MediaWiki, balisage DokuWiki, balisage Haddock, EPUB (v2 ou v3), FictionBook2, Textile,
pages de manuel groff, mode Emacs Org, AsciiDoc, InDesign ICML et Slidy, Slideous, DZSlides,
show.js ou diaporamas HTML S5. Il peut également produire une sortie PDF sur des systèmes où LaTeX,
ConTeXt ou wkhtmltopdf est installé.
La version améliorée de Pandoc de Markdown inclut la syntaxe pour les notes de bas de page, les tableaux,
listes ordonnées, listes de définitions, blocs de code clôturés, exposants et indices,
barré, blocs de métadonnées, tables des matières automatiques, mathématiques LaTeX intégrées, citations,
et Markdown à l'intérieur des éléments de bloc HTML. (Ces améliorations, décrites ci-dessous sous
Markdown de Pandoc, peut être désactivé à l'aide du format d'entrée ou de sortie markdown_strict.)
Contrairement à la plupart des outils existants pour convertir Markdown en HTML, qui utilisent regex
substitutions, pandoc a une conception modulaire : il se compose d'un ensemble de lecteurs, qui analysent
texte dans un format donné et produire une représentation native du document, et un ensemble de
écrivains, qui convertissent cette représentation native en un format cible. Ainsi, en ajoutant un
le format d'entrée ou de sortie ne nécessite que l'ajout d'un lecteur ou d'un écrivain.
Parce que la représentation intermédiaire d'un document par pandoc est moins expressive que beaucoup de
les formats entre lesquels il convertit, il ne faut pas s'attendre à des conversions parfaites entre chaque
format et tous les autres. Pandoc tente de préserver les éléments structurels d'un
document, mais pas les détails de mise en forme tels que la taille de la marge. Et quelques éléments du document,
tels que des tableaux complexes, peuvent ne pas s'adapter au modèle de document simple de pandoc. Tandis que
les conversions de Pandoc's Markdown vers tous les formats aspirent à être parfaites, les conversions de
les formats plus expressifs que le Markdown de pandoc peuvent être à perte.
En utilisant pandoc
Sinon fichier-entrée est spécifié, l'entrée est lue à partir de Stdin. Dans le cas contraire, le fichiers-d'entrée are
concaténées (avec une ligne vide entre chacune) et utilisées comme entrée. La sortie va à Stdout by
par défaut (bien que la sortie vers Stdout est désactivé pour les sorties odt, docx, epub et epub3
formats). Pour la sortie dans un fichier, utilisez l'option -o :
pandoc -o sortie.html entrée.txt
Par défaut, pandoc produit un fragment de document, pas un document autonome avec un
en-tête et pied de page. Pour produire un document autonome, utilisez l'indicateur -s ou --standalone :
pandoc -s -o sortie.html entrée.txt
Pour plus d'informations sur la façon dont les documents autonomes sont produits, voir Modèles, ci-dessous.
Au lieu d'un fichier, un URI absolu peut être donné. Dans ce cas, pandoc va chercher le
contenu utilisant HTTP :
pandoc -f html -t démarque http://www.fsf.org
Si plusieurs fichiers d'entrée sont fournis, pandoc les concaténera tous (avec des lignes vierges
entre eux) avant l'analyse. Cette fonctionnalité est désactivée pour les formats d'entrée binaires tels que
EPUB, odt et docx.
Le format de l'entrée et de la sortie peut être spécifié explicitement à l'aide des options de ligne de commande.
Le format d'entrée peut être spécifié à l'aide des options -r/--read ou -f/--from, la sortie
formater à l'aide des options -w/--write ou -t/--to. Ainsi, pour convertir hello.txt de Markdown
à LaTeX, vous pouvez taper :
pandoc -f markdown -t latex bonjour.txt
Pour convertir hello.html de HTML en Markdown :
pandoc -f html -t démarcation bonjour.html
Les formats de sortie pris en charge sont répertoriés ci-dessous sous l'option -t/--to. Entrée prise en charge
les formats sont répertoriés ci-dessous sous l'option -f/--from. A noter que le premier, textile, latex,
et les lecteurs html ne sont pas complets ; il y a certaines constructions qu'ils n'analysent pas.
Si le format d'entrée ou de sortie n'est pas spécifié explicitement, pandoc tentera de le deviner
à partir des extensions des noms de fichiers d'entrée et de sortie. Ainsi, par exemple,
pandoc -o bonjour.tex bonjour.txt
convertira hello.txt de Markdown en LaTeX. Si aucun fichier de sortie n'est spécifié (de sorte que
la sortie va à Stdout), ou si l'extension du fichier de sortie est inconnue, le format de sortie
sera par défaut en HTML. Si aucun fichier d'entrée n'est spécifié (pour que l'entrée provienne de Stdin), ou
si les extensions des fichiers d'entrée sont inconnues, le format d'entrée sera supposé être
Markdown sauf indication contraire.
Pandoc utilise le codage de caractères UTF-8 pour l'entrée et la sortie. Si votre local
l'encodage des caractères n'est pas UTF-8, vous devez diriger l'entrée et la sortie via iconv :
iconv -t utf-8 entrée.txt | pandoc | iconv -f utf-8
Notez que dans certains formats de sortie (tels que HTML, LaTeX, ConTeXt, RTF, OPML, DocBook et
Texinfo), des informations sur l'encodage des caractères sont incluses dans l'en-tête du document,
qui ne sera inclus que si vous utilisez l'option -s/--standalone.
La création a PDF
Pour produire un PDF, spécifiez un fichier de sortie avec une extension .pdf. Par défaut, pandoc
utilisez LaTeX pour le convertir en PDF :
pandoc test.txt -o test.pdf
La production d'un PDF nécessite l'installation d'un moteur LaTeX (voir --latex-engine, ci-dessous),
et suppose que les packages LaTeX suivants sont disponibles : amsfonts, amsmath, lm,
ifxetex, ifluatex, eurosym, listings (si l'option --listings est utilisée), fancyvrb,
longtable, booktabs, graphicx et grffile (si le document contient des images), hyperref,
ulem, geometry (avec la variable de géométrie définie), setspace (avec linestretch) et babel
(avec langue). L'utilisation de xelatex ou lualatex comme moteur LaTeX nécessite fontspec ;
xelatex utilise mathspec, polyglossia (avec lang), xecjk et bidi (avec la variable dir
ensemble). Les packages upquote et microtype sont utilisés s'ils sont disponibles, et les csquotes seront utilisés
pour une ponctuation intelligente s'il est ajouté au modèle ou inclus dans un fichier d'en-tête. Les
Les packages natbib, biblatex, bibtex et biber peuvent éventuellement être utilisés pour la citation
le rendu. Ceux-ci sont inclus avec toutes les versions récentes de TeX Live.
Alternativement, pandoc peut utiliser ConTeXt ou wkhtmltopdf pour créer un PDF. Pour cela, précisez
un fichier de sortie avec une extension .pdf, comme avant, mais ajoutez -t context ou -t html5 au
ligne de commande.
La sortie PDF peut être contrôlée à l'aide de variables pour LaTeX (si LaTeX est utilisé) et de variables
pour ConTeXt (si ConTeXt est utilisé). Si wkhtmltopdf est utilisé, alors les variables margin-left,
la marge droite, la marge supérieure, la marge inférieure et le format du papier affecteront la sortie, tout comme
--css.
OPTIONS
Général Options
-f Format, -r Format, --de=Format, --lire=Format
Spécifiez le format d'entrée. Format peut être natif (Haskell natif), json (version JSON de
AST natif), markdown (markdown étendu de pandoc), markdown_strict (original
Markdown non étendu), markdown_phpextra (PHP Markdown Extra), markdown_github
(GitHub-Flavored Markdown), marque commune (CommonMark Markdown), textile (Textile),
premier (reStructuredText), html (HTML), docbook (DocBook), t2t (txt2tags), docx
(docx), odt (ODT), epub (EPUB), opml (OPML), org (mode Emacs Org), mediawiki
(balisage MediaWiki), twiki (balisage TWiki), haddock (balisage Haddock) ou latex
(Latex). Si +lhs est ajouté à markdown, rst, latex ou html, l'entrée sera
traité comme une source Haskell alphabétisée : voir le support Haskell alphabétisé, ci-dessous. Réduction
les extensions de syntaxe peuvent être activées ou désactivées individuellement en ajoutant +EXTENSION
ou -EXTENSION au nom du format. Ainsi, par exemple,
markdown_strict+footnotes+definition_lists est un Markdown strict avec des notes de bas de page et
les listes de définitions sont activées, et markdown-pipe_tables+hard_line_breaks est celui de pandoc
Markdown sans tables de tuyaux et avec des ruptures de ligne dures. Voir la démarque de Pandoc,
ci-dessous, pour une liste des extensions et leurs noms.
-t Format, -w Format, --à=Format, --écrire=Format
Spécifiez le format de sortie. Format peut être natif (Haskell natif), json (version JSON
de l'AST natif), plain (texte brut), markdown (pandoc's Extended Markdown),
markdown_strict (markdown original non étendu), markdown_phpextra (PHP Markdown
Extra), markdown_github (GitHub-Flavored Markdown), commonmark (CommonMark
Markdown), d'abord (reStructuredText), html (XHTML), html5 (HTML5), latex (LaTeX),
beamer (diaporama du beamer LaTeX), contexte (ConTeXt), man (groff man), mediawiki
(balisage MediaWiki), dokuwiki (balisage DokuWiki), textile (Textile), org (Emacs Org
mode), texinfo (GNU Texinfo), opml (OPML), docbook (DocBook), opendocument
(OpenDocument), odt (document texte OpenOffice), docx (Word docx), haddock (Haddock
balisage), rtf (format texte enrichi), epub (livre EPUB v2), epub3 (EPUB v3), fb2
(livre électronique FictionBook2), asciidoc (AsciiDoc), icml (InDesign ICML), slidy (Slidy HTML
et diaporama javascript), slideous (Slideous HTML et diaporama javascript),
dzslides (DZSlides HTML5 + diaporama javascript), Revealjs (reveal.js HTML5 +
diaporama javascript), s5 (diaporama S5 HTML et javascript), ou le chemin d'un
rédacteur lua personnalisé (voir rédacteurs personnalisés, ci-dessous). Notez que odt, epub et epub3
la sortie ne sera pas dirigée vers Stdout; un nom de fichier de sortie doit être spécifié en utilisant
l'option -o/--output. Si +lhs est ajouté à markdown, rst, latex, beamer, html,
ou html5, la sortie sera rendue en tant que source Haskell alphabétisée : voir alphabétisé
Support Haskell, ci-dessous. Les extensions de syntaxe Markdown peuvent être activées individuellement ou
désactivé en ajoutant +EXTENSION ou -EXTENSION au nom du format, comme décrit
ci-dessus sous -f.
-o DOSSIER, --sortie=DOSSIER
Écrire la sortie dans DOSSIER au lieu de Stdout. Si DOSSIER est -, la sortie ira à Stdout.
(Exception : si le format de sortie est odt, docx, epub ou epub3, la sortie vers stdout est
désactivée.)
--data-dir=ANNUAIRE
Spécifiez le répertoire de données utilisateur pour rechercher les fichiers de données pandoc. Si cette option est
non spécifié, le répertoire de données utilisateur par défaut sera utilisé. C'est, sous Unix :
$HOME/.pandoc
sous Windows XP :
C:\Documents et paramètres\USERNAME\Application Data\pandoc
et sous Windows Vista ou version ultérieure :
C:\Utilisateurs\USERNAME\AppData\Roaming\pandoc
Vous pouvez trouver le répertoire de données utilisateur par défaut sur votre système en consultant le
sortie de pandoc --version. Un reference.odt, reference.docx, epub.css, des templates,
Le répertoire slidy, slideous ou s5 placé dans ce répertoire remplacera celui de pandoc
valeurs par défaut normales.
--bash-complétion
Générez un script d'achèvement bash. Pour activer la complétion bash avec pandoc, ajoutez ceci
à votre .bashrc :
eval "$(pandoc --bash-completion)"
--verbeux
Donne une sortie de débogage détaillée. Actuellement, cela n'a d'effet qu'avec la sortie PDF.
-dans, --version
Version imprimée.
-h, --Aidez-moi
Afficher le message d'utilisation.
Reader Options
-R, --parse-raw
Analyser les codes HTML intraduisibles et les environnements LaTeX en HTML brut ou LaTeX,
au lieu de les ignorer. Affecte uniquement les entrées HTML et LaTeX. Le HTML brut peut être
imprimé en Markdown, reStructuredText, HTML, Slidy, Slideous, DZSlides, Reveal.js,
et sortie S5 ; Le LaTeX brut peut être imprimé dans Markdown, reStructuredText, LaTeX et
sortie ConTeXt. La valeur par défaut est que les lecteurs omettent les codes HTML intraduisibles
et les environnements LaTeX. (Le lecteur LaTeX passe par le LaTeX intraduisible
commandes, même si -R n'est pas spécifié.)
-S, --intelligent
Produisez une sortie typographiquement correcte, en convertissant les guillemets droits en guillemets bouclés,
--- aux tirets cadratins, -- aux tirets cadencés, et ... aux ellipses. Les espaces insécables sont
inséré après certaines abréviations, telles que "M." (Remarque : cette option est sélectionnée
automatiquement lorsque le format de sortie est latex ou context, sauf si --no-tex-ligatures
est utilisé. Cela n'a aucun effet sur l'entrée de latex.)
--vieux-tirets
Sélectionne le comportement pandoc <= 1.8.2.1 pour l'analyse des tirets intelligents : - avant un chiffre
est un tiret fin, et -- est un tiret cadratin. Cette option est sélectionnée automatiquement pour
entrée textile.
--base-header-level=NUMÉRO
Spécifiez le niveau de base des en-têtes (valeur par défaut à 1).
--indented-code-classes=HORAIRE
Spécifiez les classes à utiliser pour les blocs de code indentés - par exemple, perl, numberLines ou
haskel. Plusieurs classes peuvent être séparées par des espaces ou des virgules.
--default-image-extension=EXTENSION
Spécifiez une extension par défaut à utiliser lorsque les chemins/URL des images n'ont pas d'extension. Cette
vous permet d'utiliser la même source pour des formats qui nécessitent différents types de
images. Actuellement, cette option n'affecte que les lecteurs Markdown et LaTeX.
--filtre=EXÉCUTABLE
Spécifiez un exécutable à utiliser comme filtre transformant le pandoc AST après le
l'entrée est analysée et avant que la sortie ne soit écrite. L'exécutable doit lire JSON
de stdin et écrivez JSON sur stdout. Le JSON doit être formaté comme celui de pandoc
Entrée et sortie JSON. Le nom du format de sortie sera passé au filtre
comme premier argument. D'où,
pandoc --filter ./caps.py -t latex
équivaut à
pandoc-t json | ./caps.py latex | pandoc -f json -t latex
Cette dernière forme peut être utile pour le débogage des filtres.
Les filtres peuvent être écrits dans n'importe quelle langue. Text.Pandoc.JSON exporte vers JSONFilter vers
faciliter l'écriture de filtres en Haskell. Ceux qui préféreraient écrire des filtres dans
python peut utiliser le module pandocfilters, installable depuis PyPI. Il y a aussi
bibliothèques de filtres pandoc en PHP, perl et javascript/node.js.
Notez que le EXÉCUTABLE sera recherché dans le CHEMIN de l'utilisateur, et non dans le travail
répertoire, si aucun répertoire n'est fourni. Si vous souhaitez exécuter un script dans le
répertoire, faites précéder le nom du fichier par ./.
-M clé - KEY[=VAL], --métadonnées=clé - KEY[:VAL]
Définir le champ de métadonnées clé - KEY à la valeur VAL. Une valeur spécifiée sur la ligne de commande
remplace une valeur spécifiée dans le document. Les valeurs seront analysées en tant que booléen YAML
ou des valeurs de chaîne. Si aucune valeur n'est spécifiée, la valeur sera traitée comme booléenne
vrai. Comme --variable, --metadata provoque la définition de variables de modèle. Mais contrairement à
--variable, --metadata affecte les métadonnées du document sous-jacent (qui est
accessible à partir des filtres et peut être imprimé dans certains formats de sortie).
--normaliser
Normaliser le document après lecture : fusionner les éléments Str ou Emph adjacents, par
exemple, et supprimez les espaces répétés.
-p, --preserve-onglets
Conservez les tabulations au lieu de les convertir en espaces (valeur par défaut). Notez que ce
n'affectera que les onglets dans les étendues de code littérales et les blocs de code ; tabulations en texte normal
seront traités comme des espaces.
--tab-stop=NUMÉRO
Spécifiez le nombre d'espaces par onglet (la valeur par défaut est 4).
--track-changes=accepter|rejeter|tout
Spécifie ce qu'il faut faire avec les insertions et les suppressions produites par MS Word "Track
Fonctionnalité "Modifications". accept (valeur par défaut), insère toutes les insertions et ignore toutes
suppressions. rejeter insère toutes les suppressions et ignore les insertions. tout met dans les deux
insertions et suppressions, enveloppées dans des intervalles avec des classes d'insertion et de suppression,
respectivement. L'auteur et l'heure du changement sont inclus. tout est utile pour
scripting : accepter uniquement les modifications d'un certain relecteur, disons, ou avant un certain
Date. Cette option n'affecte que le lecteur docx.
--extract-media=DIR
Extraire les images et autres médias contenus dans un conteneur docx ou epub vers le chemin
DIR, en le créant si nécessaire, et ajustez les références des images dans le document pour
ils pointent vers les fichiers extraits. Cette option n'affecte que les docx et epub
lecteurs.
Général écrivain Options
-Oui, - standalone
Produisez une sortie avec un en-tête et un pied de page appropriés (par exemple, un HTML autonome,
LaTeX, ou fichier RTF, pas un fragment). Cette option est définie automatiquement pour le pdf,
sortie epub, epub3, fb2, docx et odt.
--modèle=DOSSIER
Utilisez DOSSIER comme modèle personnalisé pour le document généré. Implique --standalone.
Voir Modèles, ci-dessous, pour une description de la syntaxe des modèles. Si aucune extension n'est
spécifié, une extension correspondant au rédacteur sera ajoutée, de sorte que
--template=special recherche special.html pour la sortie HTML. Si le modèle n'est pas
trouvé, pandoc le recherchera dans le sous-répertoire templates des données utilisateur
répertoire (voir --data-dir). Si cette option n'est pas utilisée, un modèle par défaut
approprié pour le format de sortie sera utilisé (voir -D/--print-default-template).
-V clé - KEY[=VAL], --variable=clé - KEY[:VAL]
Définir la variable de modèle clé - KEY à la valeur VAL lors du rendu du document dans
mode autonome. Ceci n'est généralement utile que lorsque l'option --template est utilisée
pour spécifier un modèle personnalisé, puisque pandoc définit automatiquement les variables utilisées dans
les modèles par défaut. Sinon VAL est spécifié, la clé recevra la valeur
vrai.
-D Format, --print-default-template=Format
Imprimer le modèle par défaut du système pour une sortie Format. (Voir -t pour une liste de
possible Formats.) Les modèles du répertoire de données utilisateur sont ignorés.
--print-default-data-file=DOSSIER
Imprimez un fichier de données par défaut du système. Les fichiers du répertoire de données utilisateur sont ignorés.
--dpi=NUMÉRO
Spécifiez la valeur dpi (points par pouce) pour la conversion de pixels en
pouces/centimètres et vice versa. La valeur par défaut est 96 dpi. Techniquement, le bon
terme serait ppi (pixels par pouce).
--wrap=[auto|aucun|conserver]
Déterminez comment le texte est enveloppé dans la sortie (le code source, pas le rendu
version). Avec auto (la valeur par défaut), pandoc tentera de rattacher les lignes à la colonne
largeur spécifiée par --columns (par défaut 80). Sans aucun, pandoc n'enveloppera pas les lignes
du tout. Avec préserver, pandoc tentera de préserver l'emballage du
document source (c'est-à-dire, là où il y a des retours à la ligne non sémantiques dans la source, il y a
sera également des nouvelles lignes non sémantiques dans la sortie).
--sans emballage
Synonyme déconseillé de --wrap=none.
--colonnes=NUMÉRO
Spécifiez la longueur des lignes en caractères (pour l'habillage du texte). Cela n'affecte que le
le code source généré, pas la mise en page sur la page rendue.
--toc, --table des matières
Inclure une table des matières générée automatiquement (ou, dans le cas du latex,
contexte, et d'abord, une instruction pour en créer un) dans le document de sortie. Cette
L'option n'a aucun effet sur la sortie man, docbook, slidy, slideous, s5, docx ou odt.
--toc-profondeur=NUMÉRO
Spécifiez le nombre de niveaux de section à inclure dans la table des matières. Les
la valeur par défaut est 3 (ce qui signifie que les en-têtes de niveau 1, 2 et 3 seront répertoriés dans le
Contenu).
--pas de surbrillance
Désactive la mise en évidence de la syntaxe pour les blocs de code et les inlines, même lorsqu'une langue
l'attribut est donné.
--highlight-style=STYLE
Spécifie le style de coloration à utiliser dans le code source mis en surbrillance. Les options sont
pygments (par défaut), kate, monochrome, espresso, zenburn, haddock et tango.
Pour plus d'informations sur la coloration syntaxique dans pandoc, consultez coloration syntaxique,
ci-dessous.
-H DOSSIER, --include-in-header=DOSSIER
Inclure le contenu de DOSSIER, mot pour mot, à la fin de l'en-tête. Cela peut être utilisé,
par exemple, pour inclure un CSS ou un javascript spécial dans des documents HTML. Cette option
peut être utilisé à plusieurs reprises pour inclure plusieurs fichiers dans l'en-tête. Ils seront
inclus dans la commande spécifiée. Implique --standalone.
-B DOSSIER, --include-avant-corps=DOSSIER
Inclure le contenu de DOSSIER, mot pour mot, au début du corps du document (par exemple
après le balise en HTML, ou la commande \begin{document} en LaTeX). Ceci peut
être utilisé pour inclure des barres de navigation ou des bannières dans les documents HTML. Cette option peut
être utilisé à plusieurs reprises pour inclure plusieurs fichiers. Ils seront inclus dans la commande
spécifié. Implique --standalone.
-A DOSSIER, --include-after-body=DOSSIER
Inclure le contenu de DOSSIER, mot pour mot, à la fin du corps du document (avant le
balise en HTML, ou la commande \end{document} en LaTeX). Cette option peut être
être utilisé à plusieurs reprises pour inclure plusieurs fichiers. Ils seront inclus dans la commande
spécifié. Implique --standalone.
Options affectant groupe de neurones écrivains
--autonome
Produisez un fichier HTML autonome sans dépendances externes, en utilisant des données : URI vers
incorporer le contenu des scripts liés, des feuilles de style, des images et des vidéos. Les
le fichier résultant doit être « autonome », dans le sens où il n'a besoin d'aucun fichier externe
fichiers et aucun accès au réseau pour être affiché correctement par un navigateur. Cette option fonctionne
uniquement avec les formats de sortie HTML, y compris html, html5, html+lhs, html5+lhs, s5,
slidy, slideous, dzslides et Revejs. Scripts, images et feuilles de style sur
les URL absolues seront téléchargées ; ceux à des URL relatives seront recherchés par rapport à
le répertoire de travail (si le premier fichier source est local) ou relatif à la base
URL (si le premier fichier source est distant). Limitation : ressources qui sont chargées
dynamiquement via JavaScript ne peut pas être incorporé ; par conséquent,
--self-contained ne fonctionne pas avec --mathjax, et certaines fonctionnalités avancées (par exemple
zoom ou notes du conférencier) peuvent ne pas fonctionner dans une diapositive Reveal.js "autonome" hors ligne
montrer.
--html-q-tags
Utilisez des balises pour les guillemets en HTML.
--ascii
Utilisez uniquement des caractères ASCII dans la sortie. Actuellement pris en charge uniquement pour la sortie HTML
(qui utilise des entités numériques au lieu d'UTF-8 lorsque cette option est sélectionnée).
--liens-de-référence
Utilisez des liens de style référence, plutôt que des liens en ligne, en écrivant Markdown ou
reStructuredText. Par défaut, les liens intégrés sont utilisés.
--atx-en-têtes
Utilisez des en-têtes de style ATX dans la sortie Markdown et asciidoc. La valeur par défaut est d'utiliser
les en-têtes de style setext pour les niveaux 1-2, puis les en-têtes ATX.
--chapitres
Traitez les en-têtes de niveau supérieur comme des chapitres dans les sorties LaTeX, ConTeXt et DocBook. Lorsque
la classe de document LaTeX est définie sur rapport, livre ou mémoire, cette option est implicite.
Si beamer est le format de sortie, les en-têtes de niveau supérieur deviendront \part{..}.
-N, --nombre-sections
Numéroter les en-têtes de section dans la sortie LaTeX, ConTeXt, HTML ou EPUB. Par défaut,
les sections ne sont pas numérotées. Les sections avec classe non numérotée ne seront jamais numérotées,
même si --number-sections est spécifié.
--nombre-décalage=NUMÉRO[,NUMÉRO, ]
Décalage pour les en-têtes de section dans la sortie HTML (ignoré dans les autres formats de sortie). Les
le premier numéro est ajouté au numéro de section pour les en-têtes de niveau supérieur, le second pour
en-têtes de deuxième niveau, et ainsi de suite. Ainsi, par exemple, si vous voulez que le premier niveau supérieur
en-tête dans votre document à numéroter "6", spécifiez --number-offset=5. Si votre
document commence par un en-tête de niveau 2 que vous souhaitez numéroter "1.5", précisez
--number-offset=1,4. Les décalages sont de 0 par défaut. Implique --number-sections.
--pas de ligatures tex
N'utilisez pas les ligatures TeX pour les guillemets, les apostrophes et les tirets (`...',
``..'', --, ---) lors de l'écriture ou de la lecture de LaTeX ou ConTeXt. En lisant LaTeX, analysez
les caractères `, ' et - littéralement, plutôt que d'analyser les ligatures pour la citation
marques et tirets. En écrivant LaTeX ou ConTeXt, imprimez des guillemets unicode et
tirets littéralement, plutôt que de les convertir en TeX ASCII standard
ligatures. Remarque : normalement --smart est sélectionné automatiquement pour LaTeX et ConTeXt
sortie, mais il doit être spécifié explicitement si --no-tex-ligatures est sélectionné. Si
vous utilisez des guillemets bouclés littéraux, des tirets et des points de suspension dans votre source, alors vous pouvez
voulez utiliser --no-tex-ligatures sans --smart.
--Annonces
Utilisez le package de listes pour les blocs de code LaTeX
-je, --incrémentale
Faire en sorte que les éléments de liste dans les diaporamas s'affichent de manière incrémentielle (un par un). La valeur par défaut est
pour que les listes s'affichent toutes en même temps.
--slide-level=NUMÉRO
Spécifie que les en-têtes avec le niveau spécifié créent des diapositives (pour beamer, s5,
glissant, glissant, dzslides). Les en-têtes au-dessus de ce niveau dans la hiérarchie sont utilisés pour
diviser le diaporama en sections ; les en-têtes en dessous de ce niveau créent des sous-titres
dans une diapositive. La valeur par défaut consiste à définir le niveau de la diapositive en fonction du contenu du
document; voir Structurer le diaporama.
--section-divs
Enveloppez les sections dans balises (ou balises en HTML5), et attachez des identifiants à
l'enclos (ou ) plutôt que l'en-tête lui-même. Voir l'en-tête
identifiants, ci-dessous.
--email-obfuscation=none|javascript|références
Spécifiez une méthode pour masquer mailto : liens dans les documents HTML. aucun ne laisse
mailto : les liens tels qu'ils sont. javascript les obscurcit en utilisant javascript.
les références les obscurcissent en imprimant leurs lettres sous forme décimale ou hexadécimale
références de personnages. La valeur par défaut est javascript.
--id-préfixe=STRING
Spécifiez un préfixe à ajouter à tous les identifiants générés automatiquement en HTML et
sortie DocBook et aux numéros de note de bas de page dans la sortie Markdown. Ceci est utile pour
empêcher les identifiants en double lors de la génération de fragments à inclure dans d'autres
.
-T STRING, --titre-préfixe=STRING
Spécifier STRING comme préfixe au début du titre qui apparaît dans le HTML
en-tête (mais pas dans le titre car il apparaît au début du corps HTML).
Implique --standalone.
-c URL, --css=URL
Lien vers une feuille de style CSS. Cette option peut être utilisée à plusieurs reprises pour inclure
plusieurs fichiers. Ils seront inclus dans l'ordre spécifié.
--référence-odt=DOSSIER
Utilisez le fichier spécifié comme référence de style pour produire un ODT. Pour les meilleurs résultats,
l'ODT de référence doit être une version modifiée d'un ODT produit à l'aide de pandoc.
Le contenu de l'ODT de référence est ignoré, mais ses feuilles de style sont utilisées dans le
nouvel ODT. Si aucune référence ODT n'est spécifiée sur la ligne de commande, pandoc cherchera
pour un fichier reference.odt dans le répertoire des données utilisateur (voir --data-dir). Si c'est
introuvable non plus, des valeurs par défaut sensibles seront utilisées.
--référence-docx=DOSSIER
Utilisez le fichier spécifié comme référence de style lors de la production d'un fichier docx. Pour le meilleur
résultats, le docx de référence doit être une version modifiée d'un fichier docx produit
en utilisant pandoc. Le contenu de la docx de référence est ignoré, mais ses feuilles de style
et les propriétés du document (y compris les marges, la taille de la page, l'en-tête et le pied de page) sont utilisées
dans le nouveau docx. Si aucune référence docx n'est spécifiée sur la ligne de commande, pandoc
recherchera un fichier reference.docx dans le répertoire des données utilisateur (voir --data-dir).
S'il n'est pas trouvé non plus, des valeurs par défaut sensibles seront utilisées. Les styles suivants
sont utilisés par pandoc : [paragraphe] Normal, Corps de texte, Premier paragraphe, Compact, Titre,
Sous-titre, Auteur, Date, Résumé, Bibliographie, Titre 1, Titre 2, Titre 3,
Titre 4, Titre 5, Titre 6, Bloc de texte, Texte de note de bas de page, Terme de définition,
Définition, Légende, Légende du tableau, Légende de l'image, Figure, Figure avec légende, Table des matières
Titre; [caractère] Police de paragraphe par défaut, caractère du corps du texte, caractère verbatim,
Référence de note de bas de page, lien hypertexte ; [tableau] Tableau normal.
--epub-stylesheet=DOSSIER
Utilisez le fichier CSS spécifié pour styliser l'EPUB. Si aucune feuille de style n'est spécifiée,
pandoc recherchera un fichier epub.css dans le répertoire des données utilisateur (voir --data-dir).
S'il n'y est pas trouvé, des valeurs par défaut sensibles seront utilisées.
--epub-cover-image=DOSSIER
Utilisez l'image spécifiée comme couverture EPUB. Il est recommandé que l'image soit
moins de 1000px en largeur et en hauteur. Notez que dans un document source Markdown, vous
peut également spécifier une image de couverture dans un bloc de métadonnées YAML (voir les métadonnées EPUB, ci-dessous).
--epub-métadonnées=DOSSIER
Recherchez dans le fichier XML spécifié les métadonnées de l'EPUB. Le fichier doit contenir
une série d'éléments Dublin Core. Par exemple:
Creative Commons
es-AR
Par défaut, pandoc inclura les éléments de métadonnées suivants : (de
le titre du document), (des auteurs du document), (du
la date du document, qui doit être au format ISO 8601), (de la langue
variable ou, si elle n'est pas définie, la locale), et (une
UUID généré aléatoirement). N'importe lequel de ces éléments peut être remplacé par des éléments de la
fichier de métadonnées.
Remarque : si le document source est Markdown, un bloc de métadonnées YAML dans le document peut
être utilisé à la place. Voir ci-dessous sous Métadonnées EPUB.
--epub-embed-font=DOSSIER
Intégrez la police spécifiée dans l'EPUB. Cette option peut être répétée pour intégrer
plusieurs polices. Des caractères génériques peuvent également être utilisés : par exemple, DejaVuSans-*.ttf.
Cependant, si vous utilisez des caractères génériques sur la ligne de commande, assurez-vous de les échapper ou de mettre
le nom du fichier entier entre guillemets simples, pour éviter qu'ils ne soient interprétés par le
coquille. Pour utiliser les polices intégrées, vous devrez ajouter des déclarations telles que
suivant à votre CSS (voir --epub-stylesheet):
@ font-face {
famille de polices : DejaVuSans ;
font-style: normal;
font-weight: normal;
src:url("DejaVuSans-Regular.ttf");
}
@ font-face {
famille de polices : DejaVuSans ;
font-style: normal;
font-weight: bold;
src:url("DejaVuSans-Bold.ttf");
}
@ font-face {
famille de polices : DejaVuSans ;
style de police : italique ;
font-weight: normal;
src:url("DejaVuSans-Oblique.ttf");
}
@ font-face {
famille de polices : DejaVuSans ;
style de police : italique ;
font-weight: bold;
src:url("DejaVuSans-BoldOblique.ttf");
}
body { font-family: "DejaVuSans"; }
--epub-chapitre-level=NUMÉRO
Spécifiez le niveau d'en-tête auquel diviser l'EPUB en fichiers "chapitres" distincts.
La valeur par défaut consiste à diviser en chapitres au niveau des en-têtes de niveau 1. Cette option n'affecte que
la composition interne de l'EPUB, et non la façon dont les chapitres et les sections sont
affiché aux utilisateurs. Certains lecteurs peuvent être lents si les fichiers de chapitres sont trop volumineux,
donc pour les gros documents avec peu d'en-têtes de niveau 1, on peut vouloir utiliser un chapitre
niveau 2 ou 3.
--latex-engine=pdflatex|lualatex|xelatex
Utilisez le moteur LaTeX spécifié lors de la production d'une sortie PDF. La valeur par défaut est pdflatex.
Si le moteur n'est pas dans votre PATH, le chemin complet du moteur peut être spécifié
ici.
--latex-engine-opt=STRING
Utilisez la chaîne donnée comme argument de ligne de commande pour le moteur latex. Si utilisé
plusieurs fois, les arguments sont fournis avec des espaces entre eux. Notez que non
vérifier les options en double est fait.
Citation rendu
--bibliographie=DOSSIER
Définissez le champ bibliographie dans les métadonnées du document sur DOSSIER, en remplaçant toute valeur
défini dans les métadonnées et traitez les citations à l'aide de pandoc-citeproc. (C'est
équivalent à --metadata bibliography=FILE --filter pandoc-citeproc.) Si --natbib
ou --biplatex est également fourni, pandoc-citeproc n'est pas utilisé, ce qui en fait l'équivalent
à --metadata bibliography=FILE. Si vous fournissez cet argument plusieurs fois, chaque
DOSSIER sera ajouté à la bibliographie.
--csl=DOSSIER
Définissez le champ csl dans les métadonnées du document sur DOSSIER, en remplaçant toute valeur définie dans
les métadonnées. (Ceci est équivalent à --metadata csl=FILE.) Cette option est uniquement
pertinent avec pandoc-citeproc.
--citation-abréviations=DOSSIER
Définissez le champ des abréviations des citations dans les métadonnées du document sur DOSSIER, dépassant
toute valeur définie dans les métadonnées. (Ceci équivaut à
--metadata citation-abbreviations=FILE.) Cette option n'est pertinente qu'avec
pandoc-citeproc.
--natbib
Utilisez natbib pour les citations dans la sortie LaTeX. Cette option n'est pas à utiliser avec le
filtre pandoc-citeproc ou avec sortie PDF. Il est destiné à être utilisé dans la production d'un
Fichier LaTeX pouvant être traité avec bibtex.
--biblatex
Utilisez biblatex pour les citations dans la sortie LaTeX. Cette option n'est pas à utiliser avec le
filtre pandoc-citeproc ou avec sortie PDF. Il est destiné à être utilisé dans la production d'un
Fichier LaTeX pouvant être traité avec bibtex ou biber.
Mathématique rendu in HTML
-m [URL], --latexmathml[=URL]
Utilisez LaTeXMathML pour afficher les mathématiques TeX intégrées dans la sortie HTML. Les URL devrait pointer
au script de chargement LaTeXMathML.js. Si un URL n'est pas fourni, un lien vers
LaTeXMathML.js sur la page d'accueil de LaTeXMathML sera inséré.
--mathml[=URL]
Convertissez les maths TeX en MathML (dans docbook ainsi qu'en html et html5). En autonome
sortie html, un petit javascript (ou un lien vers un tel script si un URL est fourni)
sera inséré qui permet au MathML d'être affiché sur certains navigateurs.
--jsmath[=URL]
Utilisez jsMath pour afficher les mathématiques TeX intégrées dans la sortie HTML. Les URL devrait pointer vers
le script de chargement jsMath (par exemple jsMath/easy/load.js) ; s'il est fourni, il sera lié
dans l'en-tête des documents HTML autonomes. Si un URL n'est pas fourni, pas de lien
au script de chargement jsMath sera inséré ; il appartient alors à l'auteur de fournir
un tel lien dans le modèle HTML.
--mathjax[=URL]
Utilisez MathJax pour afficher les mathématiques TeX intégrées dans la sortie HTML. Les URL devrait pointer vers
le script de chargement MathJax.js. Si un URL n'est pas fourni, un lien vers le CDN MathJax
sera inséré.
--gladtex
Joignez les maths TeX dans balises dans la sortie HTML. Ceux-ci peuvent ensuite être traités par
gladTeX pour produire des liens vers des images des formules composées.
--mimetex[=URL]
Rendu mathématique TeX à l'aide du script CGI mimeTeX. Si URL n'est pas spécifié, c'est
supposons que le script se trouve dans /cgi-bin/mimetex.cgi.
--webtex[=URL]
Rendu des formules TeX à l'aide d'un script externe qui convertit les formules TeX en images.
La formule sera concaténée avec l'URL fournie. Si URL n'est pas spécifié,
l'API Google Chart sera utilisée.
--katex[=URL]
Utilisez KaTeX pour afficher les mathématiques TeX intégrées dans la sortie HTML. Les URL devrait pointer vers le
Script de chargement de katex.js. Si un URL n'est pas fourni, un lien vers le CDN KaTeX sera
inséré.
--katex-stylesheet=URL
La URL doit pointer vers la feuille de style katex.css. Si cette option n'est pas spécifiée,
un lien vers le CDN KaTeX sera inséré. Notez que cette option n'implique pas
--katex.
Options pour papier d'emballage scripts
--dump-arguments
Imprimer des informations sur les arguments de ligne de commande à Stdout, puis quittez. Cette option
est principalement destiné à être utilisé dans les scripts wrapper. La première ligne de sortie
contient le nom du fichier de sortie spécifié avec l'option -o, ou - (pour
Stdout) si aucun fichier de sortie n'a été spécifié. Les lignes restantes contiennent le
arguments de ligne de commande, un par ligne, dans l'ordre dans lequel ils apparaissent. Ceux-ci ne
inclure les options pandoc régulières et leurs arguments, mais inclure toutes les options
apparaissant après un -- séparateur à la fin de la ligne.
--ignore-arguments
Ignorez les arguments de ligne de commande (à utiliser dans les scripts wrapper). Options pandoc régulières
ne sont pas ignorés. Ainsi, par exemple,
pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1
équivaut à
pandoc -o foo.html -s
MODÈLES
Lorsque l'option -s/--standalone est utilisée, pandoc utilise un modèle pour ajouter un en-tête et un pied de page
matériel qui est nécessaire pour un document autonome. Pour voir le modèle par défaut qui est
utilisé, il suffit de taper
pandoc -D *FORMAT*
où Format est le nom du format de sortie. Un modèle personnalisé peut être spécifié en utilisant
l'option --template. Vous pouvez également remplacer les modèles par défaut du système pour un
format de sortie Format en mettant un fichier templates/default.*FORMAT* dans les données utilisateur
répertoire (voir --data-dir, ci-dessus). Des exceptions: Pour une sortie odt, personnalisez le
modèle par défaut.opendocument. Pour la sortie pdf, personnalisez le modèle default.latex.
Les modèles contiennent les variables, qui permettent l'inclusion d'informations arbitraires à tout
point dans le fichier. Les variables peuvent être définies dans le document à l'aide de blocs de métadonnées YAML.
Ils peuvent également être définis en ligne de commande à l'aide de l'option -V/--variable : variables définies dans
de cette façon, remplacez les champs de métadonnées portant le même nom.
Variables set by pandoc
Certaines variables sont définies automatiquement par pandoc. Celles-ci varient quelque peu selon les
format de sortie, mais incluez les champs de métadonnées ainsi que les éléments suivants :
Titre, auteur, données
permettre l'identification des aspects fondamentaux du document. Inclus dans les métadonnées PDF
via LaTeX et ConTeXt. Ceux-ci peuvent être définis via un bloc de titre pandoc, qui
autorise plusieurs auteurs ou via un bloc de métadonnées YAML :
---
auteur:
-Aristote
- Pierre Abélard
sous-titre
sous-titre du document, inclus dans HTML, EPUB, LaTeX, ConTeXt et Word docx ; rend
dans LaTeX uniquement lors de l'utilisation d'une classe de document qui prend en charge \subtitle, telle que beamer
ou la série KOMA-Script (scrartcl, scrreprt, scrbook).
résumé
résumé du document, inclus dans LaTeX, ConTeXt, AsciiDoc et Word docx
mots clés
liste de mots-clés à inclure dans les métadonnées HTML, PDF et AsciiDoc ; Peut être
répété comme pour l'auteur, ci-dessus
en-tête-inclut
contenu spécifié par -H/--include-in-header (peut avoir plusieurs valeurs)
toc valeur non nulle si --toc/--table-of-contents a été spécifié
toc-titre
titre de la table des matières (fonctionne uniquement avec EPUB et docx)
inclure-avant
contenu spécifié par -B/--include-before-body (peut avoir plusieurs valeurs)
inclure-après
contenu spécifié par -A/--include-after-body (peut avoir plusieurs valeurs)
corps corps du document
méta-json
Représentation JSON de toutes les métadonnées du document
Langue les variables
long identifie la langue principale du document, à l'aide d'un code selon BCP 47
(par exemple en ou en-GB). Pour certains formats de sortie, pandoc le convertira en un
format approprié stocké dans les variables supplémentaires babel-lang, polyglossia-lang
(LaTeX) et context-lang (ConTeXt).
Les spans et divs pandoc natifs avec l'attribut lang (valeur dans BCP 47) peuvent être utilisés
pour changer la langue dans cette plage.
autres langages
une liste des autres langues utilisées dans le document dans les métadonnées YAML, selon
BCP 47. Par exemple : otherlangs : [en-GB, fr]. Ceci est généré automatiquement
des attributs lang dans tous les spans et divs, mais peut être remplacé. Actuellement
uniquement utilisé par LaTeX via les babel-otherlangs générés et
variables polyglossia-otherlangs. L'écrivain LaTeX génère des commandes polyglossia dans
le texte mais la variable babel-newcommands contient des mappages pour eux avec le
babel correspondant.
dir la direction de base du document, soit rtl (de droite à gauche) ou ltr
(de gauche à droite).
Pour les documents bidirectionnels, pandoc natif s'étend et div avec l'attribut dir
(valeur rtl ou ltr) peut être utilisé pour remplacer la direction de base dans certaines sorties
formatage. Cela peut ne pas toujours être nécessaire si le moteur de rendu final (par exemple le
navigateur, lors de la génération de HTML) prend en charge l'algorithme bidirectionnel Unicode.
Lors de l'utilisation de LaTeX pour des documents bidirectionnels, seul le moteur xelatex est entièrement
pris en charge (utilisez --latex-engine=xelatex).
Variables pour diapositives
Des variables sont disponibles pour produire des diaporamas avec pandoc, y compris tous les Reveal.js
options de configuration.
URL coulissante
URL de base pour les documents Slidy (par défaut http://www.w3.org/Talks/Tools/Slidy2)
URL glissante
URL de base pour les documents Slideous (par défaut, slideous)
URL-s5 URL de base pour les documents S5 (par défaut s5/default)
URL-révélerjs
URL de base pour les documents Reveal.js (valeur par défaut pour Reveal.js)
thème, thème de couleur, thème de police, thème intérieur, thème extérieur
thèmes pour les documents beamer LaTeX
la navigation
contrôle les symboles de navigation dans les documents beamer (la valeur par défaut est vide pour aucune navigation
symboles; les autres valeurs valides sont frame, vertical et horizontal).
titres-de-section
active sur les "pages de titre" pour les nouvelles sections dans les documents beamer (par défaut = vrai).
Variables pour Latex
Les variables LaTeX sont utilisées lors de la création d'un PDF.
taille de papier
format de papier, par exemple lettre, A4
taille de police
taille de la police pour le corps du texte (par exemple 10pt, 12pt)
classe de document
classe de document, par exemple article, rapport, livre, mémoire
option de classe
option pour la classe de document, par exemple oneside ; peut être répété pour plusieurs options
géométrie
option pour le package de géométrie, par exemple margin=1in; peut être répété pour plusieurs options
marge-gauche, marge-droite, marge supérieure, marge-bas
définit les marges, si la géométrie n'est pas utilisée (sinon la géométrie les remplace)
étirement
ajuste l'interligne à l'aide du package setspace, par exemple 1.25, 1.5
famille de polices
paquet de polices à utiliser avec pdflatex : TeX Live inclut de nombreuses options, documentées dans
le catalogue de polices LaTeX. La valeur par défaut est latin moderne.
policefamilleoptions
options pour le package utilisé comme fontfamily : par exemple osf,sc avec fontfamily défini sur
mathpazo fournit à Palatino des chiffres à l'ancienne et de vraies petites capitales ; Peut être
répété pour plusieurs options
police principale, sans police, monopolice, police mathématique, CJCmainfont
familles de polices à utiliser avec xelatex ou lualatex : prenez le nom de n'importe quelle police système,
en utilisant le package fontspec. Notez que si CJKmainfont est utilisé, le package xecjk
doit être disponible.
optionsmainfont, sansoptionsdefonte, options de police unique, options de police mathématique, Options CJC
options à utiliser avec mainfont, sansfont, monofont, mathfont, CJKmainfont dans xelatex
et lualatex. Autoriser tous les choix disponibles via fontspec, tels que le
Fonctionnalités OpenType Numbers=OldStyle,Numbers=Proportional. Peut être répété pour
plusieurs options.
fontenc
permet de spécifier l'encodage des polices via le package fontenc (avec pdflatex);
la valeur par défaut est T1 (voir le guide des encodages de polices LaTeX)
liens de couleur
ajouter de la couleur au texte du lien ; automatiquement activé si l'un de linkcolor, citecolor,
urlcolor ou toccolor sont définis
couleur du lien, citecolor, couleur de l'url, toccolor
couleur pour les liens internes, les liens de citation, les liens externes et les liens dans le tableau des
contenu : utilise l'une des couleurs LaTeX prédéfinies
liens-comme-notes
provoque l'impression des liens sous forme de notes de bas de page
retrait utilise les paramètres de classe de document pour l'indentation (le modèle LaTeX par défaut sinon
supprime l'indentation et ajoute de l'espace entre les paragraphes)
sous-paragraphe
désactive le comportement par défaut du modèle LaTeX qui redéfinit les (sous)paragraphes comme
sections, modification de l'apparence des en-têtes imbriqués dans certaines classes
à spécifie le contenu de la note de bas de page des remerciements après le titre du document.
toc inclure la table des matières (peut également être défini à l'aide de --toc/--table-of-contents)
toc-profondeur
niveau de section à inclure dans la table des matières
mdr, lot
inclure la liste des figures, la liste des tableaux
bibliographie
bibliographie à utiliser pour résoudre les références
style biblio
style bibliographie, lorsqu'il est utilisé avec --natbib et --biblatex.
options biblatex
liste d'options pour biblatex.
Variables pour Le contexte
taille de papier
format de papier, par exemple lettre, A4, paysage (voir Configuration du papier ConTeXt) ; peut être répété
pour plusieurs options
disposition options pour les marges de page et la disposition du texte (voir ConTeXt Layout) ; peut être répété
pour plusieurs options
marge-gauche, marge-droite, marge supérieure, marge-bas
définit les marges, si la mise en page n'est pas utilisée (sinon la mise en page les remplace)
taille de police
taille de la police pour le corps du texte (par exemple 10pt, 12pt)
police principale, sans police, monopolice, police mathématique
familles de polices : prenez le nom de n'importe quelle police système (voir Changement de police ConTeXt)
couleur du lien, couleur de contraste
couleur pour les liens à l'extérieur et à l'intérieur d'une page, par exemple rouge, bleu (voir ConTeXt Color)
style de lien
style de police de caractères pour les liens, par exemple normal, gras, incliné, gras, type, majuscule,
petit
indentation
contrôle l'indentation des paragraphes, par exemple oui,petit,suivant (voir Indentation ConTeXt) ;
peut être répété pour plusieurs options
whitespace
espacement entre les paragraphes, par exemple aucun, petit (en utilisant setupwhitespace)
interligne
ajuste l'espacement des lignes, par exemple 4ex (en utilisant setupinterlineespace); peut être répété pour
plusieurs options
en-tête, texte de pied de page
texte à placer dans l'en-tête ou le pied de page courant (voir En-têtes et pieds de page ConTeXt) ;
peut être répété jusqu'à quatre fois pour un placement différent
numérotation des pages
le style et l'emplacement du numéro de page (à l'aide de setuppagenumbering) ; peut être répété pour
plusieurs options
toc inclure la table des matières (peut également être défini à l'aide de --toc/--table-of-contents)
mdr, lot
inclure la liste des figures, la liste des tableaux
Variables pour man pages
numéro de section dans les pages de manuel
entête en-tête dans les pages de manuel
pied de page pied de page dans les pages de manuel
réglage
ajuste le texte à gauche (l), à droite (r), au centre (c) ou aux deux (b) marges
trait d'union
si vrai (valeur par défaut), la césure sera utilisée
En utilisant les variables in modèles
Les noms de variables sont des séquences de caractères alphanumériques, - et _, commençant par une lettre. UNE
le nom de la variable entouré de signes $ sera remplacé par sa valeur. Par exemple, le
chaîne $titre$ dans
$titre$
sera remplacé par le titre du document.
Pour écrire un littéral $ dans un modèle, utilisez $$.
Les modèles peuvent contenir des conditions. La syntaxe est la suivante :
$si(variable)$
X
$autre$
Y
$endif$
Cela inclura X dans le modèle si la variable a une valeur non nulle ; sinon ça va
inclure Y. X et Y sont des espaces réservés pour tout texte de modèle valide et peuvent inclure
variables interpolées ou autres conditions. La section $else$ peut être omise.
Lorsque les variables peuvent avoir plusieurs valeurs (par exemple, auteur dans un document multi-auteurs),
vous pouvez utiliser le mot-clé $for$ :
$pour(auteur)$
$finpour$
Vous pouvez éventuellement spécifier un séparateur à utiliser entre les éléments consécutifs :
$for(auteur)$$auteur$$sep$, $endfor$
Un point peut être utilisé pour sélectionner un champ d'une variable qui prend un objet comme valeur. Donc,
par exemple:
$auteur.nom$ ($auteur.affiliation$)
Si vous utilisez des modèles personnalisés, vous devrez peut-être les réviser au fur et à mesure des changements de pandoc. Nous recommandons
suivi des changements dans les modèles par défaut et modification de vos modèles personnalisés
par conséquent. Un moyen simple de le faire est de forker le référentiel pandoc-templates et de fusionner
dans les changements après chaque version de pandoc.
PANDOC'S RÉDUCTION
Pandoc comprend une version étendue et légèrement révisée du Markdown de John Gruber
syntaxe. Ce document explique la syntaxe, en notant les différences par rapport au Markdown standard.
Sauf indication contraire, ces différences peuvent être supprimées en utilisant le markdown_strict
format au lieu de démarques. Une extension peut être activée en ajoutant +EXTENSION au
nom du format et désactivé en ajoutant -EXTENSION. Par exemple, markdown_strict+notes de bas de page est
Markdown strict avec les notes de bas de page activées, tandis que markdown-footnotes-pipe_tables est celui de pandoc
Markdown sans notes de bas de page ni tableaux de tuyaux.
Philosophie
Markdown est conçu pour être facile à écrire et, plus important encore, facile à lire :
Un document au format Markdown doit être publiable tel quel, en texte brut, sans
on dirait qu'il a été balisé avec des balises ou des instructions de formatage. -- John
Gruber
Ce principe a guidé les décisions de pandoc dans la recherche de la syntaxe des tableaux, notes de bas de page et
autres extensions.
Il y a, cependant, un aspect dans lequel les objectifs de pandoc sont différents des objectifs originaux
de Markdown. Alors que Markdown a été conçu à l'origine avec la génération HTML à l'esprit,
pandoc est conçu pour plusieurs formats de sortie. Ainsi, alors que pandoc permet l'intégration
du HTML brut, il le décourage et fournit d'autres moyens non HTML de représenter
éléments importants du document comme les listes de définitions, les tableaux, les mathématiques et les notes de bas de page.
Paragraphes
Un paragraphe est constitué d'une ou plusieurs lignes de texte suivies d'une ou plusieurs lignes vides. Nouvelles lignes
sont traités comme des espaces, vous pouvez donc redistribuer vos paragraphes comme vous le souhaitez. Si vous avez besoin d'un dur
saut de ligne, mettez deux espaces ou plus à la fin d'une ligne.
Extension: escaped_line_breaks
Une barre oblique inverse suivie d'une nouvelle ligne est également un saut de ligne dur. Remarque : en multiligne et en grille
cellules du tableau, c'est le seul moyen de créer un saut de ligne fixe, car les espaces de fin dans
les cellules sont ignorées.
En-têtes
Il existe deux types d'en-têtes : Setext et ATX.
Style de sétexte têtes
Un en-tête de style textuel est une ligne de texte "soulignée" avec une rangée de signes = (pour un niveau
un en-tête) ou des signes - (pour un en-tête de niveau XNUMX) :
Un en-tête de niveau un
==================
Un en-tête de niveau deux
------------------
Le texte de l'en-tête peut contenir une mise en forme en ligne, telle que l'emphase (voir Mise en forme en ligne,
ci-dessous).
Style ATX têtes
Un en-tête de style ATX se compose d'un à six signes # et d'une ligne de texte, éventuellement suivis
par un nombre quelconque de # signes. Le nombre de # signes au début de la ligne est le
niveau d'en-tête :
## Un en-tête de niveau deux
### Un en-tête de niveau trois ###
Comme pour les en-têtes de style setext, le texte d'en-tête peut contenir une mise en forme :
# Un en-tête de niveau un avec un [lien](/url) et *emphase*
Extension: blank_before_header
La syntaxe Markdown standard ne nécessite pas de ligne vide avant un en-tête. Pandoc fait
l'exiger (sauf, bien sûr, au début du document). La raison de la
condition est qu'il est trop facile pour un # de se retrouver au début d'une ligne en
accident (peut-être par retour à la ligne). Considérez, par exemple :
J'aime plusieurs de leurs parfums de glaces :
#22, par exemple, et #5.
En-tête Identificateurs
Extension: header_attributes
Les en-têtes peuvent se voir attribuer des attributs en utilisant cette syntaxe à la fin de la ligne contenant le
en-tête:
{#identifiant .class .class clé=valeur clé=valeur}
Ainsi, par exemple, les en-têtes suivants se verront tous attribuer l'identifiant foo :
# Mon en-tête {#foo}
## Mon en-tête ## {#foo}
Mon autre en-tête {#foo}
---------------
(Cette syntaxe est compatible avec PHP Markdown Extra.)
Notez que bien que cette syntaxe permette l'affectation de classes et d'attributs clé/valeur,
les auteurs n'utilisent généralement pas toutes ces informations. Identifiants, classes et clé/valeur
les attributs sont utilisés dans les formats HTML et basés sur HTML tels que EPUB et slidy. Identifiants
sont utilisés pour les étiquettes et les ancres de lien dans les rédacteurs LaTeX, ConTeXt, Textile et AsciiDoc.
Les en-têtes avec la classe non numérotée ne seront pas numérotés, même si --number-sections est
spécifié. Un seul tiret (-) dans un contexte d'attribut équivaut à .unnumbered, et
préférable dans les documents non anglais. Donc,
# Mon entête {-}
est juste le même que
# Mon en-tête {.unnumbered}
Extension: identifiants automatiques
Un en-tête sans identifiant explicitement spécifié se verra automatiquement attribuer un
identifiant unique basé sur le texte de l'en-tête. Pour dériver l'identifiant de l'en-tête
texte,
· Supprimez tous les formatages, liens, etc.
· Supprimez toutes les notes de bas de page.
· Supprimez toutes les ponctuations, à l'exception des traits de soulignement, des traits d'union et des points.
· Remplacez tous les espaces et les nouvelles lignes par des tirets.
· Convertissez tous les caractères alphabétiques en minuscules.
· Supprimez tout jusqu'à la première lettre (les identifiants ne doivent pas commencer par un chiffre ou
signe de ponctuation).
· S'il ne reste rien après cela, utilisez la section identifiant.
Ainsi, par exemple,
Identifiant d'en-tête
?? ??
Identifiants d'en-tête en HTML header-identifiers-in-html
*Chiens*?--dans *ma* maison ? chiens--dans-ma-maison
[HTML], [S5] ou [RTF] ? html-s5-ou-rtf
3. Candidatures
Six pans
Ces règles devraient, dans la plupart des cas, permettre de déterminer l'identifiant à partir de l'en-tête
texte. L'exception est lorsque plusieurs en-têtes ont le même texte ; dans ce cas, le premier
obtiendra un identifiant comme décrit ci-dessus ; le second obtiendra le même identifiant avec -1
en annexe ; le troisième avec -2 ; etc.
Ces identifiants sont utilisés pour fournir des cibles de liens dans la table des matières générée par
l'option --toc|--table des matières. Ils permettent également de fournir facilement des liens à partir d'un
section d'un document à l'autre. Un lien vers cette section, par exemple, pourrait ressembler à
ce:
Voir la rubrique sur
[identificateurs d'en-tête](#header-identifiers-in-html-latex-and-context).
Notez, cependant, que cette méthode de fourniture de liens vers des sections ne fonctionne qu'en HTML, LaTeX,
et ConTeXt.
Si l'option --section-divs est spécifiée, alors chaque section sera enveloppée dans un div (ou
une section, si --html5 a été spécifié), et l'identifiant sera attaché à l'englobant
(ou ) plutôt que l'en-tête lui-même. Cela permet à des sections entières d'être
manipulé à l'aide de javascript ou traité différemment en CSS.
Extension: références_en-tête_implicites
Pandoc se comporte comme si des liens de référence avaient été définis pour chaque en-tête. Alors, au lieu de
[identificateurs d'en-tête](#header-identifiers-in-html)
vous pouvez simplement écrire
[identifiants d'en-tête]
or
[identifiants d'en-tête][]
or
[la section sur les identifiants d'en-tête][identifiants d'en-tête]
S'il y a plusieurs en-têtes avec un texte identique, la référence correspondante fera le lien
au premier seulement, et vous devrez utiliser des liens explicites pour vous lier aux autres, comme
décrit ci-dessus.
Comme les liens de référence normaux, ces références sont insensibles à la casse.
Les définitions de référence de lien explicite ont toujours la priorité sur les références d'en-tête implicites.
Ainsi, dans l'exemple suivant, le lien pointera vers bar, pas vers #foo :
# Foo
[toto] : barre
Voir [toto]
Bloquer citations
Markdown utilise des conventions de courrier électronique pour citer des blocs de texte. Une cotation en bloc est une ou
plus de paragraphes ou d'autres éléments de bloc (tels que des listes ou des en-têtes), avec chaque ligne
précédé d'un caractère > et d'un espace facultatif. (Le > n'a pas besoin de commencer à gauche
marge, mais il ne doit pas être en retrait de plus de trois espaces.)
> Ceci est une citation en bloc. Cette
> le paragraphe a deux lignes.
>
> 1. Il s'agit d'une liste à l'intérieur d'un guillemet.
> 2. Deuxième élément.
Une forme "paresseuse", qui nécessite le caractère > uniquement sur la première ligne de chaque bloc, est
aussi permis :
> Ceci est une citation en bloc. Cette
paragraphe a deux lignes.
> 1. Il s'agit d'une liste à l'intérieur d'un guillemet.
2. Deuxième élément.
Parmi les éléments de bloc qui peuvent être contenus dans une citation de bloc, il y a d'autres citations de bloc.
C'est-à-dire que les guillemets de bloc peuvent être imbriqués :
> Ceci est une citation en bloc.
>
> > Une citation de bloc dans une citation de bloc.
Si le caractère > est suivi d'un espace facultatif, cet espace sera considéré comme faisant partie de
le marqueur de guillemets de bloc et ne fait pas partie de l'indentation du contenu. Ainsi, mettre un
bloc de code en retrait dans un guillemet de bloc, vous avez besoin de cinq espaces après le > :
> code
Extension: blank_before_blockquote
La syntaxe Markdown standard ne nécessite pas de ligne vide avant un guillemet de bloc. Pandoc fait
l'exiger (sauf, bien sûr, au début du document). La raison de la
l'exigence est qu'il est trop facile pour un > de se retrouver au début d'une ligne en
accident (peut-être par retour à la ligne). Donc, à moins que le format markdown_strict soit utilisé,
ce qui suit ne produit pas de citation de bloc imbriquée dans pandoc :
> Ceci est une citation en bloc.
>> Imbriqué.
Textuellement (code) blocs
Dentelé code blocs
Un bloc de texte en retrait de quatre espaces (ou une tabulation) est traité comme du texte verbatim : c'est-à-dire
les caractères spéciaux ne déclenchent pas de formatage spécial et tous les espaces et sauts de ligne sont
conservé. Par exemple,
si (a > 3) {
moveShip (5 * gravité, BAS);
}
L'indentation initiale (quatre espaces ou une tabulation) n'est pas considérée comme faisant partie du verbatim
text, et est supprimé dans la sortie.
Remarque : les lignes vides dans le texte textuel ne doivent pas nécessairement commencer par quatre espaces.
Clôturé code blocs
Extension: blocs_de_code_clôturés
En plus des blocs de code indentés standard, pandoc prend en charge clôturé blocs de code. Ces
commencer par une rangée de trois tildes ou plus (~) et se terminer par une rangée de tildes qui doit être à
au moins aussi long que la ligne de départ. Tout ce qui se trouve entre ces lignes est traité comme du code. Non
l'indentation est nécessaire :
~~~~~~~
si (a > 3) {
moveShip (5 * gravité, BAS);
}
~~~~~~~
Comme les blocs de code normaux, les blocs de code clôturés doivent être séparés du texte environnant par
lignes vierges.
Si le code lui-même contient une rangée de tildes ou de backticks, utilisez simplement une rangée plus longue de tildes
ou backticks au début et à la fin :
~~~~~~~~~~~~~~~~~
~~~~~~~~~~
code avec tildes
~~~~~~~~~~
~~~~~~~~~~~~~~~~~
Extension: backtick_code_blocks
Identique à fenced_code_blocks, mais utilise des backticks (`) au lieu de tildes (~).
Extension: clôture_code_attributes
Facultativement, vous pouvez attacher des attributs au bloc de code clôturé ou backtick en utilisant cette syntaxe :
~~~~ {#moncode .haskell .numberLines startFrom="100"}
qtrier [] = []
qsort (x:xs) = qsort (filtre (< x) xs) ++ [x] ++
qsort (filtre (>= x) xs)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Ici mycode est un identifiant, haskell et numberLines sont des classes, et startFrom est un
attribut avec la valeur 100. Certains formats de sortie peuvent utiliser ces informations pour faire la syntaxe
mise en évidence. Actuellement, les seuls formats de sortie qui utilisent ces informations sont HTML et
Latex. Si la mise en évidence est prise en charge pour votre format de sortie et votre langue, le code
le bloc ci-dessus apparaîtra en surbrillance, avec des lignes numérotées. (Pour voir quelles langues sont
pris en charge, faites pandoc --version.) Sinon, le bloc de code ci-dessus apparaîtra comme suit :
Un formulaire de raccourci peut également être utilisé pour spécifier la langue du bloc de code :
```haskel
qtrier [] = []
`` `
Cela équivaut à:
``` {.haskell}
qtrier [] = []
`` `
Si l'extension fenced_code_attributes est désactivée, mais que l'entrée contient des attributs de classe
pour le bloc de code, le premier attribut de classe sera imprimé après la clôture d'ouverture en tant que
mot nu.
Pour éviter toute surbrillance, utilisez l'indicateur --no-highlight. Pour définir le style de surbrillance,
utilisez --highlight-style. Pour plus d'informations sur la mise en évidence, voir Mise en évidence de la syntaxe,
ci-dessous.
Gamme blocs
Extension: blocs_lignes
Un bloc de lignes est une séquence de lignes commençant par une barre verticale (|) suivie d'un espace.
La division en lignes sera conservée dans la sortie, tout comme les espaces de début ;
sinon, les lignes seront formatées en Markdown. Ceci est utile pour le verset et
adresses :
| Le limerick packs rit anatomique
| Dans l'espace, c'est assez économique.
| Mais les bons que j'ai vu
| Si rarement sont propres
| Et les propres sont si rarement comiques
| 200, rue Main
| Berkeley, Californie 94718
Les lignes peuvent être encapsulées si nécessaire, mais la ligne de continuation doit commencer par un
espace.
| Le Très Honorable Très Vénérable et Juste Samuel L.
L'agent de police Jr.
| 200, rue Main
| Berkeley, Californie 94718
Cette syntaxe est empruntée à reStructuredText.
Liste
Canon listes
Une liste à puces est une liste d'éléments de liste à puces. Un élément de liste à puces commence par une puce
(*, + ou -). Voici un exemple simple :
* une
* deux
* Trois
Cela produira une liste "compacte". Si vous voulez une liste « libre », dans laquelle chaque élément est
formaté comme un paragraphe, placez des espaces entre les éléments :
* une
* deux
* Trois
Les balles n'ont pas besoin d'être alignées avec la marge de gauche ; ils peuvent être en retrait d'un, deux ou
trois espaces. La puce doit être suivie d'un espace.
Les éléments de la liste sont plus beaux si les lignes suivantes affleurent la première ligne (après la puce) :
* voici mon premier
élément de liste.
* et mon deuxième.
Mais Markdown permet aussi un format « paresseux » :
* voici mon premier
élément de liste.
* et mon deuxième.
La quatre espaces exclure
Un élément de liste peut contenir plusieurs paragraphes et autre contenu de niveau bloc. Cependant,
les paragraphes suivants doivent être précédés d'une ligne vierge et indentés de quatre espaces ou d'une tabulation.
La liste sera meilleure si le premier paragraphe est aligné avec le reste :
* Premier paragraphe.
A continué.
* La deuxième paragraphe. Avec un bloc de code, qui doit être indenté
huit espaces :
{code}
Les éléments de liste peuvent inclure d'autres listes. Dans ce cas, la ligne vierge précédente est facultative.
La liste imbriquée doit être en retrait de quatre espaces ou d'une tabulation :
* des fruits
+ pommes
-macintosh
- rouge délicieux
+ poires
+ pêches
* les légume
+ brocoli
+ bette
Comme indiqué ci-dessus, Markdown vous permet d'écrire des éléments de liste "paresseusement", au lieu de mettre en retrait
lignes de continuation. Cependant, s'il y a plusieurs paragraphes ou autres blocs dans une liste
élément, la première ligne de chacun doit être en retrait.
+ Une liste paresseuse, paresseuse
article.
+ Un autre ; ça a l'air
mauvais mais est légal.
Deuxième paragraphe du deuxième
élément de liste.
Attention: Bien que la règle des quatre espaces pour les paragraphes de continuation vienne de la
Guide de syntaxe Markdown, l'implémentation de référence, Markdown.pl, ne le suit pas. Donc
pandoc donnera des résultats différents de Markdown.pl lorsque les auteurs auront mis en retrait
paragraphes de continuation de moins de quatre espaces.
Le guide de syntaxe Markdown n'est pas explicite si la règle des quatre espaces s'applique à tous
contenu de niveau bloc dans un élément de liste ; il ne mentionne que les paragraphes et les blocs de code. Mais il
implique que la règle s'applique à tout le contenu de niveau bloc (y compris les listes imbriquées), et
pandoc l'interprète ainsi.
Ordonné listes
Les listes ordonnées fonctionnent exactement comme les listes à puces, sauf que les éléments commencent par des énumérateurs
plutôt que des balles.
Dans Markdown standard, les énumérateurs sont des nombres décimaux suivis d'un point et d'un espace.
Les nombres eux-mêmes sont ignorés, il n'y a donc aucune différence entre cette liste :
1. un
2. deux
3. trois
et celui-là:
5. un
7. deux
1. trois
Extension: listes_fantaisies
Contrairement au Markdown standard, pandoc permet aux éléments de liste ordonnés d'être marqués avec des majuscules et
lettres minuscules et chiffres romains, en plus des chiffres arabes. Les marqueurs de liste peuvent être
entre parenthèses ou suivi d'une seule parenthèse droite ou d'un point. Ils doivent être
séparé du texte qui suit par au moins un espace, et, si le marqueur de liste est un
majuscule avec un point, d'au moins deux espaces.
L'extension fancy_lists permet également d'utiliser '#' comme marqueur de liste ordonnée à la place de
un chiffre :
#. une
#. deux
Extension: numéro de départ
Pandoc fait également attention au type de marqueur de liste utilisé, et au numéro de départ,
et les deux sont préservés dans la mesure du possible dans le format de sortie. Ainsi, ce qui suit
donne une liste avec des nombres suivis d'une seule parenthèse, commençant par 9, et un
sous-liste avec des chiffres romains minuscules :
9) Neuvième
10) Dixième
11) Onzième
je. sous-un
ii. sous-deux
iii. sous-trois
Pandoc commencera une nouvelle liste à chaque fois qu'un type différent de marqueur de liste est utilisé. Alors le
suivant va créer trois listes :
(2) Deux
(5) Trois
1. Quatre
* Cinq
Si des marqueurs de liste par défaut sont souhaités, utilisez #. :
#. une
#. deux
#. Trois
Définition listes
Extension: définition_listes
Pandoc prend en charge les listes de définitions, en utilisant la syntaxe de PHP Markdown Extra avec certains
Extensions.
Terme 1
: Définition 1
Terme 2 avec *balisage en ligne*
: Définition 2
{ du code, partie de la définition 2 }
Troisième paragraphe de la définition 2.
Chaque terme doit tenir sur une ligne, qui peut éventuellement être suivie d'une ligne vierge, et doit
être suivi d'une ou plusieurs définitions. Une définition commence par un deux-points ou un tilde, qui
peut être en retrait d'un ou deux espaces.
Un terme peut avoir plusieurs définitions, et chaque définition peut consister en un ou plusieurs blocs
éléments (paragraphe, bloc de code, liste, etc.), chacun indenté de quatre espaces ou d'un taquet de tabulation.
Le corps de la définition (y compris la première ligne, à part les deux points ou le tilde)
devrait être en retrait de quatre espaces. Cependant, comme avec d'autres listes Markdown, vous pouvez "paresseusement"
omettre l'indentation sauf au début d'un paragraphe ou d'un autre élément de bloc :
Terme 1
: Définition
avec poursuite paresseuse.
Deuxième paragraphe de la définition.
Si vous laissez un espace avant la définition (comme dans l'exemple ci-dessus), le texte de la
la définition sera traitée comme un paragraphe. Dans certains formats de sortie, cela signifie une plus grande
espacement entre les paires terme/définition. Pour une liste de définitions plus compacte, omettez l'espace
avant la définition :
Terme 1
~ Définition 1
Terme 2
~ Définition 2a
~ Définition 2b
Notez que l'espace entre les éléments d'une liste de définitions est requis. (Une variante qui desserre
cette exigence, mais interdit l'emballage dur "paresseux", peut être activée avec
compact_definition_lists : voir les extensions non-pandoc, ci-dessous.)
numérotée (ici) listes
Extension: exemples_listes
Le marqueur de liste spéciale @ peut être utilisé pour des exemples numérotés de manière séquentielle. La première liste
l'élément avec un marqueur @ sera numéroté « 1 », le prochain « 2 », et ainsi de suite, tout au long de la
document. Les exemples numérotés n'ont pas besoin d'apparaître dans une seule liste ; chaque nouvelle liste en utilisant @
reprendra là où le dernier s'est arrêté. Ainsi, par exemple :
(@) Mon premier exemple sera numéroté (1).
(@) Mon deuxième exemple sera numéroté (2).
Explication des exemples.
(@) Mon troisième exemple sera numéroté (3).
Les exemples numérotés peuvent être étiquetés et référencés ailleurs dans le document :
(@bon) C'est un bon exemple.
Comme (@good) l'illustre, ...
L'étiquette peut être n'importe quelle chaîne de caractères alphanumériques, de traits de soulignement ou de tirets.
Compact et en vrac listes
Pandoc se comporte différemment de Markdown.pl sur certains "cas extrêmes" impliquant des listes.
Considérez cette source :
+ Premier
+ Deuxième :
- Frais
- Fi
- Ennemi
+ Troisième
Pandoc la transforme en une "liste compacte" (sans balises autour de "Premier", "Deuxième",
ou "Troisième"), tandis que Markdown met balises autour de "Deuxième" et "Troisième" (mais pas "Premier"),
à cause de l'espace vide autour de "Troisième". Pandoc suit une règle simple : si le texte est
suivi d'une ligne vierge, il est traité comme un paragraphe. Étant donné que « Deuxième » est suivi d'un
list, et non une ligne vide, il n'est pas traité comme un paragraphe. Le fait que la liste soit
suivi d'une ligne vierge n'a pas d'importance. (Remarque : Pandoc fonctionne de cette façon même lorsque le
le format markdown_strict est spécifié. Ce comportement est conforme à l'officiel
Description de la syntaxe de Markdown, même si elle est différente de celle de Markdown.pl.)
Fin a liste
Et si vous vouliez mettre un bloc de code en retrait après une liste ?
- article un
- point deux
{ mon bloc de code }
Inquiéter! Ici, pandoc (comme d'autres implémentations Markdown) traitera { mon bloc de code } comme
le deuxième paragraphe du point deux, et non comme un bloc de code.
Pour "couper" la liste après l'élément deux, vous pouvez insérer du contenu non indenté, comme un
Commentaire HTML, qui ne produira de sortie visible dans aucun format :
- article un
- point deux
{ mon bloc de code }
Vous pouvez utiliser la même astuce si vous voulez deux listes consécutives au lieu d'une grande liste :
1. un
2. deux
3. trois
1. un
2. faire
3. trois
Horizontal
Une ligne contenant une ligne de trois caractères ou plus *, - ou _ (éventuellement séparés par
espaces) produit une règle horizontale :
* * * *
---------------
Tables
Quatre types de tableaux peuvent être utilisés. Les trois premiers types supposent l'utilisation d'un
police à largeur fixe, telle que Courier. Le quatrième type peut être utilisé avec un espacement proportionnel
polices, car il ne nécessite pas d'aligner les colonnes.
Extension: table_captions
Une légende peut éventuellement être fournie avec les 4 types de tableaux (comme illustré dans le
exemples ci-dessous). Une légende est un paragraphe commençant par la chaîne Table : (ou simplement :),
qui sera dépouillé. Il peut apparaître avant ou après le tableau.
Extension: tables_simples
Les tableaux simples ressemblent à ceci :
Droite Gauche Centre Par défaut
------- ------ ---------- -------
12 12 12 12
123 123 123 123
1 1 1 1
Tableau : démonstration de la syntaxe simple d'un tableau.
Les en-têtes et les lignes du tableau doivent tenir chacun sur une ligne. Les alignements de colonnes sont déterminés par
la position du texte d'en-tête par rapport à la ligne pointillée en dessous :
· Si la ligne pointillée est alignée avec le texte d'en-tête sur le côté droit mais s'étend au-delà
à gauche, la colonne est alignée à droite.
· Si la ligne pointillée est alignée avec le texte de l'en-tête sur le côté gauche mais s'étend au-delà
à droite, la colonne est alignée à gauche.
· Si la ligne pointillée s'étend au-delà du texte d'en-tête des deux côtés, la colonne est centrée.
· Si la ligne pointillée affleure le texte de l'en-tête des deux côtés, l'alignement par défaut est
utilisé (dans la plupart des cas, cela sera laissé).
Le tableau doit se terminer par une ligne vierge ou une ligne de tirets suivie d'une ligne vierge.
Les en-têtes de colonne peuvent être omis, à condition qu'une ligne pointillée soit utilisée pour terminer le tableau. Pour
Exemple:
------- ------ ---------- -------
12 12 12 12
123 123 123 123
1 1 1 1
------- ------ ---------- -------
Lorsque les en-têtes sont omis, les alignements de colonnes sont déterminés sur la base de la première ligne
du corps du tableau. Ainsi, dans les tableaux ci-dessus, les colonnes seraient à droite, à gauche, au centre et
aligné à droite, respectivement.
Extension: tables_multilignes
Les tableaux multilignes permettent aux en-têtes et aux lignes de tableau de s'étendre sur plusieurs lignes de texte (mais les cellules
qui s'étendent sur plusieurs colonnes ou lignes du tableau ne sont pas pris en charge). Voici un exemple:
-------------------------------------------------- -----------
Centré Par défaut Droite Gauche
En-tête Aligné Aligné Aligné
----------- ------- --------------- ----------------- --------
Première ligne 12.0 Exemple d'une ligne qui
s'étend sur plusieurs lignes.
Deuxième rangée 5.0 En voici une autre. Noter
la ligne vide entre
Lignes.
-------------------------------------------------- -----------
Tableau : Voici la légende. Il peut aussi s'étendre
plusieurs lignes.
Ceux-ci fonctionnent comme de simples tableaux, mais avec les différences suivantes :
· Ils doivent commencer par une rangée de tirets, avant le texte de l'en-tête (sauf si les en-têtes sont
omis).
· Ils doivent se terminer par une rangée de tirets, puis une ligne blanche.
· Les lignes doivent être séparées par des lignes vides.
Dans les tables multilignes, l'analyseur de table fait attention à la largeur des colonnes et à la
les rédacteurs essaient de reproduire ces largeurs relatives dans la sortie. Donc, si vous trouvez que l'un des
les colonnes sont trop étroites dans la sortie, essayez de l'élargir dans la source Markdown.
Les en-têtes peuvent être omis dans les tableaux multilignes ainsi que dans les tableaux simples :
----------- ------- --------------- ----------------- --------
Première ligne 12.0 Exemple d'une ligne qui
s'étend sur plusieurs lignes.
Deuxième rangée 5.0 En voici une autre. Noter
la ligne vide entre
Lignes.
----------- ------- --------------- ----------------- --------
: Voici un tableau multiligne sans en-têtes.
Il est possible qu'un tableau multiligne n'ait qu'une seule ligne, mais la ligne doit être suivie
par une ligne vide (puis la ligne de tirets qui termine le tableau), ou le tableau peut être
interprété comme un simple tableau.
Extension: grille_tables
Les tableaux de grille ressemblent à ceci :
: Exemple de tableau de grille.
+---------------+---------------+----------------- ---+
| Fruits | Prix | Avantages |
+===============+===============+================= ===+
| Bananes | 1.34 $ | - enrubanneuse intégrée |
| | | - couleur vive |
+---------------+---------------+----------------- ---+
| Oranges | 2.10 $ | - guérit le scorbut |
| | | - savoureux |
+---------------+---------------+----------------- ---+
La ligne de =s sépare l'en-tête du corps du tableau et peut être omise pour un
tableau sans en-tête. Les cellules des tableaux de grille peuvent contenir des éléments de bloc arbitraires (plusieurs
paragraphes, blocs de code, listes, etc.). Les alignements ne sont pas pris en charge, pas plus que les cellules qui
s'étendre sur plusieurs colonnes ou lignes. Les tableaux en grille peuvent être créés facilement en utilisant le mode tableau d'Emacs.
Extension: pipe_tables
Les tables de tuyaux ressemblent à ceci :
| Droite | Gauche | Par défaut | Centre |
|------:|:-----|---------|:------:|
| 12 | 12 | 12 | 12 |
| 123 | 123 | 123 | 123 |
| 1 | 1 | 1 | 1 |
: Démonstration de la syntaxe de la table pipe.
La syntaxe est identique aux tables PHP Markdown Extra. Le tuyau de début et de fin
les caractères sont facultatifs, mais des tuyaux sont requis entre toutes les colonnes. Les deux points indiquent
alignement des colonnes comme indiqué. L'en-tête ne peut pas être omis. Pour simuler un tableau sans en-tête,
inclure un en-tête avec des cellules vides.
Étant donné que les tuyaux indiquent les limites des colonnes, les colonnes n'ont pas besoin d'être alignées verticalement, car
ils sont dans l'exemple ci-dessus. Donc, c'est une table de tuyaux parfaitement légale (bien que laide):
fruits| le prix
-----|----- :
pomme|2.05
poire|1.37
orange|3.09
Les cellules des tables de tuyaux ne peuvent pas contenir d'éléments de bloc tels que des paragraphes et des listes, et
ne peut pas s'étendre sur plusieurs lignes. Si une table pipe contient une ligne dont le contenu imprimable est
plus large que la largeur de la colonne (voir --columns), alors le contenu de la cellule s'enroulera, avec le
largeurs de cellules relatives déterminées par les largeurs des lignes de séparation.
Remarque : pandoc reconnaît également les tables de tuyaux de la forme suivante, comme cela peut être produit par
Le mode orgtbl d'Emacs :
| Un | Deux |
|-----+-------|
| mon | tableau |
| est | sympa |
La différence est que + est utilisé au lieu de |. Les autres fonctionnalités d'orgtbl ne sont pas prises en charge.
En particulier, pour obtenir un alignement de colonnes différent de celui par défaut, vous devrez ajouter des deux-points comme ci-dessus.
Métadonnées blocs
Extension: pandoc_title_block
Si le fichier commence par un cartouche
% Titre
% auteur(s) (séparés par des points-virgules)
% Date
il sera analysé comme une information bibliographique, et non comme du texte normal. (Il sera utilisé, pour
exemple, dans le titre de la sortie autonome LaTeX ou HTML.) Le bloc peut contenir juste un
titre, un titre et un auteur, ou les trois éléments. Si vous souhaitez inclure un auteur mais
pas de titre, ou un titre et une date mais pas d'auteur, il faut une ligne vierge :
%
% Auteur
% Mon titre
%
% 15 juin 2006
Le titre peut occuper plusieurs lignes, mais les lignes de continuation doivent commencer par un espace de début,
Ainsi:
% Mon titre
sur plusieurs lignes
Si un document a plusieurs auteurs, les auteurs peuvent être mis sur des lignes séparées avec en tête
espace, ou séparés par des points-virgules, ou les deux. Ainsi, tous les éléments suivants sont équivalents :
% auteur un
Auteur deux
% auteur un ; Auteur deux
% auteur un ;
Auteur deux
La date doit tenir sur une seule ligne.
Les trois champs de métadonnées peuvent contenir un formatage en ligne standard (italique, liens,
notes de bas de page, etc.).
Les cartouches seront toujours analysées, mais elles n'affecteront la sortie que lorsque le
L'option --standalone (-s) est choisie. Dans la sortie HTML, les titres apparaîtront deux fois : une fois dans le
en-tête du document -- c'est le titre qui apparaîtra en haut de la fenêtre dans un navigateur
-- et une fois au début du corps du document. Le titre dans l'en-tête du document peut
avoir un préfixe facultatif attaché (--title-prefix ou -T option). Le titre dans le corps
apparaît comme un élément H1 avec la classe "title", donc il peut être supprimé ou reformaté avec
CSS. Si un préfixe de titre est spécifié avec -T et qu'aucun cartouche n'apparaît dans le document,
le préfixe du titre sera utilisé seul comme titre HTML.
Le rédacteur de page de manuel extrait un titre, un numéro de section de page de manuel et d'autres en-tête et pied de page
informations de la ligne de titre. Le titre est supposé être le premier mot du titre
ligne, qui peut éventuellement se terminer par un numéro de section (à un chiffre) entre parenthèses.
(Il ne doit pas y avoir d'espace entre le titre et les parenthèses.) Tout ce qui suit est
supposé être un pied de page et un texte d'en-tête supplémentaires. Un seul caractère pipe (|) doit être
utilisé pour séparer le texte du pied de page du texte de l'en-tête. Ainsi,
% PANDOC(1)
donnera une page de manuel avec le titre PANDOC et la section 1.
% PANDOC(1) Manuels d'utilisation Pandoc
aura également « Manuels de l'utilisateur Pandoc » dans le pied de page.
% PANDOC(1) Manuels d'utilisation Pandoc | Version 4.0
aura également "Version 4.0" dans l'en-tête.
Extension: yaml_metadata_block
Un bloc de métadonnées YAML est un objet YAML valide, délimité par une ligne de trois tirets (---)
en haut et une ligne de trois tirets (---) ou trois points (...) en bas. Un YAML
bloc de métadonnées peut se produire n'importe où dans le document, mais s'il n'est pas au début, il
doit être précédé d'une ligne vierge. (Notez qu'en raison de la façon dont pandoc concatène
fichiers d'entrée lorsque plusieurs sont fournis, vous pouvez également conserver les métadonnées dans un YAML séparé
et transmettez-le à pandoc en tant qu'argument, avec vos fichiers Markdown :
pandoc chap1.md chap2.md chap3.md metadata.yaml -s -o livre.html
Assurez-vous simplement que le fichier YAML commence par --- et se termine par --- ou ....)
Les métadonnées seront extraites des champs de l'objet YAML et ajoutées à tout
métadonnées du document. Les métadonnées peuvent contenir des listes et des objets (imbriqués arbitrairement), mais tous
les scalaires de chaîne seront interprétés comme Markdown. Champs dont les noms se terminent par un trait de soulignement
sera ignoré par pandoc. (Ils peuvent se voir attribuer un rôle par des processeurs externes.)
Un document peut contenir plusieurs blocs de métadonnées. Les champs de métadonnées seront combinés
à travers un biaisé à gauche union: si deux blocs de métadonnées tentent de définir le même champ, le
la valeur du premier bloc sera prise.
Lorsque pandoc est utilisé avec -t markdown pour créer un document Markdown, un bloc de métadonnées YAML
ne sera produit que si l'option -s/--standalone est utilisée. Toutes les métadonnées seront
apparaissent en un seul bloc au début du document.
Notez que les règles d'échappement YAML doivent être suivies. Ainsi, par exemple, si un titre contient un
deux points, il doit être cité. Le caractère pipe (|) peut être utilisé pour commencer un bloc en retrait
qui sera interprété littéralement, sans avoir besoin de s'échapper. Ce formulaire est nécessaire
lorsque le champ contient des lignes vides :
---
title : 'Ceci est le titre : il contient un deux-points'
auteur:
- nom : Auteur Un
affiliation: Université de Somewhere
- nom : Auteur Deux
affiliation : Université de nulle part
tags: [rien, néant]
résumé : |
C'est l'abstrait.
Il se compose de deux paragraphes.
Les variables de modèle seront définies automatiquement à partir des métadonnées. Ainsi, par exemple, dans
écrivant du HTML, la variable abstract sera définie sur l'équivalent HTML du Markdown dans
le champ abstrait :
C'est l'abstrait.
Il se compose de deux paragraphes.
Remarque : la variable author dans les modèles par défaut attend une simple liste ou chaîne. À
utilisez les auteurs structurés dans l'exemple, vous auriez besoin d'un modèle personnalisé. Par example:
$pour(auteur)$
$if(auteur.nom)$
$auteur.nom$$if(auteur.affiliation)$ ($auteur.affiliation$)$endif$
$autre$
$auteur$
$endif$
$finpour$
Barre oblique inverse s'échappe
Extension: all_symbols_ecapable
Sauf à l'intérieur d'un bloc de code ou d'un code en ligne, tout caractère de ponctuation ou d'espace précédé de
une barre oblique inverse sera traitée littéralement, même si elle indiquerait normalement un formatage.
Ainsi, par exemple, si l'on écrit
*\*Bonjour\**
on obtiendra
*Bonjour*
au lieu de
Bonjour
Cette règle est plus facile à retenir que la règle standard de Markdown, qui autorise uniquement les
les caractères suivants doivent être échappés par une barre oblique inverse :
\`*_{}[]()>#+-.!
(Cependant, si le format markdown_strict est utilisé, la règle Markdown standard sera utilisée.)
Un espace échappé par une barre oblique inverse est analysé comme un espace insécable. Il apparaîtra dans la sortie TeX
comme ~ et en HTML et XML comme \ ou \ .
Une nouvelle ligne échappée par une barre oblique inverse (c'est-à-dire une barre oblique inverse apparaissant à la fin d'une ligne) est analysée
comme un saut de ligne dur. Il apparaîtra dans la sortie TeX sous la forme \\ et en HTML sous la forme . C'est
une bonne alternative à la manière "invisible" de Markdown d'indiquer les sauts de ligne durs à l'aide de deux
espaces de fin sur une ligne.
Les échappements de barre oblique inverse ne fonctionnent pas dans les contextes textuels.
Smart ponctuation
Extension
Si l'option --smart est spécifiée, pandoc produira une sortie typographiquement correcte,
convertir les guillemets droits en guillemets bouclés, --- en tirets cadratinaux, -- en tirets fins, et ... en
ellipses. Des espaces insécables sont insérés après certaines abréviations, telles que « Mr ».
Remarque : si votre modèle LaTeX ou tout fichier d'en-tête inclus appelle le package csquotes,
pandoc le détectera automatiquement et utilisera \enquote{...} pour le texte cité.
En ligne formatage
Accentuation
À mettre en relief du texte, entourez-le de *s ou _, comme ceci :
Ce texte est _souligné par des traits de soulignement_, et ce
est *souligné par des astérisques*.
Double * ou _ produit STRONG l'accent:
Ceci est **accent fort** et __avec des traits de soulignement__.
Un caractère * ou _ entouré d'espaces, ou échappé par une barre oblique inverse, ne déclenchera pas l'accentuation :
Ceci n'est * pas souligné *, et \*ce n'est pas non plus\*.
Extension: intraword_underscores
Parce que _ est parfois utilisé à l'intérieur de mots et d'identifiants, pandoc n'interprète pas un _
entouré de caractères alphanumériques comme marqueur d'emphase. Si vous voulez souligner
juste une partie d'un mot, utilisez * :
faisable*, non faisable*.
Strikeout
Extension: barré
Pour barrer une section de texte avec une ligne horizontale, commencez et terminez-la par ~~. Ainsi,
par exemple,
Ce ~~est du texte supprimé.~~
Exposants et indices
Extension: exposant, indice
Les exposants peuvent être écrits en entourant le texte en exposant de caractères ^ ;
les indices peuvent être écrits en entourant le texte en indice de ~ caractères. Ainsi, pour
Par exemple,
H~2~O est un liquide. 2^10^ vaut 1024.
Si le texte en exposant ou en indice contient des espaces, ces espaces doivent être échappés
avec des barres obliques inverses. (Cela permet d'éviter les exposants et les indices accidentels via
l'utilisation ordinaire de ~ et ^.) Ainsi, si vous voulez la lettre P avec 'un chat' en indices,
utilisez P~a\ cat~, pas P~a cat~.
Textuellement
Pour créer une courte partie de texte textuellement, mettez-la à l'intérieur de backticks :
Quelle est la différence entre `>>=` et `>>` ?
Si le texte textuel comprend un backtick, utilisez des backticks doubles :
Voici un backtick littéral `` ` ``.
(Les espaces après les backticks d'ouverture et avant les backticks de fermeture seront ignorés.)
La règle générale est qu'une durée textuelle commence par une chaîne de backticks consécutifs
(éventuellement suivi d'un espace) et se termine par une chaîne du même nombre de backticks
(éventuellement précédé d'un espace).
Notez que les backslash-escapes (et autres constructions Markdown) ne fonctionnent pas textuellement
contextes :
Il s'agit d'une barre oblique inverse suivie d'un astérisque : `\*`.
Extension: inline_code_attributes
Les attributs peuvent être attachés au texte verbatim, tout comme avec les blocs de code clôturés :
`<$>`{.haskell}
Petite capes
Pour écrire en petites majuscules, vous pouvez utiliser une balise span HTML :
En minuscule
(Le point-virgule est facultatif et il peut y avoir de l'espace après les deux-points.) Cela fonctionnera dans tous les
formats de sortie qui prennent en charge les petites capitales.
Mathématique
Extension: tex_math_dollars
Tout ce qui se trouve entre deux caractères $ sera traité comme du calcul TeX. Le $ d'ouverture doit avoir un
caractère non espace immédiatement à sa droite, tandis que le $ de fermeture doit avoir un non-espace
caractère immédiatement à sa gauche et ne doit pas être immédiatement suivi d'un chiffre. Ainsi,
20,000 30,000 $ et XNUMX XNUMX $ ne seront pas analysés comme des mathématiques. Si, pour une raison quelconque, vous devez inclure du texte dans
les caractères $ littéraux, échappez-les par barre oblique inverse et ils ne seront pas traités comme des délimiteurs mathématiques.
TeX math sera imprimé dans tous les formats de sortie. Le rendu dépend de la sortie
Format:
Réduction, Latex, Emacs Bio Mode, Le contexte
Il apparaîtra textuellement entre les caractères $.
Texterestructuré
Il sera rendu en utilisant un rôle de texte interprété :math:.
DocAscii
Il sera rendu sous la forme latexmath:[...].
Texinfo
Il sera rendu dans une commande @math.
groff man
Il sera rendu textuellement sans $.
MédiaWiki, DokuWikiName
Il sera rendu à l'intérieur Mots clés.
Textile
Il sera rendu à l'intérieur des balises.
RTF, Document ouvert, ODT
Il sera rendu, si possible, à l'aide de caractères Unicode, et sinon
apparaissent textuellement.
DocBook
Si l'indicateur --mathml est utilisé, il sera rendu à l'aide de MathML dans une inlineequation
ou étiquette d'équation informelle. Sinon, il sera rendu, si possible, en utilisant l'unicode
caractères.
Docx Il sera rendu à l'aide du balisage mathématique OMML.
FictionLivre2
Si l'option --webtex est utilisée, les formules sont rendues sous forme d'images à l'aide de Google Charts
ou tout autre service Web compatible, téléchargé et intégré dans le livre électronique. Autrement,
ils apparaîtront textuellement.
HTML, Glissant, DZSlides, S5, EPUB
La façon dont les mathématiques sont rendues en HTML dépendra des options de ligne de commande sélectionnées :
1. La valeur par défaut est de rendre les maths TeX autant que possible en utilisant des caractères Unicode,
comme avec la sortie RTF, DocBook et OpenDocument. Les formules sont mises à l'intérieur d'une étendue
avec class="math", afin qu'ils puissent être stylisés différemment de l'entourage
texte si besoin.
2. Si l'option --latexmathml est utilisée, TeX math sera affiché entre $ ou $$
caractères et mis dans des balises avec la classe LaTeX. Le script LaTeXMathML va
être utilisé pour le rendre sous forme de formules. (Cette astuce ne fonctionne pas dans tous les navigateurs,
mais cela fonctionne dans Firefox. Dans les navigateurs qui ne prennent pas en charge LaTeXMathML, TeX math
apparaîtra textuellement entre les caractères $.)
3. Si l'option --jsmath est utilisée, TeX math sera placé à l'intérieur des balises (pour
mathématiques en ligne) ou tags (pour afficher les mathématiques) avec la classe math. Le jsMath
le script sera utilisé pour le rendre.
4. Si l'option --mimetex est utilisée, le script CGI mimeTeX sera appelé pour
générer des images pour chaque formule TeX. Cela devrait fonctionner dans tous les navigateurs. le
L'option --mimetex prend une URL facultative comme argument. Si aucune URL n'est spécifiée, il
sera supposé que le script CGI mimeTeX se trouve dans /cgi-bin/mimetex.cgi.
5. Si l'option --gladtex est utilisée, les formules TeX seront incluses dans balises dans
la sortie HTML. Le fichier htex résultant peut ensuite être traité par gladTeX,
qui produira des fichiers images pour chaque formule et un fichier HTML avec des liens vers
ces images. Ainsi, la procédure est la suivante :
pandoc -s --gladtex monfichier.txt -o monfichier.htex
gladtex -d monfichier-images monfichier.htex
# produit myfile.html et des images dans myfile-images
6. Si l'option --webtex est utilisée, les formules TeX seront converties en Mots clés
ce lien vers un script externe qui convertit les formules en images. La formule
sera codé en URL et concaténé avec l'URL fournie. Si aucune URL n'est
spécifié, l'API Google Chart sera utilisée
(http://chart.apis.google.com/chart?cht=tx&chl=).
7. Si l'option --mathjax est utilisée, TeX math sera affiché entre \(...\) (pour
math inline) ou \[...\] (pour afficher les maths) et mettre dans les balises avec la classe
math. Le script MathJax sera utilisé pour le rendre sous forme de formules.
raw HTML
Extension: brut_html
Markdown vous permet d'insérer du HTML brut (ou DocBook) n'importe où dans un document (sauf
contextes textuels, où <, > et & sont interprétés littéralement). (Techniquement, ce n'est pas
une extension, puisque le Markdown standard le permet, mais il a été fait une extension pour que
il peut être désactivé si vous le souhaitez.)
Le HTML brut est transmis sans changement en HTML, S5, Slidy, Slideous, DZSlides, EPUB,
Sortie Markdown et Textile, et supprimée dans d'autres formats.
Extension: markdown_in_html_blocks
Standard Markdown vous permet d'inclure des "blocs" HTML : des blocs de HTML entre équilibrés
balises séparées du texte environnant par des lignes vides et commençant et se terminant à
la marge de gauche. Dans ces blocs, tout est interprété en HTML, pas en Markdown ; alors
(par exemple), * ne signifie pas emphase.
Pandoc se comporte de cette façon lorsque le format markdown_strict est utilisé ; mais par défaut, pandoc
interprète le matériel entre les balises de bloc HTML comme Markdown. Ainsi, par exemple, pandoc
tourner
*un*
[un lien](http://google.com)
développement
un
<a href="/http://google.com"> un lien
alors que Markdown.pl le conservera tel quel.
Il y a une exception à cette règle : le texte entre and tags is not
interprété comme Markdown.
Ce changement par rapport au Markdown standard devrait faciliter le mélange du Markdown avec du HTML
éléments de bloc. Par exemple, on peut entourer un bloc de texte Markdown avec Mots clés
sans l'empêcher d'être interprété comme Markdown.
Extension: native_divs
Utilisez les blocs natifs de la division pandoc pour le contenu à l'intérieur Mots clés. Pour la plupart, cela devrait
donne le même résultat que markdown_in_html_blocks, mais cela facilite l'écriture de pandoc
filtres pour manipuler des groupes de blocs.
Extension: native_spans
Utilisez des blocs Span pandoc natifs pour le contenu à l'intérieur des balises. Pour la plupart, cela
devrait donner la même sortie que raw_html, mais cela facilite l'écriture de filtres pandoc sur
manipuler des groupes d'inlines.
raw Texas
Extension: brut_tex
En plus du HTML brut, pandoc permet d'inclure du LaTeX, TeX et ConTeXt bruts dans un
document. Les commandes TeX en ligne seront conservées et transmises telles quelles au LaTeX et
écrivains ConTeXt. Ainsi, par exemple, vous pouvez utiliser LaTeX pour inclure des citations BibTeX :
Ce résultat a été prouvé dans \cite{jones.1967}.
Notez que dans les environnements LaTeX, comme
\begin{tabulaire}{|l|l|}\hline
Âge et fréquence \\ \hline
18--25 & 15 \\
26--35 & 33 \\
36--45 & 22 \\ \hline
\end{tabulaire}
le matériel entre les balises de début et de fin sera interprété comme du LaTeX brut, pas comme
Réduction.
Le LaTeX en ligne est ignoré dans les formats de sortie autres que Markdown, LaTeX et ConTeXt.
Latex macros
Extension: latex_macros
Pour les formats de sortie autres que LaTeX, pandoc analysera LaTeX \newcommand et \renewcommand
définitions et appliquer les macros résultantes à tous les mathématiques LaTeX. Ainsi, par exemple, le
suivant fonctionnera dans tous les formats de sortie, pas seulement LaTeX :
\newcommand{\tuple}[1]{\langle #1 \rangle}
$\uplet{a, b, c}$
Dans la sortie LaTeX, la définition de \newcommand sera simplement transmise sans modification à la sortie.
Liens
Markdown permet de spécifier les liens de plusieurs manières.
Automatique Gauche
Si vous mettez une URL ou une adresse e-mail entre crochets pointus, elle deviendra un lien :
<http://google.com>
<[email protected]>
En ligne Gauche
Un lien en ligne se compose du texte du lien entre crochets, suivi de l'URL dans
parenthèses. (Facultativement, l'URL peut être suivie d'un titre de lien, entre guillemets.)
Ceci est un [lien en ligne](/url), et voici [un avec
un titre](http://fsf.org « cliquez ici pour passer un bon moment ! »).
Il ne doit pas y avoir d'espace entre la partie entre crochets et la partie entre parenthèses. Le lien
le texte peut contenir une mise en forme (comme l'emphase), mais pas le titre.
Les adresses e-mail dans les liens intégrés ne sont pas détectées automatiquement, elles doivent donc être préfixées par
mailto:
[Écris moi!](mailto:[email protected])
Références Gauche
An explicite lien de référence comporte deux parties, le lien lui-même et la définition du lien, qui
peut apparaître ailleurs dans le document (avant ou après le lien).
Le lien se compose d'un texte de lien entre crochets, suivi d'une étiquette entre crochets.
(Il peut y avoir un espace entre les deux.) La définition du lien se compose de l'étiquette entre crochets,
suivi de deux points et d'un espace, suivi de l'URL, et éventuellement (après un espace) d'un
titre du lien entre guillemets ou entre parenthèses. L'étiquette ne doit pas être analysable comme un
citation (en supposant que l'extension citations soit activée) : les citations ont préséance sur
étiquettes de lien.
Voici quelques exemples:
[mon étiquette 1] : /foo/bar.html "Mon titre, facultatif"
[mon étiquette 2] : /foo
[mon étiquette 3] : http://fsf.org (La fondation du logiciel libre)
[mon étiquette 4] : /bar#special 'Un titre entre guillemets simples'
L'URL peut éventuellement être entourée de chevrons :
[mon étiquette 5] :http://foo.bar.baz>
Le titre peut aller sur la ligne suivante :
[mon étiquette 3] : http://fsf.org
"La fondation du logiciel libre"
Notez que les étiquettes de lien ne sont pas sensibles à la casse. Donc, cela fonctionnera :
Voici [mon lien][FOO]
[Foo] : /bar/baz
Dans une implicitement lien de référence, la deuxième paire de parenthèses est vide :
Voir [mon site][].
[Mon site internet]: http://foo.bar.baz
Remarque : Dans Markdown.pl et la plupart des autres implémentations de Markdown, référencez les définitions de liens
ne peut pas se produire dans les constructions imbriquées telles que les éléments de liste ou les guillemets. Ascenseurs Pandoc
cette restriction apparente arbitraire. Donc ce qui suit est bien dans pandoc, mais pas dans
la plupart des autres implémentations :
> Mon bloc [citation].
>
> [citation] : /toto
Extension: raccourci_référence_liens
Dans un raccourci lien de référence, la deuxième paire de parenthèses peut être entièrement omise :
Voir [mon site Web].
[Mon site internet]: http://foo.bar.baz
Interne Gauche
Pour créer un lien vers une autre section du même document, utilisez le fichier généré automatiquement
identifiant (voir Identifiants d'en-tête). Par example:
Voir l'[Introduction](#introduction).
or
Voir l'[Introduction].
[Introduction] : #introduction
Les liens internes sont actuellement pris en charge pour les formats HTML (y compris les diaporamas HTML et
EPUB), LaTeX et ConTeXt.
Images
Un lien immédiatement précédé d'un ! sera traité comme une image. Le texte du lien sera
utilisé comme texte alternatif de l'image :

![bobine de film]
[bobine de film] : movie.gif
Extension: chiffres_implicites
Une image apparaissant seule dans un paragraphe sera rendue sous forme de figure avec une légende.
(En LaTeX, un environnement figure sera utilisé ; en HTML, l'image sera placée dans un div
avec la figure de la classe, avec une légende dans ap avec la légende de la classe.) L'alt de l'image
le texte sera utilisé comme légende.

Si vous voulez juste une image en ligne régulière, assurez-vous simplement que ce n'est pas la seule chose dans le
paragraphe. Une façon de procéder consiste à insérer un espace insécable après l'image :
\
Extension: attributs_liens
Les attributs peuvent être définis sur les liens et les images :
Un en ligne {#id .class width=30 height=20px}
et une référence ![image][ref] avec des attributs.
[ref] : foo.jpg "titre optionnel" {#id .class key=val key2="val 2"}
(Cette syntaxe est compatible avec PHP Markdown Extra lorsque seuls #id et .class sont utilisés.)
Pour HTML et EPUB, tous les attributs sauf largeur et hauteur (mais y compris srcset et tailles)
sont passés tels quels. Les autres rédacteurs ignorent les attributs qui ne sont pas pris en charge par
leur format de sortie.
Les attributs de largeur et de hauteur sur les images sont traités spécialement. Lorsqu'il est utilisé sans
unité, l'unité est supposée être le pixel. Cependant, l'un des identificateurs d'unité suivants
peuvent être utilisés : px, cm, mm, in, inch et %. Il ne doit pas y avoir d'espace entre le nombre
et l'unité. Par example:
{ largeur=50% }
· Les dimensions sont converties en pouces pour une sortie dans des formats basés sur des pages comme LaTeX.
Les dimensions sont converties en pixels pour une sortie dans des formats de type HTML. Utilisez le --dpi
option pour spécifier le nombre de pixels par pouce. La valeur par défaut est 96 dpi.
· L'unité % est généralement relative à un espace disponible. Par exemple l'exemple ci-dessus
rendra à (HTML),
\includegraphics[width=0.5\textwidth]{file.jpg} (LaTeX), ou
\externalfigure[file.jpg][width=0.5\textwidth] (ConTeXt).
· Certains formats de sortie ont une notion de classe (ConTeXt) ou d'identifiant unique (LaTeX
\caption), ou les deux (HTML).
· Lorsqu'aucun attribut de largeur ou de hauteur n'est spécifié, la solution de secours consiste à regarder l'image
résolution et les métadonnées dpi intégrées dans le fichier image.
Notes
Extension: notes
Le Markdown de Pandoc autorise les notes de bas de page, en utilisant la syntaxe suivante :
Voici une référence de note de bas de page,[^1] et une autre.[^longnote]
[^1] : Voici la note de bas de page.
[^longnote] : en voici un avec plusieurs blocs.
Les paragraphes suivants sont mis en retrait pour montrer qu'ils
appartiennent à la note de bas de page précédente.
{ un.code }
Le paragraphe entier peut être en retrait, ou juste le premier
ligne. De cette façon, les notes de bas de page à plusieurs paragraphes fonctionnent comme
éléments de liste à plusieurs paragraphes.
Ce paragraphe ne fera pas partie de la note, car il
n'est pas en retrait.
Les identificateurs dans les références de notes de bas de page ne doivent pas contenir d'espaces, de tabulations ou de sauts de ligne. Ces
les identifiants ne sont utilisés que pour corréler la référence de la note de bas de page avec la note elle-même ; dans le
sortie, les notes de bas de page seront numérotées séquentiellement.
Les notes de bas de page elles-mêmes n'ont pas besoin d'être placées à la fin du document. Ils peuvent apparaître
n'importe où sauf à l'intérieur d'autres éléments de bloc (listes, guillemets de bloc, tableaux, etc.).
Extension: notes_inline
Les notes de bas de page sont également autorisées (bien que, contrairement aux notes normales, elles ne peuvent pas contenir
plusieurs paragraphes). La syntaxe est la suivante :
Voici une note en ligne.^[Les notes en ligne sont plus faciles à écrire, car
vous n'avez pas besoin de choisir un identifiant et de descendre pour taper le
Remarque.]
Les notes de bas de page en ligne et régulières peuvent être mélangées librement.
Citations
Extension: citations
En utilisant un filtre externe, pandoc-citeproc, pandoc peut générer automatiquement des citations et
une bibliographie dans un certain nombre de styles. L'utilisation de base est
pandoc --filter pandoc-citeproc monentrée.txt
Pour utiliser cette fonctionnalité, vous devrez spécifier un fichier bibliographique à l'aide de la
champ de métadonnées bibliography dans une section de métadonnées YAML, ou ligne de commande --bibliography
argument. Vous pouvez fournir plusieurs arguments --bibliography ou définir des métadonnées bibliographiques
champ au tableau YAML, si vous souhaitez utiliser plusieurs fichiers de bibliographie. La bibliographie peut
avoir l'un de ces formats :
Formater l'extension de fichier
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
BibLaTeX .bib
BibTeX .bibtex
Copac .copac
CSLJSON.json
CSLYAML.yaml
Note de fin .enl
EndNote XML .xml
ISI.wos
MEDLINE .medline
MODS .mods
RIS .ris
Notez que .bib peut être utilisé avec les fichiers BibTeX et BibLaTeX ; utiliser .bibtex pour forcer
BibTeX.
Notez que pandoc-citeproc --bib2json et pandoc-citeproc --bib2yaml peuvent produire .json et
.yaml à partir de l'un des formats pris en charge.
Balisage sur le terrain : dans les bases de données BibTeX et BibLaTeX, pandoc-citeproc analyse un sous-ensemble de
balisage LaTeX ; dans les bases de données CSL YAML, pandoc Markdown ; et dans les bases de données CSL JSON, un
Balisage de type HTML :
italique
...
goupille
style="font-variant:small-caps;">... or ...
petites capitales
...
indice
...
en exposant
class="nocase">...
empêcher une phrase d'être mise en majuscule comme casse de titre
pandoc-citeproc -j et -y interconvertissent les formats CSL JSON et CSL YAML dans la mesure où
de qualité.
Comme alternative à la spécification d'un fichier bibliographique à l'aide de --bibliography ou du YAML
bibliographie du champ de métadonnées, vous pouvez inclure les données de citation directement dans les références
champ des métadonnées YAML du document. Le champ doit contenir un tableau de code YAML
références, par exemple :
---
les références:
- type : article-journal
identifiant : WatsonCrick1953
auteur:
- famille : Watson
donné : JD
- famille : Crick
donné : FHC
Publié:
parties de date :
- - 1953
à 4
à 25
titre : 'Structure moléculaire des acides nucléiques : une structure pour le désoxyribose
acide nucléique'
titre court : Structure moléculaire des acides nucléiques
titre-conteneur : Nature
tome : 171
numéro : 4356
pages : 737-738
DOI : 10.1038/171737a0
URL: http://www.nature.com/nature/journal/v171/n4356/abs/171737a0.html
langue: en-GB
(pandoc-citeproc --bib2yaml peut les produire à partir d'un fichier bibliographique dans l'un des
formats pris en charge.)
Les citations et les références peuvent être formatées à l'aide de n'importe quel style pris en charge par le style de citation
Langue, répertoriée dans le référentiel de styles Zotero. Ces fichiers sont spécifiés à l'aide de la
--csl ou le champ de métadonnées csl. Par défaut, pandoc-citeproc utilisera le Chicago
Format auteur-date du Manuel de style. Le projet CSL fournit de plus amples informations sur
rechercher et éditer des styles.
Pour faire de vos citations des hyperliens vers les entrées de bibliographie correspondantes, ajoutez
link-citations : fidèle à vos métadonnées YAML.
Les citations sont placées entre crochets et sont séparées par des points-virgules. Chaque citation doit
avoir une clé, composée de '@' + l'identifiant de citation de la base de données, et peut
avoir éventuellement un préfixe, un localisateur et un suffixe. La clé de citation doit commencer par un
lettre, chiffre ou _, et peut contenir des caractères alphanumériques, _ et des caractères de ponctuation internes
(:.#$%&-+?<>~/). Voici quelques exemples:
Blah blah [voir @doe99, pp. 33-35; aussi @smith04, chap. 1].
Blah bla [@doe99, pp. 33-35, 38-39 et *passim*].
Blah bla [@smith04; @doe99].
pandoc-citeproc détecte les termes de localisation dans les fichiers de paramètres régionaux CSL. Soit abrégé, soit
les formulaires non abrégés sont acceptés. Dans les paramètres régionaux en-US, les termes de localisation peuvent être écrits en
formes singulières ou plurielles, comme livre, bk./bks.; chapitre, chap./chaps.; colonne,
col./col.; figure, fig./fig. ; folio, fol./fol.; nombre, n°/n° ; ligne, l./ll.; Remarque,
n./nn. ; opus, op./opp.; page, p./pp. ; paragraphe, para./par.; partie, pt./pts.; section,
s./s. ; sous-verbe, sv/s.vv.; verset, v./vv.; volume, vol./vol.; /¶¶; §/§§. Sinon
terme de localisation est utilisé, "page" est supposé.
Un signe moins (-) avant le @ supprimera la mention de l'auteur dans la citation. Cette
peut être utile lorsque l'auteur est déjà mentionné dans le texte :
Smith dit blabla [-@smith04].
Vous pouvez également rédiger une citation dans le texte, comme suit :
@smith04 dit blablabla.
@smith04 [p. 33] dit bla.
Si le style appelle une liste d'ouvrages cités, elle sera placée à la fin du
document. Normalement, vous voudrez terminer votre document avec un en-tête approprié :
dernier paragraphe...
# Les références
La bibliographie sera insérée après cet en-tête. Notez que la classe non numérotée sera
être ajouté à cet en-tête, afin que la section ne soit pas numérotée.
Si vous souhaitez inclure des éléments dans la bibliographie sans réellement les citer dans le corps
text, vous pouvez définir un champ de métadonnées nocite factice et y mettre les citations :
---
nocite : |
@élément1, @élément2
@ élément3
Dans cet exemple, le document contiendra une citation pour l'élément 3 uniquement, mais la bibliographie
contiendra des entrées pour item1, item2 et item3.
Pour la sortie LaTeX ou PDF, vous pouvez également utiliser natbib ou biblatex pour rendre la bibliographie. Dans
pour ce faire, spécifiez les fichiers de bibliographie comme indiqué ci-dessus et ajoutez --natbib ou
--argument biplatex à l'invocation de pandoc. Gardez à l'esprit que les fichiers de bibliographie doivent être
dans le format respectif (soit BibTeX soit BibLaTeX).
Pour plus d'informations, consultez la page de manuel pandoc-citeproc.
Non pandoc extensions
Les extensions de syntaxe Markdown suivantes ne sont pas activées par défaut dans pandoc, mais peuvent être
activé en ajoutant +EXTENSION au nom du format, où EXTENSION est le nom du
extension. Ainsi, par exemple, markdown+hard_line_breaks est Markdown avec une ligne dure
des pauses.
Extension: listes_sans_preceding_blankline
Autoriser une liste à apparaître juste après un paragraphe, sans espace vide intermédiaire.
Extension: hard_line_breaks
Tous les retours à la ligne d'un paragraphe sont interprétés comme des sauts de ligne fixes au lieu de
les espaces.
Extension: ignore_line_breaks
Ignore les retours à la ligne dans un paragraphe, plutôt que d'être traités comme des espaces ou
comme des sauts de ligne durs. Cette option est destinée à être utilisée avec les langues d'Asie de l'Est où
les espaces ne sont pas utilisés entre les mots, mais le texte est divisé en lignes pour plus de lisibilité.
Extension: east_asian_line_breaks
Ignore les retours à la ligne dans un paragraphe, plutôt que d'être traités comme des espaces ou
comme des sauts de ligne durs, lorsqu'ils se produisent entre deux caractères larges d'Asie de l'Est. C'est un
meilleur choix que ignore_line_breaks pour les textes qui incluent un mélange d'Asie de l'Est
personnages et autres personnages.
Extension: emoji
Analyse les emojis textuels comme :smile: comme des émoticônes Unicode.
Extension: tex_math_single_backslash
Fait que tout ce qui se trouve entre \( et \) est interprété comme un calcul TeX en ligne, et tout
entre \[ et \] pour être interprété comme un affichage mathématique TeX. Remarque : un inconvénient de cette
l'extension est qu'elle empêche l'échappement ( et [.
Extension: tex_math_double_backslash
Fait que tout ce qui se trouve entre \\( et \\) est interprété comme un calcul TeX en ligne, et tout
entre \\[ et \\] pour être interprété comme un affichage mathématique TeX.
Extension: markdown_attribute
Par défaut, pandoc interprète le matériel à l'intérieur des balises de niveau bloc comme Markdown. Cette
l'extension modifie le comportement de sorte que Markdown ne soit analysé qu'à l'intérieur des balises de niveau bloc si
les balises ont l'attribut markdown=1.
Extension: mmd_title_block
Active un cartouche de style MultiMarkdown en haut du document, par exemple :
Titre : Mon titre
Auteur : John Doe
Date: Septembre 1, 2008
Commentaire : Ceci est un exemple de cartouche mmd, avec
un champ s'étendant sur plusieurs lignes.
Consultez la documentation MultiMarkdown pour plus de détails. Si pandoc_title_block ou
yaml_metadata_block est activé, il aura priorité sur mmd_title_block.
Extension: abréviations
Analyse les clés d'abréviation PHP Markdown Extra, comme
*[HTML] : Langage de balisage hypertexte
Notez que le modèle de document pandoc ne prend pas en charge les abréviations, donc si cette extension
est activé, les touches d'abréviation sont simplement ignorées (au lieu d'être analysées comme
paragraphes).
Extension: autolink_bare_uris
Transforme tous les URI absolus en liens, même lorsqu'ils ne sont pas entourés d'accolades pointues <...>.
Extension: ascii_identifiers
Fait que les identifiants produits par auto_identifiers sont de l'ASCII pur. Les accents sont
les lettres latines accentuées sont supprimées et les lettres non latines sont omises.
Extension: mmd_link_attributes
Analyse les attributs de valeur-clé de style multimarkdown sur les références de lien et d'image. Cette
ne doit pas être confondu avec l'extension link_attributes.
Ceci est une référence ![image][ref] avec des attributs multimarkdown.
[réf] : http://path.to/image "Titre de l'image" largeur=20px hauteur=30px
id=myId class="myClass1 myClass2"
Extension: mmd_header_identifiers
Analyse les identifiants d'en-tête de style multimarkdown (entre crochets, après l'en-tête mais
avant tout # de fin dans un en-tête ATX).
Extension: listes_de_définition_compactes
Active la syntaxe de liste de définitions de pandoc 1.12.x et versions antérieures. Cette syntaxe diffère
de celui décrit ci-dessus sous Définition énumère à plusieurs égards :
· Aucune ligne blanche n'est requise entre les éléments consécutifs de la liste de définitions.
· Pour obtenir une liste "serrée" ou "compacte", omettez l'espace entre les éléments consécutifs ; l'espace
entre un terme et sa définition n'affecte rien.
· L'emballage paresseux des paragraphes n'est pas autorisé : la définition entière doit être en retrait de quatre
les espaces.
Markdown variantes
En plus du Markdown étendu de pandoc, les variantes de Markdown suivantes sont prises en charge :
markdown_phpextra (PHP Markdown Supplémentaire)
notes de bas de page, pipe_tables, raw_html, markdown_attribute, fenced_code_blocks,
listes_definition, intraword_underscores, header_attributes, link_attributes,
abréviations, raccourci_référence_liens.
markdown_github (GitHub-Saveur Réduction)
pipe_tables, raw_html, tex_math_single_backslash, fenced_code_blocks,
auto_identifiers, ascii_identifiers, backtick_code_blocks, autolink_bare_uris,
intraword_underscores, barré, hard_line_breaks, emoji,
raccourci_référence_liens.
markdown_mmd (MultiMarkdown)
pipe_tables raw_html, markdown_attribute, mmd_link_attributes, raw_tex,
tex_math_double_backslash, intraword_underscores, mmd_title_block, notes de bas de page,
definition_lists, all_symbols_ecapable, implicit_header_references,
auto_identifiers, mmd_header_identifiers, short_reference_links.
markdown_strict (Markdown.pl)
brut_html
Extensions avec formats autre que Markdown
Certaines des extensions décrites ci-dessus peuvent être utilisées avec des formats autres que Markdown :
· auto_identifiers peut être utilisé avec les entrées latex, rst, mediawiki et textile (et est utilisé
par défaut).
· tex_math_dollars, tex_math_single_backslash et tex_math_double_backslash peuvent être utilisés
avec entrée html. (C'est pratique pour lire des pages Web formatées à l'aide de MathJax, par
Exemple.)
PRODUIRE SLIDE MONTRE avec PANDOC
Vous pouvez utiliser pandoc pour produire une présentation de diapositives HTML + javascript qui peut être visualisée
via un navigateur Internet. Il y a cinq façons de le faire, en utilisant S5, DZSlides, Slidy, Slideous,
ou révéler.js. Vous pouvez également produire un diaporama PDF à l'aide du projecteur LaTeX.
Voici la source Markdown pour un simple diaporama, habitudes.txt :
% Les habitudes
% Jean Doe
% 22 mars 2005
# Du matin
## Se lever
- Désactiver l'alarme
- Sors du lit
## Petit-déjeuner
- manger des oeufs
- Boire du café
# Dans la soirée
## Dîner
- Manger des spaghettis
- Boire du vin
------------------

## Aller dormir
- Aller au lit
- Compter les moutons
Pour produire un diaporama HTML/javascript, tapez simplement
pandoc -t FORMAT -s habitudes.txt -o habitudes.html
où FORMAT est soit s5, slidy, slideous, dzslides, soit Revejs.
Pour Slidy, Slideous, Reveal.js et S5, le fichier produit par pandoc avec le
L'option -s/--standalone intègre un lien vers les javascripts et les fichiers CSS, qui sont supposés être
disponible au chemin relatif s5/default (pour S5), slideous (pour Slideous), Reveal.js
(pour Reveal.js), ou sur le site Web de Slidy à l'adresse w3.org (pour Slidy). (Ces chemins peuvent être
modifié en définissant les variables slidy-url, slideous-url, révélationjs-url ou s5-url ; voir
Variables pour les diapositives, ci-dessus.) Pour DZSlides, le javascript (relativement court) et le css sont
inclus dans le fichier par défaut.
Avec tous les formats de diapositive HTML, l'option --self-contained peut être utilisée pour produire un seul
fichier contenant toutes les données nécessaires à l'affichage du diaporama, y compris les
scripts, feuilles de style, images et vidéos.
Pour produire un diaporama PDF à l'aide du projecteur, tapez
pandoc -t beamer habitudes.txt -o habitudes.pdf
Notez qu'un diaporama de Reveal.js peut également être converti en PDF en l'imprimant dans un fichier
depuis le navigateur.
Structurer le diapositive montrer
Par défaut, le diapositive niveau est le niveau d'en-tête le plus élevé dans la hiérarchie qui est suivie
immédiatement par le contenu, et non un autre en-tête, quelque part dans le document. Dans l'exemple
ci-dessus, les en-têtes de niveau 1 sont toujours suivis des en-têtes de niveau 2, qui sont suivis de
contenu, donc 2 est le niveau de la diapositive. Cette valeur par défaut peut être remplacée à l'aide de --slide-level
option.
Le document est découpé en diapositives selon les règles suivantes :
· Une règle horizontale commence toujours une nouvelle diapositive.
· Un en-tête au niveau de la diapositive démarre toujours une nouvelle diapositive.
· En-têtes ci-dessous le niveau de diapositive dans la hiérarchie créer des en-têtes dans les une diapositive.
· En-têtes au dessus de le niveau de diapositive dans la hiérarchie crée des « diapositives de titre », qui contiennent simplement
le titre de la section et aider à diviser le diaporama en sections.
· Une page de titre est construite automatiquement à partir du bloc de titre du document, s'il est présent.
(Dans le cas du beamer, cela peut être désactivé en commentant certaines lignes dans la valeur par défaut
modèle.)
Ces règles sont conçues pour prendre en charge de nombreux styles différents de diaporama. Si vous ne
vous souciez de structurer vos diapositives en sections et sous-sections, vous pouvez simplement utiliser le niveau 1
en-têtes pour chaque diapositive. (Dans ce cas, le niveau 1 sera le niveau de la diapositive.) Mais vous pouvez
structurez également le diaporama en sections, comme dans l'exemple ci-dessus.
Remarque : dans les diaporamas Reveal.js, si le niveau de diapositive est 2, une mise en page en deux dimensions sera
produit, avec des en-têtes de niveau 1 construits horizontalement et des en-têtes de niveau 2 construits
verticalement. Il n'est pas recommandé d'utiliser une imbrication plus profonde des niveaux de section avec
révéler.js.
Incrémental listes
Par défaut, ces rédacteurs produisent des listes qui s'affichent « tout à la fois ». Si vous voulez vos listes
pour afficher de manière incrémentielle (un élément à la fois), utilisez l'option -i. Si vous voulez un
liste particulière pour s'écarter de la valeur par défaut (c'est-à-dire pour afficher de manière incrémentielle sans le
-i et tout à la fois avec l'option -i), placez-le entre guillemets :
> - Manger des spaghettis
> - Boire du vin
De cette façon, les listes incrémentielles et non incrémentielles peuvent être mélangées dans un seul document.
Insertion pauses
Vous pouvez ajouter des "pauses" dans une diapositive en incluant un paragraphe contenant trois points,
séparés par des espaces :
# Glisser avec une pause
contenu avant la pause
. . .
contenu après la pause
Stylisme le diapositives
Vous pouvez modifier le style des diapositives HTML en plaçant des fichiers CSS personnalisés dans
$DATADIR/s5/default (pour S5), $DATADIR/slidy (pour Slidy) ou $DATADIR/slideous (pour
Slideous), où $DATADIR est le répertoire de données utilisateur (voir --data-dir, ci-dessus). le
les originaux peuvent être trouvés dans le répertoire de données système de pandoc (généralement
$CABALDIR/pandoc-VERSION/s5/default). Pandoc y cherchera tous les fichiers qu'il ne recherche pas
trouver dans le répertoire des données utilisateur.
Pour les dzslides, le CSS est inclus dans le fichier HTML lui-même, et peut y être modifié.
Toutes les options de configuration de Reveal.js peuvent être définies via des variables. Par exemple, les thèmes peuvent
être utilisé en définissant la variable de thème :
-V thème=lune
Ou vous pouvez spécifier une feuille de style personnalisée à l'aide de l'option --css.
Pour styliser les diapositives du projecteur, vous pouvez spécifier un thème, un thème de couleur, un thème de police, un thème intérieur et
externaltheme, en utilisant l'option -V :
pandoc -t beamer habitudes.txt -V theme:Varsovie -o habitudes.pdf
Notez que les attributs d'en-tête se transformeront en attributs de diapositive (sur un ou ) dans
Formats de diapositives HTML, vous permettant de styliser des diapositives individuelles. Dans le projecteur, le seul en-tête
l'attribut qui affecte les diapositives est la classe allowframebreaks, qui définit le
option allowframebreaks, provoquant la création de plusieurs diapositives si le contenu déborde
le cadre. Ceci est particulièrement recommandé pour les bibliographies :
# Références {.allowframebreaks}
Speaker note
Reveal.js prend bien en charge les notes du conférencier. Vous pouvez ajouter des notes à votre document Markdown
Ainsi:
Ceci est ma note.
- Il peut contenir du Markdown
- comme cette liste
</div>
Pour afficher la fenêtre de notes, appuyez sur s pendant la visualisation de la présentation. Les notes ne sont pas encore
pris en charge pour d'autres formats de diapositives, mais les notes n'apparaîtront pas sur les diapositives elles-mêmes.
Cadre métallique robuste attributs in beamer
Parfois, il est nécessaire d'ajouter l'option LaTeX [fragile] à un cadre dans le beamer (par
exemple, lors de l'utilisation de l'environnement monnayé). Cela peut être forcé en ajoutant le fragile
classe à l'en-tête introduisant la diapositive :
# Diapositive fragile {.fragile}
Tous les autres attributs de trame décrits dans la section 8.1 du Guide de l'utilisateur du Beamer peuvent
également être utilisé : allowdisplaybreaks, allowframebreaks, b, c, t, environment, label, plain,
rétrécir.
CRÉATEUR EPUB avec PANDOC
EPUB Métadonnées
Les métadonnées EPUB peuvent être spécifiées à l'aide de l'option --epub-metadata, mais si la source
document est Markdown, il est préférable d'utiliser un bloc de métadonnées YAML. Voici un exemple:
---
titre:
- type : principal
texte : mon livre
- type : sous-titre
texte : Une enquête sur les métadonnées
créateur:
- rôle : auteur
texte : John Smith
- rôle : éditeur
texte : Sarah Jones
identifiant :
- schéma : DOI
texte : doi : 10.234234.234/33
éditeur : Ma Presse
droits : © 2007 John Smith, CC BY-NC
Les champs suivants sont reconnus :
identifiant
Soit une valeur de chaîne, soit un objet avec des champs texte et schéma. Valeurs valides pour
sont ISBN-10, GTIN-13, UPC, ISMN-10, DOI, LCCN, GTIN-14, ISBN-13,
Numéro de dépôt légal, URN, OCLC, ISMN-13, ISBN-A, JP, OLCC.
titre Soit une valeur de chaîne, soit un objet avec des champs file-as et type, soit une liste de tels
objets. Les valeurs valides pour le type sont main, subtitle, short, collection, edition,
élargi.
créateur
Soit une valeur de chaîne, soit un objet avec des champs role, file-as et text, soit une liste
de tels objets. Les valeurs valides pour le rôle sont des relations MARC, mais pandoc tentera
traduire les versions lisibles par l'homme (comme "auteur" et "éditeur") au
les relateurs marc appropriés.
contributeur
Même format que le créateur.
données Une valeur de chaîne au format AAAA-MM-JJ. (Seule l'année est nécessaire.) Pandoc
essayer de convertir d'autres formats de date courants.
long (ou héritage: Langue)
Une valeur de chaîne au format BCP 47. Pandoc utilisera par défaut la langue locale si
rien n'est précisé.
sujet
Une valeur de chaîne ou une liste de telles valeurs.
la description
Une valeur de chaîne.
type Une valeur de chaîne.
le format Une valeur de chaîne.
rapport
Une valeur de chaîne.
couverture
Une valeur de chaîne.
droits Une valeur de chaîne.
Image de couverture
Une valeur de chaîne (chemin vers l'image de couverture).
feuille de style
Une valeur de chaîne (chemin vers la feuille de style CSS).
sens de progression de la page
Soit ltr ou rtl. Spécifie l'attribut page-progression-direction pour le
élément de la colonne vertébrale.
Produit lié galerie de
Par défaut, pandoc téléchargera les médias liés (y compris l'audio et la vidéo) et l'inclura
dans le conteneur EPUB, ce qui donne un EPUB complètement autonome. Si vous souhaitez créer un lien vers
ressources multimédias externes à la place, utilisez du HTML brut dans votre source et ajoutez data-external="1" à
la balise avec l'attribut src. Par example:
<source src="/http://example.com/music/toccata.mp3"
data-external="1" type="audio/mpeg">
ALPHABÉTISATION HASKELL SUPPORT
Si vous ajoutez +lhs (ou +literate_haskell) à un format d'entrée ou de sortie approprié
(markdown, markdown_strict, rst ou latex pour l'entrée ou la sortie ; beamer, html ou html5 pour
sortie uniquement), pandoc traitera le document comme une source Haskell alphabétisée. Cela signifie que
· Dans l'entrée Markdown, les sections "bird track" seront analysées en tant que code Haskell plutôt que
bloquer les citations. Le texte entre \begin{code} et \end{code} sera également traité comme
Code Haskell. Pour les en-têtes de style ATX, le caractère '=' sera utilisé à la place de '#'.
· Dans la sortie Markdown, les blocs de code avec les classes haskell et literate seront rendus à l'aide
les traces d'oiseaux et les citations en bloc seront indentées d'un espace, de sorte qu'elles ne seront pas
traité comme du code Haskell. De plus, les en-têtes seront rendus de style setext (avec
souligne) plutôt que de style ATX (avec des caractères '#'). (C'est parce que ghc traite
caractères '#' dans la colonne 1 pour introduire les numéros de ligne.)
· Dans la saisie de texte restructurée, les sections de « piste d'oiseau » seront analysées en tant que code Haskell.
· Dans la sortie de texte restructurée, les blocs de code avec la classe haskell seront rendus à l'aide de bird
pistes.
· Dans l'entrée LaTeX, le texte dans les environnements de code sera analysé en tant que code Haskell.
· Dans la sortie LaTeX, les blocs de code avec la classe haskell seront rendus à l'intérieur du code
environnements.
· Dans la sortie HTML, les blocs de code avec la classe haskell seront rendus avec la classe
alphabétiséshaskell et traces d'oiseaux.
Exemples :
pandoc -f markdown+lhs -t html
lit le code source Haskell formaté avec les conventions Markdown et écrit du HTML ordinaire
(sans traces d'oiseaux).
pandoc -f markdown+lhs -t html+lhs
écrit du code HTML avec le code Haskell dans les traces d'oiseaux, il peut donc être copié et collé en tant que
alphabétisé source Haskell.
SYNTAXE MISE EN ÉVIDENCE
Pandoc mettra automatiquement en évidence la syntaxe dans les blocs de code isolés qui sont marqués d'un
Nom de la langue. La bibliothèque Haskell Highlighting-kate est utilisée pour le surlignage, ce qui
fonctionne en sortie HTML, Docx et LaTeX/PDF. Le schéma de couleurs peut être sélectionné à l'aide de la
--option de style de surbrillance. Le schéma de couleurs par défaut est pygments, qui imite le
schéma de couleurs par défaut utilisé par les pygments de la bibliothèque Python, mais pygments n'est pas réellement
utilisé pour faire la mise en évidence.
Pour voir une liste des noms de langues que pandoc reconnaîtra, tapez pandoc --version.
Pour désactiver la surbrillance, utilisez l'option --no-highlight.
SUR MESURE ÉCRIVAINS
Pandoc peut être étendu avec des rédacteurs personnalisés écrits en lua. (Pandoc comprend un lua
interpréteur, donc lua n'a pas besoin d'être installé séparément.)
Pour utiliser un écrivain personnalisé, spécifiez simplement le chemin d'accès au script lua à la place de la sortie
format. Par exemple:
pandoc -t data/sample.lua
La création d'un rédacteur personnalisé nécessite l'écriture d'une fonction lua pour chaque élément possible dans un
document pandoc. Pour obtenir un exemple documenté que vous pouvez modifier selon votre
besoins, faire
pandoc --print-default-data-file exemple.lua
AUTEURS
© 2006-2015 John Mac Farlane ([email protected]). Publié sous licence GPL, version 2 ou
plus grand. Ce logiciel ne comporte aucune garantie d'aucune sorte. (Voir COPYRIGHT pour l'intégralité
avis de droit d'auteur et de garantie.)
Les contributeurs incluent Aaron Wolen, Albert Krewinkel, Alexander Kondratskiy, Alexander
Sulfrian, Alexander V Vershilov, Alfred Wechselberger, Andreas Lööw, Andrew Dunning,
Antoine Latter, Arata Mizuki, Arlo O'Keeffe, Artyom Kazak, Ben Gamari, Beni
Cherniavsky-Paskin, Bjorn Buckwalter, Bradley Kuhn, Brent Yorgey, Bryan O'Sullivan, B.
Scott Michel, Caleb McDaniel, Calvin Beck, Christoffer Ackelman, Christoffer Sawicki,
Clare Macrae, Clint Adams, Conal Elliott, Craig S. Bosma, Daniel Bergey, Daniel T.
Staal, David Lazar, David Röthlisberger, Denis Laxalde, Douglas Calvert, Douglas F.
Calvert, Eric Kow, Eric Seidel, Florian Eitel, François Gannaz, Freiric Barral, Fiodor
Sheremetyev, Gabor Pali, Gavin Beatty, Greg Maslov, Grégory Bataille, Greg Rundlett,
gwern, Gwern Branwen, Hans-Peter Deifel, Henry de Valence, Ilya V. Portnov, infinity0x,
Jaime Marquínez Ferrándiz, James Aspnes, Jamie F. Olson, Jan Larres, Jason Ronallo, Jeff
Arnold, Jeff Runningen, Jens Petersen, Jérémy Bobbio, Jesse Rosenthal, J. Lewis Muir, Joe
Hillenbrand, John MacFarlane, Jonas Smedegaard, Jonathan Daugherty, Josef Svenningsson,
José Luis Duran, Julien Cretel, Justin Bogner, Kelsey Hightower, Konstantin Zudov,
Lars-Dominik Braun, Luke Plant, Mark Szepieniec, Mark Wright, Masayoshi Takahashi, Matej
Kollar, Mathias Schenner, Matthew Pickering, Matthias CM Troffaes, Mauro Bieg, Max
Bolingbroke, Max Rydahl Andersen, Merijn Verstraaten, Michael Snoyman, Michael Thompson,
MinRK, Nathan Gass, Neil Mayhew, Nick Bart, Nicolas Kaiser, Nikolay Yakimov, nkalvi, Paulo
Tanimoto, Paul Rivier, Peter Wang, Philippe Ombredanne, Phillip Alday, Puneeth Chaganti,
qerub, Ralf Stephan, Recai Oktaş, rodja.trappe, RyanGlScott, Scott Morrison, Sergei
Trofimovitch, 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 et Xavier Olive.
Le code source de Pandoc et toute la documentation peuvent être téléchargés à partir dehttp://pandoc.org>.
Utilisez pandoc en ligne en utilisant les services onworks.net