3Copyright (C) 2006-2013 John MacFarlane <jgm@berkeley.edu>
5This program is free software; you can redistribute it and/or modify
6it under the terms of the GNU General Public License as published by
7the Free Software Foundation; either version 2 of the License, or
8(at your option) any later version.
10This program is distributed in the hope that it will be useful,
11but WITHOUT ANY WARRANTY; without even the implied warranty of
12MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13GNU General Public License for more details.
15You should have received a copy of the GNU General Public License
16along with this program; if not, write to the Free Software
17Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 Copyright : Copyright (C) 2006-2013 John MacFarlane
23 License : GNU GPL, version 2 or above
25 Maintainer : John MacFarlane <jgm@berkeley@edu>
27 Portability : portable
29Parses command-line options and calls the appropriate readers and
34import Text.Pandoc.PDF (tex2pdf)
35import Text.Pandoc.Readers.LaTeX (handleIncludes)
36import Text.Pandoc.Shared ( tabFilter, readDataFileUTF8, safeRead,
37 headerShift, normalize, err, warn )
38import Text.Pandoc.XML ( toEntities, fromEntities )
39import Text.Pandoc.SelfContained ( makeSelfContained )
40import Text.Pandoc.Highlighting ( languages, Style, tango, pygments,
41 espresso, zenburn, kate, haddock, monochrome )
42import System.Environment ( getArgs, getProgName )
43import System.Exit ( exitWith, ExitCode (..) )
45import System.Console.GetOpt
46import Data.Char ( toLower )
47import Data.List ( intercalate, isPrefixOf )
48import System.Directory ( getAppUserDataDirectory, doesFileExist, findExecutable )
49import System.IO ( stdout )
50import System.IO.Error ( isDoesNotExistError )
51import qualified Control.Exception as E
52import Control.Exception.Extensible ( throwIO )
53import qualified Text.Pandoc.UTF8 as UTF8
54import qualified Text.CSL as CSL
55import Control.Monad (when, unless, liftM)
56import Network.HTTP (simpleHTTP, mkRequest, getResponseBody, RequestMethod(..))
57import Network.URI (parseURI, isURI, URI(..))
58import qualified Data.ByteString.Lazy as B
59import Text.CSL.Reference (Reference(..))
61copyrightMessage :: String
62copyrightMessage = "\nCopyright (C) 2006-2013 John MacFarlane\n" ++
63 "Web: http://johnmacfarlane.net/pandoc\n" ++
64 "This is free software; see the source for copying conditions. There is no\n" ++
65 "warranty, not even for merchantability or fitness for a particular purpose."
69 "\nCompiled with citeproc-hs " ++ VERSION_citeproc_hs ++ ", texmath " ++
70 VERSION_texmath ++ ", highlighting-kate " ++ VERSION_highlighting_kate ++
71 ".\nSyntax highlighting is supported for the following languages:\n " ++
72 wrapWords 4 78 languages
74-- | Converts a list of strings into a single string with the items printed as
75-- comma separated words in lines with a maximum line length.
76wrapWords :: Int -> Int -> [String] -> String
77wrapWords indent c = wrap' (c - indent) (c - indent)
78 where wrap' _ _ [] = ""
79 wrap' cols remaining (x:xs) = if remaining == cols
80 then x ++ wrap' cols (remaining - length x) xs
81 else if (length x + 1) > remaining
82 then ",\n" ++ replicate indent ' ' ++ x ++ wrap' cols (cols - length x) xs
83 else ", " ++ x ++ wrap' cols (remaining - (length x + 2)) xs
85isTextFormat :: String -> Bool
86isTextFormat s = takeWhile (`notElem` "+-") s `notElem` ["odt","docx","epub","epub3"]
88-- | Data structure for command line options.
90 { optTabStop :: Int -- ^ Number of spaces per tab
91 , optPreserveTabs :: Bool -- ^ Preserve tabs instead of converting to spaces
92 , optStandalone :: Bool -- ^ Include header, footer
93 , optReader :: String -- ^ Reader format
94 , optWriter :: String -- ^ Writer format
95 , optParseRaw :: Bool -- ^ Parse unconvertable HTML and TeX
96 , optTableOfContents :: Bool -- ^ Include table of contents
97 , optTransforms :: [Pandoc -> Pandoc] -- ^ Doc transforms to apply
98 , optTemplate :: Maybe FilePath -- ^ Custom template
99 , optVariables :: [(String,String)] -- ^ Template variables to set
100 , optOutputFile :: String -- ^ Name of output file
101 , optNumberSections :: Bool -- ^ Number sections in LaTeX
102 , optSectionDivs :: Bool -- ^ Put sections in div tags in HTML
103 , optIncremental :: Bool -- ^ Use incremental lists in Slidy/Slideous/S5
104 , optSelfContained :: Bool -- ^ Make HTML accessible offline
105 , optSmart :: Bool -- ^ Use smart typography
106 , optOldDashes :: Bool -- ^ Parse dashes like pandoc <=1.8.2.1
107 , optHtml5 :: Bool -- ^ Produce HTML5 in HTML
108 , optHtmlQTags :: Bool -- ^ Use <q> tags in HTML
109 , optHighlight :: Bool -- ^ Highlight source code
110 , optHighlightStyle :: Style -- ^ Style to use for highlighted code
111 , optChapters :: Bool -- ^ Use chapter for top-level sects
112 , optHTMLMathMethod :: HTMLMathMethod -- ^ Method to print HTML math
113 , optReferenceODT :: Maybe FilePath -- ^ Path of reference.odt
114 , optReferenceDocx :: Maybe FilePath -- ^ Path of reference.docx
115 , optEpubStylesheet :: Maybe String -- ^ EPUB stylesheet
116 , optEpubMetadata :: String -- ^ EPUB metadata
117 , optEpubFonts :: [FilePath] -- ^ EPUB fonts to embed
118 , optEpubChapterLevel :: Int -- ^ Header level at which to split chapters
119 , optTOCDepth :: Int -- ^ Number of levels to include in TOC
120 , optDumpArgs :: Bool -- ^ Output command-line arguments
121 , optIgnoreArgs :: Bool -- ^ Ignore command-line arguments
122 , optReferenceLinks :: Bool -- ^ Use reference links in writing markdown, rst
123 , optWrapText :: Bool -- ^ Wrap text
124 , optColumns :: Int -- ^ Line length in characters
125 , optPlugins :: [Pandoc -> IO Pandoc] -- ^ Plugins to apply
126 , optEmailObfuscation :: ObfuscationMethod
127 , optIdentifierPrefix :: String
128 , optIndentedCodeClasses :: [String] -- ^ Default classes for indented code blocks
129 , optDataDir :: Maybe FilePath
130 , optCiteMethod :: CiteMethod -- ^ Method to output cites
131 , optBibliography :: [String]
132 , optCslFile :: Maybe FilePath
133 , optAbbrevsFile :: Maybe FilePath
134 , optListings :: Bool -- ^ Use listings package for code blocks
135 , optLaTeXEngine :: String -- ^ Program to use for latex -> pdf
136 , optSlideLevel :: Maybe Int -- ^ Header level that creates slides
137 , optSetextHeaders :: Bool -- ^ Use atx headers for markdown level 1-2
138 , optAscii :: Bool -- ^ Use ascii characters only in html
139 , optTeXLigatures :: Bool -- ^ Use TeX ligatures for quotes/dashes
142-- | Defaults for command-line options.
146 , optPreserveTabs = False
147 , optStandalone = False
148 , optReader = "" -- null for default reader
149 , optWriter = "" -- null for default writer
150 , optParseRaw = False
151 , optTableOfContents = False
153 , optTemplate = Nothing
155 , optOutputFile = "-" -- "-" means stdout
156 , optNumberSections = False
157 , optSectionDivs = False
158 , optIncremental = False
159 , optSelfContained = False
161 , optOldDashes = False
163 , optHtmlQTags = False
164 , optHighlight = True
165 , optHighlightStyle = pygments
166 , optChapters = False
167 , optHTMLMathMethod = PlainMath
168 , optReferenceODT = Nothing
169 , optReferenceDocx = Nothing
170 , optEpubStylesheet = Nothing
171 , optEpubMetadata = ""
173 , optEpubChapterLevel = 1
175 , optDumpArgs = False
176 , optIgnoreArgs = False
177 , optReferenceLinks = False
181 , optEmailObfuscation = JavascriptObfuscation
182 , optIdentifierPrefix = ""
183 , optIndentedCodeClasses = []
184 , optDataDir = Nothing
185 , optCiteMethod = Citeproc
186 , optBibliography = []
187 , optCslFile = Nothing
188 , optAbbrevsFile = Nothing
189 , optListings = False
190 , optLaTeXEngine = "pdflatex"
191 , optSlideLevel = Nothing
192 , optSetextHeaders = True
194 , optTeXLigatures = True
197-- | A list of functions, each transforming the options data structure
198-- in response to a command-line option.
199options :: [OptDescr (Opt -> IO Opt)]
201 [ Option "fr" ["from","read"]
203 (\arg opt -> return opt { optReader = map toLower arg })
207 , Option "tw" ["to","write"]
209 (\arg opt -> return opt { optWriter = map toLower arg })
213 , Option "o" ["output"]
215 (\arg opt -> return opt { optOutputFile = arg })
217 "" -- "Name of output file"
219 , Option "" ["data-dir"]
221 (\arg opt -> return opt { optDataDir = Just arg })
222 "DIRECTORY") -- "Directory containing pandoc data files."
225 , Option "" ["strict"]
228 err 59 $ "The --strict option has been removed.\n" ++
229 "Use `markdown_strict' input or output format instead."
231 "" -- "Disable markdown syntax extensions"
233 , Option "R" ["parse-raw"]
235 (\opt -> return opt { optParseRaw = True }))
236 "" -- "Parse untranslatable HTML codes and LaTeX environments as raw"
238 , Option "S" ["smart"]
240 (\opt -> return opt { optSmart = True }))
241 "" -- "Use smart quotes, dashes, and ellipses"
243 , Option "" ["old-dashes"]
245 (\opt -> return opt { optSmart = True
246 , optOldDashes = True }))
247 "" -- "Use smart quotes, dashes, and ellipses"
249 , Option "" ["base-header-level"]
254 let oldTransforms = optTransforms opt
256 return opt{ optTransforms =
257 headerShift shift : oldTransforms }
259 "base-header-level must be a number > 0")
261 "" -- "Headers base level"
263 , Option "" ["indented-code-classes"]
265 (\arg opt -> return opt { optIndentedCodeClasses = words $
266 map (\c -> if c == ',' then ' ' else c) arg })
268 "" -- "Classes (whitespace- or comma-separated) to use for indented code-blocks"
270 , Option "" ["normalize"]
272 (\opt -> return opt { optTransforms =
273 normalize : optTransforms opt } ))
274 "" -- "Normalize the Pandoc AST"
276 , Option "p" ["preserve-tabs"]
278 (\opt -> return opt { optPreserveTabs = True }))
279 "" -- "Preserve tabs instead of converting to spaces"
281 , Option "" ["tab-stop"]
285 Just t | t > 0 -> return opt { optTabStop = t }
287 "tab-stop must be a number greater than 0")
289 "" -- "Tab stop (default 4)"
291 , Option "s" ["standalone"]
293 (\opt -> return opt { optStandalone = True }))
294 "" -- "Include needed header and footer on output"
296 , Option "" ["template"]
299 return opt{ optTemplate = Just arg,
300 optStandalone = True })
302 "" -- "Use custom template"
304 , Option "V" ["variable"]
307 let (key,val) = case break (`elem` ":=") arg of
310 return opt{ optVariables = (key,val) : optVariables opt })
312 "" -- "Use custom template"
314 , Option "D" ["print-default-template"]
317 templ <- getDefaultTemplate Nothing arg
319 Right t -> UTF8.hPutStr stdout t
320 Left e -> error $ show e
321 exitWith ExitSuccess)
323 "" -- "Print default template for FORMAT"
325 , Option "" ["no-wrap"]
327 (\opt -> return opt { optWrapText = False }))
328 "" -- "Do not wrap text in output"
330 , Option "" ["columns"]
334 Just t | t > 0 -> return opt { optColumns = t }
336 "columns must be a number greater than 0")
338 "" -- "Length of line in characters"
340 , Option "" ["toc", "table-of-contents"]
342 (\opt -> return opt { optTableOfContents = True }))
343 "" -- "Include table of contents"
345 , Option "" ["toc-depth"]
349 Just t | t >= 1 && t <= 6 ->
350 return opt { optTOCDepth = t,
351 optTableOfContents = True }
353 "TOC level must be a number between 1 and 6")
355 "" -- "Number of levels to include in TOC"
357 , Option "" ["no-highlight"]
359 (\opt -> return opt { optHighlight = False }))
360 "" -- "Don't highlight source code"
362 , Option "" ["highlight-style"]
365 newStyle <- case map toLower arg of
366 "pygments" -> return pygments
367 "tango" -> return tango
368 "espresso" -> return espresso
369 "zenburn" -> return zenburn
370 "kate" -> return kate
371 "monochrome" -> return monochrome
372 "haddock" -> return haddock
374 "Unknown style :" ++ arg
375 return opt{ optHighlightStyle = newStyle })
377 "" -- "Style for highlighted code"
379 , Option "H" ["include-in-header"]
382 text <- UTF8.readFile arg
383 -- add new ones to end, so they're included in order specified
384 let newvars = optVariables opt ++ [("header-includes",text)]
385 return opt { optVariables = newvars,
386 optStandalone = True })
388 "" -- "File to include at end of header (implies -s)"
390 , Option "B" ["include-before-body"]
393 text <- UTF8.readFile arg
394 -- add new ones to end, so they're included in order specified
395 let newvars = optVariables opt ++ [("include-before",text)]
396 return opt { optVariables = newvars,
397 optStandalone = True })
399 "" -- "File to include before document body"
401 , Option "A" ["include-after-body"]
404 text <- UTF8.readFile arg
405 -- add new ones to end, so they're included in order specified
406 let newvars = optVariables opt ++ [("include-after",text)]
407 return opt { optVariables = newvars,
408 optStandalone = True })
410 "" -- "File to include after document body"
412 , Option "" ["self-contained"]
414 (\opt -> return opt { optSelfContained = True,
415 optVariables = ("slidy-url","slidy") :
417 optStandalone = True }))
418 "" -- "Make slide shows include all the needed js and css"
420 , Option "" ["offline"]
422 (\opt -> do warn $ "--offline is deprecated. Use --self-contained instead."
423 return opt { optSelfContained = True,
424 optStandalone = True }))
425 "" -- "Make slide shows include all the needed js and css"
426 -- deprecated synonym for --self-contained
428 , Option "5" ["html5"]
431 warn $ "--html5 is deprecated. "
432 ++ "Use the html5 output format instead."
433 return opt { optHtml5 = True }))
434 "" -- "Produce HTML5 in HTML output"
436 , Option "" ["html-q-tags"]
439 return opt { optHtmlQTags = True }))
440 "" -- "Use <q> tags for quotes in HTML"
442 , Option "" ["ascii"]
444 (\opt -> return opt { optAscii = True }))
445 "" -- "Use ascii characters only in HTML output"
447 , Option "" ["reference-links"]
449 (\opt -> return opt { optReferenceLinks = True } ))
450 "" -- "Use reference links in parsing HTML"
452 , Option "" ["atx-headers"]
454 (\opt -> return opt { optSetextHeaders = False } ))
455 "" -- "Use atx-style headers for markdown"
457 , Option "" ["chapters"]
459 (\opt -> return opt { optChapters = True }))
460 "" -- "Use chapter for top-level sections in LaTeX, DocBook"
462 , Option "N" ["number-sections"]
464 (\opt -> return opt { optNumberSections = True }))
465 "" -- "Number sections in LaTeX"
467 , Option "" ["no-tex-ligatures"]
469 (\opt -> return opt { optTeXLigatures = False }))
470 "" -- "Don't use tex ligatures for quotes, dashes"
472 , Option "" ["listings"]
474 (\opt -> return opt { optListings = True }))
475 "" -- "Use listings package for LaTeX code blocks"
477 , Option "i" ["incremental"]
479 (\opt -> return opt { optIncremental = True }))
480 "" -- "Make list items display incrementally in Slidy/Slideous/S5"
482 , Option "" ["slide-level"]
486 Just t | t >= 1 && t <= 6 ->
487 return opt { optSlideLevel = Just t }
489 "slide level must be a number between 1 and 6")
491 "" -- "Force header level for slides"
493 , Option "" ["section-divs"]
495 (\opt -> return opt { optSectionDivs = True }))
496 "" -- "Put sections in div tags in HTML"
498 , Option "" ["email-obfuscation"]
501 method <- case arg of
502 "references" -> return ReferenceObfuscation
503 "javascript" -> return JavascriptObfuscation
504 "none" -> return NoObfuscation
506 ("Unknown obfuscation method: " ++ arg)
507 return opt { optEmailObfuscation = method })
508 "none|javascript|references")
509 "" -- "Method for obfuscating email in HTML"
511 , Option "" ["id-prefix"]
513 (\arg opt -> return opt { optIdentifierPrefix = arg })
515 "" -- "Prefix to add to automatically generated HTML identifiers"
517 , Option "T" ["title-prefix"]
520 let newvars = ("title-prefix", arg) : optVariables opt
521 return opt { optVariables = newvars,
522 optStandalone = True })
524 "" -- "String to prefix to HTML window title"
529 -- add new link to end, so it is included in proper order
530 let newvars = optVariables opt ++ [("css",arg)]
531 return opt { optVariables = newvars,
532 optStandalone = True })
534 "" -- "Link to CSS style sheet"
536 , Option "" ["reference-odt"]
539 return opt { optReferenceODT = Just arg })
541 "" -- "Path of custom reference.odt"
543 , Option "" ["reference-docx"]
546 return opt { optReferenceDocx = Just arg })
548 "" -- "Path of custom reference.docx"
550 , Option "" ["epub-stylesheet"]
553 text <- UTF8.readFile arg
554 return opt { optEpubStylesheet = Just text })
556 "" -- "Path of epub.css"
558 , Option "" ["epub-cover-image"]
561 return opt { optVariables =
562 ("epub-cover-image", arg) : optVariables opt })
564 "" -- "Path of epub cover image"
566 , Option "" ["epub-metadata"]
569 text <- UTF8.readFile arg
570 return opt { optEpubMetadata = text })
572 "" -- "Path of epub metadata file"
574 , Option "" ["epub-embed-font"]
577 return opt{ optEpubFonts = arg : optEpubFonts opt })
579 "" -- "Directory of fonts to embed"
581 , Option "" ["epub-chapter-level"]
585 Just t | t >= 1 && t <= 6 ->
586 return opt { optEpubChapterLevel = t }
588 "chapter level must be a number between 1 and 6")
590 "" -- "Header level at which to split chapters in EPUB"
592 , Option "" ["latex-engine"]
595 let b = takeBaseName arg
596 if (b == "pdflatex" || b == "lualatex" || b == "xelatex")
597 then return opt { optLaTeXEngine = arg }
598 else err 45 "latex-engine must be pdflatex, lualatex, or xelatex.")
600 "" -- "Name of latex program to use in generating PDF"
602 , Option "" ["bibliography"]
604 (\arg opt -> return opt { optBibliography = (optBibliography opt) ++ [arg] })
610 (\arg opt -> return opt { optCslFile = Just arg })
614 , Option "" ["citation-abbreviations"]
616 (\arg opt -> return opt { optAbbrevsFile = Just arg })
620 , Option "" ["natbib"]
622 (\opt -> return opt { optCiteMethod = Natbib }))
623 "" -- "Use natbib cite commands in LaTeX output"
625 , Option "" ["biblatex"]
627 (\opt -> return opt { optCiteMethod = Biblatex }))
628 "" -- "Use biblatex cite commands in LaTeX output"
630 , Option "m" ["latexmathml", "asciimathml"]
633 return opt { optHTMLMathMethod = LaTeXMathML arg })
635 "" -- "Use LaTeXMathML script in html output"
637 , Option "" ["mathml"]
640 return opt { optHTMLMathMethod = MathML arg })
642 "" -- "Use mathml for HTML math"
644 , Option "" ["mimetex"]
647 let url' = case arg of
649 Nothing -> "/cgi-bin/mimetex.cgi?"
650 return opt { optHTMLMathMethod = WebTeX url' })
652 "" -- "Use mimetex for HTML math"
654 , Option "" ["webtex"]
657 let url' = case arg of
659 Nothing -> "http://chart.apis.google.com/chart?cht=tx&chl="
660 return opt { optHTMLMathMethod = WebTeX url' })
662 "" -- "Use web service for HTML math"
664 , Option "" ["jsmath"]
666 (\arg opt -> return opt { optHTMLMathMethod = JsMath arg})
668 "" -- "Use jsMath for HTML math"
670 , Option "" ["mathjax"]
673 let url' = case arg of
675 Nothing -> "http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"
676 return opt { optHTMLMathMethod = MathJax url'})
678 "" -- "Use MathJax for HTML math"
680 , Option "" ["gladtex"]
682 (\opt -> return opt { optHTMLMathMethod = GladTeX }))
683 "" -- "Use gladtex for HTML math"
685 , Option "" ["dump-args"]
687 (\opt -> return opt { optDumpArgs = True }))
688 "" -- "Print output filename and arguments to stdout."
690 , Option "" ["ignore-args"]
692 (\opt -> return opt { optIgnoreArgs = True }))
693 "" -- "Ignore command-line arguments."
695 , Option "v" ["version"]
699 UTF8.hPutStrLn stdout (prg ++ " " ++ pandocVersion ++ compileInfo ++
701 exitWith ExitSuccess ))
702 "" -- "Print version"
704 , Option "h" ["help"]
708 UTF8.hPutStr stdout (usageMessage prg options)
709 exitWith ExitSuccess ))
714-- Returns usage message
715usageMessage :: String -> [OptDescr (Opt -> IO Opt)] -> String
716usageMessage programName = usageInfo
717 (programName ++ " [OPTIONS] [FILES]" ++ "\nInput formats: " ++
718 (wrapWords 16 78 $ readers'names) ++ "\nOutput formats: " ++
719 (wrapWords 16 78 $ writers'names) ++ "\nOptions:")
721 writers'names = map fst writers
722 readers'names = map fst readers
724-- Determine default reader based on source file extensions
725defaultReaderName :: String -> [FilePath] -> String
726defaultReaderName fallback [] = fallback
727defaultReaderName fallback (x:xs) =
728 case takeExtension (map toLower x) of
736 ".lhs" -> "markdown+lhs"
738 ".wiki" -> "mediawiki"
739 ".textile" -> "textile"
740 ".native" -> "native"
742 _ -> defaultReaderName fallback xs
744-- Returns True if extension of first source is .lhs
745lhsExtension :: [FilePath] -> Bool
746lhsExtension (x:_) = takeExtension x == ".lhs"
747lhsExtension _ = False
749-- Determine default writer based on output file extension
750defaultWriterName :: FilePath -> String
751defaultWriterName "-" = "html" -- no output file
753 case takeExtension (map toLower x) of
754 "" -> "markdown" -- empty extension
758 ".context" -> "context"
763 ".native" -> "native"
766 ".text" -> "markdown"
768 ".markdown" -> "markdown"
769 ".textile" -> "textile"
770 ".lhs" -> "markdown+lhs"
772 ".texinfo" -> "texinfo"
778 ".asciidoc" -> "asciidoc"
781 ['.',y] | y `elem` ['1'..'9'] -> "man"
787 rawArgs <- liftM (map UTF8.decodeArg) getArgs
789 let compatMode = (prg == "hsmarkdown")
791 let (actions, args, errors) = if compatMode
792 then ([], rawArgs, [])
793 else getOpt Permute options rawArgs
795 unless (null errors) $
796 err 2 $ concat $ errors ++
797 ["Try " ++ prg ++ " --help for more information."]
799 let defaultOpts' = if compatMode
800 then defaultOpts { optReader = "markdown_strict"
802 , optEmailObfuscation =
803 ReferenceObfuscation }
806 -- thread option data structure through all supplied option actions
807 opts <- foldl (>>=) (return defaultOpts') actions
809 let Opt { optTabStop = tabStop
810 , optPreserveTabs = preserveTabs
811 , optStandalone = standalone
812 , optReader = readerName
813 , optWriter = writerName
814 , optParseRaw = parseRaw
815 , optVariables = variables
816 , optTableOfContents = toc
817 , optTransforms = transforms
818 , optTemplate = templatePath
819 , optOutputFile = outputFile
820 , optNumberSections = numberSections
821 , optSectionDivs = sectionDivs
822 , optIncremental = incremental
823 , optSelfContained = selfContained
825 , optOldDashes = oldDashes
827 , optHtmlQTags = htmlQTags
828 , optHighlight = highlight
829 , optHighlightStyle = highlightStyle
830 , optChapters = chapters
831 , optHTMLMathMethod = mathMethod
832 , optReferenceODT = referenceODT
833 , optReferenceDocx = referenceDocx
834 , optEpubStylesheet = epubStylesheet
835 , optEpubMetadata = epubMetadata
836 , optEpubFonts = epubFonts
837 , optEpubChapterLevel = epubChapterLevel
838 , optTOCDepth = epubTOCDepth
839 , optDumpArgs = dumpArgs
840 , optIgnoreArgs = ignoreArgs
841 , optReferenceLinks = referenceLinks
843 , optColumns = columns
844 , optEmailObfuscation = obfuscationMethod
845 , optIdentifierPrefix = idPrefix
846 , optIndentedCodeClasses = codeBlockClasses
847 , optDataDir = mbDataDir
848 , optBibliography = reffiles
850 , optAbbrevsFile = cslabbrevs
851 , optCiteMethod = citeMethod
852 , optListings = listings
853 , optLaTeXEngine = latexEngine
854 , optSlideLevel = slideLevel
855 , optSetextHeaders = setextHeaders
857 , optTeXLigatures = texLigatures
861 do UTF8.hPutStrLn stdout outputFile
862 mapM_ (\arg -> UTF8.hPutStrLn stdout arg) args
865 let sources = if ignoreArgs then [] else args
867 datadir <- case mbDataDir of
869 (liftM Just $ getAppUserDataDirectory "pandoc")
870 (\e -> let _ = (e :: E.SomeException)
872 Just _ -> return mbDataDir
874 -- assign reader and writer based on options and filenames
875 let readerName' = if null readerName
876 then let fallback = if any isURI sources
879 in defaultReaderName fallback sources
882 let writerName' = if null writerName
883 then defaultWriterName outputFile
886 let pdfOutput = map toLower (takeExtension outputFile) == ".pdf"
888 let laTeXOutput = "latex" `isPrefixOf` writerName' ||
889 "beamer" `isPrefixOf` writerName'
892 -- make sure writer is latex or beamer
894 err 47 $ "cannot produce pdf output with " ++ writerName' ++ " writer"
895 -- check for latex program
896 mbLatex <- findExecutable latexEngine
899 latexEngine ++ " not found. " ++
900 latexEngine ++ " is needed for pdf output."
903 reader <- case getReader readerName' of
907 let standalone' = standalone || not (isTextFormat writerName') || pdfOutput
909 templ <- case templatePath of
910 _ | not standalone' -> return ""
912 deftemp <- getDefaultTemplate datadir writerName'
917 -- strip off extensions
918 let format = takeWhile (`notElem` "+-") writerName'
919 let tp' = case takeExtension tp of
922 E.catch (UTF8.readFile tp')
923 (\e -> if isDoesNotExistError e
925 (readDataFileUTF8 datadir
926 ("templates" </> tp'))
927 (\e' -> let _ = (e' :: E.SomeException)
931 variables' <- case mathMethod of
932 LaTeXMathML Nothing -> do
933 s <- readDataFileUTF8 datadir
935 return $ ("mathml-script", s) : variables
937 s <- readDataFileUTF8 datadir
939 return $ ("mathml-script", s) : variables
940 _ -> return variables
942 variables'' <- if "dzslides" `isPrefixOf` writerName'
944 dztempl <- readDataFileUTF8 datadir
945 ("dzslides" </> "template.html")
946 let dzcore = unlines $ dropWhile (not . isPrefixOf "<!-- {{{{ dzslides core")
948 return $ ("dzslides-core", dzcore) : variables'
949 else return variables'
951 -- unescape reference ids, which may contain XML entities, so
952 -- that we can do lookups with regular string equality
953 let unescapeRefId ref = ref{ refId = fromEntities (refId ref) }
955 refs <- mapM (\f -> E.catch (CSL.readBiblioFile f)
956 (\e -> let _ = (e :: E.SomeException)
957 in err 23 $ "Error reading bibliography `" ++ f ++
958 "'" ++ "\n" ++ show e))
960 return . map unescapeRefId . concat
962 mbsty <- if citeMethod == Citeproc && not (null refs)
964 csl <- CSL.parseCSL =<<
966 Nothing -> readDataFileUTF8 datadir
969 exists <- doesFileExist cslfile
971 then UTF8.readFile cslfile
973 csldir <- getAppUserDataDirectory "csl"
974 readDataFileUTF8 (Just csldir)
975 (replaceExtension cslfile "csl")
976 abbrevs <- maybe (return []) CSL.readJsonAbbrevFile cslabbrevs
977 return $ Just csl { CSL.styleAbbrevs = abbrevs }
980 let sourceDir = case sources of
982 (x:_) -> case parseURI x of
984 | uriScheme u `elem` ["http:","https:"] ->
985 show u{ uriPath = "", uriQuery = "", uriFragment = "" }
988 let readerOpts = def{ readerSmart = smart || (texLigatures &&
989 (laTeXOutput || "context" `isPrefixOf` writerName'))
990 , readerStandalone = standalone'
991 , readerParseRaw = parseRaw
992 , readerColumns = columns
993 , readerTabStop = tabStop
994 , readerOldDashes = oldDashes
995 , readerReferences = refs
996 , readerCitationStyle = mbsty
997 , readerIndentedCodeClasses = codeBlockClasses
998 , readerApplyMacros = not laTeXOutput
1001 let writerOptions = def { writerStandalone = standalone',
1002 writerTemplate = templ,
1003 writerVariables = variables'',
1004 writerTabStop = tabStop,
1005 writerTableOfContents = toc,
1006 writerHTMLMathMethod = mathMethod,
1007 writerIncremental = incremental,
1008 writerCiteMethod = citeMethod,
1009 writerBiblioFiles = reffiles,
1010 writerIgnoreNotes = False,
1011 writerNumberSections = numberSections,
1012 writerSectionDivs = sectionDivs,
1013 writerReferenceLinks = referenceLinks,
1014 writerWrapText = wrap,
1015 writerColumns = columns,
1016 writerEmailObfuscation = obfuscationMethod,
1017 writerIdentifierPrefix = idPrefix,
1018 writerSourceDirectory = sourceDir,
1019 writerUserDataDir = datadir,
1020 writerHtml5 = html5,
1021 writerHtmlQTags = htmlQTags,
1022 writerChapters = chapters,
1023 writerListings = listings,
1024 writerBeamer = False,
1025 writerSlideLevel = slideLevel,
1026 writerHighlight = highlight,
1027 writerHighlightStyle = highlightStyle,
1028 writerSetextHeaders = setextHeaders,
1029 writerTeXLigatures = texLigatures,
1030 writerEpubMetadata = epubMetadata,
1031 writerEpubStylesheet = epubStylesheet,
1032 writerEpubFonts = epubFonts,
1033 writerEpubChapterLevel = epubChapterLevel,
1034 writerTOCDepth = epubTOCDepth,
1035 writerReferenceODT = referenceODT,
1036 writerReferenceDocx = referenceDocx
1039 when (not (isTextFormat writerName') && outputFile == "-") $
1040 err 5 $ "Cannot write " ++ writerName' ++ " output to stdout.\n" ++
1041 "Specify an output file using the -o option."
1043 let readSources [] = mapM readSource ["-"]
1044 readSources srcs = mapM readSource srcs
1045 readSource "-" = UTF8.getContents
1046 readSource src = case parseURI src of
1047 Just u | uriScheme u `elem` ["http:","https:"] ->
1049 _ -> UTF8.readFile src
1050 readURI uri = simpleHTTP (mkRequest GET uri) >>= getResponseBody >>=
1051 return . UTF8.toStringLazy -- treat all as UTF8
1053 let convertTabs = tabFilter (if preserveTabs then 0 else tabStop)
1055 let handleIncludes' = if readerName' == "latex" || readerName' == "latex+lhs"
1059 doc <- readSources sources >>=
1060 handleIncludes' . convertTabs . intercalate "\n" >>=
1063 let doc0 = foldr ($) doc transforms
1065 let writeBinary :: B.ByteString -> IO ()
1066 writeBinary = B.writeFile (UTF8.encodePath outputFile)
1068 let writerFn :: FilePath -> String -> IO ()
1069 writerFn "-" = UTF8.putStr
1070 writerFn f = UTF8.writeFile f
1072 case getWriter writerName' of
1074 Right (IOStringWriter f) -> f writerOptions doc0 >>= writerFn outputFile
1075 Right (IOByteStringWriter f) -> f writerOptions doc0 >>= writeBinary
1076 Right (PureStringWriter f)
1078 res <- tex2pdf latexEngine $ f writerOptions doc0
1080 Right pdf -> writeBinary pdf
1081 Left err' -> err 43 $ UTF8.toStringLazy err'
1082 | otherwise -> selfcontain (f writerOptions doc0 ++
1083 ['\n' | not standalone'])
1084 >>= writerFn outputFile . handleEntities
1085 where htmlFormat = writerName' `elem`
1086 ["html","html+lhs","html5","html5+lhs",
1087 "s5","slidy","slideous","dzslides"]
1088 selfcontain = if selfContained && htmlFormat
1089 then makeSelfContained datadir
1091 handleEntities = if htmlFormat && ascii
keysesc to close
- j k
- move down, up
- enter
- open
- esc
- back, or up a level
- 1 2 3 4
- readme, files, commits, refs
- /
- filter
- y
- copy the clone command
- c
- compare the chosen commit with another (or shift-click both)
- ?
- show or hide this list