Pandoc
{{Short description|Software for converting between text document formats}}
{{Infobox software
| name = Pandoc
| author = John MacFarlane
| released = {{start date and age|2006|08|10|df=yes|paren=yes}}
| latest release version = {{wikidata|property|reference|edit|P348}}
| latest release date = {{start date and age|{{wikidata|qualifier|P348|P577}}|df=yes|paren=yes}}
| programming language = Haskell
| operating system = Unix-like, Windows
| platform = Cross-platform
| license = GNU GPLv2-or-later
| website = {{URL|https://pandoc.org}}
}}
Pandoc is a free-software document converter, widely used as a writing tool (especially by scholars){{Cite web
| last = Mullen
| first = Lincoln
| title = Pandoc Converts All Your (Text) Documents
| work = The Chronicle of Higher Education Blogs: ProfHacker
| access-date = 27 June 2014
| date = 23 February 2012
| url = http://chronicle.com/blogs/profhacker/pandoc-converts-all-your-text-documents/38700
}}
- {{Cite web
| last = McDaniel
| first = W. Caleb
| title = Why (and How) I Wrote My Academic Book in Plain Text
| work = W. Caleb McDaniel at Rice University
| access-date = 27 June 2014
| date = 28 September 2012
| url = http://wcm1.web.rice.edu/my-academic-book-in-plain-text.html
}}
- {{Cite web
| last = Healy
| first = Kieran
| title = Plain Text, Papers, Pandoc
| access-date = 27 June 2014
| date = 23 January 2014
| url = http://kieranhealy.org/blog/archives/2014/01/23/plain-text/
}}
- {{Cite journal
| doi = 10.1080/01639269.2014.904696
| issn = 0163-9269
| volume = 33
| issue = 2
| pages = 120–124
| last = Ovadia
| first = Steven
| title = Markdown for Librarians and Academics
| journal = Behavioral & Social Sciences Librarian
| date = 2014
| s2cid = 62762368
| url = http://academicworks.cuny.edu/lg_pubs/7/
| url-access = subscription
}} and as a basis for publishing workflows.{{Cite web
|last1 = Till
|first1 = Kaitlyn
|first2 = Shed
|last2 = Simas
|first3 = Velma
|last3 = Larkai
|title = The Flying Narwhal: Small mag workflow
|work = Publishing @ SFU
|access-date = 11 March 2018
|date = 14 April 2014
|url = http://tkbr.publishing.sfu.ca/mpub/2014/04/14/the-flying-narwhal-small-mag-workflow/#more-639
}}
- {{Cite web
| last = Maxwell
| first = John
| title = Building Publishing Workflows with Pandoc and Git
| work = Publishing @ SFU
| access-date = 27 June 2014
| date = 1 November 2013
| url = http://www.ccsp.sfu.ca/2013/11/building-publishing-workflows-with-pandoc-and-git/
}}{{Dead link|date=April 2020 |bot=InternetArchiveBot |fix-attempted=yes }}
- {{Cite web
|last = Maxwell
|first = John
|title = On Pandoc
|location = eBound Canada: Digital Production Workshop, Vancouver, BC
|access-date = 27 June 2014
|date = 26 February 2014
|url = http://tkbr.ccsp.sfu.ca:5001/Slides/On%20Pandoc
|url-status = dead
|archive-url = https://web.archive.org/web/20150228184316/http://tkbr.ccsp.sfu.ca:5001/Slides/On%20Pandoc
|archive-date = 28 February 2015
}}
- {{Cite web
| last = Maxwell
| first = John
| title = Building Publishing Workflows with Pandoc and Git
| work = Publishing @ SFU
| access-date = 12 April 2019
| date = 1 November 2013
| url = https://publishing.sfu.ca/2013/11/building-publishing-workflows-with-pandoc-and-git/
}}
- {{Cite journal
| doi = 10.7717/peerj-cs.112
| last = Krewinkel
| first = Albert
| author2 = Robert Winkler
| title = Formatting Open Science: agilely creating multiple document formats for academic manuscripts with Pandoc Scholar
| journal = PeerJ Computer Science
| access-date = 25 May 2017
| date = 8 May 2017
| volume = 3
| pages = e112
| url = https://peerj.com/articles/cs-112/
| doi-access = free
}} It was created by John MacFarlane, a philosophy professor at the University of California, Berkeley.{{cite web|url=https://philosophy.berkeley.edu/people/detail/1|title=John MacFarlane|website=Department of Philosophy|publisher=University of California, Berkeley|access-date=25 July 2014}}
Functionality
Pandoc dubs itself a "markup format" converter. It can take a document in one of the supported formats and convert only its markup to another format. Maintaining the look and feel of the document is not a priority.{{Cite web|url=https://pandoc.org/MANUAL.html#description|title=Pandoc User's Guide|website=pandoc.org|at=Description|access-date=22 January 2019|quote=...one should not expect perfect conversions between every format and every other. Pandoc attempts to preserve the structural elements of a document, but not formatting details...}}
Plug-ins for custom formats can also be written in Lua, which has been used to create an exporting tool for the Journal Article Tag Suite, for example.{{Cite journal
| last = Fenner
| first = Martin
| title = From Markdown to JATS XML in one Step
| journal = Gobbledygook
| access-date = 27 June 2014
| date = 12 December 2013
| doi = 10.53731/r294649-6f79289-8cw0k
| url = http://blog.martinfenner.org/2013/12/12/from-markdown-to-jats-xml-in-one-step/
| doi-access = free
}}
= CiteProc<!-- Linked from [[Comparison of reference management software]]: do not rename heading without fixing incoming links --> =
An included CiteProc option allows pandoc to use bibliographic data from reference management software in any of five formats: BibTeX, BibLaTeX, CSL JSON or CSL YAML, or RIS.{{Cite web | title = Citations | work = Pandoc User's Guide | access-date = 2021-04-08 | url = https://pandoc.org/MANUAL.html#citations }} The information is automatically transformed into a citation in various styles (such as APA, Chicago, or MLA) using an implementation of the Citation Style Language. This allows the program to serve as a simpler alternative to LaTeX for producing academic writing in Markdown with inline citation keys.{{Cite journal | last = Tenen | first = Dennis | author2=Grant Wythoff | title = Sustainable Authorship in Plain Text using Pandoc and Markdown | journal = The Programming Historian | access-date = 27 June 2014 | date = 19 March 2014 | issue = 3 | doi = 10.46430/phen0041 | url = http://programminghistorian.org/lessons/sustainable-authorship-in-plain-text-using-pandoc-and-markdown | doi-access = free}} Or the program can be used to convert any bibliographic data stream in the accepted formats into a list of citations in a chosen style.{{Cite web |last=Denlinger |first=Kyle |title=Research Guides: Zotero: Citations & Bibliographies |url=https://guides.zsr.wfu.edu/zotero/citations |access-date=2023-06-21 |website=guides.zsr.wfu.edu |language=en}}
Supported file formats
= Input formats =
The input format with the most support is an extended version of Markdown.{{Cite web | title = Pandoc's Markdown | work = Pandoc User's Guide | access-date = 2019-08-01 | url = https://pandoc.org/MANUAL.html#pandocs-markdown }} Notwithstanding, pandoc can also read in the following formats:
- Creole
- DocBook
- EPUB
- FictionBook (FB2)
- Haddock
- HTML
- Jira wiki markup
- Journal Article Tag Suite (JATS)
- JSON
- LaTeX
- Lightweight markup language
- man
- Markdown: Strict, CommonMark, GitHub Flavored Markdown (GFM), MultiMarkdown (MMD) and Markdown Extra (PHP Extra) variants
- OpenDocument (ODT)
- OPML
- Office Open XML: Microsoft Word variant
- Org-mode
- reStructuredText
- Textile
- txt2tags (t2t)
- Wiki markup: MediaWiki, Muse, TikiWiki, TWiki and Vimwiki variants
= Output formats =
Pandoc can create files in the following output formats, which are not necessarily the same set of formats as the input formats:
- AsciiDoc
- ConTeXt
- DocBook: Versions 4 and 5
- EPUB: Versions 2 and 3{{Cite web | last = Mullen | first = Lincoln | title = Make Your Own E-Books with Pandoc | work = The Chronicle of Higher Education Blogs: ProfHacker | access-date = 27 June 2014 | date = 20 March 2012 | url = http://chronicle.com/blogs/profhacker/make-your-own-e-books-with-pandoc/39067 }}
- FictionBook (FB2)
- Haddock
- HTML: HTML4 and HTML5 variants, respectively compliant with XHTML 1.0 Transitional and XHTML Strict
- InDesign ICML
- Jira wiki markup
- Journal Article Tag Suite (JATS)
- JSON
- LaTeX
- man
- Markdown: Strict, CommonMark, GitHub Flavored Markdown (GFM), MultiMarkdown (MMD) and Markdown Extra (PHP Extra) variants
- OpenDocument (ODT/ODF)
- OPML
- Office Open XML: Microsoft Word and Microsoft PowerPoint variants
- Org-mode
- PDF (needs a third-party add-on like ConTeXt,
pdfroff
,wkhtmltopdf
,weasyprint
orprince
){{Cite web|url=https://pandoc.org/getting-started.html#creating-a-pdf|title=Getting started with pandoc|website=pandoc.org|at=Creating a PDF|access-date=22 January 2019}} - Plain text
- reStructuredText
- Rich Text Format (RTF)
- TEI
- Texinfo
- Textile
- Web-based slideshows: LaTeX Beamer, Slideous, Slidy, DZSlides, reveal.js and S5 variantsSee as an example {{Cite web | last = MacFarlane | first = John | title = Pandoc for Haskell Hackers | location = BayHac 2014, Mountain View, CA | access-date = 27 June 2014 | date = 17 May 2014 | url = http://johnmacfarlane.net/BayHac2014/ }} The [http://johnmacfarlane.net/BayHac2014/slides.txt source file] is written in Markdown.
- Wiki markup: DokuWiki, MediaWiki, Muse, TikiWiki, TWiki and Vimwiki variants
See also
{{Portal|Free and open-source software}}
References
{{Reflist|30em}}
External links
{{wikiversity|PanDocElectron}}
- {{Official website|pandoc.org}}
{{Document markup languages}}
{{HTML editors}}
{{LaTeX navbox}}
{{Haskell programming}}
Category:File conversion software
Category:Free software programmed in Haskell
Category:Lightweight markup languages
Category:Lua (programming language)-scriptable software