e279175ea5
Previously we used to store the directory of the first input file, even if it was local, and used this as a base directory for finding images in ODT, EPUB, Docx, and PDF. This has been confusing to many users. It seems better to look for images relative to the current working directory, even if the first file argument is in another directory. writerSourceURL is set to 'Just url' when the first command-line argument is an absolute URL. (So, relative links will be resolved in relation to the first page.) Otherwise, 'Nothing'. The ODT, EPUB, Docx, and PDF writers have been modified accordingly. Note that this change may break some existing workflows. If you have been assuming that relative links will be interpreted relative to the directory of the first file argument, you'll need to make that the current directory before running pandoc. Closes #942.
358 lines
16 KiB
Haskell
358 lines
16 KiB
Haskell
{-
|
|
Copyright (C) 2012 John MacFarlane <jgm@berkeley.edu>
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
-}
|
|
|
|
{- |
|
|
Module : Text.Pandoc.Options
|
|
Copyright : Copyright (C) 2012 John MacFarlane
|
|
License : GNU GPL, version 2 or above
|
|
|
|
Maintainer : John MacFarlane <jgm@berkeley.edu>
|
|
Stability : alpha
|
|
Portability : portable
|
|
|
|
Data structures and functions for representing parser and writer
|
|
options.
|
|
-}
|
|
module Text.Pandoc.Options ( Extension(..)
|
|
, pandocExtensions
|
|
, strictExtensions
|
|
, phpMarkdownExtraExtensions
|
|
, githubMarkdownExtensions
|
|
, multimarkdownExtensions
|
|
, ReaderOptions(..)
|
|
, HTMLMathMethod (..)
|
|
, CiteMethod (..)
|
|
, ObfuscationMethod (..)
|
|
, HTMLSlideVariant (..)
|
|
, EPUBVersion (..)
|
|
, WriterOptions (..)
|
|
, def
|
|
, isEnabled
|
|
) where
|
|
import Data.Set (Set)
|
|
import qualified Data.Set as Set
|
|
import Data.Default
|
|
import Text.Pandoc.Highlighting (Style, pygments)
|
|
import qualified Text.CSL as CSL
|
|
|
|
-- | Individually selectable syntax extensions.
|
|
data Extension =
|
|
Ext_footnotes -- ^ Pandoc/PHP/MMD style footnotes
|
|
| Ext_inline_notes -- ^ Pandoc-style inline notes
|
|
| Ext_pandoc_title_block -- ^ Pandoc title block
|
|
| Ext_yaml_metadata_block -- ^ YAML metadata block
|
|
| Ext_mmd_title_block -- ^ Multimarkdown metadata block
|
|
| Ext_table_captions -- ^ Pandoc-style table captions
|
|
| Ext_implicit_figures -- ^ A paragraph with just an image is a figure
|
|
| Ext_simple_tables -- ^ Pandoc-style simple tables
|
|
| Ext_multiline_tables -- ^ Pandoc-style multiline tables
|
|
| Ext_grid_tables -- ^ Grid tables (pandoc, reST)
|
|
| Ext_pipe_tables -- ^ Pipe tables (as in PHP markdown extra)
|
|
| Ext_citations -- ^ Pandoc/citeproc citations
|
|
| Ext_raw_tex -- ^ Allow raw TeX (other than math)
|
|
| Ext_raw_html -- ^ Allow raw HTML
|
|
| Ext_tex_math_dollars -- ^ TeX math between $..$ or $$..$$
|
|
| Ext_tex_math_single_backslash -- ^ TeX math btw \(..\) \[..\]
|
|
| Ext_tex_math_double_backslash -- ^ TeX math btw \\(..\\) \\[..\\]
|
|
| Ext_latex_macros -- ^ Parse LaTeX macro definitions (for math only)
|
|
| Ext_fenced_code_blocks -- ^ Parse fenced code blocks
|
|
| Ext_fenced_code_attributes -- ^ Allow attributes on fenced code blocks
|
|
| Ext_backtick_code_blocks -- ^ Github style ``` code blocks
|
|
| Ext_inline_code_attributes -- ^ Allow attributes on inline code
|
|
| Ext_markdown_in_html_blocks -- ^ Interpret as markdown inside HTML blocks
|
|
| Ext_markdown_attribute -- ^ Interpret text inside HTML as markdown
|
|
-- iff container has attribute 'markdown'
|
|
| Ext_escaped_line_breaks -- ^ Treat a backslash at EOL as linebreak
|
|
| Ext_link_attributes -- ^ MMD style reference link attributes
|
|
| Ext_autolink_bare_uris -- ^ Make all absolute URIs into links
|
|
| Ext_fancy_lists -- ^ Enable fancy list numbers and delimiters
|
|
| Ext_startnum -- ^ Make start number of ordered list significant
|
|
| Ext_definition_lists -- ^ Definition lists as in pandoc, mmd, php
|
|
| Ext_example_lists -- ^ Markdown-style numbered examples
|
|
| Ext_all_symbols_escapable -- ^ Make all non-alphanumerics escapable
|
|
| Ext_intraword_underscores -- ^ Treat underscore inside word as literal
|
|
| Ext_blank_before_blockquote -- ^ Require blank line before a blockquote
|
|
| Ext_blank_before_header -- ^ Require blank line before a header
|
|
| Ext_strikeout -- ^ Strikeout using ~~this~~ syntax
|
|
| Ext_superscript -- ^ Superscript using ^this^ syntax
|
|
| Ext_subscript -- ^ Subscript using ~this~ syntax
|
|
| Ext_hard_line_breaks -- ^ All newlines become hard line breaks
|
|
| Ext_ignore_line_breaks -- ^ Newlines in paragraphs are ignored
|
|
| Ext_literate_haskell -- ^ Enable literate Haskell conventions
|
|
| Ext_abbreviations -- ^ PHP markdown extra abbreviation definitions
|
|
| Ext_auto_identifiers -- ^ Automatic identifiers for headers
|
|
| Ext_ascii_identifiers -- ^ ascii-only identifiers for headers
|
|
| Ext_header_attributes -- ^ Explicit header attributes {#id .class k=v}
|
|
| Ext_mmd_header_identifiers -- ^ Multimarkdown style header identifiers [myid]
|
|
| Ext_implicit_header_references -- ^ Implicit reference links for headers
|
|
| Ext_line_blocks -- ^ RST style line blocks
|
|
deriving (Show, Read, Enum, Eq, Ord, Bounded)
|
|
|
|
pandocExtensions :: Set Extension
|
|
pandocExtensions = Set.fromList
|
|
[ Ext_footnotes
|
|
, Ext_inline_notes
|
|
, Ext_pandoc_title_block
|
|
, Ext_yaml_metadata_block
|
|
, Ext_table_captions
|
|
, Ext_implicit_figures
|
|
, Ext_simple_tables
|
|
, Ext_multiline_tables
|
|
, Ext_grid_tables
|
|
, Ext_pipe_tables
|
|
, Ext_citations
|
|
, Ext_raw_tex
|
|
, Ext_raw_html
|
|
, Ext_tex_math_dollars
|
|
, Ext_latex_macros
|
|
, Ext_fenced_code_blocks
|
|
, Ext_fenced_code_attributes
|
|
, Ext_backtick_code_blocks
|
|
, Ext_inline_code_attributes
|
|
, Ext_markdown_in_html_blocks
|
|
, Ext_escaped_line_breaks
|
|
, Ext_fancy_lists
|
|
, Ext_startnum
|
|
, Ext_definition_lists
|
|
, Ext_example_lists
|
|
, Ext_all_symbols_escapable
|
|
, Ext_intraword_underscores
|
|
, Ext_blank_before_blockquote
|
|
, Ext_blank_before_header
|
|
, Ext_strikeout
|
|
, Ext_superscript
|
|
, Ext_subscript
|
|
, Ext_auto_identifiers
|
|
, Ext_header_attributes
|
|
, Ext_implicit_header_references
|
|
, Ext_line_blocks
|
|
]
|
|
|
|
phpMarkdownExtraExtensions :: Set Extension
|
|
phpMarkdownExtraExtensions = Set.fromList
|
|
[ Ext_footnotes
|
|
, Ext_pipe_tables
|
|
, Ext_raw_html
|
|
, Ext_markdown_attribute
|
|
, Ext_fenced_code_blocks
|
|
, Ext_definition_lists
|
|
, Ext_intraword_underscores
|
|
, Ext_header_attributes
|
|
, Ext_abbreviations
|
|
]
|
|
|
|
githubMarkdownExtensions :: Set Extension
|
|
githubMarkdownExtensions = Set.fromList
|
|
[ Ext_pipe_tables
|
|
, Ext_raw_html
|
|
, Ext_tex_math_single_backslash
|
|
, Ext_fenced_code_blocks
|
|
, Ext_fenced_code_attributes
|
|
, Ext_auto_identifiers
|
|
, Ext_ascii_identifiers
|
|
, Ext_backtick_code_blocks
|
|
, Ext_autolink_bare_uris
|
|
, Ext_intraword_underscores
|
|
, Ext_strikeout
|
|
, Ext_hard_line_breaks
|
|
]
|
|
|
|
multimarkdownExtensions :: Set Extension
|
|
multimarkdownExtensions = Set.fromList
|
|
[ Ext_pipe_tables
|
|
, Ext_raw_html
|
|
, Ext_markdown_attribute
|
|
, Ext_link_attributes
|
|
, Ext_raw_tex
|
|
, Ext_tex_math_double_backslash
|
|
, Ext_intraword_underscores
|
|
, Ext_mmd_title_block
|
|
, Ext_footnotes
|
|
, Ext_definition_lists
|
|
, Ext_all_symbols_escapable
|
|
, Ext_implicit_header_references
|
|
, Ext_auto_identifiers
|
|
, Ext_mmd_header_identifiers
|
|
]
|
|
|
|
strictExtensions :: Set Extension
|
|
strictExtensions = Set.fromList
|
|
[ Ext_raw_html ]
|
|
|
|
data ReaderOptions = ReaderOptions{
|
|
readerExtensions :: Set Extension -- ^ Syntax extensions
|
|
, readerSmart :: Bool -- ^ Smart punctuation
|
|
, readerStrict :: Bool -- ^ FOR TRANSITION ONLY
|
|
, readerStandalone :: Bool -- ^ Standalone document with header
|
|
, readerParseRaw :: Bool -- ^ Parse raw HTML, LaTeX
|
|
, readerColumns :: Int -- ^ Number of columns in terminal
|
|
, readerTabStop :: Int -- ^ Tab stop
|
|
, readerOldDashes :: Bool -- ^ Use pandoc <= 1.8.2.1 behavior
|
|
-- in parsing dashes; -- is em-dash;
|
|
-- - before numerial is en-dash
|
|
, readerReferences :: [CSL.Reference] -- ^ Bibliographic references
|
|
, readerCitationStyle :: Maybe CSL.Style -- ^ Citation style
|
|
, readerApplyMacros :: Bool -- ^ Apply macros to TeX math
|
|
, readerIndentedCodeClasses :: [String] -- ^ Default classes for
|
|
-- indented code blocks
|
|
, readerDefaultImageExtension :: String -- ^ Default extension for images
|
|
} deriving (Show, Read)
|
|
|
|
instance Default ReaderOptions
|
|
where def = ReaderOptions{
|
|
readerExtensions = pandocExtensions
|
|
, readerSmart = False
|
|
, readerStrict = False
|
|
, readerStandalone = False
|
|
, readerParseRaw = False
|
|
, readerColumns = 80
|
|
, readerTabStop = 4
|
|
, readerOldDashes = False
|
|
, readerReferences = []
|
|
, readerCitationStyle = Nothing
|
|
, readerApplyMacros = True
|
|
, readerIndentedCodeClasses = []
|
|
, readerDefaultImageExtension = ""
|
|
}
|
|
|
|
--
|
|
-- Writer options
|
|
--
|
|
|
|
data EPUBVersion = EPUB2 | EPUB3 deriving (Eq, Show, Read)
|
|
|
|
data HTMLMathMethod = PlainMath
|
|
| LaTeXMathML (Maybe String) -- url of LaTeXMathML.js
|
|
| JsMath (Maybe String) -- url of jsMath load script
|
|
| GladTeX
|
|
| WebTeX String -- url of TeX->image script.
|
|
| MathML (Maybe String) -- url of MathMLinHTML.js
|
|
| MathJax String -- url of MathJax.js
|
|
deriving (Show, Read, Eq)
|
|
|
|
data CiteMethod = Citeproc -- use citeproc to render them
|
|
| Natbib -- output natbib cite commands
|
|
| Biblatex -- output biblatex cite commands
|
|
deriving (Show, Read, Eq)
|
|
|
|
-- | Methods for obfuscating email addresses in HTML.
|
|
data ObfuscationMethod = NoObfuscation
|
|
| ReferenceObfuscation
|
|
| JavascriptObfuscation
|
|
deriving (Show, Read, Eq)
|
|
|
|
-- | Varieties of HTML slide shows.
|
|
data HTMLSlideVariant = S5Slides
|
|
| SlidySlides
|
|
| SlideousSlides
|
|
| DZSlides
|
|
| RevealJsSlides
|
|
| NoSlides
|
|
deriving (Show, Read, Eq)
|
|
|
|
-- | Options for writers
|
|
data WriterOptions = WriterOptions
|
|
{ writerStandalone :: Bool -- ^ Include header and footer
|
|
, writerTemplate :: String -- ^ Template to use in standalone mode
|
|
, writerVariables :: [(String, String)] -- ^ Variables to set in template
|
|
, writerTabStop :: Int -- ^ Tabstop for conversion btw spaces and tabs
|
|
, writerTableOfContents :: Bool -- ^ Include table of contents
|
|
, writerSlideVariant :: HTMLSlideVariant -- ^ Are we writing S5, Slidy or Slideous?
|
|
, writerIncremental :: Bool -- ^ True if lists should be incremental
|
|
, writerHTMLMathMethod :: HTMLMathMethod -- ^ How to print math in HTML
|
|
, writerIgnoreNotes :: Bool -- ^ Ignore footnotes (used in making toc)
|
|
, writerNumberSections :: Bool -- ^ Number sections in LaTeX
|
|
, writerNumberOffset :: [Int] -- ^ Starting number for section, subsection, ...
|
|
, writerSectionDivs :: Bool -- ^ Put sections in div tags in HTML
|
|
, writerExtensions :: Set Extension -- ^ Markdown extensions that can be used
|
|
, writerReferenceLinks :: Bool -- ^ Use reference links in writing markdown, rst
|
|
, writerWrapText :: Bool -- ^ Wrap text to line length
|
|
, writerColumns :: Int -- ^ Characters in a line (for text wrapping)
|
|
, writerEmailObfuscation :: ObfuscationMethod -- ^ How to obfuscate emails
|
|
, writerIdentifierPrefix :: String -- ^ Prefix for section & note ids in HTML
|
|
-- and for footnote marks in markdown
|
|
, writerSourceURL :: Maybe String -- ^ Absolute URL + directory of 1st source file
|
|
, writerUserDataDir :: Maybe FilePath -- ^ Path of user data directory
|
|
, writerCiteMethod :: CiteMethod -- ^ How to print cites
|
|
, writerBiblioFiles :: [FilePath] -- ^ Biblio files to use for citations
|
|
, writerHtml5 :: Bool -- ^ Produce HTML5
|
|
, writerHtmlQTags :: Bool -- ^ Use @<q>@ tags for quotes in HTML
|
|
, writerBeamer :: Bool -- ^ Produce beamer LaTeX slide show
|
|
, writerSlideLevel :: Maybe Int -- ^ Force header level of slides
|
|
, writerChapters :: Bool -- ^ Use "chapter" for top-level sects
|
|
, writerListings :: Bool -- ^ Use listings package for code
|
|
, writerHighlight :: Bool -- ^ Highlight source code
|
|
, writerHighlightStyle :: Style -- ^ Style to use for highlighting
|
|
, writerSetextHeaders :: Bool -- ^ Use setext headers for levels 1-2 in markdown
|
|
, writerTeXLigatures :: Bool -- ^ Use tex ligatures quotes, dashes in latex
|
|
, writerEpubVersion :: Maybe EPUBVersion -- ^ Nothing or EPUB version
|
|
, writerEpubMetadata :: String -- ^ Metadata to include in EPUB
|
|
, writerEpubStylesheet :: Maybe String -- ^ EPUB stylesheet specified at command line
|
|
, writerEpubFonts :: [FilePath] -- ^ Paths to fonts to embed
|
|
, writerEpubChapterLevel :: Int -- ^ Header level for chapters (separate files)
|
|
, writerTOCDepth :: Int -- ^ Number of levels to include in TOC
|
|
, writerReferenceODT :: Maybe FilePath -- ^ Path to reference ODT if specified
|
|
, writerReferenceDocx :: Maybe FilePath -- ^ Ptah to reference DOCX if specified
|
|
} deriving Show
|
|
|
|
instance Default WriterOptions where
|
|
def = WriterOptions { writerStandalone = False
|
|
, writerTemplate = ""
|
|
, writerVariables = []
|
|
, writerTabStop = 4
|
|
, writerTableOfContents = False
|
|
, writerSlideVariant = NoSlides
|
|
, writerIncremental = False
|
|
, writerHTMLMathMethod = PlainMath
|
|
, writerIgnoreNotes = False
|
|
, writerNumberSections = False
|
|
, writerNumberOffset = [0,0,0,0,0,0]
|
|
, writerSectionDivs = False
|
|
, writerExtensions = pandocExtensions
|
|
, writerReferenceLinks = False
|
|
, writerWrapText = True
|
|
, writerColumns = 72
|
|
, writerEmailObfuscation = JavascriptObfuscation
|
|
, writerIdentifierPrefix = ""
|
|
, writerSourceURL = Nothing
|
|
, writerUserDataDir = Nothing
|
|
, writerCiteMethod = Citeproc
|
|
, writerBiblioFiles = []
|
|
, writerHtml5 = False
|
|
, writerHtmlQTags = False
|
|
, writerBeamer = False
|
|
, writerSlideLevel = Nothing
|
|
, writerChapters = False
|
|
, writerListings = False
|
|
, writerHighlight = False
|
|
, writerHighlightStyle = pygments
|
|
, writerSetextHeaders = True
|
|
, writerTeXLigatures = True
|
|
, writerEpubVersion = Nothing
|
|
, writerEpubMetadata = ""
|
|
, writerEpubStylesheet = Nothing
|
|
, writerEpubFonts = []
|
|
, writerEpubChapterLevel = 1
|
|
, writerTOCDepth = 3
|
|
, writerReferenceODT = Nothing
|
|
, writerReferenceDocx = Nothing
|
|
}
|
|
|
|
-- | Returns True if the given extension is enabled.
|
|
isEnabled :: Extension -> WriterOptions -> Bool
|
|
isEnabled ext opts = ext `Set.member` (writerExtensions opts)
|