Free Software Foundation!

Join now

Difference between revisions of "Pandoc"

From Free Software Directory
Jump to: navigation,
(add licence information, expand description)
Line 2: Line 2:
 
|Name=Pandoc
 
|Name=Pandoc
 
|Short description=general markup converter
 
|Short description=general markup converter
|Full description= Pandoc is a Haskell library for converting from one markup format to
+
|Full description=Pandoc is a Haskell library for converting from one markup format
another, and a command-line tool that uses this library. It can read
+
to another, and a command-line tool that uses this library. It
markdown and (subsets of) Textile, reStructuredText, HTML, LaTeX,
+
can read markdown and (subsets of) Textile, reStructuredText,
MediaWiki markup, and DocBook XML; and it can write plain text,
+
HTML, LaTeX, MediaWiki markup, and DocBook XML; and it can write
markdown, reStructuredText, XHTML, HTML 5, LaTeX (including beamer
+
plain text, markdown, reStructuredText, XHTML, HTML 5,
slide shows), ConTeXt, RTF, DocBook XML, OpenDocument XML, ODT, Word
+
LaTeX (including beamer slide shows), ConTeXt, RTF, DocBook XML,
docx, GNU Texinfo, MediaWiki markup, EPUB (v2 or v3), FictionBook2,
+
OpenDocument XML, ODT, Word docx, GNU Texinfo, MediaWiki markup,
Textile, groff man pages, Emacs Org-Mode, AsciiDoc, and Slidy,
+
EPUB (v2 or v3), FictionBook2, Textile, groff man pages, Emacs
Slideous, DZSlides, or S5 HTML slide shows. It can also produce PDF
+
Org-Mode, AsciiDoc, and Slidy, Slideous, DZSlides, or S5 HTML
output on systems where LaTeX is installed.
+
slide shows. It can also produce PDF output on systems where
 +
LaTeX is installed.
  
Pandoc's enhanced version of markdown includes syntax for footnotes,
+
Pandoc's enhanced version of markdown includes syntax for
tables, flexible ordered lists, definition lists, fenced code blocks,
+
footnotes, tables, flexible ordered lists, definition lists,
superscript, subscript, strikeout, title blocks, automatic tables of
+
fenced code blocks, superscript, subscript, strikeout, title
contents, embedded LaTeX math, citations, and markdown inside HTML
+
blocks, automatic tables of contents, embedded LaTeX math,
block elements.  (These enhancements can be disabled.)
+
citations, and markdown inside HTML block elements.  (These
 +
enhancements can be disabled.)
  
In contrast to most existing tools for converting markdown to HTML,
+
In contrast to most existing tools for converting markdown to
which use regex substitutions, Pandoc has a modular design: it consists
+
HTML, which use regex substitutions, Pandoc has a modular design:
of a set of readers, which parse text in a given format and produce a
+
it consists of a set of readers, which parse text in a given
native representation of the document, and a set of writers, which
+
format and produce a native representation of the document, and a
convert this native representation into a target format. Thus, adding
+
set of writers, which convert this native representation into a
an input or output format requires only adding a reader or writer.
+
target format. Thus, adding an input or output format requires
 +
only adding a reader or writer.
  
This package contains the pandoc tool.
+
This package contains the pandoc tool.
  
PDF output via PDFLaTeX requires the package texlive-latex-recommended,
+
PDF output via PDFLaTeX requires the package
via XeLaTeX it additionally requires texlive-xetex, and via LuaTeX
+
texlive-latex-recommended, via XeLaTeX it additionally requires
additionally texlive-luatex.
+
texlive-xetex, and via LuaTeX additionally texlive-luatex.
 
|Homepage URL=http://johnmacfarlane.net/pandoc/
 
|Homepage URL=http://johnmacfarlane.net/pandoc/
 
|User level=beginner
 
|User level=beginner
Line 53: Line 56:
  
 
License: http://creativecommons.org/licenses/LGPL/2.1/
 
License: http://creativecommons.org/licenses/LGPL/2.1/
 
 
}}
 
}}
 
{{Project license
 
{{Project license
 
|License=Other
 
|License=Other
|License note= By using and/or copying this document, or the W3C document from which
+
|License note=By using and/or copying this document, or the W3C document from which
 
  this statement is linked, you (the licensee) agree that you have read,
 
  this statement is linked, you (the licensee) agree that you have read,
 
  understood, and will comply with the following terms and conditions:
 
  understood, and will comply with the following terms and conditions:
Line 110: Line 112:
 
{{Project license
 
{{Project license
 
|License=other
 
|License=other
|License note= By obtaining, using and/or copying this work, you (the licensee) agree
+
|License note=By obtaining, using and/or copying this work, you (the licensee) agree
 
  that you have read, understood, and will comply with the following
 
  that you have read, understood, and will comply with the following
 
  terms and conditions.
 
  terms and conditions.

Revision as of 19:14, 26 February 2013

[edit]

Pandoc

http://johnmacfarlane.net/pandoc/
Pandoc is a Haskell library for converting from one markup format to another, and a command-line tool that uses this library.

It can read Markdown and (subsets of) Textile, reStructuredText, HTML, LaTeX, MediaWiki markup, and DocBook XML; and it can write plain text, Markdown, reStructuredText, XHTML, HTML 5,

LaTeX (including beamer slide shows), ConTeXt, RTF, DocBook XML, OpenDocument XML, ODT, Word docx, GNU Texinfo, MediaWiki markup, EPUB (v2 or v3), FictionBook2, Textile, groff man pages, Emacs Org-Mode, AsciiDoc, and Slidy, Slideous, DZSlides, or S5 HTML slide shows. It can also produce PDF output on systems where LaTeX is installed.

Pandoc's enhanced version of markdown includes syntax for footnotes, tables, flexible ordered lists, definition lists, fenced code blocks, superscript, subscript, strikeout, title blocks, automatic tables of contents, embedded LaTeX math, citations, and markdown inside HTML block elements (these enhancements can be disabled).

In contrast to most existing tools for converting markdown to HTML, which use regex substitutions, Pandoc has a modular design: it consists of a set of readers, which parse text in a given format and produce a native representation of the document, and a set of writers, which convert this native representation into a target format. Thus, adding an input or output format requires only adding a reader or writer.

PDF output via PDFLaTeX requires the package texlive-latex-recommended, via XeLaTeX it additionally requires texlive-xetex, and via LuaTeX additionally texlive-luatex.




Licensing

LicenseVerified byVerified onNotes
GPLv2orlaterjgay29 October 2013



Leaders and contributors

Contact(s)Role
John MacFarlane contact


Resources and communication

Audience Resource type URI
Download http://hackage.haskell.org/packages/archive/pandoc/


Software prerequisites

This entry (in part or in whole) was last reviewed on 29 October 2013.



Entry





































Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.3 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A copy of the license is included in the page “GNU Free Documentation License”.

The copyright and license notices on this page only apply to the text on this page. Any software or copyright-licenses or other similar notices described in this text has its own copyright notice and license, which can usually be found in the distribution or license text itself.


Personal tools
Namespaces

Variants
Actions
Navigation
Contribute