From 93b82e8ea6a6ea3263a54b7d2a78e910323505b8 Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Tue, 28 Oct 2014 10:21:09 -0700 Subject: [PATCH] Clarified need for `-s` to get character encoding info. Closes #1724, #1725. --- README | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/README b/README index 556c35bc8..f117ef103 100644 --- a/README +++ b/README @@ -50,6 +50,15 @@ default (though output to *stdout* is disabled for the `odt`, `docx`, pandoc -o output.html input.txt +By default, pandoc produces a document fragment, not a standalone +document with a proper header and footer. To produce a standalone +document, use the `-s` or `--standalone` flag: + + pandoc -s -o output.html input.txt + +For more information on how standalone documents are produced, see +[Templates](#templates), below. + Instead of a file, an absolute URI may be given. In this case pandoc will fetch the content using HTTP: @@ -95,6 +104,11 @@ should pipe input and output through `iconv`: iconv -t utf-8 input.txt | pandoc | iconv -f utf-8 +Note that in some output formats (such as HTML, LaTeX, ConTeXt, +RTF, OPML, DocBook, and Texinfo), information about +the character encoding is included in the document header, which +will only be included if you use the `-s/--standalone` option. + Creating a PDF --------------