aboutsummaryrefslogtreecommitdiff
path: root/README
AgeCommit message (Collapse)AuthorFilesLines
2007-07-28Reinstated dependence on fancyvrb. It is compatible with examplep.fiddlosopher1-1/+2
fancyvrb is needed for verbatim environments in footnotes. git-svn-id: https://pandoc.googlecode.com/svn/trunk@808 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-28Changed LaTeX writer to use the examplep package insteadfiddlosopher1-35/+36
of fancyvrb. examplep allows verbatim text in places where fancyvrb does not, e.g. definition list terms, and provides for line-breaking of verbatim text. + examplep code put in LaTeX header instead of being dynamically included, since it is frequently used, and people may want to customize the options. + documented dependency on examplep + added texlive-latex-extra as a "Suggested" package in debian/control + use examplep's \Q{} is now used instead of \verb: note that \Q requires backslash- escaping symbols in its scope. + modified README so that the verbatim sections will look good at shorter line lengths. git-svn-id: https://pandoc.googlecode.com/svn/trunk@807 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-26Updated documentation on ASCIIMathML.js.fiddlosopher1-18/+14
git-svn-id: https://pandoc.googlecode.com/svn/trunk@800 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-24Copyright date change - README.fiddlosopher1-1/+1
git-svn-id: https://pandoc.googlecode.com/svn/trunk@797 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-24README: Use definition list for command-line options.fiddlosopher1-120/+136
git-svn-id: https://pandoc.googlecode.com/svn/trunk@796 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-24README: Added missing ~ after '~a\ cat' in subscript example.fiddlosopher1-1/+1
git-svn-id: https://pandoc.googlecode.com/svn/trunk@794 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-23Added quotes around attribute in ASCIIMathML link examplefiddlosopher1-1/+1
(in README). git-svn-id: https://pandoc.googlecode.com/svn/trunk@788 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-23README: Removed the statement that the RST reader doesn't parsefiddlosopher1-7/+6
definition lists. HTML reader: Added failIfStrict to the definitionList parser, so definition lists will be passed through as raw HTML if --strict specified. git-svn-id: https://pandoc.googlecode.com/svn/trunk@783 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-22Clarified role of --strict option when input is HTML.fiddlosopher1-2/+2
git-svn-id: https://pandoc.googlecode.com/svn/trunk@773 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-21Documented fact that --strict option has a role even whenfiddlosopher1-1/+4
input format is not markdown (in README). git-svn-id: https://pandoc.googlecode.com/svn/trunk@749 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-21Use capital letters for title in sample man page title block.fiddlosopher1-4/+4
git-svn-id: https://pandoc.googlecode.com/svn/trunk@746 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-21Changed system for indicating man page title, section,fiddlosopher1-6/+15
header and footer. Documented in README. git-svn-id: https://pandoc.googlecode.com/svn/trunk@745 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-21README changes:fiddlosopher1-19/+34
+ Documented superscript, subscript, and strikeout syntax + Modified description of LaTeX packages needed for markdown2pdf git-svn-id: https://pandoc.googlecode.com/svn/trunk@743 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-15Documented ConTeXt writer in README. Removed statementfiddlosopher1-27/+27
that table output is limited to HTML and LaTeX writers, since it is now supported in all writers. git-svn-id: https://pandoc.googlecode.com/svn/trunk@724 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-14Changed title in README to "Pandoc User's Guide."fiddlosopher1-2/+2
git-svn-id: https://pandoc.googlecode.com/svn/trunk@698 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-13Added note in README about how you might want to link tofiddlosopher1-2/+12
an external ASCIIMathML.js script instead of including it in the generated HTML file using -m. git-svn-id: https://pandoc.googlecode.com/svn/trunk@694 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-12Slightly larger table of header identifiers, so stuff doesn't wrap on LaTeXfiddlosopher1-1/+1
output. git-svn-id: https://pandoc.googlecode.com/svn/trunk@681 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-12README: Documented scheme for header identifiers in HTML.fiddlosopher1-34/+69
git-svn-id: https://pandoc.googlecode.com/svn/trunk@680 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-12Documented --toc/--table-of-contents option in pandoc manfiddlosopher1-0/+5
page and README. git-svn-id: https://pandoc.googlecode.com/svn/trunk@679 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-10README: Documented man page writer, special title-linefiddlosopher1-21/+33
conventions for man pages. git-svn-id: https://pandoc.googlecode.com/svn/trunk@670 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-06README: Documented the fact that if pandoc is calledfiddlosopher1-0/+8
as 'hsmarkdown', it runs in strict markdown compatibility mode. This can be achieved using a symbolic link. git-svn-id: https://pandoc.googlecode.com/svn/trunk@627 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-06Minor wording changes in README.fiddlosopher1-3/+3
git-svn-id: https://pandoc.googlecode.com/svn/trunk@626 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-05-03Changed definition list syntax in markdown reader and simplifiedfiddlosopher1-8/+7
the parsing code. A colon is now required before every block in a definition. This fixes a problem with the old syntax, in which the last block in the following was ambiguous between a regular paragraph in the definition and a code block following the definition list: term : definition is this code or more definition? git-svn-id: https://pandoc.googlecode.com/svn/trunk@589 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-04-10Extensive changes stemming from a rethinking of the Pandoc datafiddlosopher1-3/+7
structure. Key and Note blocks have been removed. Link and image URLs are now stored directly in Link and Image inlines, and note blocks are stored in Note inlines. This requires changes in both parsers and writers. Markdown and RST parsers need to extract data from key and note blocks and insert them into the relevant inline elements. Other parsers can be simplified, since there is no longer any need to construct separate key and note blocks. Markdown, RST, and HTML writers need to construct lists of notes; Markdown and RST writers need to construct lists of link references (when the --reference-links option is specified); and the RST writer needs to construct a list of image substitution references. All writers have been rewritten to use the State monad when state is required. This rewrite yields a small speed boost and considerably cleaner code. * Text/Pandoc/Definition.hs: + blocks: removed Key and Note + inlines: removed NoteRef, added Note + modified Target: there is no longer a 'Ref' target; all targets are explicit URL, title pairs * Text/Pandoc/Shared.hs: + Added 'Reference', 'isNoteBlock', 'isKeyBlock', 'isLineClump', used in some of the readers. + Removed 'generateReference', 'keyTable', 'replaceReferenceLinks', 'replaceRefLinksBlockList', along with some auxiliary functions used only by them. These are no longer needed, since reference links are resolved in the Markdown and RST readers. + Moved 'inTags', 'selfClosingTag', 'inTagsSimple', and 'inTagsIndented' to the Docbook writer, since that is now the only module that uses them. + Changed name of 'escapeSGMLString' to 'escapeStringForXML' + Added KeyTable and NoteTable types + Removed fields from ParserState; 'stateKeyBlocks', 'stateKeysUsed', 'stateNoteBlocks', 'stateNoteIdentifiers', 'stateInlineLinks'. Added 'stateKeys' and 'stateNotes'. + Added clause for Note to 'prettyBlock'. + Added 'writerNotes', 'writerReferenceLinks' fields to WriterOptions. * Text/Pandoc/Entities.hs: Renamed 'escapeSGMLChar' and 'escapeSGMLString' to 'escapeCharForXML' and 'escapeStringForXML' * Text/ParserCombinators/Pandoc.hs: Added lineClump parser: parses a raw line block up to and including following blank lines. * Main.hs: Replaced --inline-links with --reference-links. * README: + Documented --reference-links and removed description of --inline-links. + Added note that footnotes may occur anywhere in the document, but must be at the outer level, not embedded in block elements. * man/man1/pandoc.1, man/man1/html2markdown.1: Removed --inline-links option, added --reference-links option * Markdown and RST readers: + Rewrote to fit new Pandoc definition. Since there are no longer Note or Key blocks, all note and key blocks are parsed on a first pass through the document. Once tables of notes and keys have been constructed, the remaining parts of the document are reassembled and parsed. + Refactored link parsers. * LaTeX and HTML readers: Rewrote to fit new Pandoc definition. Since there are no longer Note or Key blocks, notes and references can be parsed in a single pass through the document. * RST, Markdown, and HTML writers: Rewrote using state monad new Pandoc and definition. State is used to hold lists of references footnotes to and be printed at the end of the document. * RTF and LaTeX writers: Rewrote using new Pandoc definition. (Because of the different treatment of footnotes, the "notes" parameter is no longer needed in the block and inline conversion functions.) * Docbook writer: + Moved the functions 'attributeList', 'inTags', 'selfClosingTag', 'inTagsSimple', 'inTagsIndented' from Text/Pandoc/Shared, since they are now used only by the Docbook writer. + Rewrote using new Pandoc definition. (Because of the different treatment of footnotes, the "notes" parameter is no longer needed in the block and inline conversion functions.) * Updated test suite * Throughout: old haskell98 module names replaced by hierarchical module names, e.g. List by Data.List. * debian/control: Include libghc6-xhtml-dev instead of libghc6-html-dev in "Build-Depends." * cabalize: + Remove haskell98 from BASE_DEPENDS (since now the new hierarchical module names are being used throughout) + Added mtl to BASE_DEPENDS (needed for state monad) + Removed html from GHC66_DEPENDS (not needed since xhtml is now used) git-svn-id: https://pandoc.googlecode.com/svn/trunk@580 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-03-11New syntax documentation for definition lists. Now wefiddlosopher1-7/+9
require a ':' at the beginning of the definition; otherwise, too many false positives for definition lists. git-svn-id: https://pandoc.googlecode.com/svn/trunk@570 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-03-10Added documentation for definition lists.fiddlosopher1-2/+41
git-svn-id: https://pandoc.googlecode.com/svn/trunk@567 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-03-09Change in ordered lists in Markdown reader:fiddlosopher1-12/+11
+ Lists may begin with lowercase letters only, and only 'a' through 'n'. Otherwise first initials and page references (e.g., p. 400) are too easily parsed as lists. + Numbers beginning list items must end with '.' (not ')', which is now allowed only after letters). NOTE: This change may cause documents to be parsed differently. Users should take care in upgrading. git-svn-id: https://pandoc.googlecode.com/svn/trunk@561 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-03-03Added --inline-links option to force links in HTML to be parsedfiddlosopher1-0/+3
as inline links, rather than reference links. (Addresses Issue #4.) git-svn-id: https://pandoc.googlecode.com/svn/trunk@554 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-01-15Added support for tables in markdown reader and in LaTeX,fiddlosopher1-0/+65
DocBook, and HTML writers. The syntax is documented in README. Tests have been added to the test suite. git-svn-id: https://pandoc.googlecode.com/svn/trunk@493 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-01-08+ Changed 'escapedChar' in Markdown reader so that only thefiddlosopher1-0/+22
characters Markdown escapes are escaped in strict mode. When not in strict mode, Pandoc allows all non-alphanumeric characters to be escaped. + Added documentation of backslash escapes to README. git-svn-id: https://pandoc.googlecode.com/svn/trunk@461 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-01-08Documentation changes corresponding to r456.fiddlosopher1-9/+21
git-svn-id: https://pandoc.googlecode.com/svn/trunk@457 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-01-08Changes to Pandoc's options to facilitate wrapper scripts:fiddlosopher1-17/+31
+ removed -d/--debug option + added --dump-args option, which prints the name of the output file (or '-' for STDOUT) and all the command-line arguments (excluding Pandoc options and their arguments), one per line, then exits. Note that special wrapper options will be treated as arguments if they follow '--' at the end of the command line. Thus, pandoc --dump-args -o foo.html foo.txt -- -e latin1 will print the following to STDOUT: foo.html foo.txt -e latin1 + added --ignore-args option, which causes Pandoc to ignore all (non-option) arguments, including any special options that occur after '--' at the end of the command line. + '-' now means STDIN as the name of an input file, STDOUT as the name of an output file. So, pandoc -o - - will take input from STDIN and print output to STDOUT. Note that if multiple '-o' options are specified on the same line, the last one takes precedence. So, in a script, pandoc "$@" -o - will guarantee output to STDOUT, even if the '-o' option was used. + documented these changes in man pages, README, and changelog. git-svn-id: https://pandoc.googlecode.com/svn/trunk@454 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-01-06Merged changes from 'quotes' branch since r431. Smart typographyfiddlosopher1-2/+4
is now handled in the Markdown and LaTeX readers, rather than in the writers. The HTML writer has been rewritten to use the prettyprinting library. git-svn-id: https://pandoc.googlecode.com/svn/trunk@436 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-01-04Small README changes documenting differences from standard markdown.fiddlosopher1-2/+5
git-svn-id: https://pandoc.googlecode.com/svn/trunk@415 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-01-02Added 'hsmarkdown' wrapper, designed to be used as a drop-infiddlosopher1-11/+21
replacement for Markdown.pl. It calls pandoc with the options '--from markdown --to html --strict' and disallows other options. (Any command-line options will be interpreted as arguments.) git-svn-id: https://pandoc.googlecode.com/svn/trunk@399 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-01-01Merged changes from docbook branch since r363.fiddlosopher1-14/+16
git-svn-id: https://pandoc.googlecode.com/svn/trunk@386 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-30Documented the "blank line before header and block quote" discrepancyfiddlosopher1-0/+13
between standard markdown and pandoc. git-svn-id: https://pandoc.googlecode.com/svn/trunk@350 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-30Merged 'strict' branch from r324. This adds a '--strict'fiddlosopher1-22/+13
option to pandoc, which forces it to stay as close as possible to official Markdown syntax. git-svn-id: https://pandoc.googlecode.com/svn/trunk@347 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-29Changed date on README.fiddlosopher1-1/+1
git-svn-id: https://pandoc.googlecode.com/svn/trunk@318 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-29+ Changed 'web2markdown' to 'html2markdown'.fiddlosopher1-9/+9
git-svn-id: https://pandoc.googlecode.com/svn/trunk@309 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-29Reversed changes from r246:fiddlosopher1-21/+0
+ Removed invisible anchors in front of header tags in HTML output. Reason: no way to prevent duplicate ID attributes (which is invalid HTML), since there might be duplicate header titles. See http://six.pairlist.net/pipermail/markdown-discuss/2005-January/000975.html. git-svn-id: https://pandoc.googlecode.com/svn/trunk@306 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-28Added two more demo cases to website. Put a footnote infiddlosopher1-3/+5
README for demonstration purposes. git-svn-id: https://pandoc.googlecode.com/svn/trunk@302 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-28+ Removed the convenience symlinks (which don't work on Windows underfiddlosopher1-75/+64
Cygwin, due to Windows' lack of true symbolic links). + Modified the wrappers to use 'pandoc' instead of the symlinks. + Modified the Makefile to remove all references to the symlinks. + Removed code from Main.hs that made pandoc's behavior depend on the name of the calling program. + Added code to Main.hs that sets default reader and writer based on extensions of input and output filenames (if provided). (Thanks to roktas for the idea.) + Modified README and man pages accordingly. + Removed WINDOWS-README target from Makefile. It is no longer needed now that we don't have the symlinks. git-svn-id: https://pandoc.googlecode.com/svn/trunk@295 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-22Merged changes from branches/wrappers since r177.fiddlosopher1-97/+154
Summary of main changes: + Added -o/--output and -d/--debug options to pandoc. + Modified pandoc to behave differently depending on the name of the program. For example, if the program name is 'html2latex', the default reader will be html and the default writer latex. + Removed most of the old wrappers, replacing them with symlinks to pandoc. + Rewrote markdown2pdf and created a new wrapper web2markdown, with the functionality of the old html2markdown script. These new scripts exploit pandoc's -d option to avoid having to do complex command-line parsing. + Revised man pages and documentation appropriately. git-svn-id: https://pandoc.googlecode.com/svn/trunk@279 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-20Obscured email addresses in documents that will be web-accessible.fiddlosopher1-2/+2
git-svn-id: https://pandoc.googlecode.com/svn/trunk@251 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-20Removed LICENSE, replacing it with COPYING (text of GPL)fiddlosopher1-1/+1
and COPYRIGHT (including copyright information and licenses for other packages used). Modified Pandoc.cabal.in and README accordingly. git-svn-id: https://pandoc.googlecode.com/svn/trunk@249 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-20Modified the HTML writer to add invisible anchors to each sectionfiddlosopher1-0/+20
heading. The anchors are derived form the text of the section heading as described in README. This makes it easy to insert links that jump from one part of a document to another: for example, '[back to the Introduction](#Introduction)'. git-svn-id: https://pandoc.googlecode.com/svn/trunk@246 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-19Merged changes to footnotes branch r219-r240.fiddlosopher1-5/+18
git-svn-id: https://pandoc.googlecode.com/svn/trunk@241 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-19Changed footnote syntax to conform to the de facto standardfiddlosopher1-13/+15
for markdown footnotes. References are now like this[^1] rather than like this^(1). There are corresponding changes in the footnotes themselves. See the updated README for more details. git-svn-id: https://pandoc.googlecode.com/svn/trunk@230 788f1e2b-df1e-0410-8736-df70ead52e1b
2006-12-18Changed '--smartypants' to '--smart' and adjusted documentationfiddlosopher1-1/+1
and symbols accordingly. git-svn-id: https://pandoc.googlecode.com/svn/trunk@224 788f1e2b-df1e-0410-8736-df70ead52e1b