From e0984a43a99231e72c02a0a716c8d0315de9abdf Mon Sep 17 00:00:00 2001 From: John MacFarlane Date: Sun, 6 Sep 2020 16:25:16 -0700 Subject: Add built-in citation support using new citeproc library. This deprecates the use of the external pandoc-citeproc filter; citation processing is now built in to pandoc. * Add dependency on citeproc library. * Add Text.Pandoc.Citeproc module (and some associated unexported modules under Text.Pandoc.Citeproc). Exports `processCitations`. [API change] * Add data files needed for Text.Pandoc.Citeproc: default.csl in the data directory, and a citeproc directory that is just used at compile-time. Note that we've added file-embed as a mandatory rather than a conditional depedency, because of the biblatex localization files. We might eventually want to use readDataFile for this, but it would take some code reorganization. * Text.Pandoc.Loging: Add `CiteprocWarning` to `LogMessage` and use it in `processCitations`. [API change] * Add tests from the pandoc-citeproc package as command tests (including some tests pandoc-citeproc did not pass). * Remove instructions for building pandoc-citeproc from CI and release binary build instructions. We will no longer distribute pandoc-citeproc. * Markdown reader: tweak abbreviation support. Don't insert a nonbreaking space after a potential abbreviation if it comes right before a note or citation. This messes up several things, including citeproc's moving of note citations. * Add `csljson` as and input and output format. This allows pandoc to convert between `csljson` and other bibliography formats, and to generate formatted versions of CSL JSON bibliographies. * Add module Text.Pandoc.Writers.CslJson, exporting `writeCslJson`. [API change] * Add module Text.Pandoc.Readers.CslJson, exporting `readCslJson`. [API change] * Added `bibtex`, `biblatex` as input formats. This allows pandoc to convert between BibLaTeX and BibTeX and other bibliography formats, and to generated formatted versions of BibTeX/BibLaTeX bibliographies. * Add module Text.Pandoc.Readers.BibTeX, exporting `readBibTeX` and `readBibLaTeX`. [API change] * Make "standalone" implicit if output format is a bibliography format. This is needed because pandoc readers for bibliography formats put the bibliographic information in the `references` field of metadata; and unless standalone is specified, metadata gets ignored. (TODO: This needs improvement. We should trigger standalone for the reader when the input format is bibliographic, and for the writer when the output format is markdown.) * Carry over `citationNoteNum` to `citationNoteNumber`. This was just ignored in pandoc-citeproc. * Text.Pandoc.Filter: Add `CiteprocFilter` constructor to Filter. [API change] This runs the processCitations transformation. We need to treat it like a filter so it can be placed in the sequence of filter runs (after some, before others). In FromYAML, this is parsed from `citeproc` or `{type: citeproc}`, so this special filter may be specified either way in a defaults file (or by `citeproc: true`, though this gives no control of positioning relative to other filters). TODO: we need to add something to the manual section on defaults files for this. * Add deprecation warning if `upandoc-citeproc` filter is used. * Add `--citeproc/-C` option to trigger citation processing. This behaves like a filter and will be positioned relative to filters as they appear on the command line. * Rewrote the manual on citatations, adding a dedicated Citations section which also includes some information formerly found in the pandoc-citeproc man page. * Look for CSL styles in the `csl` subdirectory of the pandoc user data directory. This changes the old pandoc-citeproc behavior, which looked in `~/.csl`. Users can simply symlink `~/.csl` to the `csl` subdirectory of their pandoc user data directory if they want the old behavior. * Add support for CSL bibliography entry formatting to LaTeX, HTML, Ms writers. Added CSL-related CSS to styles.html. --- src/Text/Pandoc/Writers/Ms.hs | 64 +++++++++++++++++++++++++++++++++++++++---- 1 file changed, 59 insertions(+), 5 deletions(-) (limited to 'src/Text/Pandoc/Writers/Ms.hs') diff --git a/src/Text/Pandoc/Writers/Ms.hs b/src/Text/Pandoc/Writers/Ms.hs index f3aadde59..dbf7a3d79 100644 --- a/src/Text/Pandoc/Writers/Ms.hs +++ b/src/Text/Pandoc/Writers/Ms.hs @@ -110,16 +110,37 @@ blockToMs :: PandocMonad m -> Block -- ^ Block element -> MS m (Doc Text) blockToMs _ Null = return empty -blockToMs opts (Div (ident,_,_) bs) = do +blockToMs opts (Div (ident,cls,kvs) bs) = do let anchor = if T.null ident then empty else nowrap $ literal ".pdfhref M " <> doubleQuotes (literal (toAscii ident)) - setFirstPara - res <- blockListToMs opts bs - setFirstPara - return $ anchor $$ res + case cls of + _ | "csl-entry" `elem` cls -> + (".CSLENTRY" $$) . vcat <$> mapM (cslEntryToMs True opts) bs + | "csl-bib-body" `elem` cls -> do + res <- blockListToMs opts bs + return $ anchor $$ + -- so that XP paragraphs are indented: + ".nr PI 3n" $$ + -- space between entries + ".de CSLENTRY" $$ + (case lookup "entry-spacing" kvs >>= safeRead of + Just n | n > (0 :: Int) -> ".sp" + _ -> mempty) $$ + ".." $$ + ".de CSLP" $$ + (if "hanging-indent" `elem` cls + then ".XP" + else ".LP") $$ + ".." $$ + res + _ -> do + setFirstPara + res <- blockListToMs opts bs + setFirstPara + return $ anchor $$ res blockToMs opts (Plain inlines) = liftM vcat $ mapM (inlineListToMs' opts) $ splitSentences inlines blockToMs opts (Para [Image attr alt (src,_tit)]) @@ -440,6 +461,39 @@ inlineToMs _ (Note contents) = do modify $ \st -> st{ stNotes = contents : stNotes st } return $ literal "\\**" +cslEntryToMs :: PandocMonad m + => Bool + -> WriterOptions + -> Block + -> MS m (Doc Text) +cslEntryToMs atStart opts (Para xs) = + case xs of + (Span ("",["csl-left-margin"],[]) lils : + rest@(Span ("",["csl-right-inline"],[]) _ : _)) + -> do lils' <- inlineListToMs' opts lils + ((cr <> literal ".IP " <> + doubleQuotes (nowrap lils') <> + literal " 5") $$) + <$> cslEntryToMs False opts (Para rest) + (Span ("",["csl-block"],[]) ils : rest) + -> ((cr <> literal ".LP") $$) + <$> cslEntryToMs False opts (Para (ils ++ rest)) + (Span ("",["csl-left-margin"],[]) ils : rest) + -> ((cr <> literal ".LP") $$) + <$> cslEntryToMs False opts (Para (ils ++ rest)) + (Span ("",["csl-indented"],[]) ils : rest) + -> ((cr <> literal ".LP") $$) + <$> cslEntryToMs False opts (Para (ils ++ rest)) + _ | atStart + -> (".CSLP" $$) <$> cslEntryToMs False opts (Para xs) + | otherwise + -> case xs of + [] -> return mempty + (x:rest) -> (<>) <$> (inlineToMs opts x) + <*> (cslEntryToMs False opts (Para rest)) +cslEntryToMs _ opts x = blockToMs opts x + + handleNotes :: PandocMonad m => WriterOptions -> Doc Text -> MS m (Doc Text) handleNotes opts fallback = do notes <- gets stNotes -- cgit v1.2.3