XML coversheet

From STMDocs
Revision as of 06:58, 21 December 2012 by Cvr (talk | contribs)
Jump to navigation Jump to search

<Back

Introduction

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.

What is XML coversheet?

XML coversheet means, coversheets in XML format which are accompanied with the manuscript for typesetting. Metadata is tagged using XML elements.

Advantages of XML coversheets

XML coversheet poses lot of advantages.

  1. All meta information are tagged properly.
  2. This can easily be generated from manuscript submission systems without any re-keying.
  3. This can be used for booking in an article in any XML compliant production tracking system.
  4. The tagged information can be extracted or re-used in subsequent stages of production.
  5. Since the original data is used, typos can be avoided which eliminates further checking of metadata while proof-reading.
  6. Using XSLT, these coversheets can be rendered in a browser.

Specimen

You may download a specimen XML coversheet from here.

XML coversheet

Elements and attributes

purchase_order

Top-level element

<geshi lang="xml"> <purchase_order 

  xmlns="http://www.river-valley.com/xml/schema/purchase_order/2012.1/RVMS" 
  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
  xsi:schemaLocation="http://www.river-valley.com/xml/schema/purchase_order/2012.1/RVMS 
  http://www.river-valley.com/xml/schema/purchase_order/2012.1/RVMS.xsd"
  schema-version="2012.1">

</geshi>

order_meta

To hold the details about an order which may include publisher's name, order_date, due_date, stage.

publisher

Publisher's name. For example PeerJ.

order_date

The date on which the purchase order is created.

timestamp

The timestamp shall be in the format 2012-12-18T12:24:12.000.

due_date

The date on which the proof is due back to the publisher.

stage

The milestone (or stage) for which the purchase order is sent. This has two attributes namely step and version.

<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>

article

Holds metadata related to the article. The main elements are journal_meta, article_meta, manuscript_meta, other_info, remarks

journal_meta

Contains journal_id, journal_name, issn

journal_id

Provide journal id here, usually four or five letter journal code. For example, SPMI for Superlattices and Microstructures.

journal_name

Provide full name of the journal.

issn

This has an attribute type with values epub and ppub. epub is for online issn and ppub 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>

article_meta

Details related to the article like doi, copyright, corresponding author etc.

article_id[@pubid]

Article id provided by the publisher, usually numerals only.

<geshi lang="xml"> 

<article_id type="pubid">001</article_id>

</geshi>

article_id[@doi]

The DOI of the article.

<geshi lang="xml"> 

<article_id type="doi">10.1111/PeerJ.2012.001</article_id>

</geshi>

copyright[@year]

The copyright year and copyright owner of the article.

<geshi lang="xml"> 

<copyright year="2012">PeerJ</copyright>

</geshi>

article_category

The type attribute should hold two or three letters abbreviation for each article type. For example RP for Research Papers, EDI for Editorial etc. For example <geshi lang="xml"> 

<article_category type="RP">Research Paper</article_category>

</geshi>

article_title

Full title of the article. <geshi lang="xml"> 

<article_title>First PeerJ Article</article_title>

</geshi>

first_author

First author's name.

<geshi lang="xml"> 

<first_author>John Smith</first_author>

</geshi>

corr_author

This element has a type attribute with values proofto, inarticle and all.

    proofto — Author to whom the proof should be sent.

    inarticle — Corresponding author's details which needs to appear in the document.

    all — This is used when the corresponding author's details which should come in the article and the proof should be sent to is same.

name

Name of the corresponding author.

email

Email of the corresponding author.

<geshi lang="xml"> 

<corr_author type="proofto">
  <name>Dr. Mary John</name>
  <email>m.john@reference.com</email>
</corr_author>
<corr_author type="inarticle">
  <name>Dr. John Smith</name>
   <email>j.smith@university.com</email>
</corr_author>

</geshi>

OR

<geshi lang="xml"> <corr_author type="all"> 

  <name>Dr. Mary John</name>
  <email>m.john@reference.com</email>
</corr_author>

</geshi>

history_date

Has an attribute type. The values shall be received, revised and accepted.

<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>

copy-edit-content

This element has one attribute required. The values are yes or no.

<geshi lang="xml"> 

<copy-edit-content required="no"/>

</geshi>

supplemental_info

Holds information regarding supplemental material.

file

Details of supplemental material.

filename

Filename of the supplemental material.

type

File format. Audio, Video etc.

title

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>


manuscript_meta

To hold details of the manuscript submitted.

no_mns_pages

Number of manuscript pages submitted.

<geshi lang="xml"> 

<no_mns_pages>12</no_mns_pages>

</geshi>

source

Source file submitted. TeX, Word or PDF.

<geshi lang="xml"> 

TeX

</geshi>

figures

Contain one or more figure details.

figure

Contains figure_nr, figure_type and fig_parts

figure_nr

Figure number. Figure 1, Figure 2 etc.

figure_type

Should be COLOUR or BW

figure_parts

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>

tables

Number of tables.

<geshi lang="xml"> 

<tables>1</tables>

</geshi>

other_info

Contains fastrack and proof_to_author.

fastrack

If the article is fastrack, give YES, otherwise NO.

proof_to_author

If the proof need not be send to the author, then please give NO. Otherwise YES.

<geshi lang="xml"> 

 <other_info>
   <fastrack>YES</fastrack>
   <proof_to_author>YES</proof_to_author>
 </other_info>

</geshi>

remarks

Any special remarks to the setter can be added here.

<geshi lang="xml"> 

 <remarks>
  Any special remarks to the typesetter.
 </remarks>

</geshi>

Retrieved from "https://els-support2.river-valley.com/index.php?title=XML_coversheet&oldid=715"