Free Software Foundation!

Join now

Difference between revisions of "Pandoc"

From Free Software Directory
Jump to: navigation,
(add pandoc)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Entry
 
{{Entry
 
|Name=Pandoc
 
|Name=Pandoc
|Short description=text markup conversion tool
+
|Short description=general markup converter
|Full description=Converts between text markup formats (e.g. Markdown, reStructuredText) and from text markup to other document formats (e.g. HTML, PDF).
+
|Full description=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.
 +
 
 +
This package contains the pandoc tool.
 +
 
 +
PDF output via PDFLaTeX requires the package
 +
texlive-latex-recommended, via XeLaTeX it additionally requires
 +
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
 +
|Component programs=pandoc
 
|VCS checkout command=git clone git://github.com/jgm/pandoc.git
 
|VCS checkout command=git clone git://github.com/jgm/pandoc.git
 
|Computer languages=Haskell
 
|Computer languages=Haskell
 
|Status=
 
|Status=
 
|Is GNU=No
 
|Is GNU=No
 +
}}
 +
{{Project license
 +
|License=GPLv2orlater
 +
}}
 +
{{Project license
 +
|License=Public domain
 +
}}
 +
{{Project license
 +
|License=BSD 3Clause
 +
}}
 +
{{Project license
 +
|License=Other
 +
|License note=This work is licensed under Creative Commons GNU LGPL License.
 +
 +
License: http://creativecommons.org/licenses/LGPL/2.1/
 +
}}
 +
{{Project license
 +
|License=Other
 +
|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,
 +
understood, and will comply with the following terms and conditions:
 +
.
 +
Permission to copy, and distribute the contents of this document, or
 +
the W3C document from which this statement is linked, in any medium for
 +
any purpose and without fee or royalty is hereby granted, provided that
 +
you include the following on ALL copies of the document, or portions
 +
thereof, that you use:
 +
.
 +
    A link or URL to the original W3C document.
 +
    The pre-existing copyright notice of the original author, or if it
 +
    doesn't exist, a notice (hypertext is preferred, but a textual
 +
    representation is permitted) of the form: "Copyright ©
 +
    [$date-of-document] World Wide Web Consortium, (Massachusetts
 +
    Institute of Technology, European Research Consortium for
 +
    Informatics and Mathematics, Keio University). All Rights Reserved.
 +
    http://www.w3.org/Consortium/Legal/2002/copyright-documents-20021231"
 +
    If it exists, the STATUS of the W3C document.
 +
.
 +
When space permits, inclusion of the full text of this NOTICE should be
 +
provided. We request that authorship attribution be provided in any
 +
software, documents, or other items or products that you create
 +
pursuant to the implementation of the contents of this document, or any
 +
portion thereof.
 +
.
 +
No right to create modifications or derivatives of W3C documents is
 +
granted pursuant to this license. However, if additional requirements
 +
(documented in the Copyright FAQ) are satisfied, the right to create
 +
modifications or derivatives is sometimes granted by the W3C to
 +
individuals complying with those requirements.
 +
.
 +
Disclaimers
 +
.
 +
THIS DOCUMENT IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO
 +
REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING, BUT NOT
 +
LIMITED TO, WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
 +
PURPOSE, NON-INFRINGEMENT, OR TITLE; THAT THE CONTENTS OF THE DOCUMENT
 +
ARE SUITABLE FOR ANY PURPOSE; NOR THAT THE IMPLEMENTATION OF SUCH
 +
CONTENTS WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
 +
TRADEMARKS OR OTHER RIGHTS.
 +
.
 +
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL
 +
OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE DOCUMENT OR THE
 +
PERFORMANCE OR IMPLEMENTATION OF THE CONTENTS THEREOF.
 +
.
 +
The name and trademarks of copyright holders may NOT be used in
 +
advertising or publicity pertaining to this document or its contents
 +
without specific, written prior permission. Title to copyright in this
 +
document will at all times remain with copyright holders.
 +
}}
 +
{{Project license
 +
|License=other
 +
|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
 +
terms and conditions.
 +
.
 +
Permission to copy, modify, and distribute this software and its
 +
documentation, with or without modification, for any purpose and
 +
without fee or royalty is hereby granted, provided that you include the
 +
following on ALL copies of the software and documentation or portions
 +
thereof, including modifications:
 +
.
 +
    The full text of this NOTICE in a location viewable to users of the
 +
    redistributed or derivative work.
 +
    Any pre-existing intellectual property disclaimers, notices, or
 +
    terms and conditions. If none exist, the W3C Software Short Notice
 +
    should be included (hypertext is preferred, text is permitted)
 +
    within the body of any redistributed or derivative code.
 +
    Notice of any changes or modifications to the files, including the
 +
    date changes were made. (We recommend you provide URIs to the
 +
    location from which the code is derived.)
 +
.
 +
Disclaimers
 +
.
 +
THIS SOFTWARE AND DOCUMENTATION IS PROVIDED "AS IS," AND COPYRIGHT
 +
HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED,
 +
INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS
 +
FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR
 +
DOCUMENTATION WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS,
 +
TRADEMARKS OR OTHER RIGHTS.
 +
.
 +
COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL
 +
OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR
 +
DOCUMENTATION.
 +
.
 +
The name and trademarks of copyright holders may NOT be used in
 +
advertising or publicity pertaining to the software without specific,
 +
written prior permission. Title to copyright in this software and any
 +
associated documentation will at all times remain with copyright
 +
holders.
 +
}}
 +
{{Person
 +
|Real name=John MacFarlane
 +
|Role=contact
 +
|Email=jgm@berkeley.edu
 +
|Resource URL=
 +
}}
 +
{{Person
 +
|Resource URL=
 +
}}
 +
{{Resource
 +
|Resource kind=Download
 +
|Resource URL=http://hackage.haskell.org/packages/archive/pandoc/
 
}}
 
}}
 
{{Software category
 
{{Software category

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