|
|
| (2 intermediate revisions by the same user not shown) |
| Line 1: |
Line 1: |
| [[Main Page|<Back]]
| |
|
| |
|
| ==<span style="color:green">Introduction</span>==
| |
| River Valley have a XML complaint production tracking system known as `RVMS' which means `River Valley Management System'. It can import XML coversheets and bookin a new job. It can render the coversheet. So we request XML coversheets from our clients.
| |
|
| |
| ==<span style="color:green">What is XML coversheet?</span>==
| |
| XML coversheet means, coversheets in XML format which are accompanied with the manuscript for typesetting. Metadata is tagged using XML elements.
| |
|
| |
| ==<span style="color:green">Advantages of XML coversheets</span>==
| |
| XML coversheet poses lot of advantages.
| |
| # All meta information are tagged properly.
| |
| # This can easily be generated from manuscript submission systems without any re-keying.
| |
| # This can be used for booking in an article in any XML compliant production tracking system.
| |
| # The tagged information can be extracted or re-used in subsequent stages of production.
| |
| # Since the original data is used, typos can be avoided which eliminates further checking of metadata while proof-reading.
| |
| # Using XSLT, these coversheets can be rendered in a browser.
| |
|
| |
| ===<span style="color:green">Specimen</span>===
| |
| You may download a specimen XML coversheet and <code>RVMS.xsd</code> from here.
| |
|
| |
| [http://download.river-valley.com/RVMS/XML_coversheet.zip XML coversheet and RVMS.xsd]
| |
|
| |
| ===<span style="color:green">Elements and attributes</span>===
| |
| ;<span style="color:orange">purchase_order</span>
| |
| Top-level element
| |
|
| |
| <geshi lang="xml">
| |
| <purchase_order
| |
| xmlns:xs="http://www.w3.org/2001/XMLSchema"
| |
| xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
| |
| xsi:noNamespaceSchemaLocation="RVMS.xsd">
| |
| </geshi>
| |
| ;<span style="color:orange">order_meta</span>
| |
| To hold the details about an order which may include publisher's name, order_date, due_date, stage.
| |
|
| |
| ;<span style="color:orange">publisher</span>
| |
| Publisher's name. For example <code>PeerJ</code>.
| |
|
| |
| ;<span style="color:orange">order_date</span>
| |
| The date on which the purchase order is created.
| |
|
| |
| ;<span style="color:orange">timestamp</span>
| |
| The timestamp shall be in the format <code>2012-12-18T12:24:12.000</code>.
| |
|
| |
| ;<span style="color:orange">due_date</span>
| |
| The date on which the proof is due back to the publisher.
| |
|
| |
| ;<span style="color:orange">stage</span>
| |
| The milestone (or stage) for which the purchase order is sent. This has two attributes namely <code>step</code> and <code>version</code>.
| |
|
| |
| <geshi lang="xml">
| |
| <order_meta>
| |
| <publisher>PeerJ</publisher>
| |
| <order_date>
| |
| <timestamp>2012-12-18T12:24:12.000</timestamp>
| |
| </order_date>
| |
| <due_date>
| |
| <timestamp>2012-12-31T12:24:12.000</timestamp>
| |
| </due_date>
| |
| <stage step="proof" version="1"/>
| |
| </order_meta>
| |
|
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">article</span>
| |
| Holds metadata related to the article. The main elements are <code>journal_meta, article_meta, manuscript_meta, other_info, remarks</code>
| |
|
| |
| ;<span style="color:orange">journal_meta</span>
| |
| Contains <code>journal_id, journal_name, issn</code>
| |
|
| |
| ;<span style="color:orange">journal_id</span>
| |
| Provide journal id here, usually four or five letter journal code. For example, <code>SPMI</code> for <code>Superlattices and Microstructures</code>.
| |
|
| |
| ;<span style="color:orange">journal_name</span>
| |
| Provide full name of the journal.
| |
|
| |
| ;<span style="color:orange">issn</span>
| |
| This has an attribute <code>type</code> with values <code>epub</code> and <code>ppub</code>. <code>epub</code> is for online issn and <code>ppub</code> is for print issn.
| |
|
| |
| <geshi lang="xml">
| |
| <journal_meta>
| |
| <journal_id>peerj</journal_id>
| |
| <journal_name>Journal of PeerJ</journal_name>
| |
| <issn type="ppub">xxxx-xxxx</issn>
| |
| <issn type="epub">yyyy-yyyy</issn>
| |
| </journal_meta>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">article_meta</span>
| |
| Details related to the article like doi, copyright, corresponding author etc.
| |
|
| |
| ;<span style="color:orange">article_id[@pubid]</span>
| |
| Article id provided by the publisher, usually numerals only.
| |
|
| |
| <geshi lang="xml">
| |
| <article_id type="pubid">001</article_id>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">article_id[@doi]</span>
| |
| The DOI of the article.
| |
|
| |
| <geshi lang="xml">
| |
| <article_id type="doi">10.1111/PeerJ.2012.001</article_id>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">article_categories</span>
| |
| Contains the subject groups.
| |
|
| |
| ;<span style="color:orange">subj_group[@subj_group_type]</span>
| |
| Give the subject group type.
| |
|
| |
| ;<span style="color:orange">subject</span>
| |
| Contains the subject.
| |
|
| |
| <geshi lang="xml">
| |
| <article_categories>
| |
| <subj_group subj_group_type="heading">
| |
| <subject>Agricultural Science</subject>
| |
| <subject>Animal Behavior</subject>
| |
| <subject>Allergy and Clinical Immunology</subject>
| |
| <subject>Anaesthesiology and Pain Management</subject>
| |
| </subj_group>
| |
| </article_categories>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">copyright[@year]</span>
| |
| The copyright year and copyright owner of the article.
| |
|
| |
| <geshi lang="xml">
| |
| <copyright year="2012">PeerJ</copyright>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">article_type</span>
| |
| The <code>type</code> attribute should hold two or three letters abbreviation for each article type. For example <code>RP</code> for <code>Research Papers</code>, <code>EDI</code> for <code>Editorial</code> etc. For example
| |
| <geshi lang="xml">
| |
| <article_category type="REP">Research Paper</article_category>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">article_title</span>
| |
| Full title of the article.
| |
| <geshi lang="xml">
| |
| <article_title>First PeerJ Article</article_title>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">alt_title</span>
| |
| Alternate title.
| |
|
| |
| <geshi lang="xml">
| |
| <alt_title>First PeerJ Article</alt_title>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">contrib_group</span>
| |
| Contains the list of authors.
| |
|
| |
| ;<span style="color:orange">contrib[@id,@contrib-type]</span>
| |
| Contributors id, type (author, editor etc.) and their name.
| |
|
| |
| ;<span style="color:orange">name</span>
| |
| Holds author name.
| |
|
| |
| ;<span style="color:orange">surname</span>
| |
| Surname.
| |
|
| |
| ;<span style="color:orange">email</span>
| |
| Email id of the contributor.
| |
|
| |
| ;<span style="color:orange">xref[@reftype, @rid]</span>
| |
| Link the contributor with his affiliation. The <code>ref-type</code> can be <code>aff, corresp</code> etc.
| |
|
| |
| ;<span style="color:orange">aff[@id]</span>
| |
| Affiliation part.
| |
|
| |
| ;<span style="color:orange">label</span>
| |
| Label of the affiliation.
| |
|
| |
| ;<span style="color:orange">addr-line</span>
| |
| Address line.
| |
|
| |
| ;<span style="color:orange">author-notes</span>
| |
| Notes related to contributors.
| |
|
| |
| ;<span style="color:orange">corresp_author</span>
| |
| Contains corresponding author's email id which needs to appear in proof and the id to which the proof to be send. When this is same, only <code><corresp_author id="corresp-1"><email>alf@peerj.com</email></corresp_author></code> is enough. But when it is different, <code>type="proofto"</code> attribute should be used.
| |
|
| |
| <geshi lang="xml">
| |
| <contrib_group>
| |
| <contrib id="author-1" contrib-type="author">
| |
| <name>
| |
| <surname>Eaton</surname>
| |
| <given_names>Alfred B G</given_names>
| |
| </name>
| |
| <email>alf@peerj.com</email>
| |
| <xref ref-type="aff" rid="aff-1">1</xref>
| |
| <xref ref-type="corresp" rid="corresp-1">*</xref>
| |
| </contrib>
| |
| </contrib_group>
| |
| <aff id="aff-1">
| |
| <label>1</label>
| |
| <addr-line>Department of Test, University of Test, Test City, Testland</addr-line>
| |
| </aff>
| |
| <author-notes>
| |
| <corresp_author id="corresp-1"><email>alf@peerj.com</email></corresp_author>
| |
| <corresp_author id="corresp-2" type="proofto"><email>alf@peerj.com</email></corresp_author>
| |
| </author-notes>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">history_date</span>
| |
| Has an attribute <code>type</code>. The values shall be <code>received, revised</code> and <code>accepted</code>.
| |
|
| |
| <geshi lang="xml">
| |
| <history_date type="received">
| |
| <date day="15" month="12" yr="2012"/>
| |
| </history_date>
| |
| <history_date type="revised">
| |
| <date day="16" month="12" yr="2012"/>
| |
| </history_date>
| |
| <history_date type="accepted">
| |
| <date day="17" month="12" yr="2012"/>
| |
| </history_date>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">copy-edit-content</span>
| |
| This element has one attribute <code>required</code>. The values are <code>yes</code> or <code>no</code>.
| |
|
| |
| <geshi lang="xml">
| |
| <copy-edit-content required="no"/>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">supplemental_info</span>
| |
| Holds information regarding supplemental material.
| |
|
| |
| ;<span style="color:orange">file</span>
| |
| Details of supplemental material.
| |
|
| |
| ;<span style="color:orange">filename</span>
| |
| Filename of the supplemental material.
| |
|
| |
| ;<span style="color:orange">type</span>
| |
| File format. Audio, Video etc.
| |
|
| |
| ;<span style="color:orange">title</span>
| |
| Caption to the supplemental material.
| |
|
| |
| <geshi lang="xml">
| |
| <supplemental_info>
| |
| <file>
| |
| <filename>Supplemental001S1</filename>
| |
| <type>MOV</type>
| |
| <title>This is video file.</title>
| |
| </file>
| |
| <file>
| |
| <filename>Supplemental001S2</filename>
| |
| <type>WAV</type>
| |
| <title>This is an audio file.</title>
| |
| </file>
| |
| </supplemental_info>
| |
| </geshi>
| |
|
| |
|
| |
| ;<span style="color:orange">manuscript_meta</span>
| |
| To hold details of the manuscript submitted.
| |
|
| |
| ;<span style="color:orange">no_mns_pages</span>
| |
| Number of manuscript pages submitted.
| |
|
| |
| <geshi lang="xml">
| |
| <no_mns_pages>12</no_mns_pages>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">source</span>
| |
| Source file submitted. TeX, Word or PDF.
| |
|
| |
| <geshi lang="xml">
| |
| <source>TeX</source>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">figures</span>
| |
| Contain one or more figure details.
| |
|
| |
| ;<span style="color:orange">figure</span>
| |
| Contains <code>figure_nr, figure_type</code> and <code>fig_parts</code>
| |
|
| |
| ;<span style="color:orange">figure_nr</span>
| |
| Figure number. Figure 1, Figure 2 etc.
| |
|
| |
| ;<span style="color:orange">figure_type</span>
| |
| Should be <code>COLOUR</code> or <code>BW</code>
| |
|
| |
| ;<span style="color:orange">figure_parts</span>
| |
| Option element. Should be provided if that particular figure has part figures. Enter the number of figure parts.
| |
|
| |
| <geshi lang="xml">
| |
| <figures>
| |
| <figure>
| |
| <figure_nr>1</figure_nr>
| |
| <figure_type>COLOUR</figure_type>
| |
| <fig_parts>4</fig_parts>
| |
| </figure>
| |
| <figure>
| |
| <figure_nr>2</figure_nr>
| |
| <figure_type>BW</figure_type>
| |
| </figure>
| |
| </figures>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">tables</span>
| |
| Number of tables.
| |
|
| |
| <geshi lang="xml">
| |
| <tables>1</tables>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">other_info</span>
| |
| Contains <code>fastrack</code> and <code>proof_to_author</code>.
| |
|
| |
| ;<span style="color:orange">fastrack</span>
| |
| If the article is fastrack, give <code>YES</code>, otherwise <code>NO</code>.
| |
|
| |
| ;<span style="color:orange">proof_to_author</span>
| |
| If the proof need not be send to the author, then please give <code>NO</code>. Otherwise <code>YES</code>.
| |
|
| |
| <geshi lang="xml">
| |
| <other_info>
| |
| <fastrack>YES</fastrack>
| |
| <proof_to_author>YES</proof_to_author>
| |
| </other_info>
| |
| </geshi>
| |
|
| |
| ;<span style="color:orange">remarks</span>
| |
| Any special remarks to the setter can be added here.
| |
|
| |
| <geshi lang="xml">
| |
| <remarks>
| |
| Any special remarks to the typesetter.
| |
| </remarks>
| |
| </geshi>
| |