XML coversheet: Difference between revisions

From STMDocs
Jump to navigation Jump to search
No edit summary
Line 96: Line 96:


;history_date
;history_date
Has an attribute <code>type</code>. The values will be <code>received, revised</code> or <code>accepted</code>.
Has an attribute <code>type</code>. The values will be <code>received, revised</code> and <code>accepted</code>.


;copy-edit-content
This element has one attribute <code>required</code>. The values are <code>yes</code> or <code>no</code>.


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


;manuscript_meta
To hold details of the manuscript submitted.


;no_mns_pages
Number of manuscript pages submitted.


<!--
;source
===Structure===
Source file submitted. TeX, Word or PDF.
* XML declaration on the top.
 
<geshi lang="xml">
;figures
<?xml version="1.0" encoding="utf-8" ?>
Contain one or more figure details.
</geshi>
 
* Top-level element
;figure
<geshi lang="xml">
Contains <code>figure_nr, figure_type</code> and <code>fig_parts</code>
<purchase_order>
 
</geshi>
;figure_nr
* It holds mainly the following elements
Figure number. Figure 1, Figure 2 etc.
-->
 
;figure_type
Should be <code>COLOUR</code> or <code>BW</code>
 
;figure_parts
Option element. Should be provided if that particular figure has part figures. Enter the number of figure parts.
 
;tables
Number of tables.
 
;other_info
Contains <code>fastrack</code> and <code>proof_to_author</code>.
 
;fastrack
If the article is fastrack, give <code>YES</code>, otherwise <code>NO</code>.
 
;proof_to_author
If the proof need not be send to the author, then please give <code>NO</code>. Otherwise <code>YES</code>.
 
;remarks
Any special remarks to the setter can be added here.

Revision as of 19:17, 17 December 2012

<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. The XML file can sometimes be a well-formed XML or a DTD/XSD driven one.

Advantages of XML coversheets

XML coversheet poses lot of advantages.

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

Specimen

You may download a specimen XML coversheet from here.

Elements and attributes

purchase_order

Top-level element

order_meta

To hold the details regarding the particular 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 should 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

This is to say for which milestone stage the purchase order is sent. This has two attributes namely step and version.

article

Holds the 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 the journal id here. Normally 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.

article_meta

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

article_id[@pubid]

Article id which the publisher provides. Normally integers only.

article_id[@doi]

The DOI of the article.

copyright[@year]

The copyright year and copyright owner of the article.

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.

first_author

Give the first author's name.

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 corresponding author.

history_date

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

copy-edit-content

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

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.

manuscript_meta

To hold details of the manuscript submitted.

no_mns_pages

Number of manuscript pages submitted.

source

Source file submitted. TeX, Word or PDF.

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.

tables

Number of tables.

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.

remarks

Any special remarks to the setter can be added here.