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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
|
#!/usr/bin/env perl
=pod
=head1 NAME
ltx2crossrefxml.pl - a tool for creation of XML files for submitting to crossref.
=head1 SYNOPSIS
ltx2crossrefxml [B<-c> I<config_file>] [B<-o> I<output>] I<latex_file> I<latex_file> ...
=head1 OPTIONS
=over 4
=item B<-c> I<config_file>
Configuration file. If this file is absent, some defaults are used.
See below for its format.
=item B<-o> I<output>
Output file. If this option is not used, the XML is output to stdout.
=back
=head1 DESCRIPTION
The script takes a number of latex files and produces an XML file
ready for submission to Crossref. Each file must be previously processed
by LaTeX with the newest C<resphilosophica> package: the package creates
the file C<.rti> wtih the information about the bibliography.
The processing of reference list is at present rather limited: only so
called unstructured references are produced.
=head1 CONFIGURATION FILE FORMAT
The configuration file is mostly self-explanatory: it has comments
(starting with C<#>) and assginments in the form
$field = value ;
=head1 EXAMPLES
ltx2crossrefxml.pl ../paper1/paper1.tex ../paper2/paper2.tex -o result.xml
ltx2crossrefxml.pl -c myconfig.cnf paper.tex -o paper.xml
=head1 AUTHOR
Boris Veytsman
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2012-2015 Boris Veytsman
This is free software. You may redistribute copies of it under the
terms of the GNU General Public License
L<http://www.gnu.org/licenses/gpl.html>. There is NO WARRANTY, to the
extent permitted by law.
=cut
use strict;
use POSIX qw(strftime);
use Text::BibTeX;
use Text::BibTeX::Name;
use TeX::Encode;
use Encode;
use HTML::Entities;
use XML::Entities;
use File::Basename;
use File::Spec;
my $USAGE="USAGE: $0 [-c config] [-o output] file1 file2 ...\n";
my $VERSION = <<END;
ltx2crossrefxml v1.0
This is free software. You may redistribute copies of it under the
terms of the GNU General Public License
http://www.gnu.org/licenses/gpl.html. There is NO WARRANTY, to the
extent permitted by law.
$USAGE
END
use Getopt::Std;
my %opts;
getopts('c:o:hV',\%opts) or die $USAGE;
if ($opts{h} || $opts{V}){
print $VERSION;
exit 0;
}
################################################################
# Defaults and parameters
################################################################
*OUT=*STDOUT;
if (defined($opts{o})) {
open (OUT, ">$opts{o}") or die "Cannot open file $opts{o} for writing\n";
}
our $depositorName='DEPOSITOR_NAME';
our $depositorEmail='DEPOSITOR_EMAIL';
our $registrant='REGISTRANT';
our $fullTitle = "FULL TITLE";
our $abbrevTitle = "ABBR. Title.";
our $issn = "1234-5678";
our $coden = "CODEN";
our $batchId="ltx2crossref$$";
our $timestamp=strftime("%Y%m%d%H%M%S", gmtime);
if ($opts{c}) {
if (-r $opts{c}) {
require $opts{c};
} else {
die "Cannot read options $opts{c}. $USAGE";
}
}
PrintHead();
#
# The hash %papers. Keys year->vol->issue->number
#
my %papers;
foreach my $file (@ARGV) {
AddPaper($file);
}
foreach my $year (keys %papers) {
foreach my $volume (keys %{$papers{$year}}) {
foreach my $issue (keys %{$papers{$year}->{$volume}}) {
PrintIssueHead($year, $volume, $issue);
my $paperList = $papers{$year}->{$volume}->{$issue};
foreach my $paper (@{$paperList}) {
PrintPaper($paper);
}
}
}
}
PrintTail();
exit(0);
#####################################################
# Printing the head and the tail
#####################################################
sub PrintHead {
print OUT <<END;
<doi_batch xmlns="http://www.crossref.org/schema/4.3.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="4.3.0" xsi:schemaLocation="http://www.crossref.org/schema/4.3.0 http://www.crossref.org/schema/deposit/crossref4.3.0.xsd">
<head>
<doi_batch_id>$batchId</doi_batch_id>
<timestamp>$timestamp</timestamp>
<depositor>
<name>$depositorName</name>
<email_address>$depositorEmail</email_address>
</depositor>
<registrant>$registrant</registrant>
</head>
<body>
<journal>
<journal_metadata language="en">
<full_title>$fullTitle</full_title>
<abbrev_title>$abbrevTitle</abbrev_title>
<issn>$issn</issn>
<coden>$coden</coden>
</journal_metadata>
END
}
sub PrintTail {
print OUT <<END;
</journal>
</body>
</doi_batch>
END
return;
}
#######################################################
# Adding one paper
#######################################################
sub AddPaper {
my $file = shift;
my ($name,$path,$suffix) = fileparse($file, '\.[^\.]*$');
my $rpifile = File::Spec->catfile($path, "$name.rpi");
open (RPI, $rpifile) or die
"Cannot find $rpifile. Did you process $file?\n";
my %data;
while (<RPI>) {
chomp;
if (/^%([^=]*)\s*=\s*(.*)\s*$/) {
$data{$1}=$2;
}
}
close RPI;
my @bibliography;
foreach my $bibfile ($file, File::Spec->catfile($path, "$name.bbl")) {
@bibliography = (@bibliography,
AddBibliography($bibfile));
}
$data{'bibliography'}=\@bibliography;
push @{$papers{$data{year}}->{$data{volume}}->{$data{issue}}}, \%data;
}
##############################################################
# Reading a list of papers and adding it to the
# bibliography
##############################################################
sub AddBibliography {
my $bibfile = shift;
open (BIB, $bibfile) or return;
my $insidebibliography = 0;
my $currpaper="";
my @result;
my $key;
while (<BIB>) {
chomp;
if (/^\s*\\bibitem(?:\[.*\])?+\{(.+)\}/) {
if ($insidebibliography) {
if ($currpaper) {
my %paperhash;
$paperhash{$key}=$currpaper;
push @result, \%paperhash;
}
}
$key = $1;
$currpaper="";
$insidebibliography=1;
next;
}
if (/^\s*\\end\{thebibliography\}/) {
if ($currpaper) {
my %paperhash;
$paperhash{$key}=$currpaper;
push @result, \%paperhash;
}
$currpaper="";
$insidebibliography=0;
next;
}
if ($insidebibliography) {
$currpaper .= " $_";
}
}
close BIB;
return @result;
}
#################################################################
# Printing information about one issue
#################################################################
sub PrintIssueHead {
my ($year, $volume, $issue) = @_;
print OUT <<END;
<journal_issue>
<publication_date media_type="print">
<year>$year</year>
</publication_date>
<journal_volume>
<volume>$volume</volume>
</journal_volume>
<issue>$issue</issue>
</journal_issue>
END
}
###############################################################
# Printing information about one paper
###############################################################
sub PrintPaper {
my $paper = shift;
my $title=SanitizeText($paper->{title});
my $url=GetURL($paper);
print OUT <<END;
<journal_article publication_type="full_text">
<titles>
<title>
$title
</title>
</titles>
<contributors>
END
my @authors = split /\s*\\and\s*/, $paper->{authors};
my $seq='first';
foreach my $author (@authors) {
print OUT <<END;
<person_name sequence="$seq" contributor_role="author">
END
$seq='additional';
PrintAuthor($author);
print OUT <<END;
</person_name>
END
}
print OUT <<END;
</contributors>
<publication_date media_type="print">
<year>$paper->{year}</year>
</publication_date>
<pages>
<first_page>$paper->{startpage}</first_page>
<last_page>$paper->{endpage}</last_page>
</pages>
<doi_data>
<doi>$paper->{doi}</doi>
<timestamp>$timestamp</timestamp>
<resource>$url</resource>
</doi_data>
END
if (scalar(@{$paper->{bibliography}})) {
print OUT <<END;
<citation_list>
END
foreach my $citation (@{$paper->{bibliography}}) {
PrintCitation($citation);
}
print OUT <<END;
</citation_list>
END
}
print OUT <<END;
</journal_article>
END
}
###############################################################
# Sanitization of a text string
###############################################################
sub SanitizeText {
my $string = shift;
# There is a bug in the decode function, which we need to work
# around: it adds space to constructions like \o x
$string =~ s/(\\[a-zA-Z])\s+/$1/g;
$string =~ s/\\newblock//g;
$string =~ s/\\bgroup//g;
$string =~ s/\\egroup//g;
$string =~ s/\\scshape//g;
$string =~ s/\\urlprefix//g;
$string =~ s/\\emph//g;
$string =~ s/\\textbf//g;
$string =~ s/\\enquote//g;
$string =~ s/\\url/URL: /g;
$string =~ s/\\doi/DOI: /g;
$string =~ s/\\\\/ /g;
$string =~ s/\$//g;
# Another bug in decode: it does not understan macrons
$string =~ s/\\=(A|\{A\})/##SANITIZE#MACRON##256;/g;
$string =~ s/\\=(a|\{a\})/##SANITIZE#MACRON##257;/g;
$string =~ s/\\=(E|\{E\})/##SANITIZE#MACRON##274;/g;
$string =~ s/\\=(e|\{e\})/##SANITIZE#MACRON##275;/g;
$string =~ s/\\=(I|\{I\})/##SANITIZE#MACRON##298;/g;
$string =~ s/\\=(i|\{i\})/##SANITIZE#MACRON##299;/g;
$string =~ s/\\=(O|\{O\})/##SANITIZE#MACRON##332;/g;
$string =~ s/\\=(o|\{o\})/##SANITIZE#MACRON##333;/g;
$string =~ s/\\=(U|\{U\})/##SANITIZE#MACRON##362;/g;
$string =~ s/\\=(u|\{u\})/##SANITIZE#MACRON##363;/g;
$string = decode('latex', $string);
$string =~ s/\\[a-zA-Z]+/ /g;
$string =~ s/\\\\/ /g;
$string =~ s/[\[\{\}\]]/ /g;
$string = encode_entities($string);
$string = XML::Entities::numify('all', $string);
$string =~ s/amp;//g;
$string =~ s/~/ /g;
$string =~ s/\s*([\.;,])/$1/g;
$string =~ s/##SANITIZE#MACRON##(\d+);/&#$1;/g;
return $string;
}
################################################################
# Printing one author
################################################################
sub PrintAuthor {
my $author=shift;
my $person=new Text::BibTeX::Name ($author);
if ($person->part('first')) {
my @tokens = $person->part('first');
my $line = join(" ", @tokens);
$line = SanitizeText($line);
print OUT <<END;
<given_name>$line</given_name>
END
}
if ($person->part('last')) {
my $line = SanitizeText($person->part('last'));
print OUT <<END;
<surname>$line</surname>
END
}
if ($person->part('jr')) {
my $line = SanitizeText($person->part('jr'));
print OUT <<END;
<suffix>$line</suffix>
END
}
}
#############################################################
# Printing citations
#############################################################
sub PrintCitation {
my $paperhash=shift;
foreach my $key (keys (%{$paperhash})) {
my $citation=$paperhash->{$key};
$citation=SanitizeText($citation);
print OUT <<END;
<citation key="$key">
<unstructured_citation>
$citation
</unstructured_citation>
</citation>
END
}
}
##############################################################
# Calculating URL
##############################################################
sub GetURL {
my $paper = shift;
my $result;
if ($paper->{paperUrl}) {
$result= $paper->{paperUrl}
} else {
my $doi=$paper->{doi};
$result= 'http://www.pdcnet.org/oom/service?url_ver=Z39.88-2004&rft_val_fmt=&rft.imuse_synonym=resphilosophica&rft.DOI='.$doi.'&svc_id=info:www.pdcnet.org/collection';
}
$result =~ s/&/&/g;
return $result;
}
|
