Skip to content
Snippets Groups Projects
Commit 0966ed70 authored by Bogdan Cochior's avatar Bogdan Cochior
Browse files

docs(mts): add readme

parent ea6c49ec
No related branches found
No related tags found
1 merge request!34Sprint 17 features
Hide whitespace changes
Inline Side-by-side
packages/component-mts-package/readme.md 0 → 100644
+ 16
− 0
View file @ 0966ed70
### Use-case
As an Editor in Chief, I want the manuscript to go through Editorial Quality Screening before I assign a Handling Editor to it and start the review process.
### Workflow
Stage 1: When an article is submitted, Faraday needs to convert the submission to XML JATS format, and upload as a .zip file to a FTP server.
Stage 2: When new .zip file has been detected on FTP server, then third party system MTS (Manuscript Tracking System - Hindawi) needs to consume package and populate DB records.
Stage 3: When check is completed, then Faraday system needs to be updated to move status from Technical Checks to Submitted - which allows the Editor in Chief to assign a Handling Editor.
packages/component-mts-package/tests/sample.json
+ 62
− 113
View file @ 0966ed70
...@@ -24,12 +24,12 @@ ...@@ -24,12 +24,12 @@
"_attributes": { "_attributes": {
"journal-id-type": "email" "journal-id-type": "email"
}, },
"_text": "trashjo@ariessys.com" "_text": "faraday@hindawi.com"
} }
], ],
"journal-title-group": { "journal-title-group": {
"journal-title": { "journal-title": {
"_text": "Research" "_text": "Bioinorganic Chemistry and Applications"
} }
}, },
"issn": [ "issn": [
...@@ -37,7 +37,7 @@ ...@@ -37,7 +37,7 @@
"_attributes": { "_attributes": {
"pub-type": "ppub" "pub-type": "ppub"
}, },
"_text": "0000-000Y" "_text": "2474-7394"
}, },
{ {
"_attributes": { "_attributes": {
...@@ -52,60 +52,28 @@ ...@@ -52,60 +52,28 @@
"_attributes": { "_attributes": {
"pub-id-type": "publisher-id" "pub-id-type": "publisher-id"
}, },
"_text": "RESEARCH-D-18-00005" "_text": "RESEARCH-F-3326913"
}, },
{ {
"_attributes": { "_attributes": {
"pub-id-type": "manuscript" "pub-id-type": "manuscript"
}, },
"_text": "RESEARCH-D-18-00005" "_text": "RESEARCH-F-3326913"
} }
], ],
"article-categories": { "article-categories": {
"subj-group": [ "subj-group": {
{ "_attributes": {
"_attributes": { "subj-group-type": "Article Type"
"subj-group-type": "Article Type"
},
"subject": {
"_text": "Research Article"
}
},
{
"_attributes": {
"subj-group-type": "Category"
},
"subject": {
"_text": "Information science"
}
},
{
"_attributes": {
"subj-group-type": "Classification"
},
"subject": {
"_text": "Applied sciences and engineering"
}
}, },
{ "subject": {
"_attributes": { "_text": "clinical-study"
"subj-group-type": "Classification"
},
"subject": {
"_text": "Scientific community"
}
} }
] }
}, },
"title-group": { "title-group": {
"article-title": { "article-title": {
"_text": "January 24 sample article with new email trigger in place" "_text": "Demo sprint 16 no fun"
},
"alt-title": {
"_attributes": {
"alt-title-type": "running-head"
},
"_text": "let's hope this works"
} }
}, },
"contrib-group": { "contrib-group": {
...@@ -121,17 +89,17 @@ ...@@ -121,17 +89,17 @@
}, },
"name": { "name": {
"surname": { "surname": {
"_text": "Heckner" "_text": "Raluca"
}, },
"given-names": { "given-names": {
"_text": "Hannah" "_text": "Authorescu"
}, },
"prefix": { "prefix": {
"_text": "Ms." "_text": "miss"
} }
}, },
"email": { "email": {
"_text": "hheckner@aaas.org" "_text": "raluca.gramschi+auth@thinslices.com"
}, },
"xref": { "xref": {
"_attributes": { "_attributes": {
...@@ -144,8 +112,9 @@ ...@@ -144,8 +112,9 @@
"_attributes": { "_attributes": {
"id": "aff1" "id": "aff1"
}, },
"country": { "country": {},
"_text": "UNITED STATES" "addr-line": {
"_text": "Technical University Gheorghe Asachi Iasi"
} }
} }
}, },
...@@ -155,10 +124,10 @@ ...@@ -155,10 +124,10 @@
"date-type": "received" "date-type": "received"
}, },
"day": { "day": {
"_text": "24" "_text": "3"
}, },
"month": { "month": {
"_text": "01" "_text": "8"
}, },
"year": { "year": {
"_text": "2018" "_text": "2018"
...@@ -166,78 +135,58 @@ ...@@ -166,78 +135,58 @@
} }
}, },
"abstract": { "abstract": {
"p": { "_text": "<p>some abstract here</p>"
"_text": "Abstract\nThis article explains and illustrates the use of LATEX in preparing manuscripts for submission to the American Journal of Physics (AJP). While it is not a comprehensive reference, we hope it will suffice for the needs of most AJP authors."
}
}, },
"kwd-group": { "funding-group": {}
"kwd": [ },
{ "files": {
"_text": "manuscript" "file": [
{
"item_type": {
"_text": "coverLetter"
}, },
{ "item_description": {
"_text": "submissions" "_text": "sample cover letter_ms 1.doc"
}, },
{ "item_name": {
"_text": "ftp site" "_text": "sample cover letter_ms 1.doc"
}
]
},
"funding-group": {},
"counts": {
"fig-count": {
"_attributes": {
"count": "0"
} }
} },
}, {
"custom-meta-group": { "item_type": {
"custom-meta": [ "_text": "manuscripts"
{
"meta-name": {
"_text": "Black and White Image Count"
},
"meta-value": {
"_text": "0"
}
}, },
{ "item_description": {
"meta-name": { "_text": "manuscript.pdf"
"_text": "Color Image Count" },
}, "item_name": {
"meta-value": { "_text": "manuscript.pdf"
"_text": "0"
}
} }
]
}
}
},
"body": {
"fig": [
{
"label": {
"_text": "Figure 1"
}, },
"graphic": { {
"_attributes": { "item_type": {
"xlink:href": "GasBulbData.eps", "_text": "supplementary"
"xmlns:xlink": "http://www.w3.org/1999/xlink" },
"item_description": {
"_text": "important-emails.md"
},
"item_name": {
"_text": "important-emails.md"
} }
}
},
{
"label": {
"_text": "Figure 2"
}, },
"graphic": { {
"_attributes": { "item_type": {
"xlink:href": "ThreeSunsets.jpg", "_text": "supplementary"
"xmlns:xlink": "http://www.w3.org/1999/xlink" },
"item_description": {
"_text": "important-emails.md"
},
"item_name": {
"_text": "important-emails (1).md"
} }
} }
} ]
] }
} }
} }
} }
\ No newline at end of file
packages/component-mts-package/tests/sample.xml
+ 41
− 59
View file @ 0966ed70
...@@ -4,89 +4,71 @@ ...@@ -4,89 +4,71 @@
<front> <front>
<journal-meta> <journal-meta>
<journal-id journal-id-type="publisher">research</journal-id> <journal-id journal-id-type="publisher">research</journal-id>
<journal-id journal-id-type="email">trashjo@ariessys.com</journal-id> <journal-id journal-id-type="email">faraday@hindawi.com</journal-id>
<journal-title-group> <journal-title-group>
<journal-title>Research</journal-title> <journal-title>Bioinorganic Chemistry and Applications</journal-title>
</journal-title-group> </journal-title-group>
<issn pub-type="ppub">0000-000Y</issn> <issn pub-type="ppub">2474-7394</issn>
<issn pub-type="epub"></issn> <issn pub-type="epub"></issn>
</journal-meta> </journal-meta>
<article-meta> <article-meta>
<article-id pub-id-type="publisher-id">RESEARCH-D-18-00005</article-id> <article-id pub-id-type="publisher-id">RESEARCH-F-3326913</article-id>
<article-id pub-id-type="manuscript">RESEARCH-D-18-00005</article-id> <article-id pub-id-type="manuscript">RESEARCH-F-3326913</article-id>
<article-categories> <article-categories>
<subj-group subj-group-type="Article Type"> <subj-group subj-group-type="Article Type">
<subject>Research Article</subject> <subject>clinical-study</subject>
</subj-group>
<subj-group subj-group-type="Category">
<subject>Information science</subject>
</subj-group>
<subj-group subj-group-type="Classification">
<subject>Applied sciences and engineering</subject>
</subj-group>
<subj-group subj-group-type="Classification">
<subject>Scientific community</subject>
</subj-group> </subj-group>
</article-categories> </article-categories>
<title-group> <title-group>
<article-title>January 24 sample article with new email trigger in place</article-title> <article-title>Demo sprint 16 no fun</article-title>
<alt-title alt-title-type="running-head">let's hope this works</alt-title>
</title-group> </title-group>
<contrib-group> <contrib-group>
<contrib contrib-type="author" corresp="yes"> <contrib contrib-type="author" corresp="yes">
<role content-type="1" /> <role content-type="1"></role>
<name> <name>
<surname>Heckner</surname> <surname>Raluca</surname>
<given-names>Hannah</given-names> <given-names>Authorescu</given-names>
<prefix>Ms.</prefix> <prefix>miss</prefix>
</name> </name>
<email>hheckner@aaas.org</email> <email>raluca.gramschi+auth@thinslices.com</email>
<xref ref-type="aff" rid="aff1" /> <xref ref-type="aff" rid="aff1"></xref>
</contrib> </contrib>
<aff id="aff1"> <aff id="aff1">
<country>UNITED STATES</country> <country></country>
<addr-line>Technical University Gheorghe Asachi Iasi</addr-line>
</aff> </aff>
</contrib-group> </contrib-group>
<history> <history>
<date date-type="received"> <date date-type="received">
<day>24</day> <day>3</day>
<month>01</month> <month>8</month>
<year>2018</year> <year>2018</year>
</date> </date>
</history> </history>
<abstract> <abstract>&lt;p&gt;some abstract here&lt;/p&gt;</abstract>
<p>Abstract <funding-group></funding-group>
This article explains and illustrates the use of LATEX in preparing manuscripts for submission to the American Journal of Physics (AJP). While it is not a comprehensive reference, we hope it will suffice for the needs of most AJP authors.</p>
</abstract>
<kwd-group>
<kwd>manuscript</kwd>
<kwd>submissions</kwd>
<kwd>ftp site</kwd>
</kwd-group>
<funding-group />
<counts>
<fig-count count="0" />
</counts>
<custom-meta-group>
<custom-meta>
<meta-name>Black and White Image Count</meta-name>
<meta-value>0</meta-value>
</custom-meta>
<custom-meta>
<meta-name>Color Image Count</meta-name>
<meta-value>0</meta-value>
</custom-meta>
</custom-meta-group>
</article-meta> </article-meta>
<files>
<file>
<item_type>coverLetter</item_type>
<item_description>sample cover letter_ms 1.doc</item_description>
<item_name>sample cover letter_ms 1.doc</item_name>
</file>
<file>
<item_type>manuscripts</item_type>
<item_description>manuscript.pdf</item_description>
<item_name>manuscript.pdf</item_name>
</file>
<file>
<item_type>supplementary</item_type>
<item_description>important-emails.md</item_description>
<item_name>important-emails.md</item_name>
</file>
<file>
<item_type>supplementary</item_type>
<item_description>important-emails.md</item_description>
<item_name>important-emails (1).md</item_name>
</file>
</files>
</front> </front>
<body>
<fig>
<label>Figure 1</label>
<graphic xlink:href="GasBulbData.eps" xmlns:xlink="http://www.w3.org/1999/xlink" />
</fig>
<fig>
<label>Figure 2</label>
<graphic xlink:href="ThreeSunsets.jpg" xmlns:xlink="http://www.w3.org/1999/xlink" />
</fig>
</body>
</article> </article>
\ No newline at end of file
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment