aboutsummaryrefslogtreecommitdiff
path: root/README
AgeCommit message (Collapse)AuthorFilesLines
2008-02-09Documentation for delimited code blocks.fiddlosopher1-2/+51
git-svn-id: https://pandoc.googlecode.com/svn/trunk@1208 788f1e2b-df1e-0410-8736-df70ead52e1b
2008-01-08Made -c/--css option repeatable on the command line (like -H, -A, -B).fiddlosopher1-4/+11
Documented repeatability of these options in README. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1186 788f1e2b-df1e-0410-8736-df70ead52e1b
2008-01-08Changed dates on documentation.fiddlosopher1-1/+1
git-svn-id: https://pandoc.googlecode.com/svn/trunk@1180 788f1e2b-df1e-0410-8736-df70ead52e1b
2008-01-04Use an interpreted text role to render math in restructuredText.fiddlosopher1-0/+4
See http://www.american.edu/econ/itex2mml/mathhack.rst for the strategy. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1168 788f1e2b-df1e-0410-8736-df70ead52e1b
2008-01-03Added optional HTML sanitization using a whitelist.fiddlosopher1-0/+5
When this option is specified (--sanitize-html on the command line), unsafe HTML tags will be replaced by HTML comments, and unsafe HTML attributes will be removed. This option should be especially useful for those who want to use pandoc libraries in web applications, where users will provide the input. + Main.hs: Added --sanitize-html option. + Text.Pandoc.Shared: Added stateSanitizeHTML to ParserState. + Text.Pandoc.Readers.HTML: - Added whitelists of sanitaryTags and sanitaryAttributes. - Added parsers to check these lists (and state) to see if a given tag or attribute should be counted unsafe. - Modified anyHtmlTag and anyHtmlEndTag to replace unsafe tags with comments. - Modified htmlAttribute to remove unsafe attributes. - Modified htmlScript and htmlStyle to remove these elements if unsafe. - Modified rawHtmlBlock to use anyHtmlBlockTag instead of anyHtmlTag and anyHtmlEndTag. This fixes a bug in markdown parsing, where inline tags would be included in raw HTML blocks. - Modified anyHtmlBlockTag to test for (not inline) rather than directly for block. This allows us to handle e.g. docbook in the markdown reader. - Minor tweaks in nonTitleNonHead and parseTitle. + Text.Pandoc.Readers.Markdown: - In non-strict mode use rawHtmlBlocks instead of htmlBlock. Simplified htmlBlock, since we know it's only called in strict mode. + Modified README and man pages to document new option. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1166 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-12-21Modified rules for HTML header identifiers to ensure legal identifiers.fiddlosopher1-6/+13
+ Modified htmlListToIdentifier and uniqueIdentifier in HTML writer to ensure that identifiers begin with an alphabetic character. + The new rules are described in README. + Resolves Issue #33. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1150 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-12-08Removed support for "box-style" block quotes in markdown.fiddlosopher1-10/+0
This adds unneeded complexity and makes pandoc diverge further than necessary from other markdown extensions. Brought documentation, tests, and debian/changelog up to date. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1141 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-12-02Removed note about public mimetex server from README.fiddlosopher1-3/+1
git-svn-id: https://pandoc.googlecode.com/svn/trunk@1134 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-12-02Put math in HTML inside <span class="math">.fiddlosopher1-1/+3
This way it can be distinguished from the surrounding text, e.g. put in a different font. Updated README accordingly. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1130 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-12-02Added Text.Pandoc.Readers.TeXMath and changed default handling of math.fiddlosopher1-8/+16
+ Text.Pandoc.Readers.TeXMath exports readTeXMath, which reads raw TeX math and outputs a string of pandoc inlines that tries to render it as far as possible, lapsing into literal TeX when needed. + Added Text.Pandoc.Readers.TeXMath to pandoc.cabal + ghc66 version. + Modified writers so that readTeXMath is used for default HTMl output in HTML, S5, RTF, Docbook. + Updated README with information about how math is rendered in all formats. + Updated test suite. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1129 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-12-01Documented new --gladtex and --mimetex options, and new treatment of TeX math.fiddlosopher1-21/+68
git-svn-id: https://pandoc.googlecode.com/svn/trunk@1124 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-12-01Small change to wording in README.fiddlosopher1-2/+3
git-svn-id: https://pandoc.googlecode.com/svn/trunk@1121 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-11-23Reverted changes in r1086 (implicit section header references).fiddlosopher1-23/+3
This caused too much of a performance hit. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1093 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-11-22Implemented implicit reference-style links to section headers in markdown.fiddlosopher1-3/+23
For example, if you have a header '# Supported architectures', you can link to it with '[Supported architectures]'. If there are multiple headers with this label, the link will point to the first of them. Implicit references are always overridden by explicitly specified references. Addresses Issue #20. + Moved isPunctuation, uniqueIdentifiers, and inlineListToIdentifier from Text.Pandoc.Writers.HTML to Text.Pandoc.Shared. + Added stHeaders to ParserState. This holds a list of header texts used in the document, and is used to construct implicit header references. + In Text.Pandoc.Readers.Markdown, added call to headerReference parser in initial parsing pass, constructing a list of section header labels. This is then passed to uniqueIdentifiers to produce identifiers, and a list of implicit references is constructed. This is added to the end of the explicitly specified references, so it will be overridden by explicitly specified references. All of this processing is skipped if --strict was specified. + Modified documentation in README. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1086 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-11-15Updated documentation to reflect the fact that LaTeX and ConTeXt writersfiddlosopher1-2/+2
now wrap text by default. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1074 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-10-18'--no-wrap' option now prevents the addition of structural whitespacefiddlosopher1-2/+2
in HTML output, minimizing the file size. git-svn-id: https://pandoc.googlecode.com/svn/trunk@1053 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-09-27Documented '--no-wrap' option in README and man pages.fiddlosopher1-0/+4
git-svn-id: https://pandoc.googlecode.com/svn/trunk@1035 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-08-25Minor formatting change in README.fiddlosopher1-1/+2
git-svn-id: https://pandoc.googlecode.com/svn/trunk@895 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-08-23Added new rule for enhanced markdown ordered lists: if the list markerfiddlosopher1-24/+27
is a capital letter followed by a period (including a single-letter capital roman numeral), then it must be followed by at least two spaces. The point of this is to avoid accidentally treating people's initials as list markers: a paragraph may begin: B. Russell was an English philosopher. and this shouldn't be treated as a list. Modified Markdown reader and README documentation. Added a test case. git-svn-id: https://pandoc.googlecode.com/svn/trunk@880 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-08-15Changed date on README.fiddlosopher1-1/+1
git-svn-id: https://pandoc.googlecode.com/svn/trunk@856 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-08-15Documented fix for paragraphs starting with (C)fiddlosopher1-1/+6
in README. git-svn-id: https://pandoc.googlecode.com/svn/trunk@848 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-08-15Changed (C) to a unicode copyright symbol.fiddlosopher1-1/+1
git-svn-id: https://pandoc.googlecode.com/svn/trunk@843 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-08-08Major change in the way ordered lists are handled:fiddlosopher1-39/+70
+ The changes are documented in README, under Lists. + The OrderedList block element now stores information about list number style, list number delimiter, and starting number. + The readers parse this information, when possible. + The writers use this information to style ordered lists. + Test suites have been changed accordingly. Motivation: It's often useful to start lists with numbers other than 1, and to have control over the style of the list. Added to Text.Pandoc.Shared: + camelCaseToHyphenated + toRomanNumeral + anyOrderedListMarker + orderedListMarker + orderedListMarkers Added to Text.Pandoc.ParserCombinators: + charsInBalanced' + withHorizDisplacement + romanNumeral RST writer: + Force blank line before lists, so that sublists will be handled correctly. LaTeX reader: + Fixed bug in parsing of footnotes containing multiple paragraphs, introduced by use of charsInBalanced. Fix: use charsInBalanced' instead. LaTeX header: + use mathletters option in ucs package, so that basic unicode Greek letters will work properly. git-svn-id: https://pandoc.googlecode.com/svn/trunk@834 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-28Removed references to examplep package in documentation, andfiddlosopher1-32/+28
removed suggest of latex-texlive-extras in debian/control, since we're not using examplep. git-svn-id: https://pandoc.googlecode.com/svn/trunk@830 788f1e2b-df1e-0410-8736-df70ead52e1b
2007-07-28Changed [URL] to [url] in description of --asciimathml option.fiddlosopher1-3/+3
git-svn-id: https://pandoc.googlecode.com/svn/trunk@822 788f1e2b-df1e-0410-8736-df70ead52e1b
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
generated by cgit v1.2.3 (git 2.39.1) at 2024-11-24 13:55:32 +0000