Debian Codegraph @

texmf-dist/doc/man/man1/ltx2crossrefxml.1

raw
1 .\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sp \" Vertical space (when we can't use .PP)
6 .if t .sp .5v
7 .if n .sp
8 ..
9 .de Vb \" Begin verbatim text
10 .ft CW
11 .nf
12 .ne \\$1
13 ..
14 .de Ve \" End verbatim text
15 .ft R
16 .fi
17 ..
18 .\" Set up some character translations and predefined strings. \*(-- will
19 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
20 .\" double quote, and \*(R" will give a right double quote. \*(C+ will
21 .\" give a nicer C++. Capital omega is used to do unbreakable dashes and
22 .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
23 .\" nothing in troff, for use with C<>.
24 .tr \(*W-
25 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
26 .ie n \{\
27 . ds -- \(*W-
28 . ds PI pi
29 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
30 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
31 . ds L" ""
32 . ds R" ""
33 . ds C` ""
34 . ds C' ""
35 'br\}
36 .el\{\
37 . ds -- \|\(em\|
38 . ds PI \(*p
39 . ds L" ``
40 . ds R" ''
41 . ds C`
42 . ds C'
43 'br\}
44 .\"
45 .\" Escape single quotes in literal strings from groff's Unicode transform.
46 .ie \n(.g .ds Aq \(aq
47 .el .ds Aq '
48 .\"
49 .\" If the F register is >0, we'll generate index entries on stderr for
50 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
51 .\" entries marked with X<> in POD. Of course, you'll have to process the
52 .\" output yourself in some meaningful fashion.
53 .\"
54 .\" Avoid warning from groff about undefined register 'F'.
55 .de IX
56 ..
57 .nr rF 0
58 .if \n(.g .if rF .nr rF 1
59 .if (\n(rF:(\n(.g==0)) \{\
60 . if \nF \{\
61 . de IX
62 . tm Index:\\$1\t\\n%\t"\\$2"
63 ..
64 . if !\nF==2 \{\
65 . nr % 0
66 . nr F 2
67 . \}
68 . \}
69 .\}
70 .rr rF
71 .\"
72 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
73 .\" Fear. Run. Save yourself. No user-serviceable parts.
74 . \" fudge factors for nroff and troff
75 .if n \{\
76 . ds #H 0
77 . ds #V .8m
78 . ds #F .3m
79 . ds #[ \f1
80 . ds #] \fP
81 .\}
82 .if t \{\
83 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
84 . ds #V .6m
85 . ds #F 0
86 . ds #[ \&
87 . ds #] \&
88 .\}
89 . \" simple accents for nroff and troff
90 .if n \{\
91 . ds ' \&
92 . ds ` \&
93 . ds ^ \&
94 . ds , \&
95 . ds ~ ~
96 . ds /
97 .\}
98 .if t \{\
99 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
100 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
101 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
102 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
103 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
104 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
105 .\}
106 . \" troff and (daisy-wheel) nroff accents
107 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
108 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
109 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
110 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
111 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
112 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
113 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
114 .ds ae a\h'-(\w'a'u*4/10)'e
115 .ds Ae A\h'-(\w'A'u*4/10)'E
116 . \" corrections for vroff
117 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
118 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
119 . \" for low resolution devices (crt and lpr)
120 .if \n(.H>23 .if \n(.V>19 \
121 \{\
122 . ds : e
123 . ds 8 ss
124 . ds o a
125 . ds d- d\h'-1'\(ga
126 . ds D- D\h'-1'\(hy
127 . ds th \o'bp'
128 . ds Th \o'LP'
129 . ds ae ae
130 . ds Ae AE
131 .\}
132 .rm #[ #] #H #V #F C
133 .\" ========================================================================
134 .\"
135 .IX Title "ltx2crossrefxml 1"
136 .TH ltx2crossrefxml 1 "2025-09-04" "" "LATEX CROSSREFWARE"
137 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
138 .\" way too many mistakes in technical documents.
139 .if n .ad l
140 .nh
141 .SH "NAME"
142 ltx2crossrefxml.pl \- create XML files for submitting to crossref.org
143 .SH "SYNOPSIS"
144 .IX Header "SYNOPSIS"
145 ltx2crossrefxml [\fB\-\-debug\fR] [\fB\-c\fR \fIconfig_file\fR] [\fB\-o\fR \fIoutput_file\fR] [\fB\-input\-is\-xml\fR]
146 \fIlatex_file1\fR \fIlatex_file2\fR ...
147 .SH "OPTIONS"
148 .IX Header "OPTIONS"
149 .IP "\fB\-c\fR \fIconfig_file\fR" 4
150 .IX Item "-c config_file"
151 Configuration file. If this file is absent, defaults are used.
152 See below for its format.
153 .IP "\fB\-o\fR \fIoutput_file\fR" 4
154 .IX Item "-o output_file"
155 Output file. If this option is not used, the \s-1XML\s0 is output to stdout.
156 .IP "\fB\-rpi\-is\-xml\fR" 4
157 .IX Item "-rpi-is-xml"
158 Do not transform author and title input strings, assume they are valid \s-1XML.\s0
159 .IP "\fB\-\-debug\fR" 4
160 .IX Item "--debug"
161 Output some progress reports.
162 .PP
163 The usual \f(CW\*(C`\-\-help\*(C'\fR and \f(CW\*(C`\-\-version\*(C'\fR options are also supported. Options
164 can begin with either \f(CW\*(C`\-\*(C'\fR or \f(CW\*(C`\-\-\*(C'\fR, and ordered arbitrarily.
165 .SH "DESCRIPTION"
166 .IX Header "DESCRIPTION"
167 For each given \fIlatex_file\fR, this script reads \f(CW\*(C`.rpi\*(C'\fR and (if they
168 exist) \f(CW\*(C`.bbl\*(C'\fR and \f(CW\*(C`.aux\*(C'\fR files and outputs corresponding \s-1XML\s0 that
169 can be uploaded to Crossref (<https://crossref.org>). Any extension
170 of \fIlatex_file\fR is ignored, and \fIlatex_file\fR itself is not read (and
171 need not even exist).
172 .PP
173 Each \f(CW\*(C`.rpi\*(C'\fR file specifies the metadata for a single article to be
174 uploaded to Crossref (a \f(CW\*(C`journal_article\*(C'\fR element in their schema); an
175 example is below. These files are output by the \f(CW\*(C`resphilosophica\*(C'\fR
176 package (<https://ctan.org/pkg/resphilosophica>), \f(CW\*(C`aomart\*(C'\fR package
177 (<https://ctan.org/pkg/aomart>), the TUGboat publication procedure
178 (<https://tug.org/TUGboat/repository.html>) and other packages. They
179 can also be created by hand or by whatever other method you implement.
180 .PP
181 Any \f(CW\*(C`.bbl\*(C'\fR, \f(CW\*(C`.aux\*(C'\fR, and \f(CW\*(C`.bib\*(C'\fR files are used for the citation
182 information in the output \s-1XML.\s0 See the \s-1CITATIONS\s0 section below.
183 .PP
184 Unless \f(CW\*(C`\-\-rpi\-is\-xml\*(C'\fR is specified, for all text (authors, title,
185 citations), standard TeX control sequences are replaced with plain text
186 or \s-1UTF\-8\s0 or eliminated, as appropriate. The \f(CW\*(C`LaTeX::ToUnicode::convert\*(C'\fR
187 routine is used for this (<https://ctan.org/pkg/bibtexperllibs>).
188 Tricky TeX control sequences will almost surely not be handled
189 correctly.
190 .PP
191 If \f(CW\*(C`\-\-rpi\-is\-xml\*(C'\fR is given, the author and title strings from the rpi
192 files are output as-is, assuming they are valid \s-1XML\s0; no checking is
193 done.
194 .PP
195 Citation text from \f(CW\*(C`.bbl\*(C'\fR files is always converted from LaTeX to plain
196 text.
197 .PP
198 This script just writes an \s-1XML\s0 file. It's up to you to do the
199 uploading to Crossref; for example, you can use their Java tool
200 \&\f(CW\*(C`crossref\-upload\-tool.jar\*(C'\fR
201 (<https://www.crossref.org/education/member\-setup/direct\-deposit\-xml/https\-post>).
202 .PP
203 For the definition of the Crossref schema currently output by this
204 script, see
205 <https://data.crossref.org/reports/help/schema_doc/5.4.0/index.html>
206 with additional links and information at
207 <https://www.crossref.org/documentation/schema\-library/metadata\-deposit\-schema\-5\-4\-0/>.
208 .SH "CONFIGURATION FILE FORMAT"
209 .IX Header "CONFIGURATION FILE FORMAT"
210 The configuration file is read as Perl code. Thus, comment lines
211 starting with \f(CW\*(C`#\*(C'\fR and blank lines are ignored. The other lines are
212 typically assignments in the form (spaces are optional):
213 .PP
214 .Vb 1
215 \& $variable = value ;
216 .Ve
217 .PP
218 Usually the value is a \f(CW"string"\fR enclosed in \s-1ASCII\s0 double-quote or
219 single-quote characters, per Perl syntax. The idea is to specify the
220 user-specific and journal-specific values needed for the Crossref
221 upload. The variables which are used are these:
222 .PP
223 .Vb 7
224 \& $depositorName = "Depositor Name";
225 \& $depositorEmail = \*([email protected]\*(Aq;
226 \& $registrant = \*(AqRegistrant\*(Aq; # required, organization name
227 \& $fullTitle = "FULL TITLE"; # required, journal name
228 \& $issn = "1234\-5678"; # required, ISSN
229 \& $abbrevTitle = "ABBR. TTL."; # optional, abbreviated journal name
230 \& $coden = "CODEN"; # optional
231 .Ve
232 .PP
233 For a given run, all \f(CW\*(C`.rpi\*(C'\fR data read is assumed to belong to the
234 journal that is specified in the configuration file. More precisely, the
235 configuration data is written as a \f(CW\*(C`journal_metadata\*(C'\fR element, with
236 given \f(CW\*(C`full_title\*(C'\fR, \f(CW\*(C`issn\*(C'\fR, etc., and then each \f(CW\*(C`.rpi\*(C'\fR is written as
237 \&\f(CW\*(C`journal_issue\*(C'\fR plus \f(CW\*(C`journal_article\*(C'\fR elements.
238 .PP
239 The configuration file can also define a Perl function
240 \&\f(CW\*(C`LaTeX_ToUnicode_convert_hook\*(C'\fR. If it is defined, it is called at the
241 beginning of the procedure that converts LaTeX text to Unicode, which is
242 done with the LaTeX::ToUnicode module, from the \f(CW\*(C`bibtexperllibs\*(C'\fR
243 package (<https://ctan.org/pkg/bibtexperllibs>). The function must
244 accept one string (the LaTeX text), and return one string (presumably
245 the transformed string). The standard conversions are then applied to
246 the returned string, so the configured function need only handle special
247 cases, such as control sequences particular to the journal at hand.
248 (See TUGboat's \f(CW\*(C`ltx2crossrefxml\-tugboat.cfg\*(C'\fR for an example.)
249 .PP
250 The configuration file can also define a hash \f(CW\*(C`BibentryToCrossref\*(C'\fR) that
251 maps Crossref entry types to BibTeX entry types used in the
252 bibliography processing (see \s-1CITATIONS\s0), for example
253 .PP
254 .Vb 2
255 \& %BibentryToCrossref = (\*(AqWEBPAGE\*(Aq => \*(Aqother\*(Aq,
256 \& \*(AqMISC\*(Aq => \*(Aqother\*(Aq);
257 .Ve
258 .PP
259 The keys in this hash must be in the upper case, while the entries
260 must be in the lower case.
261 .SH "RPI FILE FORMAT"
262 .IX Header "RPI FILE FORMAT"
263 Here's the (relevant part of the) \f(CW\*(C`.rpi\*(C'\fR file corresponding to the
264 \&\f(CW\*(C`rpsample.tex\*(C'\fR example in the \f(CW\*(C`resphilosophica\*(C'\fR package
265 (<https://ctan.org/pkg/resphilosophica>):
266 .PP
267 .Vb 10
268 \& %authors=Boris Veytsman\eand A. U. Th{\eo }r\eand C. O. R\e"espondent
269 \& %title=A Sample Paper:\e\e \eemph {A Template}
270 \& %year=2012
271 \& %volume=90
272 \& %issue=1\-\-2
273 \& %startpage=1
274 \& %endpage=1
275 \& %doi=10.11612/resphil.A31245
276 \& %paperUrl=http://borisv.lk.net/paper12
277 \& %publicationType=full_text
278 .Ve
279 .PP
280 Other lines, some not beginning with %, are ignored (and not shown).
281 For more details on processing, see the code.
282 .PP
283 The \f(CW%paperUrl\fR value is what will be associated with the given \f(CW%doi\fR
284 (output as the \f(CW\*(C`resource\*(C'\fR element). Crossref strongly recommends that
285 the url be for a so-called landing page, and not directly for a pdf
286 (<https://www.crossref.org/education/member\-setup/creating\-a\-landing\-page/>).
287 Special case: if the url is not specified,
288 and the journal is \fIRes\ Philosophica\fR,
289 a special-purpose search url using pdcnet.org is returned.
290 Any other journal must always specify this.
291 .PP
292 The \f(CW%authors\fR field is split at \f(CW\*(C`\eand\*(C'\fR (ignoring whitespace before
293 and after), and output as the \f(CW\*(C`contributors\*(C'\fR element, using
294 \&\f(CW\*(C`sequence="first"\*(C'\fR for the first listed, \f(CW\*(C`sequence="additional"\*(C'\fR for
295 the remainder. The authors are parsed using \f(CW\*(C`BibTeX::Parser::Author\*(C'\fR
296 (<https://ctan.org/pkg/bibtexperllibs>).
297 .PP
298 If the \f(CW%publicationType\fR is not specified, it defaults to
299 \&\f(CW\*(C`full_text\*(C'\fR, since that has historically been the case; \f(CW\*(C`full_text\*(C'\fR
300 can also be given explicitly. The other values allowed by the Crossref
301 schema are \f(CW\*(C`abstract_only\*(C'\fR and \f(CW\*(C`bibliographic_record\*(C'\fR. Finally, if the
302 value is \f(CW\*(C`omit\*(C'\fR, the \f(CW\*(C`publication_type\*(C'\fR attribute is omitted entirely
303 from the given \f(CW\*(C`journal_article\*(C'\fR element.
304 .PP
305 Each \f(CW\*(C`.rpi\*(C'\fR must contain information for only one article, but multiple
306 files can be read in a single run. It would not be difficult to support
307 multiple articles in a single \f(CW\*(C`.rpi\*(C'\fR file, but it makes debugging and
308 error correction easier to keep the input to one article per file.
309 .SS "\s-1MORE ABOUT AUTHOR NAMES\s0"
310 .IX Subsection "MORE ABOUT AUTHOR NAMES"
311 The three formats for names recognized are (not coincidentally) the same
312 as BibTeX:
313 .PP
314 .Vb 3
315 \& First von Last
316 \& von Last, First
317 \& von Last, Jr., First
318 .Ve
319 .PP
320 The forms can be freely intermixed within a single \f(CW%authors\fR line,
321 separated with \f(CW\*(C`\eand\*(C'\fR (including the backslash). Commas as name
322 separators are not supported, unlike BibTeX.
323 .PP
324 In short, you may almost always use the first form; you shouldn't if
325 either there's a Jr part, or the Last part has multiple tokens but
326 there's no von part. See the \f(CW\*(C`btxdoc\*(C'\fR (``BibTeXing'' by Oren Patashnik)
327 document for details. The authors are parsed using
328 \&\f(CW\*(C`BibTeX::Parser::Author\*(C'\fR (<https://ctan.org/pkg/bibtexperllibs>).
329 .PP
330 In the \f(CW%authors\fR line of a \f(CW\*(C`.rpi\*(C'\fR file, some secondary directives are
331 recognized, indicated by \f(CW\*(C`|\*(C'\fR characters. Easiest to explain with an
332 example:
333 .PP
334 .Vb 1
335 \& %authors=|organization|\eLaTeX\e Project Team \eand Alex Brown|orcid=123
336 .Ve
337 .PP
338 Thus: 1) if \f(CW\*(C`|organization|\*(C'\fR is specified, the author name will be output
339 as an \f(CW\*(C`organization\*(C'\fR contributor, instead of the usual \f(CW\*(C`person_name\*(C'\fR,
340 as the Crossref schema requires.
341 .PP
342 2) If \f(CW\*(C`|orcid=\f(CIvalue\f(CW|\*(C'\fR is specified, the \fIvalue\fR is output as an
343 \&\f(CW\*(C`ORCID\*(C'\fR element for that \f(CW\*(C`person_name\*(C'\fR.
344 .PP
345 These two directives, \f(CW\*(C`|organization\*(C'\fR| and \f(CW\*(C`|orcid|\*(C'\fR are mutually
346 exclusive, because that's how the Crossref schema defines them. The \f(CW\*(C`=\*(C'\fR
347 sign after \f(CW\*(C`orcid\*(C'\fR is required, while all spaces after the \f(CW\*(C`orcid\*(C'\fR
348 keyword are ignored. Other than that, the \s-1ORCID\s0 value is output
349 literally. (E.g., the \s-1ORCID\s0 value of \f(CW123\fR above is clearly invalid,
350 but it would be output anyway, with no warning.)
351 .PP
352 Extra \f(CW\*(C`|\*(C'\fR characters, at the beginning or end of the entire \f(CW%authors\fR
353 string, or doubled in the middle, are accepted and ignored. Whitespace
354 is ignored around all \f(CW\*(C`|\*(C'\fR characters.
355 .SH "CITATIONS"
356 .IX Header "CITATIONS"
357 Each \f(CW\*(C`.bbl\*(C'\fR file corresponding to an input \f(CW\*(C`.rpi\*(C'\fR file is read and
358 used to output a \f(CW\*(C`citation_list\*(C'\fR element for that \f(CW\*(C`journal_article\*(C'\fR in
359 the output \s-1XML.\s0 If no \f(CW\*(C`.bbl\*(C'\fR file exists for a given \f(CW\*(C`.rpi\*(C'\fR,
360 no \f(CW\*(C`citation_list\*(C'\fR is output for that article.
361 .PP
362 The \f(CW\*(C`.bbl\*(C'\fR files are processed to create the \f(CW\*(C`unstructured_citation\*(C'\fR
363 references defined by Crossref, that is, the contents of the citation
364 (each paragraph in the \f(CW\*(C`.bbl\*(C'\fR) as a single flat string without markup
365 of any kind, including font changes.
366 .PP
367 Bibliography text is unconditionally converted from TeX to \s-1XML,\s0 via the
368 method described above. It is not unusual for the conversion to be
369 incomplete or incorrect. It is up to you to check for this; e.g., if any
370 backslashes or pairs of dollar signs remain in the output, it is most
371 likely an error.
372 .PP
373 Furthermore, it is assumed that the \f(CW\*(C`.bbl\*(C'\fR file contains a sequence of
374 references, each starting with \f(CW\*(C`\ebibitem{\f(CIKEY\f(CW}\*(C'\fR (which itself must be
375 at the beginning of a line, preceded only by whitespace), and the whole
376 bibliography ending with \f(CW\*(C`\eend{thebibliography}\*(C'\fR (similarly at the
377 beginning of a line). A \f(CW\*(C`.bbl\*(C'\fR file not following this format will not
378 produce useful results. The \f(CW\*(C`.bbl\*(C'\fR file can be created by hand, or with
379 BibTeX, or any other method, as long as it has this format.
380 .PP
381 The \f(CW\*(C`key\*(C'\fR attribute for the \f(CW\*(C`citation\*(C'\fR element is taken as the \fI\s-1KEY\s0\fR
382 argument to the \f(CW\*(C`\ebibitem\*(C'\fR command. The sequential number of the
383 citation (1, 2, ...). The argument to \f(CW\*(C`\ebibitem\*(C'\fR can be
384 empty (\f(CW\*(C`\ebibitem{}\*(C'\fR, and the sequence number will be used on its own.
385 Although TeX will not handle empty \f(CW\*(C`\ebibitem\*(C'\fR keys, it can be
386 convenient when creating a \f(CW\*(C`.bbl\*(C'\fR purely for Crossref.
387 .PP
388 The \f(CW\*(C`.rpi\*(C'\fR file is also checked for the bibliography information, in
389 this same format.
390 .PP
391 Crossref's structured citations are added as follows:
392 .ie n .IP "1. If an "".aux"" file is present, it is checked for any ""\ebibdata"" commands. The ""bib"" files in these commands are read, and the information there is used to generate \s-1XML\s0 entries. The script uses ""kpsewhich"" to look for the bib files, so the usual BibTeX conventions for the search paths are followed." 4
393 .el .IP "1. If an \f(CW.aux\fR file is present, it is checked for any \f(CW\ebibdata\fR commands. The \f(CWbib\fR files in these commands are read, and the information there is used to generate \s-1XML\s0 entries. The script uses \f(CWkpsewhich\fR to look for the bib files, so the usual BibTeX conventions for the search paths are followed." 4
394 .IX Item "1. If an .aux file is present, it is checked for any bibdata commands. The bib files in these commands are read, and the information there is used to generate XML entries. The script uses kpsewhich to look for the bib files, so the usual BibTeX conventions for the search paths are followed."
395 .PD 0
396 .ie n .IP "2. For any citation the corresponding entry in the ""bib"" file is processed." 4
397 .el .IP "2. For any citation the corresponding entry in the \f(CWbib\fR file is processed." 4
398 .IX Item "2. For any citation the corresponding entry in the bib file is processed."
399 .ie n .IP "3. The Crossref entry type is determined according to the algorithm describe below (""\s-1CITATION ENTRY TYPES""\s0)." 4
400 .el .IP "3. The Crossref entry type is determined according to the algorithm describe below (``\s-1CITATION ENTRY TYPES''\s0)." 4
401 .IX Item "3. The Crossref entry type is determined according to the algorithm describe below (CITATION ENTRY TYPES)."
402 .IP "4. The entry fields are used to populate structured citation." 4
403 .IX Item "4. The entry fields are used to populate structured citation."
404 .PD
405 .SS "\s-1CITATION ENTRY TYPES\s0"
406 .IX Subsection "CITATION ENTRY TYPES"
407 The current Crossref schema
408 <https://data.crossref.org/reports/help/schema_doc/5.4.0/schema_5_4_0.html>
409 defines \f(CW\*(C`type\*(C'\fR attribute for a citation. Unfortunately the list of
410 possible types does not fully coincide with the list of BibTeX entry
411 types. Therefore the script uses the following algorithm to determine
412 the Crossref entry type for a citation:
413 .ie n .IP "1. If the entry has the field ""crossrefentrytype"", it is used." 4
414 .el .IP "1. If the entry has the field \f(CWcrossrefentrytype\fR, it is used." 4
415 .IX Item "1. If the entry has the field crossrefentrytype, it is used."
416 .PD 0
417 .ie n .IP "2. Otherwise if BibTeX entry type appears in the hash ""BibentryToCrossref"") in the configuration file (""\s-1CONFIGURATION FILE FORMAT""\s0), its value is used." 4
418 .el .IP "2. Otherwise if BibTeX entry type appears in the hash \f(CWBibentryToCrossref\fR) in the configuration file (``\s-1CONFIGURATION FILE FORMAT''\s0), its value is used." 4
419 .IX Item "2. Otherwise if BibTeX entry type appears in the hash BibentryToCrossref) in the configuration file (CONFIGURATION FILE FORMAT), its value is used."
420 .IP "3. Otherwise the default mapping is used. The script knows many BibTeX entry types, and should do a good job in most cases." 4
421 .IX Item "3. Otherwise the default mapping is used. The script knows many BibTeX entry types, and should do a good job in most cases."
422 .PD
423 .SH "EXAMPLES"
424 .IX Header "EXAMPLES"
425 .Vb 2
426 \& ltx2crossrefxml.pl ../paper1/paper1.tex ../paper2/paper2.tex \e
427 \& \-o result.xml
428 \&
429 \& ltx2crossrefxml.pl \-c myconfig.cfg paper.tex \-o paper.xml
430 .Ve
431 .SH "AUTHOR"
432 .IX Header "AUTHOR"
433 Boris Veytsman <https://github.com/borisveytsman/crossrefware>
434 .SH "COPYRIGHT AND LICENSE"
435 .IX Header "COPYRIGHT AND LICENSE"
436 Copyright (C) 2012\-2025 Boris Veytsman
437 .PP
438 This is free software. You may redistribute copies of it under the
439 terms of the \s-1GNU\s0 General Public License (any version)
440 <https://www.gnu.org/licenses/gpl.html>. There is \s-1NO WARRANTY,\s0 to the
441 extent permitted by law.