23df0ed176
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
85 lines
3.2 KiB
Groff
85 lines
3.2 KiB
Groff
.TH HTML2MARKDOWN 1 "December 15, 2006" Pandoc "User Manuals"
|
|
.SH NAME
|
|
html2markdown \- converts HTML to markdown-formatted text
|
|
.SH SYNOPSIS
|
|
\fBhtml2markdown\fR [\fIpandoc\-options\fR]
|
|
[\-\- \fIspecial\-options\fR] [\fIinput\-file\fR or \fIURL\fR]
|
|
.SH DESCRIPTION
|
|
\fBhtml2markdown\fR converts \fIinput\-file\fR or \fIURL\fR (or text
|
|
from STDIN) from HTML to markdown\-formatted plain text.
|
|
If a URL is specified, \fBhtml2markdown\fR uses an available program
|
|
(e.g. wget, w3m, lynx or curl) to fetch its contents. Output is sent
|
|
to STDOUT unless an output file is specified using the \fB\-o\fR
|
|
option.
|
|
.PP
|
|
\fBhtml2markdown\fR uses the character encoding specified in the
|
|
"Content-type" meta tag. If this is not present, or if input comes
|
|
from STDIN, UTF-8 is assumed. A character encoding may be specified
|
|
explicitly using the \fB\-e\fR special option.
|
|
.SH OPTIONS
|
|
.PP
|
|
\fBhtml2markdown\fR is a wrapper for \fBpandoc\fR, so all of
|
|
\fBpandoc\fR's options may be used. See \fBpandoc\fR(1) for
|
|
a complete list. The following options are most relevant:
|
|
.TP
|
|
.B \-s, \-\-standalone
|
|
Include title, author, and date information (if present) at the
|
|
top of markdown output.
|
|
.TP
|
|
.B \-o FILE, \-\-output=FILE
|
|
Write output to \fIFILE\fR instead of STDOUT.
|
|
.TP
|
|
.B \-\-strict
|
|
Use strict markdown syntax, with no extensions or variants.
|
|
.TP
|
|
.B \-\-reference\-links
|
|
Use reference-style links, rather than inline links, in writing markdown
|
|
or reStructuredText.
|
|
.TP
|
|
.B \-R, \-\-parse-raw
|
|
Parse untranslatable HTML codes as raw HTML.
|
|
.TP
|
|
.B \-H \fIFILE\fB, \-\-include-in-header=\fIFILE\fB
|
|
Include contents of \fIFILE\fR at the end of the header. Implies
|
|
\fB\-s\fR.
|
|
.TP
|
|
.B \-B \fIFILE\fB, \-\-include-before-body=\fIFILE\fB
|
|
Include contents of \fIFILE\fR at the beginning of the document body.
|
|
.TP
|
|
.B \-A \fIFILE\fB, \-\-include-after-body=\fIFILE\fB
|
|
Include contents of \fIFILE\fR at the end of the document body.
|
|
.TP
|
|
.B \-C \fIFILE\fB, \-\-custom-header=\fIFILE\fB
|
|
Use contents of \fIFILE\fR
|
|
as the document header (overriding the default header, which can be
|
|
printed using '\fBpandoc \-D markdown\fR'). Implies
|
|
\fB-s\fR.
|
|
.SH "SPECIAL OPTIONS"
|
|
.PP
|
|
In addition, the following special options may be used. The special
|
|
options must be separated from the \fBhtml2markdown\fR command and any
|
|
regular \fBpandoc\fR options by the delimiter `\-\-', as in
|
|
.IP
|
|
.B html2markdown \-o foo.txt \-\- \-g 'curl \-u bar:baz' \-e latin1
|
|
.B www.foo.com
|
|
.TP
|
|
.B \-e \fIencoding\fR, \-\-encoding=\fIencoding\fR
|
|
Assume the character encoding \fIencoding\fR in reading HTML.
|
|
(Note: \fIencoding\fR will be passed to \fBiconv\fR; a list of
|
|
available encodings may be obtained using `\fBiconv \-l\fR'.)
|
|
If this option is not specified and input is not from
|
|
STDIN, \fBhtml2markdown\fR will try to extract the character encoding
|
|
from the "Content-type" meta tag. If no character encoding is
|
|
specified in this way, or if input is from STDIN, UTF-8 will be
|
|
assumed.
|
|
.TP
|
|
.B \-g \fIcommand\fR, \-\-grabber=\fIcommand\fR
|
|
Use \fIcommand\fR to fetch the contents of a URL. (By default,
|
|
\fBhtml2markdown\fR searches for an available program or text-based
|
|
browser to fetch the contents of a URL.)
|
|
|
|
.SH "SEE ALSO"
|
|
\fBpandoc\fR(1),
|
|
\fBiconv\fR(1)
|
|
.SH AUTHOR
|
|
John MacFarlane and Recai Oktas
|