1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
{-# LANGUAGE TupleSections #-}
{-# LANGUAGE OverloadedStrings #-}
{- |
Module : Text.Pandoc.Readers.EndNote
Copyright : Copyright (C) 2022-2024 John MacFarlane
License : GNU GPL, version 2 or above
Maintainer : John MacFarlane <[email protected]>
Stability : alpha
Portability : portable
Parses EndNote XML bibliographies into a Pandoc document
with empty body and `references` and `nocite` fields
in the metadata. A wildcard `nocite` is used so that
if the document is rendered in another format, the
entire bibliography will be printed.
-}
module Text.Pandoc.Readers.EndNote
( readEndNoteXML
, readEndNoteXMLCitation
)
where
import Text.Pandoc.Options
import Text.Pandoc.Definition
import Citeproc (Reference(..), ItemId(..), Val(..), Date(..), DateParts(..))
import qualified Citeproc
import Text.Pandoc.Builder as B
import Text.Pandoc.Error (PandocError(..))
import Text.Pandoc.Class (PandocMonad)
import Text.Pandoc.Citeproc.MetaValue (referenceToMetaValue)
import Text.Pandoc.Sources (Sources(..), ToSources(..), sourcesToText)
import Text.Pandoc.Citeproc.Name (toName, NameOpts(..))
import Control.Applicative ((<|>))
import Control.Monad.Except (throwError)
import Control.Monad (mzero, unless)
import Text.Pandoc.XML.Light
( filterElementName,
strContent,
QName(qName),
Element(..),
Content(..),
CData(..),
filterElementsName,
filterChildName,
filterChildrenName,
findAttrBy,
parseXMLElement )
import qualified Data.Text.Lazy as TL
import qualified Data.Text as T
import Data.Text (Text)
import qualified Data.Map as M
import Safe (readMay)
-- | Read EndNote XML from an input string and return a Pandoc document.
-- The document will have only metadata, with an empty body.
-- The metadata will contain a `references` field with the
-- bibliography entries, and a `nocite` field with the wildcard `[@*]`.
readEndNoteXML :: (PandocMonad m, ToSources a)
=> ReaderOptions -> a -> m Pandoc
readEndNoteXML _opts inp = do
let sources = toSources inp
refs <- readEndNoteXMLReferences sources >>= mapM (traverse (return . text))
return $
setMeta "nocite" (cite [Citation {citationId = "*"
, citationPrefix = []
, citationSuffix = []
, citationMode = NormalCitation
, citationNoteNum = 0
, citationHash = 0}] (str "[@*]")) $
setMeta "references" (map referenceToMetaValue refs) $
B.doc mempty
readEndNoteXMLCitation :: PandocMonad m
=> Text -> m (Citeproc.Citation Text)
readEndNoteXMLCitation xml = do
tree <- either (throwError . PandocXMLError "EndNote references") return $
parseXMLElement (TL.fromStrict xml)
unless (qName (elName tree) == "EndNote") $
throwError $ PandocXMLError "EndNote references" "Expected EndNote element"
let items = map toCitationItem $ filterElementsName (name "Cite") tree
return $ Citeproc.Citation{
Citeproc.citationId = Nothing
, Citeproc.citationResetPosition = False
, Citeproc.citationPrefix = Nothing
, Citeproc.citationSuffix = Nothing
, Citeproc.citationNoteNumber = Nothing
, Citeproc.citationItems = items
}
readEndNoteXMLReferences :: PandocMonad m
=> Sources -> m [Reference Text]
readEndNoteXMLReferences sources = do
tree <- either (throwError . PandocXMLError "EndNote references") return $
parseXMLElement (TL.fromStrict . sourcesToText $ sources)
let records = filterElementsName (name "record") tree
return $ map recordToReference records
toCitationItem :: Element -> Citeproc.CitationItem Text
toCitationItem el =
Citeproc.CitationItem{ Citeproc.citationItemId =
maybe mempty referenceId mbref
, Citeproc.citationItemLabel = Nothing
, Citeproc.citationItemLocator = mbpages
, Citeproc.citationItemType = Citeproc.NormalCite
, Citeproc.citationItemPrefix = mbprefix
, Citeproc.citationItemSuffix = mbsuffix
, Citeproc.citationItemData = mbref
}
where
mbref = recordToReference <$> filterChildName (name "record") el
mbprefix = getText <$> filterChildName (name "Prefix") el
mbsuffix = getText <$> filterChildName (name "Suffix") el
mbpages = getText <$> filterChildName (name "Pages") el
name :: Text -> (QName -> Bool)
name t = (== t) . qName
getText :: Element -> Text
getText el = getText' (Elem el)
where
getText' (Elem el') = mconcat $ map getText' $ elContent el'
getText' (Text cd) = cdData cd
getText' (CRef _) = mempty
recordToReference :: Element -> Reference Text
recordToReference e =
Reference{ referenceId = ItemId refid,
referenceType = reftype,
referenceDisambiguation = Nothing,
referenceVariables = refvars }
where
-- get strContent, recursing inside style elements:
refid = maybe mempty (T.strip . strContent)
(filterElementName (name "key") e
<|> filterElementName (name "rec-number") e)
reftype = maybe "document" toCslReferenceType
(filterElementName (name "ref-type") e >>=
findAttrBy (name "name"))
authors =
filterChildrenName (name "contributors") e >>=
filterChildrenName (name "authors") >>=
filterChildrenName (name "author") >>=
toName NameOpts{ nameOptsPrefixIsNonDroppingParticle = False
, nameOptsUseJuniorComma = False }
. B.toList . B.text . T.strip . getText
titles = do
x <- filterChildrenName (name "titles") e
(key, name') <- [("title", "title"),
("container-title", "secondary-title")]
(key,) . FancyVal . T.strip . getText <$>
filterChildrenName (name name') x
pages = ("pages",) . FancyVal . T.strip . getText <$>
filterChildrenName (name "pages") e
volume = ("volume",) . FancyVal . T.strip . getText <$>
filterChildrenName (name "volume") e
number = ("number",) . FancyVal . T.strip . getText <$>
filterChildrenName (name "number") e
isbn = ("isbn",) . FancyVal . T.strip . getText <$>
filterChildrenName (name "isbn") e
publisher = ("publisher",) . FancyVal . T.strip . getText <$>
filterChildrenName (name "publisher") e
originalPublisher =
("original-publisher",) . FancyVal . T.strip . getText <$>
filterChildrenName (name "orig-pub") e
publisherPlace =
("publisher-place",) . FancyVal . T.strip . getText <$>
filterChildrenName (name "pub-location") e
abstract = ("abstract",) . FancyVal . T.strip . getText <$>
filterChildrenName (name "abstract") e
dates = ("issued",) . toDate <$> filterChildrenName (name "dates") e
toDate e' = DateVal $
Date { dateParts = toDateParts e'
, dateCirca = False
, dateSeason = Nothing
, dateLiteral = Nothing }
toDateParts e' = do
x <- filterChildrenName (name "year") e'
case readMay . T.unpack . T.strip . getText $ x of
Nothing -> mzero
Just y -> return $ DateParts [y]
refvars = M.fromList $
[ ("author", NamesVal authors) | not (null authors) ] ++
titles ++
pages ++
volume ++
number ++
isbn ++
dates ++
publisher ++
originalPublisher ++
publisherPlace ++
abstract
toCslReferenceType :: Text -> Text
toCslReferenceType t =
case t of
"Aggregated Database" -> "dataset"
"Ancient Text" -> "classic"
"Artwork" -> "graphic"
"Audiovisual Material" -> "graphic"
"Bill" -> "legislation"
"Blog" -> "post-weblog"
"Book" -> "book"
"Book Section" -> "chapter"
"Case" -> "legal_case"
"Catalog" -> "document"
"Chart or Table" -> "graphic"
"Classical Work" -> "classic"
"Computer program" -> "software"
"Conference Paper" -> "article"
"Conference Proceedings" -> "periodical"
"Dataset" -> "dataset"
"Dictionary" -> "book"
"Edited Book" -> "book"
"Electronic Article" -> "article"
"Electronic Book" -> "book"
"Electronic Book Section" -> "chapter"
"Encyclopedia" -> "book"
"Equation" -> "document"
"Figure" -> "graphic"
"Film or Broadcast" -> "motion_picture"
"Government Document" -> "document"
"Grant" -> "document"
"Hearing" -> "hearing"
"Interview" -> "interview"
"Journal Article" -> "article-journal"
"Legal Rule or Regulation" -> "regulation"
"Magazine Article" -> "article-magazine"
"Manuscript" -> "manuscript"
"Map" -> "map"
"Music" -> "musical_score"
"Newspaper Article" -> "article-newspaper"
"Online Database" -> "dataset"
"Online Multimedia" -> "webpage"
"Pamphlet" -> "pamphlet"
"Patent" -> "patent"
"Personal Communication" -> "personal_communication"
"Podcast" -> "document"
"Press Release" -> "report"
"Report" -> "report"
"Serial" -> "periodical"
"Standard" -> "standard"
"Statute" -> "legislation"
"Thesis" -> "thesis"
"Unpublished Work" -> "unpublished"
"Web Page" -> "webpage"
_ -> "document"
|
