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
|
<?php
/**
* @file CrossRefExportDom.inc.php
*
* Copyright (c) 2003-2009 John Willinsky
* Distributed under the GNU GPL v2. For full terms see the file docs/COPYING.
*
* @class CrossRefExportDom
* @ingroup plugins_importexport_crossref
*
* @brief CrossRef XML export plugin DOM functions
*/
// $Id$
import('xml.XMLCustomWriter');
/* NOTE: these values reflect the specifications for which this plugin were written
* any changes to these values must be accompanied by a review of the XML output
*/
define('CROSSREF_XMLNS_XSI' , 'http://www.w3.org/2001/XMLSchema-instance');
define('CROSSREF_XMLNS' , 'http://www.crossref.org/schema/4.3.0');
define('CROSSREF_VERSION' , '4.3.0');
define('CROSSREF_XSI_SCHEMALOCATION' , 'http://www.crossref.org/schema/4.3.0 http://www.crossref.org/schema/4.3.0/crossref4.3.0.xsd');
class CrossRefExportDom {
/**
* Build article XML using DOM elements
*
* The DOM for this XML was developed according
* http://www.crossref.org/schema/4.3.0
*/
function &generateCrossRefDom() {
// create the output XML document in DOM with a root node
$doc = &XMLCustomWriter::createDocument('', '', '');
return $doc;
}
function &generateDoiBatchDom(&$doc) {
// Generate the root node for the file first and set its attributes
$root = &XMLCustomWriter::createElement($doc, 'doi_batch');
/* Root doi_batch tag attributes
* Change to these attributes must be accompanied by a review of entire output
*/
XMLCustomWriter::setAttribute($root, 'xmlns:xsi', CROSSREF_XMLNS_XSI);
XMLCustomWriter::setAttribute($root, 'xmlns', CROSSREF_XMLNS);
XMLCustomWriter::setAttribute($root, 'version', CROSSREF_VERSION);
XMLCustomWriter::setAttribute($root, 'xsi:schemaLocation', CROSSREF_XSI_SCHEMALOCATION);
XMLCustomWriter::appendChild($doc, $root);
return $root;
}
/* Generate the <head> tag that accompanies each submission */
function &generateHeadDom(&$doc, &$journal ) {
$head = &XMLCustomWriter::createElement($doc, 'head');
// DOI batch ID is a simple tracking ID: initials + timestamp
XMLCustomWriter::createChildWithText($doc, $head, 'doi_batch_id', $journal->getLocalizedSetting('initials') . '_' . time());
XMLCustomWriter::createChildWithText($doc, $head, 'timestamp', time());
$journalId = $journal->getJournalId();
/* Depositor defaults to the Journal's technical Contact */
$depositorNode = &CrossRefExportDom::generateDepositorDom($doc, $journal->getSetting('supportName'), $journal->getSetting('supportEmail'));
XMLCustomWriter::appendChild($head, $depositorNode);
/* The registrant is assumed to be the Publishing institution */
$publisherInstitution = $journal->getSetting('publisherInstitution');
XMLCustomWriter::createChildWithText($doc, $head, 'registrant', $publisherInstitution);
return $head;
}
/* Depositor Node */
function &generateDepositorDom( &$doc, $name, $email ) {
$depositor = &XMLCustomWriter::createElement($doc, 'depositor');
XMLCustomWriter::createChildWithText($doc, $depositor, 'name', $name);
XMLCustomWriter::createChildWithText($doc, $depositor, 'email_address', $email);
return $depositor;
}
/* Metadata for journal - accompanies every article */
function &generateJournalMetadataDom( &$doc, &$journal ) {
$journalMetadataNode = &XMLCustomWriter::createElement($doc, 'journal_metadata');
/* Full Title of Journal */
XMLCustomWriter::createChildWithText($doc, $journalMetadataNode, 'full_title', $journal->getJournalTitle());
/* Abbreviated title - defaulting to initials if no abbreviation found */
if ($journal->getLocalizedSetting('abbreviation') != '' ) {
XMLCustomWriter::createChildWithText($doc, $journalMetadataNode, 'abbrev_title', $journal->getLocalizedSetting('abbreviation'));
}
/* Both ISSNs are permitted for CrossRef, so sending whichever one (or both) */
if ( $ISSN = $journal->getSetting('onlineIssn') ) {
$onlineISSN = &XMLCustomWriter::createChildWithText($doc, $journalMetadataNode, 'issn', $ISSN);
XMLCustomWriter::setAttribute($onlineISSN, 'media_type', 'electronic');
}
/* Both ISSNs are permitted for CrossRef so sending whichever one (or both) */
if ( $ISSN = $journal->getSetting('printIssn') ) {
$printISSN = &XMLCustomWriter::createChildWithText($doc, $journalMetadataNode, 'issn', $ISSN);
XMLCustomWriter::setAttribute($printISSN, 'media_type', 'print');
}
return $journalMetadataNode;
}
/* Journal Issue tag to accompany every article */
function &generateJournalIssueDom( &$doc, &$journal, &$issue, &$section, &$article) {
$journalIssueNode = &XMLCustomWriter::createElement($doc, 'journal_issue');
$publicationDateNode = &CrossRefExportDom::generatePublisherDateDom($doc, $issue->getDatePublished());
XMLCustomWriter::appendChild($journalIssueNode, $publicationDateNode);
$journalVolumeNode = &XMLCustomWriter::createElement($doc, 'journal_volume');
XMLCustomWriter::appendChild($journalIssueNode, $journalVolumeNode);
XMLCustomWriter::createChildWithText($doc, $journalVolumeNode, 'volume', $issue->getVolume());
XMLCustomWriter::createChildWithText($doc, $journalIssueNode, 'issue', $issue->getNumber());
return $journalIssueNode;
}
/* The heart of the file. The Journal Article itself */
function &generateJournalArticleDom(&$doc, &$journal, &$issue, &$section, &$article) {
// Create the base node
$journalArticleNode = &XMLCustomWriter::createElement($doc, 'journal_article');
XMLCustomWriter::setAttribute($journalArticleNode, 'publication_type', 'full_text');
/* Titles */
$titlesNode = &XMLCustomWriter::createElement($doc, 'titles');
XMLCustomWriter::createChildWithText($doc, $titlesNode, 'title', $article->getArticleTitle());
XMLCustomWriter::appendChild($journalArticleNode, $titlesNode);
$contributorsNode = &XMLCustomWriter::createElement($doc, 'contributors');
/* AuthorList */
foreach ($article->getAuthors() as $author) {
$authorNode =& CrossRefExportDom::generateAuthorDom($doc, $author);
XMLCustomWriter::appendChild($contributorsNode, $authorNode);
}
XMLCustomWriter::appendChild($journalArticleNode, $contributorsNode);
/* publication date of issue */
$publicationDateNode = &CrossRefExportDom::generatePublisherDateDom($doc, $issue->getDatePublished());
XMLCustomWriter::appendChild($journalArticleNode, $publicationDateNode);
/* publisher_item is the article pages */
if ($article->getPages() != '') {
$publisherItemNode = &XMLCustomWriter::createElement($doc, 'publisher_item');
XMLCustomWriter::createChildWithText($doc, $publisherItemNode, 'item_number', $article->getPages());
XMLCustomWriter::appendChild($journalArticleNode, $publisherItemNode);
}
return $journalArticleNode;
}
/* DOI data part - this is what assigns the DOI */
function &generateDOIdataDom( &$doc, $DOI, $url ) {
$DOIdataNode = & XMLCustomWriter::createElement($doc, 'doi_data');
XMLCustomWriter::createChildWithText($doc, $DOIdataNode, 'doi', $DOI);
XMLCustomWriter::createChildWithText($doc, $DOIdataNode, 'resource', $url);
return $DOIdataNode;
}
/* author node */
function &generateAuthorDom(&$doc, &$author) {
$authorNode = &XMLCustomWriter::createElement($doc, 'person_name');
XMLCustomWriter::setAttribute($authorNode, 'contributor_role', 'author');
/* there should only be 1 primary contact per article */
if ($author->getPrimaryContact()) {
XMLCustomWriter::setAttribute($authorNode, 'sequence', 'first');
} else {
XMLCustomWriter::setAttribute($authorNode, 'sequence', 'additional');
}
XMLCustomWriter::createChildWithText($doc, $authorNode, 'given_name', ucfirst($author->getFirstName()).(($author->getMiddleName())?' '.ucfirst($author->getMiddleName()):''));
XMLCustomWriter::createChildWithText($doc, $authorNode, 'surname', ucfirst($author->getLastName()));
return $authorNode;
}
/* publisher date - order matters */
function &generatePublisherDateDom(&$doc, $pubdate) {
$publicationDateNode = &XMLCustomWriter::createElement($doc, 'publication_date');
XMLCustomWriter::setAttribute($publicationDateNode, 'media_type', 'online');
XMLCustomWriter::createChildWithText($doc, $publicationDateNode, 'month', date('m', strtotime($pubdate)), false );
XMLCustomWriter::createChildWithText($doc, $publicationDateNode, 'day', date('d', strtotime($pubdate)), false );
XMLCustomWriter::createChildWithText($doc, $publicationDateNode, 'year', date('Y', strtotime($pubdate)) );
return $publicationDateNode;
}
}
?>
|
