pandoc(1)

NAMN

pandoc – allmän märkspråkskonverterare

SYNOPSIS

pandoc [options] [input-file]...

BESKRIVNING

Pandoc är ett Haskell-bibliotek för att konvertera från ett märkspråksformat till ett annat, och ett kommandoradsverktyg som använder detta bibliotek.

Det kan läsa markdown och delmängder av Textile, reStructuredText, HTML, LaTeX och DocBook XML; och det kan skriva vanlig text, markdown, reStructuredText, XHTML, HTML 5, LaTeX, inklusive beamer-bildspel, ConTeXt, RTF, DocBook XML, OpenDocument XML, ODT, Word docx, GNU Texinfo, MediaWiki-markup, EPUB, Textile, groff-manualsidor, Emacs Org-Mode, AsciiDoc och Slidy-, Slideous-, DZSlides- eller S5-HTML-bildspel.

Det kan också producera PDF-utdata på system där LaTeX är installerat.

Pandocs utökade version av markdown innehåller syntax för fotnoter, tabeller, flexibla ordnade listor, definitionslistor, avgränsade kodblock, upphöjd text, nedsänkt text, genomstrykning, titelblock, automatiska innehållsförteckningar, inbäddad LaTeX-matematik, citeringar och markdown inuti HTML-blockelement.

Dessa utökningar, beskrivna nedan under Pandocs markdown, kan inaktiveras med optionen --strict.

Till skillnad från de flesta befintliga verktyg för att konvertera markdown till HTML, vilka använder regex-ersättningar, har Pandoc en modulär design: det består av en uppsättning läsare, som tolkar text i ett givet format och producerar en intern representation av dokumentet, och en uppsättning skrivare, som konverterar denna interna representation till ett målformat.

Därför krävs endast att en läsare eller skrivare läggs till för att lägga till ett indata- eller utdataformat.

Använda pandoc

Om ingen input-file anges läses indata från stdin.

Annars konkateneras input-files, med en tom rad mellan varje, och används som indata.

Utdata går som standard till stdout, även om utdata till stdout är inaktiverad för utdataformaten odt, docx och epub.

För utdata till en fil, använd optionen -o:

pandoc -o output.html input.txt

I stället för en fil kan en absolut URI anges. I detta fall hämtar pandoc innehållet med HTTP:

pandoc -f html -t markdown http://www.fsf.org

Om flera indatafiler anges kommer pandoc att konkatenera dem alla, med tomma rader mellan dem, före tolkning.

Formatet för indata och utdata kan anges uttryckligen med kommandoradsoptioner.

Indataformatet kan anges med optionerna -r/--read eller -f/--from, och utdataformatet med optionerna -w/--write eller -t/--to.

För att konvertera hello.txt från markdown till LaTeX kan du skriva:

pandoc -f markdown -t latex hello.txt

För att konvertera hello.html från HTML till markdown:

pandoc -f html -t markdown hello.html

Stödda utdataformat listas nedan under optionen -t/--to.

Stödda indataformat listas nedan under optionen -f/--from.

Observera att läsarna för rst, textile, latex och html inte är kompletta; det finns vissa konstruktioner som de inte tolkar.

Om indata- eller utdataformatet inte anges uttryckligen försöker pandoc gissa det från ändelserna på indata- och utdatafilnamnen.

Exempel:

pandoc -o hello.tex hello.txt

kommer att konvertera hello.txt från markdown till LaTeX.

Om ingen utdatafil anges, så att utdata går till stdout, eller om utdatafilens ändelse är okänd, blir utdataformatet som standard HTML.

Om ingen indatafil anges, så att indata kommer från stdin, eller om indatafilernas ändelser är okända, antas indataformatet vara markdown om det inte anges uttryckligen.

Pandoc använder teckenkodningen UTF-8 för både indata och utdata.

Om din lokala teckenkodning inte är UTF-8 bör du skicka indata och utdata genom iconv:

iconv -t utf-8 input.txt | pandoc | iconv -f utf-8

Skapa en PDF

Tidigare versioner av pandoc kom med programmet markdown2pdf, som använde pandoc och pdflatex för att producera en PDF.

Detta behövs inte längre, eftersom pandoc nu själv kan producera pdf-utdata.

För att producera en PDF anger du helt enkelt en utdatafil med ändelsen .pdf.

Pandoc skapar en LaTeX-fil och använder pdflatex, eller en annan motor, se --latex-engine, för att konvertera den till PDF:

pandoc test.txt -o test.pdf

Produktion av en PDF kräver att en LaTeX-motor är installerad, se --latex-engine nedan, och antar att följande LaTeX-paket finns tillgängliga: amssymb, amsmath, ifxetex, ifluatex, listings om optionen --listings används, fancyvrb, enumerate, ctable, url, graphicx, hyperref, ulem, babel om variabeln lang är satt, fontspec om xelatex eller lualatex används som LaTeX-motor, xltxtra och xunicode om xelatex används.

hsmarkdown

En användare som vill ha en drop-in-ersättare för Markdown.pl kan skapa en symbolisk länk till pandoc-programmet med namnet hsmarkdown.

När det anropas under namnet hsmarkdown beter sig pandoc som om flaggan --strict hade valts, och inga kommandoradsoptioner känns igen.

Detta tillvägagångssätt fungerar dock inte under Cygwin på grund av problem med dess simulering av symboliska länkar.

OPTIONER

Allmänna optioner

-f FORMAT, -r FORMAT

--from= FORMAT, --read= FORMAT

Ange indataformat.

FORMAT kan vara native, intern Haskell, json, JSON-version av intern AST, markdown, textile, rst, reStructuredText, html, docbook eller latex.

Om +lhs läggs till efter markdown, rst eller latex behandlas indata som literate Haskell-källkod; se Literate Haskell-stöd nedan.

-t FORMAT, -w FORMAT

--to= FORMAT, --write= FORMAT

Ange utdataformat.

FORMAT kan vara native, json, plain, markdown, rst, html, html5, latex, beamer, context, man, mediawiki, textile, org, texinfo, docbook, opendocument, odt, docx, epub, asciidoc, slidy, slideous, dzslides, s5 eller rtf.

Observera att odt- och epub-utdata inte skickas till stdout; ett utdatafilnamn måste anges med optionen -o/--output.

Om +lhs läggs till efter markdown, rst, latex, beamer, html eller html5 renderas utdatan som literate Haskell-källkod; se Literate Haskell-stöd nedan.

-o FILE, --output= FILE

Skriv utdata till FILE i stället för till stdout.

Om FILE är - går utdata till stdout.

Undantag: om utdataformatet är odt, docx eller epub är utdata till stdout inaktiverad.

--data-dir= DIRECTORY

Ange användardatakatalogen där pandoc ska söka efter datafiler.

Om denna option inte anges används standardkatalogen:

$HOME/.pandoc

i Unix och:

C:\Documents And Settings\USERNAME\Application Data\pandoc

i Windows.

En katalog eller fil med namnet reference.odt, reference.docx, default.csl, epub.css, templates, slidy, slideous eller s5 i denna katalog åsidosätter pandocs normala standardvärden.

-v, --version

Skriv ut version.

-h, --help

Visa användningsmeddelande.

Läsaroptioner

--strict

Använd strikt markdown-syntax, utan pandoc-utökningar eller varianter.

När indataformatet är HTML betyder detta att konstruktioner som saknar motsvarigheter i standard-markdown, t.ex. definitionslistor eller genomstruken text, tolkas som rå HTML.

-R, --parse-raw

Tolka oöversättbara HTML-koder och LaTeX-miljöer som rå HTML eller LaTeX i stället för att ignorera dem.

Påverkar endast HTML- och LaTeX-indata.

Rå HTML kan skrivas i markdown, reStructuredText, HTML, Slidy, Slideous, DZSlides och S5-utdata; rå LaTeX kan skrivas i markdown, reStructuredText, LaTeX och ConTeXt-utdata.

Standard är att läsarna utelämnar oöversättbara HTML-koder och LaTeX-miljöer.

LaTeX-läsaren skickar igenom oöversättbara LaTeX-kommandon, även om -R inte anges.

-S, --smart

Producera typografiskt korrekt utdata, konvertera raka citattecken till böjda citattecken, --- till em-streck, -- till en-streck och ... till ellipser.

Hårda blanksteg infogas efter vissa förkortningar, såsom "Mr.".

Denna option är betydelsefull endast när indataformatet är markdown eller textile.

Den väljs automatiskt när indataformatet är textile eller utdataformatet är latex eller context, om inte --no-tex-ligatures används.

--old-dashes

Välj pandoc <= 1.8.2.1-beteendet för tolkning av smarta streck: - före en siffra är ett en-streck, och -- är ett em-streck.

Denna option väljs automatiskt för textile-indata.

--base-header-level= NUMBER

Ange basnivån för rubriker, standard är 1.

--indented-code-classes= CLASSES

Ange klasser att använda för indragna kodblock, till exempel perl,numberLines eller haskell.

Flera klasser kan separeras med blanksteg eller kommatecken.

--normalize

Normalisera dokumentet efter läsning: slå samman intilliggande Str- eller Emph-element, till exempel, och ta bort upprepade Space-element.

-p, --preserve-tabs

Bevara tabbar i stället för att konvertera dem till blanksteg, standard.

--tab-stop= NUMBER

Ange antalet blanksteg per tabb, standard är 4.

Allmänna skrivaroptioner

-s, --standalone

Producera utdata med lämpligt huvud och fot, t.ex. en fristående HTML-, LaTeX- eller RTF-fil, inte ett fragment.

Denna option sätts automatiskt för pdf, epub, docx och odt-utdata.

--template= FILE

Använd FILE som en egen mall för det genererade dokumentet.

Implicerar --standalone.

Se Mallar nedan för en beskrivning av mallsyntaxen.

Om ingen ändelse anges läggs en ändelse som motsvarar skrivaren till, så att --template=special söker efter special.html för HTML-utdata.

Om mallen inte hittas söker pandoc efter den i användardatakatalogen, se --data-dir.

Om denna option inte används används en standardmall som passar utdataformatet, se -D/--print-default-template.

-V KEY[=VAL], --variable= KEY[:VAL]

Sätt mallvariabeln KEY till värdet VAL när dokumentet renderas i fristående läge.

Detta är i allmänhet endast användbart när optionen --template används för att ange en egen mall, eftersom pandoc automatiskt sätter variablerna som används i standardmallarna.

Om inget VAL anges får nyckeln värdet true.

-D FORMAT, --print-default-template= FORMAT

Skriv ut standardmallen för ett utdata-FORMAT.

Se -t för en lista över möjliga FORMAT.

--no-wrap

Inaktivera radbrytning av text i utdata.

Som standard radbryts text på ett sätt som passar utdataformatet.

--columns= NUMBER

Ange radlängd i tecken, för radbrytning av text.

--toc, --table-of-contents

Inkludera en automatiskt genererad innehållsförteckning eller, för latex, context och rst, en instruktion att skapa en.

Denna option har ingen effekt på man, docbook, slidy, slideous eller s5-utdata.

--no-highlight

Inaktiverar syntaxmarkering för kodblock och inline-kod, även när ett språkattribut anges.

--highlight-style= STYLE

Anger färgstilen som ska användas i markerad källkod.

Optioner är pygments, standard, kate, monochrome, espresso, zenburn, haddock och tango.

-H FILE, --include-in-header= FILE

Inkludera innehållet i FILE, ordagrant, i slutet av huvudet.

Detta kan exempelvis användas för att inkludera särskild CSS eller JavaScript i HTML-dokument.

Option kan användas upprepade gånger för att inkludera flera filer i huvudet.

De inkluderas i angiven ordning.

Implicerar --standalone.

-B FILE, --include-before-body= FILE

Inkludera innehållet i FILE, ordagrant, i början av dokumentets body, t.ex. efter taggen <body> i HTML eller kommandot \begin{document} i LaTeX.

Kan användas för att inkludera navigationsrader eller banners i HTML-dokument.

Option kan användas upprepade gånger för att inkludera flera filer i angiven ordning.

Implicerar --standalone.

-A FILE, --include-after-body= FILE

Inkludera innehållet i FILE, ordagrant, i slutet av dokumentets body, före taggen </body> i HTML eller kommandot \end{document} i LaTeX.

Option kan användas upprepade gånger för att inkludera flera filer i angiven ordning.

Implicerar --standalone.

Optioner som påverkar specifika skrivare

--self-contained

Producera en fristående HTML-fil utan externa beroenden, med data:-URI:er för att infoga innehållet i länkade skript, stilmallar, bilder och videor.

Den resulterande filen ska vara "self-contained" i den meningen att den inte behöver externa filer och ingen nätåtkomst för att visas korrekt i en webbläsare.

Denna option fungerar endast med HTML-utdataformat, inklusive html, html5, html+lhs, html5+lhs, s5, slidy, slideous och dzslides.

Skript, bilder och stilmallar vid absoluta URL:er laddas ned; de vid relativa URL:er söks först relativt arbetskatalogen, sedan relativt användardatakatalogen, se --data-dir, och slutligen relativt pandocs standarddatakatalog.

--offline

Föråldrad synonym för --self-contained.

-5, --html5

Producera HTML5 i stället för HTML4.

Denna option har ingen effekt för andra skrivare än html.

Föråldrad: använd utdataformatet html5 i stället.

--ascii

Använd endast ASCII-tecken i utdata.

För närvarande stöds detta endast för HTML-utdata, som använder numeriska entiteter i stället för UTF-8 när denna option väljs.

--reference-links

Använd länkar av referensstil, i stället för inline-länkar, när markdown eller reStructuredText skrivs.

Som standard används inline-länkar.

--atx-headers

Använd ATX-rubriker i markdown-utdata.

Standard är att använda setext-rubriker för nivå 1–2, och därefter ATX-rubriker.

--chapters

Behandla toppnivårubriker som kapitel i LaTeX-, ConTeXt- och DocBook-utdata.

När LaTeX-mallen använder klassen report, book eller memoir impliceras denna option.

Om --beamer används blir toppnivårubriker \part{..}.

-N, --number-sections

Numrera avsnittsrubriker i LaTeX-, ConTeXt- eller HTML-utdata.

Som standard numreras inte avsnitt.

--no-tex-ligatures

Konvertera inte citattecken, apostrofer och streck till TeX-ligaturer när LaTeX eller ConTeXt skrivs.

Använd i stället bokstavliga Unicode-tecken.

Detta behövs för att använda avancerade OpenType-funktioner med XeLaTeX och LuaLaTeX.

Observera att --smart normalt väljs automatiskt för LaTeX- och ConTeXt-utdata, men måste anges uttryckligen om --no-tex-ligatures väljs.

Om du använder bokstavliga böjda citattecken, streck och ellipser i källan, kan du vilja använda --no-tex-ligatures utan --smart.

--listings

Använd paketet listings för LaTeX-kodblock.

-i, --incremental

Gör att listposter i bildspel visas inkrementellt, en i taget.

Standard är att listor visas på en gång.

--slide-level= NUMBER

Anger att rubriker med den angivna nivån skapar bilder för beamer, s5, slidy, slideous och dzslides.

Rubriker ovanför denna nivå i hierarkin används för att dela in bildspelet i avsnitt; rubriker under denna nivå skapar underrubriker inom en bild.

Standard är att sätta bildnivån baserat på dokumentets innehåll; se Strukturera bildspelet nedan.

--section-divs

Omslut avsnitt med

-taggar, eller <section>-taggar i HTML5, och fäst identifierare vid den omslutande

eller <section> i stället för vid själva rubriken.

Se Avsnittsidentifierare nedan.

--email-obfuscation= none|javascript|references

Ange en metod för att obfuskera mailto:-länkar i HTML-dokument.

none lämnar mailto:-länkar som de är.

javascript obfuskerar dem med JavaScript.

references obfuskerar dem genom att skriva deras bokstäver som decimala eller hexadecimala teckenreferenser.

Om --strict anges används references oavsett om denna option finns.

--id-prefix= STRING

Ange ett prefix som ska läggas till alla automatiskt genererade identifierare i HTML-utdata.

Detta är användbart för att förhindra dubbla identifierare när fragment genereras för att inkluderas i andra sidor.

-T STRING, --title-prefix= STRING

Ange STRING som ett prefix i början av titeln som visas i HTML-huvudet, men inte i titeln som visas i början av HTML-body.

Implicerar --standalone.

-c URL, --css= URL

Länka till en CSS-stilmall.

--reference-odt= FILE

Använd den angivna filen som stilreferens vid produktion av en ODT.

För bästa resultat bör referens-ODT:n vara en modifierad version av en ODT som producerats med pandoc.

Innehållet i referens-ODT:n ignoreras, men dess stilmallar används i den nya ODT:n.

Om ingen referens-ODT anges på kommandoraden letar pandoc efter filen reference.odt i användardatakatalogen, se --data-dir.

Om den inte heller hittas används rimliga standardvärden.

--reference-docx= FILE

Använd den angivna filen som stilreferens vid produktion av en docx-fil.

För bästa resultat bör referens-docx:en vara en modifierad version av en docx-fil som producerats med pandoc.

Innehållet i referens-docx:en ignoreras, men dess stilmallar används i den nya docx-filen.

Om ingen referens-docx anges på kommandoraden letar pandoc efter filen reference.docx i användardatakatalogen, se --data-dir.

Om den inte heller hittas används rimliga standardvärden.

--epub-stylesheet= FILE

Använd den angivna CSS-filen för att formge EPUB-filen.

Om ingen stilmall anges letar pandoc efter filen epub.css i användardatakatalogen, se --data-dir.

Om den inte hittas där används rimliga standardvärden.

--epub-cover-image= FILE

Använd den angivna bilden som EPUB-omslag.

Det rekommenderas att bilden är mindre än 1000px i bredd och höjd.

--epub-metadata= FILE

Leta i den angivna XML-filen efter metadata för EPUB-filen.

Filen bör innehålla en serie Dublin Core-element, som dokumenterat på:

http://dublincore.org/documents/dces/

Exempel:

<dc:rights>Creative Commons</dc:rights>
<dc:language>es-AR</dc:language>

Som standard inkluderar pandoc följande metadataelement: <dc:title>, från dokumenttiteln, <dc:creator>, från dokumentförfattarna, <dc:date>, från dokumentdatumet, som bör vara i ISO 8601-format, <dc:language>, från variabeln lang, eller, om den inte är satt, lokalen, och <dc:identifier id="BookId">, en slumpmässigt genererad UUID.

Alla dessa kan åsidosättas av element i metadatafilen.

--epub-embed-font= FILE

Bädda in det angivna teckensnittet i EPUB-filen.

Denna option kan upprepas för att bädda in flera teckensnitt.

För att använda inbäddade teckensnitt behöver du lägga till deklarationer som följande i din CSS, se --epub-stylesheet:

@font-face {
font-family: DejaVuSans;
font-style: normal;
font-weight: normal;
src:url("DejaVuSans-Regular.ttf");
}
@font-face {
font-family: DejaVuSans;
font-style: normal;
font-weight: bold;
src:url("DejaVuSans-Bold.ttf");
}
@font-face {
font-family: DejaVuSans;
font-style: italic;
font-weight: normal;
src:url("DejaVuSans-Oblique.ttf");
}
@font-face {
font-family: DejaVuSans;
font-style: italic;
font-weight: bold;
src:url("DejaVuSans-BoldOblique.ttf");
}
body { font-family: "DejaVuSans"; }

--latex-engine= pdflatex|lualatex|xelatex

Använd den angivna LaTeX-motorn när PDF-utdata produceras.

Standard är pdflatex.

Om motorn inte finns i din PATH kan hela sökvägen till motorn anges här.

Citeringar

--bibliography= FILE

Ange bibliografidatabas som ska användas för att lösa citeringar.

Databastypen bestäms från ändelsen på FILE, som kan vara .mods, MODS-format, .bib, BibTeX/BibLaTeX-format, .ris, RIS-format, .enl, EndNote-format, .xml, EndNote XML-format, .wos, ISI-format, .medline, MEDLINE-format, .copac, Copac-format, eller .json, citeproc JSON.

Om du vill använda flera bibliografier använder du bara denna option upprepade gånger.

--csl= FILE

Ange CSL-stil som ska användas vid formatering av citeringar och bibliografi.

Om FILE inte hittas letar pandoc efter den i:

$HOME/.csl

i Unix och:

C:\Documents And Settings\USERNAME\Application Data\csl

i Windows.

Om optionen --csl inte anges använder pandoc en standardstil: antingen default.csl i användardatakatalogen, se --data-dir, eller, om den saknas, Chicago author-date-stilen.

--citation-abbreviations= FILE

Ange en fil som innehåller förkortningar för tidskriftstitlar och andra bibliografiska fält, indikerade genom att sätta form="short" i CSL-noden för fältet.

Formatet beskrivs på:

http://citationstylist.org/2011/10/19/abbreviations-for-zotero-test-release/

Här är ett kort exempel:

{ "default": {
    "container-title": {
            "Lloyd's Law Reports": "Lloyd's Rep",
            "Estates Gazette": "EG",
            "Scots Law Times": "SLT"
    }
  }
}

--natbib

Använd natbib för citeringar i LaTeX-utdata.

--biblatex

Använd biblatex för citeringar i LaTeX-utdata.

Matematikrendering i HTML

-m [URL], --latexmathml[=URL]

Använd LaTeXMathML-skriptet för att visa inbäddad TeX-matematik i HTML-utdata.

För att infoga en länk till en lokal kopia av skriptet LaTeXMathML.js, ange en URL.

Om ingen URL anges infogas skriptets innehåll direkt i HTML-huvudet, vilket bevarar portabilitet på bekostnad av effektivitet.

Om du planerar att använda matematik på flera sidor är det mycket bättre att länka till en kopia av skriptet, så att det kan cachelagras.

--mathml[=URL]

Konvertera TeX-matematik till MathML, i docbook såväl som html och html5.

I fristående html-utdata infogas ett litet JavaScript, eller en länk till ett sådant skript om en URL anges, vilket låter MathML visas i vissa webbläsare.

--jsmath[=URL]

Använd jsMath för att visa inbäddad TeX-matematik i HTML-utdata.

URL ska peka på jsMath-laddningsskriptet, t.ex. jsMath/easy/load.js.

Om den anges länkas den in i huvudet på fristående HTML-dokument.

Om ingen URL anges infogas ingen länk till jsMath-laddningsskriptet; det är då upp till författaren att tillhandahålla en sådan länk i HTML-mallen.

--mathjax[=URL]

Använd MathJax för att visa inbäddad TeX-matematik i HTML-utdata.

URL ska peka på laddningsskriptet MathJax.js.

Om ingen URL anges infogas en länk till MathJax CDN.

--gladtex

Omslut TeX-matematik med <eq>-taggar i HTML-utdata.

Dessa kan sedan behandlas av gladTeX för att producera länkar till bilder av de typsatta formlerna.

--mimetex[=URL]

Rendera TeX-matematik med mimeTeX CGI-skriptet.

Om URL inte anges antas skriptet finnas på /cgi-bin/mimetex.cgi.

--webtex[=URL]

Rendera TeX-formler med ett externt skript som konverterar TeX-formler till bilder.

Formeln konkateneras med den angivna URL:en.

Om URL inte anges används Google Chart API.

Optioner för wrapper-skript

--dump-args

Skriv information om kommandoradsargument till stdout och avsluta sedan.

Denna option är främst avsedd för användning i wrapper-skript.

Första utdataraden innehåller namnet på utdatafilen som angavs med optionen -o, eller - för stdout om ingen utdatafil angavs.

De återstående raderna innehåller kommandoradsargumenten, ett per rad, i den ordning de förekommer.

Dessa inkluderar inte vanliga Pandoc-optioner och deras argument, men inkluderar alla optioner som förekommer efter en ---separator i slutet av raden.

--ignore-args

Ignorera kommandoradsargument, för användning i wrapper-skript.

Vanliga Pandoc-optioner ignoreras inte.

Exempel:

pandoc --ignore-args -o foo.html -s foo.txt -- -e latin1

är ekvivalent med:

pandoc -o foo.html -s

MALLAR

När optionen -s/--standalone används använder pandoc en mall för att lägga till huvud- och fotmaterial som behövs för ett fristående dokument.

För att se standardmallen som används, skriv:

pandoc -D FORMAT

där FORMAT är namnet på utdataformatet.

En egen mall kan anges med optionen --template.

Du kan också åsidosätta systemets standardmallar för ett givet utdataformat FORMAT genom att lägga filen templates/default.FORMAT i användardatakatalogen, se --data-dir ovan.

Undantag: för odt-utdata, anpassa mallen default.opendocument. För pdf-utdata, anpassa mallen default.latex. För epub-utdata, anpassa mallarna epub-page.html, epub-coverimage.html och epub-titlepage.html.

Mallar kan innehålla variabler.

Variabelnamn är sekvenser av alfanumeriska tecken, - och _, som börjar med en bokstav.

Ett variabelnamn omgivet av $-tecken ersätts av sitt värde.

Till exempel ersätts strängen $title$ i:

<title>$title$</title>

av dokumenttiteln.

För att skriva ett bokstavligt $ i en mall, använd $$.

Vissa variabler sätts automatiskt av pandoc.

Dessa varierar något beroende på utdataformat, men inkluderar:

header-includes

innehåll som anges med -H/--include-in-header, kan ha flera värden

toc

icke-null-värde om --toc/--table-of-contents angavs

include-before

innehåll som anges med -B/--include-before-body, kan ha flera värden

include-after

innehåll som anges med -A/--include-after-body, kan ha flera värden

body

dokumentets kropp

title

dokumentets titel, som angiven i titelblocket

author

dokumentets författare, som angiven i titelblocket, kan ha flera värden

date

dokumentets datum, som angivet i titelblocket

lang

språkkod för HTML- eller LaTeX-dokument

slidy-url

bas-URL för Slidy-dokument, standard:

http://www.w3.org/Talks/Tools/Slidy2

slideous-url

bas-URL för Slideous-dokument, standard default

s5-url

bas-URL för S5-dokument, standard ui/default

fontsize

teckenstorlek, 10pt, 11pt, 12pt, för LaTeX-dokument

documentclass

dokumentklass för LaTeX-dokument

geometry

optioner för LaTeX-klassen geometry, t.ex. margin=1in; kan upprepas för flera optioner

mainfont, sansfont, monofont, mathfont

teckensnitt för LaTeX-dokument, fungerar endast med xelatex och lualatex

theme

tema för LaTeX beamer-dokument

colortheme

färgtema för LaTeX beamer-dokument

linkcolor

färg för interna länkar i LaTeX-dokument, red, green, magenta, cyan, blue, black

urlcolor

färg för externa länkar i LaTeX-dokument

links-as-notes

gör att länkar skrivs som fotnoter i LaTeX-dokument

Variabler kan sättas på kommandoraden med optionen -V/--variable.

Detta gör det möjligt för användare att inkludera egna variabler i sina mallar.

Mallar kan innehålla villkor. Syntaxen är följande:

$if(variable)$
X
$else$
Y
$endif$

Detta inkluderar X i mallen om variable har ett icke-null-värde; annars inkluderas Y.

X och Y är platshållare för valfri giltig malltext, och kan innehålla interpolerade variabler eller andra villkor.

Avsnittet $else$ kan utelämnas.

När variabler kan ha flera värden, till exempel author i ett dokument med flera författare, kan nyckelordet $for$ användas:

$for(author)$
<meta name="author" content="$author$" />
$endfor$

Du kan valfritt ange en separator som ska användas mellan på varandra följande poster:

$for(author)$$author$$sep$, $endfor$

Om du använder egna mallar kan du behöva revidera dem när pandoc ändras.

Det rekommenderas att spåra ändringar i standardmallarna och modifiera egna mallar i enlighet med detta.

Ett enkelt sätt att göra detta är att forka pandoc-templates-förrådet och slå samman ändringar efter varje pandoc-utgåva:

http://github.com/jgm/pandoc-templates

PRODUCERA BILDSPEL MED PANDOC

Du kan använda Pandoc för att producera en HTML + JavaScript-presentation som kan visas i en webbläsare.

Det finns fyra sätt att göra detta: med S5, DZSlides, Slidy eller Slideous.

Du kan också producera ett PDF-bildspel med LaTeX beamer.

Här är markdown-källan för ett enkelt bildspel, habits.txt:

% Habits
% John Doe
% March 22, 2005

# In the morning

## Getting up

- Turn off alarm
- Get out of bed

## Breakfast

- Eat eggs
- Drink coffee

# In the evening

## Dinner

- Eat spaghetti
- Drink wine

------------------

![picture of spaghetti](images/spaghetti.jpg)

## Going to sleep

- Get in bed
- Count sheep

För att producera bildspelet skriver du helt enkelt:

pandoc -t s5 -s habits.txt -o habits.html

för S5,

pandoc -t slidy -s habits.txt -o habits.html

för Slidy,

pandoc -t slideous -s habits.txt -o habits.html

för Slideous,

pandoc -t dzslides -s habits.txt -o habits.html

för DZSlides, eller:

pandoc -t beamer habits.txt -o habits.pdf

för beamer.

Med alla HTML-bildspelsformat kan optionen --self-contained användas för att producera en enda fil som innehåller all data som behövs för att visa bildspelet, inklusive länkade skript, stilmallar, bilder och videor.

Strukturera bildspelet

Som standard är slide level den högsta rubriknivån i hierarkin som omedelbart följs av innehåll, och inte av en annan rubrik, någonstans i dokumentet.

I exemplet ovan följs nivå 1-rubriker alltid av nivå 2-rubriker, som följs av innehåll, så 2 är bildnivån.

Detta standardvärde kan åsidosättas med optionen --slide-level.

Dokumentet delas upp i bilder enligt följande regler:

• En horisontell linje startar alltid en ny bild.
• En rubrik på bildnivån startar alltid en ny bild.
• Rubriker under bildnivån i hierarkin skapar rubriker inom en bild.
• Rubriker över bildnivån i hierarkin skapar "titelbilder", som bara innehåller avsnittstiteln och hjälper till att dela upp bildspelet i avsnitt.
• En titelsida konstrueras automatiskt från dokumentets titelblock, om ett sådant finns. För beamer kan detta inaktiveras genom att kommentera bort vissa rader i standardmallen.

Dessa regler är utformade för att stödja många olika bildspelsstilar.

Om du inte bryr dig om att strukturera dina bilder i avsnitt och underavsnitt kan du bara använda nivå 1-rubriker för varje bild.

I så fall blir nivå 1 bildnivån.

Men du kan också strukturera bildspelet i avsnitt, som i exemplet ovan.

För Slidy, Slideous och S5 bäddar filen som produceras av pandoc med optionen -s/--standalone in en länk till JavaScript- och CSS-filer, som antas vara tillgängliga vid den relativa sökvägen s5/default för S5, slideous för Slideous, eller på Slidy-webbplatsen vid w3.org för Slidy.

Dessa sökvägar kan ändras genom att sätta variablerna slidy-url, slideous-url eller s5-url; se --variable ovan.

För DZSlides inkluderas den relativt korta JavaScript- och CSS-koden i filen som standard.

Inkrementella listor

Som standard producerar dessa skrivare listor som visas "allt på en gång".

Om du vill att listor ska visas inkrementellt, en post i taget, använd optionen -i.

Om du vill att en viss lista ska avvika från standarden, det vill säga visas inkrementellt utan optionen -i och allt på en gång med optionen -i, placera den i ett blockcitat:

> - Eat spaghetti
> - Drink wine

På detta sätt kan inkrementella och icke-inkrementella listor blandas i ett enda dokument.

Formge bilderna

Du kan ändra stilen på HTML-bilder genom att lägga anpassade CSS-filer i $DATADIR/s5/default för S5, $DATADIR/slidy för Slidy, eller $DATADIR/slideous för Slideous, där $DATADIR är användardatakatalogen, se --data-dir ovan.

Originalen kan hittas i pandocs systemdatakatalog, vanligen $CABALDIR/pandoc-VERSION/s5/default.

Pandoc letar där efter filer som inte hittas i användardatakatalogen.

För dzslides inkluderas CSS i själva HTML-filen och kan modifieras där.

För att formge beamer-bilder kan du ange ett beamer-"theme" eller "colortheme" med optionen -V:

pandoc -t beamer habits.txt -V theme:Warsaw -o habits.pdf

LITERATE HASKELL-STÖD

Om du lägger till +lhs efter ett lämpligt indata- eller utdataformat, markdown, rst eller latex för indata eller utdata; beamer, html eller html5 endast för utdata, behandlar pandoc dokumentet som literate Haskell-källkod.

Detta betyder att:

• I markdown-indata tolkas "bird track"-avsnitt som Haskell-kod i stället för blockcitat. Text mellan \begin{code} och \end{code} behandlas också som Haskell-kod.
• I markdown-utdata renderas kodblock med klasserna haskell och literate med bird tracks, och blockcitat indenteras ett blanksteg så att de inte behandlas som Haskell-kod. Dessutom renderas rubriker i setext-stil, med understrykningar, snarare än atx-stil, med #-tecken. Detta beror på att ghc behandlar #-tecken i kolumn 1 som introducerande radnummer.
• I reStructuredText-indata tolkas "bird track"-avsnitt som Haskell-kod.
• I reStructuredText-utdata renderas kodblock med klassen haskell med bird tracks.
• I LaTeX-indata tolkas text i code-miljöer som Haskell-kod.
• I LaTeX-utdata renderas kodblock med klassen haskell inuti code-miljöer.
• I HTML-utdata renderas kodblock med klassen haskell med klassen literatehaskell och bird tracks.

Exempel:

pandoc -f markdown+lhs -t html

läser literate Haskell-källkod formaterad enligt markdown-konventioner och skriver vanlig HTML, utan bird tracks.

pandoc -f markdown+lhs -t html+lhs

skriver HTML med Haskell-koden i bird tracks, så att den kan kopieras och klistras in som literate Haskell-källkod.

FÖRFATTARE

© 2006–2011 John MacFarlane, jgm at berkeley dot edu.

Utgiven under GPL, version 2 eller senare.

Denna programvara ges utan garanti av något slag.

Se COPYRIGHT för fullständiga upphovsrätts- och garantiupplysningar.

Andra bidragsgivare inkluderar Recai Oktaş, Paulo Tanimoto, Peter Wang, Andrea Rossato, Eric Kow, infinity0x, Luke Plant, shreevatsa.public, Puneeth Chaganti, Paul Rivier, rodja.trappe, Bradley Kuhn, thsutton, Nathan Gass, Jonathan Daugherty, Jérémy Bobbio, Justin Bogner, qerub, Christopher Sawicki, Kelsey Hightower, Masayoshi Takahashi, Antoine Latter, Ralf Stephan, Eric Seidel och B. Scott Michel.

PANDOC'S MARKDOWN

För en fullständig beskrivning av pandocs utökningar av standard-markdown, se pandoc_markdown(5).

SE ÄVEN

markdown2pdf(1), pandoc_markdown(5).

Pandocs källkod och all dokumentation kan hämtas från:

http://johnmacfarlane.net/pandoc/

Sidslut

Orginalhemsidan på Engelska https://linux.die.net/man/1/pandoc Det här är en maskinöversättning av Linux man sidor till svenska. Om du hittar fel är vi tacksamma om du rapporterar dem via formuläret som finns på https://www.linux.se/kontaka-linux-se/

Tack till Datorservice som har sponsrat Linux.se med webbhotell.