diff --git a/changelog b/changelog --- a/changelog +++ b/changelog @@ -1,3 +1,16 @@ +pandoc-citeproc (0.14.1) + + * More robust handling of boolean metadata values. + * Keep position of citations with prefixes when sorting (behavior + change, #292). If citations with prefixes are moved around, + gibberish can result. E.g.: + `A fascinating research tidbit [@Zanadu1999, p. 35; see + for comparison @Aalto2005]` can become + "A fascinating research tidbit (see for comparison Aalto, 2005; + Zanadu, 1999: 35)" with a sorting style like sage-harvard.csl. + This change causes sorting to be applied only to subgroups of citations + that lack prefixes. + pandoc-citeproc (0.14) * Fix non-numerical season parsing in RefDate (#316). diff --git a/pandoc-citeproc.cabal b/pandoc-citeproc.cabal --- a/pandoc-citeproc.cabal +++ b/pandoc-citeproc.cabal @@ -1,5 +1,5 @@ name: pandoc-citeproc -version: 0.14 +version: 0.14.1 cabal-version: >= 1.12 synopsis: Supports using pandoc with citeproc diff --git a/src/Text/CSL/Pandoc.hs b/src/Text/CSL/Pandoc.hs --- a/src/Text/CSL/Pandoc.hs +++ b/src/Text/CSL/Pandoc.hs @@ -57,9 +57,8 @@ map (map (toCslCite locMap)) grps) cits_map = tr' "cits_map" $ M.fromList $ zip grps (citations result) biblioList = map (renderPandoc' style) $ zip (bibliography result) (citationIds result) - moveNotes = case lookupMeta "notes-after-punctuation" m1 of - Just (MetaBool False) -> False - _ -> True + moveNotes = maybe True truish $ + lookupMeta "notes-after-punctuation" m1 Pandoc m3 bs = walk (mvPunct moveNotes style) . deNote . walk (processCite style cits_map) $ Pandoc m2 b2 m = case metanocites of @@ -109,19 +108,26 @@ isRefRemove :: Meta -> Bool isRefRemove meta = - case lookupMeta "suppress-bibliography" meta of - Just (MetaBool True) -> True - _ -> False + maybe False truish $ lookupMeta "suppress-bibliography" meta isLinkCitations :: Meta -> Bool isLinkCitations meta = - case lookupMeta "link-citations" meta of - Just (MetaBool True) -> True - Just (MetaString s) -> map toLower s `elem` yesValues - Just (MetaInlines ils) -> map toLower (stringify ils) `elem` yesValues - _ -> False - where yesValues = ["true", "yes", "on"] + maybe False truish $ lookupMeta "link-citations" meta +truish :: MetaValue -> Bool +truish (MetaBool t) = t +truish (MetaString s) = isYesValue (map toLower s) +truish (MetaInlines ils) = isYesValue (map toLower (stringify ils)) +truish (MetaBlocks [Plain ils]) = isYesValue (map toLower (stringify ils)) +truish _ = False + +isYesValue :: String -> Bool +isYesValue "t" = True +isYesValue "true" = True +isYesValue "yes" = True +isYesValue "on" = True +isYesValue _ = False + -- if the 'nocite' Meta field contains a citation with id = '*', -- create a cite with to all the references. mkNociteWildcards :: [Reference] -> [[Citation]] -> [[Citation]] @@ -194,7 +200,7 @@ let idpred = if "*" `Set.member` citids then const True else (`Set.member` citids) - bibRefs <- getBibRefs idpred $ Data.Maybe.fromMaybe (MetaList []) + bibRefs <- getBibRefs idpred $ fromMaybe (MetaList []) $ lookupMeta "bibliography" meta let refs = inlineRefs ++ bibRefs let cslAbbrevFile = lookupMeta "citation-abbreviations" meta >>= toPath diff --git a/src/Text/CSL/Proc.hs b/src/Text/CSL/Proc.hs --- a/src/Text/CSL/Proc.hs +++ b/src/Text/CSL/Proc.hs @@ -1,4 +1,5 @@ {-# LANGUAGE OverloadedStrings #-} +{-# LANGUAGE FlexibleContexts #-} {-# LANGUAGE PatternGuards #-} ----------------------------------------------------------------------------- -- | @@ -19,6 +20,7 @@ import Control.Applicative ((<|>)) import Control.Arrow (second, (&&&), (>>>)) +import Control.Monad.State (execState, modify) import Data.Aeson import Data.Char (isDigit, isLetter, toLower) import Data.List @@ -304,7 +306,19 @@ format (c,r) = (c, evalLayout (citLayout ct) (EvalCite c) False l ms opts' as r) sort_ (c,r) = evalSorting (EvalSorting c) l ms opts' (citSort ct) as r process = map (second (flip Output emptyFormatting) . format &&& sort_) - result = sortItems $ process cr + result = concatMap sortItems $ toChunks $ process cr + -- toChunks splits the citations up into groups, such that + -- a citation with a non-null prefix is by itself in its + -- group, otherwise preserving the order (see #292 for + -- motivation; we don't want to move prefixed citations + -- around) + toChunks xs = reverse $ execState (toChunks' xs) [] + toChunks' xs = do + case break hasPrefix xs of + ([], []) -> return () + ([], y:ys) -> modify ([y]:) >> toChunks' ys + (zs, ys) -> modify (zs:) >> toChunks' ys + hasPrefix ((c,_),_) = citePrefix c /= mempty formatBiblioLayout :: Formatting -> Delimiter -> [Output] -> [Output] formatBiblioLayout f d = appendOutput f . addDelim d diff --git a/tests/issue292.expected.native b/tests/issue292.expected.native new file mode 100644 --- /dev/null +++ b/tests/issue292.expected.native @@ -0,0 +1,9 @@ +Pandoc (Meta {unMeta = fromList [("csl",MetaInlines [Str "tests/sage-harvard.csl"]),("references",MetaList [MetaMap (fromList [("author",MetaMap (fromList [("family",MetaInlines [Str "Doe"])])),("id",MetaInlines [Str "doe"]),("issued",MetaMap (fromList [("year",MetaString "2007")])),("type",MetaInlines [Str "article"])]),MetaMap (fromList [("author",MetaMap (fromList [("family",MetaInlines [Str "Zoe"])])),("id",MetaInlines [Str "zoe"]),("issued",MetaList [MetaMap (fromList [("year",MetaString "2009")])]),("type",MetaInlines [Str "article"])]),MetaMap (fromList [("author",MetaMap (fromList [("family",MetaInlines [Str "Roe"])])),("id",MetaInlines [Str "roe"]),("issued",MetaList [MetaMap (fromList [("year",MetaString "2007")])]),("type",MetaInlines [Str "article"])])])]}) +[Para [Cite [Citation {citationId = "zoe", citationPrefix = [], citationSuffix = [], citationMode = NormalCitation, citationNoteNum = 0, citationHash = 1},Citation {citationId = "roe", citationPrefix = [], citationSuffix = [], citationMode = NormalCitation, citationNoteNum = 0, citationHash = 2},Citation {citationId = "doe", citationPrefix = [Str "see",Space,Str "for",Space,Str "comparison"], citationSuffix = [Str ",",Space,Str "p.\160\&3"], citationMode = NormalCitation, citationNoteNum = 0, citationHash = 3}] [Str "(Roe,",Space,Str "2007;",Space,Str "Zoe,",Space,Str "2009;",Space,Str "see",Space,Str "for",Space,Str "comparison",Space,Str "Doe,",Space,Str "2007:",Space,Str "3)"]] +,Div ("refs",["references"],[]) + [Div ("ref-doe",[],[]) + [Para [Str "Doe",Space,Str "(2007)."]] + ,Div ("ref-roe",[],[]) + [Para [Str "Roe",Space,Str "(2007)."]] + ,Div ("ref-zoe",[],[]) + [Para [Str "Zoe",Space,Str "(2009)."]]]] diff --git a/tests/issue292.in.native b/tests/issue292.in.native new file mode 100644 --- /dev/null +++ b/tests/issue292.in.native @@ -0,0 +1,2 @@ +Pandoc (Meta {unMeta = fromList [("csl",MetaInlines [Str "tests/sage-harvard.csl"]),("references",MetaList [MetaMap (fromList [("author",MetaMap (fromList [("family",MetaInlines [Str "Doe"])])),("id",MetaInlines [Str "doe"]),("issued",MetaMap (fromList [("year",MetaString "2007")])),("type",MetaInlines [Str "article"])]),MetaMap (fromList [("author",MetaMap (fromList [("family",MetaInlines [Str "Zoe"])])),("id",MetaInlines [Str "zoe"]),("issued",MetaList [MetaMap (fromList [("year",MetaString "2009")])]),("type",MetaInlines [Str "article"])]),MetaMap (fromList [("author",MetaMap (fromList [("family",MetaInlines [Str "Roe"])])),("id",MetaInlines [Str "roe"]),("issued",MetaList [MetaMap (fromList [("year",MetaString "2007")])]),("type",MetaInlines [Str "article"])])])]}) +[Para [Cite [Citation {citationId = "zoe", citationPrefix = [], citationSuffix = [], citationMode = NormalCitation, citationNoteNum = 0, citationHash = 0},Citation {citationId = "roe", citationPrefix = [], citationSuffix = [], citationMode = NormalCitation, citationNoteNum = 0, citationHash = 0},Citation {citationId = "doe", citationPrefix = [Str "see",Space,Str "for",Space,Str "comparison"], citationSuffix = [Str ",",Space,Str "p.\160\&3"], citationMode = NormalCitation, citationNoteNum = 0, citationHash = 0}] [Str "[@zoe;",Space,Str "@roe;",Space,Str "see",Space,Str "for",Space,Str "comparison",Space,Str "@doe,",Space,Str "p.",Space,Str "3]"]]] diff --git a/tests/sage-harvard.csl b/tests/sage-harvard.csl new file mode 100644 --- /dev/null +++ b/tests/sage-harvard.csl @@ -0,0 +1,202 @@ + +