Skip to content

Technical documentation

Svantje Lilienthal edited this page Mar 22, 2019 · 3 revisions

Versioning for published articles has been developed at the ojs-de.net project in Berlin.

New versions can be created of published articles. Newly created versions get a copy of the metadata (without publication date) and galleys of the recent version.

See GUI description: https://github.com/ojsde/versioning/wiki/User-documentation

URL structure

The URL structure of the current article remains the same. You can always get the latest version of an article and its galleys at this URL:

  • current article version: .../article/view/[articleId]
  • current galley version: .../article/view/[articleId]/[galleyId]

Additionally the latest version does also have an URL containing the version number (this is useful to cite this specific version). Older versions of an article can only be accessed via the version URL:

  • specific article version: .../article/version/[articleId]/[version]
  • specific galley version: .../article/version/[articleId]/[version]/[galleyId]

If you use custom identifier instead of the genereated article ids, the URL structure is the same as described above, only with the custiom identifier at the place of the article id.

DOIs and versioning

If DOIs are enabled for the journal, the default setting will be expanded per default by the version number. This means that the version number is always added to DOI, even if there is only one version.

  • DOIs at article level are stored in submission_settings
  • DOIs at galley level are stored in submission_galley_settings

Database structure

Metadata

The metadata of a submission is stored in the following tables:

  • submissions stores information about the submission (e.g. stage_id, date_submitted, etc.)
  • submission_settings stores the metadata that can differ between article versions (and translations) - new column: submission_version
  • published_submissions stores the metadata of a published submission (version specific information is beeing added here)
published_submission_id submission_id issue_id date_published ... published_submission_version prev_ver_id is_current_submission_version
1 1 1 2017-05-01 ... 1 0 0
2 1 1 2017-05-01 ... 2 0 0

Authors

A collumn for the version number has been added to the author_settings table:

author_id submission_version locale setting_name setting_value setting_type
4 1 de_DE lastName Schmidt string
4 2 de_DE lastName Müller string

Galleys

Similar to the metadata of a submission, the galley's metadata needs to be versionized. The same structure has been added to the corresponding tables (the files have been moved to a new table submission_galley_files, so the galley settings can be stored for each version).

  • submission_galley stores the metadata at galley level
  • submission_galley_settings stores the metadata that is relevant for versions (and translations)
  • submission_galley_files stores the galley files for each submission revision

Interfaces

Google Scholar

As each version is displayed at its own article page, the metadata for GoogleScholar (in dublin core) displays also the metadata of this version.

OAI

Only the metadata of the recent article is displayed at the OAI interface.