diff --git a/CHANGELOG.md b/CHANGELOG.md --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,26 @@ # citeproc changelog +## 0.8 + + * Add `SubstitutedVal` constructor for `Val` [API change] (#101, #108). + This is used to track variables that are repressed due to substitution. + (We can't just delete them, because they still count when we have + "if" elements that check for a variable.) + + * Fix logic for including a group. A group with a text node and an + empty variable should count as empty. + + * CaseTransform: don't change words that are a mix of uppercase + and nonletters, like CRT1000. + + * Fix label with "page" variable (#107). + + * Fix error in test suite. We stripped indentation in the expected result + in some cases. + + * Update fr-FR locale from upstream. + + ## 0.7 * Handle old term form `sub verbo` as if it is `sub-verbo` (the new form). diff --git a/citeproc.cabal b/citeproc.cabal --- a/citeproc.cabal +++ b/citeproc.cabal @@ -1,6 +1,6 @@ cabal-version: 2.2 name: citeproc -version: 0.7 +version: 0.8 synopsis: Generates citations and bibliography from CSL styles. description: citeproc parses CSL style files and uses them to generate a list of formatted citations and bibliography diff --git a/locales/fr-FR.xml b/locales/fr-FR.xml --- a/locales/fr-FR.xml +++ b/locales/fr-FR.xml @@ -4,6 +4,9 @@ Grégoire Colly + + Collectif Zotero francophone + This work is licensed under a Creative Commons Attribution-ShareAlike 3.0 License 2012-07-04T23:31:02+00:00 @@ -19,33 +22,33 @@ - advance online publication + publication en ligne anticipée album - audio recording + enregistrement audio film - henceforth - loc. cit. - no place - n.p. - no publisher - n.p. - on - op. cit. - original work published + désormais + loc. cit. + sans lieu + s. l. + sans nom + s. n. + sur + op. cit. + édition originale communication personnelle podcast - podcast episode - preprint - radio broadcast - radio series - radio series episode - special issue - special section - television broadcast - television series - television series episode - video - working paper + épisode de podcast + prépublication + émission de radio + série radiophonique + épisode de série radiophonique + numéro spécial + section spéciale + émission de télévision + série télévisée + épisode de série télévisée + vidéo + document de travail consulté le et et autres @@ -88,74 +91,74 @@ version - preprint - journal article - magazine article - newspaper article - bill - book - broadcast - book chapter - classic + article + article de revue + article de magazine + article de presse + projet de loi + livre + émission + chapitre de livre + classique collection - dataset + jeu de données document - entry - dictionary entry - encyclopedia entry - event + entrée + entrée de dictionnaire + entrée d'encyclopédie + événement - graphic - hearing + image + audience interview - legal case - legislation - manuscript - map - video recording - musical score + affaire + acte juridique + manuscrit + carte + enregistrement vidéo + partition pamphlet - conference paper - patent - performance - periodical + article de colloque + brevet + interprétation + périodique communication personnelle - post - blog post - regulation - report - review - book review - software - audio recording - presentation - standard - thesis - treaty - webpage + billet + billet de blog + règlement + rapport + recension + recension de livre + logiciel + chanson + présentation + norme + thèse + traité + page web - journal art. - mag. art. - newspaper art. - bk. - bk. chap. + art. de revue + art. de mag. + art. de presse + liv. + chap. de liv. doc. graph. interv. - MS - video rec. - rep. - rev. - bk. rev. - audio rec. + ms + enr. vidéo + rap. + recens. + recens. de liv. + enr. audio apr. J.-C. av. J.-C. - BCE - CE + av. n. è. + n. è. «  @@ -163,15 +166,15 @@ “ ” ‑ - : +  : , - ; +  ; ᵉ ʳᵉ ᵉʳ - + premier deuxième @@ -185,49 +188,49 @@ dixième - - act - acts + + acte + actes - - appendix - appendices + + appendice + appendices - + article - articles + articles - + canon - canons + canons - - location - locations + + emplacement + emplacements - - equation - equations + + équation + équations - - rule - rules + + règle + règles - - scene - scenes + + scène + scènes - - table - tables + + tableau + tableaux - + - - title - titles + + titre + titres livre @@ -299,41 +302,41 @@ - - app. - apps. + + append. + append. - + art. - arts. + art. - - loc. - locs. + + emplact + emplact - + eq. - eqs. + eq. - - r. - rr. + + règle + règles - + sc. - scs. + sc. - - tbl. - tbls. + + tab. + tab. - + - + tit. - tits. + tit. liv. chap. @@ -386,56 +389,56 @@ - chair - chairs + président + présidents - compiler - compilers + compilateur + compilateurs - contributor - contributors + contributeur + contributeurs - curator - curators + commissaire + commissaires - executive producer - executive producers + producteur exécutif + producteurs exécutifs - guest - guests + invité + invités - host - hosts + hôte + hôtes - narrator - narrators + narrateur + narrateurs - organizer - organizers + organisateur + organisateurs - performer - performers + interprète + interprètes - producer - producers + producteur + producteurs - writer - writers + scénariste + scénaristes - series creator - series creators + créateur de série + créateurs de série réalisateur @@ -464,44 +467,44 @@ - comp. - comps. + compil. + compil. contrib. - contribs. + contrib. - cur. - curs. + commiss. + commiss. - exec. prod. - exec. prods. + prod. exé. + prod. exé. narr. - narrs. + narr. org. - orgs. + org. - perf. - perfs. + interpr. + interpr. prod. - prods. + prod. - writ. - writs. + scénar. + scénar. - cre. - cres. + créat. + créat. réal. @@ -529,19 +532,19 @@ - chaired by - compiled by - with - curated by - executive produced by - with guest - hosted by - narrated by - organized by - performed by - produced by - written by - created by + présidé par + compilé par + avec + organisé par + production exécutive par + avec pour invité + animé par + lu par + organisé par + interprété par + produit par + scénario de + créé par par réalisé par édité par @@ -554,18 +557,18 @@ édité et traduit par - comp. by - w. - cur. by - exec. prod. by - w. guest - hosted by - narr. by - org. by - perf. by - prod. by - writ. by - cre. by + compil. par + ac + org. par + prod. exé. par + ac pr inv. + anim. par + lu par + org. par + interpr. par + prod. par + scénar. de + créé par réal. par éd. par ss la dir. de diff --git a/locales/hi-IN.xml b/locales/hi-IN.xml --- a/locales/hi-IN.xml +++ b/locales/hi-IN.xml @@ -20,6 +20,33 @@ + advance online publication + album + audio recording + film + henceforth + loc. cit. + no place + n.p. + no publisher + n.p. + on + op. cit. + original work published + personal communication + podcast + podcast episode + preprint + radio broadcast + radio series + radio series episode + special issue + special section + television broadcast + television series + television series episode + video + working paper अंतिम उपयोग व व अन्य @@ -61,9 +88,75 @@ scale संस्करण - + + preprint + journal article + magazine article + newspaper article + bill + book + broadcast + book chapter + classic + collection + dataset + document + entry + dictionary entry + encyclopedia entry + event + + graphic + hearing + interview + legal case + legislation + manuscript + map + video recording + musical score + pamphlet + conference paper + patent + performance + periodical + personal communication + post + blog post + regulation + report + review + book review + software + audio recording + presentation + standard + thesis + treaty + webpage + + + journal art. + mag. art. + newspaper art. + bk. + bk. chap. + doc. + + graph. + interv. + MS + video rec. + rep. + rev. + bk. rev. + audio rec. + + CE BCE + BCE + CE “ @@ -71,6 +164,9 @@ ‘ ’ – + : + , + ; वाँ @@ -103,6 +199,50 @@ दसवीं + + act + acts + + + appendix + appendices + + + article + articles + + + canon + canons + + + location + locations + + + equation + equations + + + rule + rules + + + scene + scenes + + + table + tables + + + + + + + title + titles + पुस्तक पुस्तकें @@ -159,7 +299,7 @@ अनुभाग sections - + sub verbo sub verbis @@ -173,6 +313,42 @@ + + app. + apps. + + + art. + arts. + + + loc. + locs. + + + eq. + eqs. + + + r. + rr. + + + sc. + scs. + + + tbl. + tbls. + + + + + + + tit. + tits. + bk. bks. @@ -229,7 +405,7 @@ sec. secs. - + s.v. s.vv. @@ -253,6 +429,58 @@ + + chair + chairs + + + compiler + compilers + + + contributor + contributors + + + curator + curators + + + executive producer + executive producers + + + guest + guests + + + host + hosts + + + narrator + narrators + + + organizer + organizers + + + performer + performers + + + producer + producers + + + writer + writers + + + series creator + series creators + निर्देशक directors @@ -279,6 +507,46 @@ + + comp. + comps. + + + contrib. + contribs. + + + cur. + curs. + + + exec. prod. + exec. prods. + + + narr. + narrs. + + + org. + orgs. + + + perf. + perfs. + + + prod. + prods. + + + writ. + writs. + + + cre. + cres. + dir. dirs. @@ -305,6 +573,19 @@ + chaired by + compiled by + with + curated by + executive produced by + with guest + hosted by + narrated by + organized by + performed by + produced by + written by + created by द्वारा निर्देशन सम्पादन @@ -317,6 +598,18 @@ सम्पादन & अनुवाद + comp. by + w. + cur. by + exec. prod. by + w. guest + hosted by + narr. by + org. by + perf. by + prod. by + writ. by + cre. by dir. by ed. by ed. by diff --git a/src/Citeproc/CaseTransform.hs b/src/Citeproc/CaseTransform.hs --- a/src/Citeproc/CaseTransform.hs +++ b/src/Citeproc/CaseTransform.hs @@ -17,7 +17,7 @@ where import Data.Ord () -import Data.Char (isUpper, isLower) +import Data.Char (isUpper, isLower, isLetter) import Data.Text (Text) import qualified Data.Text as T import Citeproc.Types (Lang(..)) @@ -92,8 +92,8 @@ where go mblang st chunk | isMixedCase chunk = chunk - | T.all isUpper chunk = chunk -- spec doesn't say this but tests do - -- textcase_TitleCapitalization.txt + | T.all (\c -> isUpper c || not (isLetter c)) chunk = chunk + -- spec doesn't say this but tests do: textcase_TitleCapitalization.txt | st == StartSentence || st == Start = capitalizeText mblang $ Unicode.toLower mblang chunk | st == AfterWordEnd diff --git a/src/Citeproc/Eval.hs b/src/Citeproc/Eval.hs --- a/src/Citeproc/Eval.hs +++ b/src/Citeproc/Eval.hs @@ -1028,6 +1028,7 @@ Just . normalizeSortKey . mconcat . intersperse "," . map T.unwords <$> mapM getNamePartSortOrder ns Just (DateVal d) -> return $ Just [T.toLower $ dateToText d] + Just SubstitutedVal -> return Nothing -- Note: we do a case-insensitive sort (using toCaseFold): normalizeSortKey :: Text -> [Text] @@ -1673,7 +1674,7 @@ modify $ \st -> -- delete variables so they aren't used again... st{ stateReference = let Reference id' type' d' m' = stateReference st - in Reference id' type' d' (foldr M.delete m' vars) } + in Reference id' type' d' (foldr (\v -> M.insert v SubstitutedVal) m' vars) } -- Numbers with prefixes or suffixes are never ordinalized -- or rendered in roman numerals (e.g. “2E” remains “2E). @@ -1742,8 +1743,6 @@ | ". " `T.isPrefixOf` T.dropWhile isLetter loc -> return NullOutput | otherwise -> getTerm "page" (TextVal loc) - ("page", Just loc, _) -> - getTerm "page" (TextVal loc) _ -> case lookupVariable var' ref of Nothing -> return NullOutput Just x -> getTerm (fromVariable var) x @@ -2214,8 +2213,9 @@ then label ++ names'' else names'' ++ label -formatNames _ _ _ (var, Just _) = do - warn $ "ignoring non-name value for variable " <> fromVariable var +formatNames _ _ _ (var, Just x) = do + when (x /= SubstitutedVal) $ + warn $ "ignoring non-name value for variable " <> fromVariable var return NullOutput formatNames _ _ _ (_, Nothing) = return NullOutput @@ -2504,14 +2504,15 @@ VarCount oldVars oldNonempty <- gets stateVarCount xs <- mconcat <$> mapM eElement els VarCount newVars newNonempty <- gets stateVarCount + let isempty = newVars /= oldVars && newNonempty == oldNonempty + -- see -- https://github.com/citation-style-language/documentation/blob/master/specification.rst#group -- "When a cs:group contains a child cs:macro, if the cs:macro is -- non-empty, it is treated as a non-empty variable for the purposes of -- determining suppression of the outer cs:group." - when (isMacro && not (all (== NullOutput) xs)) $ - updateVarCount 1 1 - return $ if oldVars == newVars || newNonempty > oldNonempty + when (isMacro && not isempty) $ updateVarCount 1 1 + return $ if not isempty then formatted formatting xs else NullOutput @@ -2660,7 +2661,7 @@ askVariable v = do ref <- gets stateReference case lookupVariable v ref of - Just x | isNonEmpty x -> do + Just x | isNonEmpty x && x /= SubstitutedVal -> do updateVarCount 1 1 return $ Just x _ -> do diff --git a/src/Citeproc/Types.hs b/src/Citeproc/Types.hs --- a/src/Citeproc/Types.hs +++ b/src/Citeproc/Types.hs @@ -1081,8 +1081,9 @@ TextVal Text -- ^ Plain text value | FancyVal a -- ^ Formatted value with parameterized type | NumVal Int -- ^ Numerical value - | NamesVal [Name] -- ^ Structured names - | DateVal Date -- ^ Structured date + | NamesVal [Name] -- ^ Structured names + | DateVal Date -- ^ Structured date + | SubstitutedVal -- ^ Value suppressed through substitution deriving (Show, Ord, Eq, Functor, Foldable, Traversable) instance ToJSON a => ToJSON (Val a) where @@ -1091,6 +1092,7 @@ toJSON (NumVal n) = toJSON n toJSON (NamesVal ns) = toJSON ns toJSON (DateVal d) = toJSON d + toJSON SubstitutedVal = toJSON () valToText :: CiteprocOutput a => Val a -> Maybe Text valToText (TextVal x) = Just x diff --git a/test/Spec.hs b/test/Spec.hs --- a/test/Spec.hs +++ b/test/Spec.hs @@ -28,7 +28,7 @@ import Data.Aeson ((.:?), (.!=)) import Data.Text.Encoding (decodeUtf8) import System.FilePath -import Data.Maybe (fromMaybe) +import Data.Maybe (fromMaybe, isJust) import Text.Printf (printf) #if !MIN_VERSION_base(4,11,0) import Data.Semigroup @@ -177,9 +177,9 @@ -> Text -> StateT Counts IO TestResult compareTest test actual = do - let expected = case citations test of - Just _ -> removeCitationNums $ result test - Nothing -> result test + let expected = if mode test == "citation" && isJust (citations test) + then removeCitationNums $ result test + else result test if actual == expected then do modify $ \st -> st{ passed = category test : passed st } @@ -340,7 +340,7 @@ (length (skipped counts)) case length (failed counts) + length (errored counts) of 0 -> exitSuccess - n | n <= 65 -> do + n | n <= 64 -> do putStrLn "We have passed all the CSL tests we expect to..." exitSuccess | otherwise -> exitWith $ ExitFailure n diff --git a/test/extra/issue_101.txt b/test/extra/issue_101.txt new file mode 100644 --- /dev/null +++ b/test/extra/issue_101.txt @@ -0,0 +1,247 @@ +>>===== MODE =====>> +bibliography +<<===== MODE =====<< + + + + +>>===== RESULT =====>> +
+
AUTHOR EDITOR Blockley, D. AUTHOR EDITOR, 2021. Engineering: a very short introduction. W.M. Haynes, ed. AUTHOR EDITOR. Oxford: Oxford University Press.
+
NO_AUTHOR EDITOR Haynes, W.M., ed. NO_AUTHOR EDITOR, 2014. CRC handbook of chemistry and physics. Boca Raton, Fla.: CRC Press/Taylor and Francis.
+
+<<===== RESULT =====<< + + +>>===== CSL =====>> + + +<<===== CSL =====<< + + +>>===== CITATION-ITEMS =====>> +[ [ {"id":"haynes2014crc"}, {"id":"blockley2021evs"} ] ] +<<===== CITATION-ITEMS =====<< + + + +>>===== INPUT =====>> +[ + { + "editor": [ + { + "family": "Haynes", + "given": "W. M." + } + ], + "id": "haynes2014crc", + "issued": { + "date-parts": [ + [ + 2014 + ] + ] + }, + "publisher": "CRC Press/Taylor and Francis", + "publisher-place": "Boca Raton, Fla.", + "title": "CRC handbook of chemistry and physics", + "type": "book" + }, + { + "author": [ + { + "family": "Blockley", + "given": "D." + } + ], + "editor": [ + { + "family": "Haynes", + "given": "W. M." + } + ], + "id": "blockley2021evs", + "issued": { + "date-parts": [ + [ + 2021 + ] + ] + }, + "publisher": "Oxford University Press", + "publisher-place": "Oxford", + "short-title": "Engineering", + "title": "Engineering: a very short introduction", + "type": "book" + } +] +<<===== INPUT =====<< + + +>>===== VERSION =====>> +1.0 +<<===== VERSION =====<< + diff --git a/test/extra/issue_107.txt b/test/extra/issue_107.txt new file mode 100644 --- /dev/null +++ b/test/extra/issue_107.txt @@ -0,0 +1,229 @@ +>>===== MODE =====>> +citation +<<===== MODE =====<< + + + + +>>===== RESULT =====>> +pp. 3–17, at p. 15 +pp. 120–154, at pp. 123–124 +pp. 380–387, at p. 281 +<<===== RESULT =====<< + + +>>===== CSL =====>> + + +<<===== CSL =====<< + + +>>===== CITATION-ITEMS =====>> +[ [ {"id":"latourette_community_1938", "locator":"15"} ], + [ {"id":"oldham_responsible_1948", "locator":"123-124"} ], + [ {"id":"barbour_justice_1979", "locator":"281"} ] +] +<<===== CITATION-ITEMS =====<< + + +>>===== INPUT =====>> +[ + { + "DOI": "10.1111/j.1758-6623.1979.tb02528.x", + "ISSN": "130796", + "URL": "http://libezproxy.open.ac.uk/login?url=https://search.ebscohost.com/login.aspx?direct=true&db=a9h&AN=6431771&site=ehost-live&scope=site", + "accessed": { + "date-parts": [ + [ + 2021, + 1, + 19 + ] + ] + }, + "author": [ + { + "family": "Barbour", + "given": "Ian G." + } + ], + "citation-key": "barbour_justice_1979", + "container-title": "Ecumenical Review", + "container-title-short": "Ecumenical Review", + "id": "barbour_justice_1979", + "issue": "4", + "issued": { + "date-parts": [ + [ + 1979, + 10 + ] + ] + }, + "language": "en-GB", + "page": "380-387", + "publisher": "Wiley-Blackwell", + "source": "EBSCOhost", + "title": "Justice, participation and sustainability at MIT", + "title-short": "Justice, participation and sustainability", + "type": "article-journal", + "volume": "31" + }, + { + "author": [ + { + "family": "Latourette", + "given": "Kenneth S." + } + ], + "citation-key": "latourette_community_1938", + "collection-number": "5", + "collection-title": "Church, community and state", + "container-title": "Church and community", + "editor": [ + { + "family": "Latourette", + "given": "Kenneth S." + }, + { + "family": "Barker", + "given": "Ernest" + }, + { + "family": "Boegner", + "given": "Marc" + }, + { + "family": "Lilje", + "given": "Hanns" + }, + { + "family": "Björkquist", + "given": "Manfred" + }, + { + "family": "Zankov", + "given": "Stefan" + }, + { + "family": "Aubrey", + "given": "Edwin E." + }, + { + "family": "Douglass", + "given": "H. Paul" + } + ], + "event-place": "Chicago", + "id": "latourette_community_1938", + "issued": { + "date-parts": [ + [ + 1938 + ] + ] + }, + "language": "en-GB", + "page": "3-17", + "publisher": "Willett, Clark & Company", + "publisher-place": "Chicago", + "title": "Community and church: an historical survey and interpretation", + "title-short": "Community and church", + "type": "chapter" + }, + { + "author": [ + { + "family": "Oldham", + "given": "J. H." + } + ], + "citation-key": "oldham_responsible_1948", + "collection-number": "3", + "collection-title": "Man’s disorder and God’s design", + "container-title": "The church and the disorder of society", + "editor": [ + { + "family": "Bates", + "given": "S." + }, + { + "family": "Bennett", + "given": "J. C." + }, + { + "family": "Bliss", + "given": "Kathleen" + }, + { + "family": "Brunner", + "given": "Emil" + }, + { + "family": "Ellul", + "given": "Jacques" + }, + { + "family": "Niebuhr", + "given": "Reinhold" + }, + { + "family": "Oldham", + "given": "J. H." + }, + { + "family": "Patijn", + "given": "C. L." + }, + { + "family": "Thomas", + "given": "M. M." + }, + { + "family": "Urwin", + "given": "E. C." + } + ], + "event-place": "London", + "id": "oldham_responsible_1948", + "issued": { + "date-parts": [ + [ + 1948 + ] + ] + }, + "language": "en-GB", + "page": "120-154", + "publisher": "SCM Press", + "publisher-place": "London", + "title": "A responsible society", + "title-short": "Responsible society", + "type": "chapter" + } +] +<<===== INPUT =====<< + + +>>===== VERSION =====>> +1.0 +<<===== VERSION =====<< + diff --git a/test/extra/issue_108.txt b/test/extra/issue_108.txt new file mode 100644 --- /dev/null +++ b/test/extra/issue_108.txt @@ -0,0 +1,270 @@ +>>===== MODE =====>> +bibliography +<<===== MODE =====<< + + + +>>===== RESULT =====>> +
+
Stanze in lode della donna brutta. 1547.
+
+<<===== RESULT =====<< + + +>>===== CITATIONS =====>> +[[ { "id":"stanze"} ]] +<<===== CITATIONS =====<< + + + + +>>===== CSL =====>> + + +<<===== CSL =====<< + + +>>===== INPUT =====>> +[ + { + "id": "stanze", + "issued": { + "date-parts": [ + [ + 1547 + ] + ] + }, + "language": "it-IT", + "publisher-place": "Florence", + "title": "Stanze in lode della donna brutta", + "type": "book" + } +] +<<===== INPUT =====<< + + +>>===== VERSION =====>> +1.0 +<<===== VERSION =====<< +