Skip to content

Commit

Permalink
update Readme
Browse files Browse the repository at this point in the history
  • Loading branch information
ronste committed Oct 19, 2023
1 parent efa9440 commit ceae8d1
Showing 1 changed file with 44 additions and 40 deletions.
84 changes: 44 additions & 40 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,57 +39,57 @@ Only validate by adding -v:
5. The script will create one XML per year.

## Article
| Field | Description | Required|
|----------|:--------:|:--------:|
| prefix | "The", "A" | |
| title | Article title | x |
| subTitle | Article subtitle | |
| abstract| Article abstract | |
| articleSeq | Article sequence inside an issue, first article '1' | x |
| pages| For example "23-45" | |
| language| Article language "en", "fi", "sv", "de", "fr" | x |
| keywords| Word 1; Word 2; Word3 | |
| disciplines| History; Political science; Astronomy | |
| articleCopyrightYear| 2005 | |
| articleCopyrightHolder| "John Doe" | |
| articleLicenseUrl| http://creativecommons.org/licenses/by/4.0 | |
| doi| "10.1234/art.182" | |
| Field | Description | Required| Multilingual Support|
|----------|:--------:|:--------:|:--------:|
| prefix | "The", "A" | | x | |
| title | Article title | x | x |
| subTitle | Article subtitle | | x |
| abstract| Article abstract | | x |
| articleSeq | Article sequence inside an issue, first article '1' | x | |
| pages| For example "23-45" | | |
| language| Article language "en", "fi", "sv", "de", "fr" | x | |
| keywords| Word 1; Word 2; Word3 | | x |
| disciplines| History; Political science; Astronomy | | x |
| articleCopyrightYear| 2005 | | |
| articleCopyrightHolder| "John Doe" | | |
| articleLicenseUrl| http://creativecommons.org/licenses/by/4.0 | | |
| doi| "10.1234/art.182" | | |

## Issue
| Field | Description | Required|
|----------|:--------:|:--------:|
| issueDatepublished | Issue publication date, yyyy-mm-dd. Note! has to be unique for each individual issue. | x |
| issueVolume | Issue volume | |
| issueNumber | Issue number | |
| issueYear | Issue year | x |
| issueTitle | Issue title | |
| sectionTitle | Section title, eg. "Articles" | x |
| sectionAbbrev | Section abbreviation, eg. "ART" | x |
| Field | Description | Required| Multilingual Support|
|----------|:--------:|:--------:|:--------:|
| issueDatepublished | Issue publication date, yyyy-mm-dd. Note! has to be unique for each individual issue. | x | |
| issueVolume | Issue volume | | |
| issueNumber | Issue number | | |
| issueYear | Issue year | x | |
| issueTitle | Issue title | | x |
| sectionTitle | Section title, eg. "Articles" | x | x |
| sectionAbbrev | Section abbreviation, eg. "ART" | x | |

## Multiplied fields
An article can have multiple authors or full text files. Every article has to have at least one author and one file.

If an article has for example three authors, the excel file should include columns for each author with the number behind the column name changing. The first name of the third author will be saved to a field called *authorFirstname3*.

### Authors
| Field | Description | Required|
|----------|:--------:|:--------:|
| authorFirstname1| Given name | x |
| authorMiddlename1| Middle name | |
| authorLastname1| Family name | |
| authorEmail1| Email | |
| authorAffiliation1| Affiliation | |
| country1| "FI", "SE", "DK", "CA", "US" | |
| orcid1| Orcid ID, should include "https://". Note that adding Orcid ID's this way is not recommended by Orcid. | |
| authorBio1| Biography | |
| Field | Description | Required| Multilingual Support|
|----------|:--------:|:--------:|:--------:|
| authorFirstname1| Given name | x | x |
| authorMiddlename1| Middle name | | |
| authorLastname1| Family name | | x |
| authorEmail1| Email | | |
| authorAffiliation1| Affiliation | | x |
| country1| "FI", "SE", "DK", "CA", "US" | | |
| orcid1| Orcid ID, should include "https://". Note that adding Orcid ID's this way is not recommended by Orcid. | | |
| authorBio1| Biography | | x |

### Files
| Field | Description | Required|
|----------|:--------:|:--------:|
| file1| Name of the file, "article1.pdf" or url for remote galley| x |
| fileLabel1| Usually "PDF"| x |
| fileGenre1| Usually "Article Text"| x |
| fileLocale1| "en", "fi" etc. | x |
| Field | Description | Required| Multilingual Support|
|----------|:--------:|:--------:|:--------:|
| file1| Name of the file, "article1.pdf" or url for remote galley| x | |
| fileLabel1| Usually "PDF"| x | x |
| fileGenre1| Usually "Article Text"| x | |
| fileLocale1| "en", "fi" etc. | x | |

## Importing multilingual data

Expand All @@ -104,6 +104,10 @@ en - English
sv - Swedish
fr - French
de - German
ru - Russian
no - Norwegian
da - Danish
es - Spanish

## Licence
The conversion tool is distributed under the GNU GPL v3.
Expand Down

0 comments on commit ceae8d1

Please sign in to comment.