Skip to content
Permalink
f4bddfc745
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

eoa_metadator/docs/index.rst

Go to file
 
 
Cannot retrieve contributors at this time
Welcome to Metadator's documentation! Code Generator Dependencies Config file
77 lines (56 sloc) 1.91 KB
Raw Blame

Welcome to Metadator's documentation!

.. toctree::
   :maxdepth: 2
   :caption: Contents:

Code Generator

This tool generates files for different purposes based on the metadata of publications.

At the moment the following formats are supported:

  • A PDF page that is prepended to the downloadable chapter files
  • JSON files to create DOIs on DataCite
  • ONIX files for insertion into OJS/OMP (unmaintained as of 2021)
  • BibTeX files and subsequently a formatted suggested citation of publications
  • XHTML files that show a table of contents (unmaintained as of 2021)

Dependencies

  • texlive-xetex
  • python3-pypdf2
  • python3-lxml
  • pandoc

Config file

The program requires a config file that stores some paths and, if a postgres database is used, the credentials for it. If several publication platforms are used, simply create different config files for each instance.

It should contain at least the following fields:

[output]
output_directory:

[server]
media_dir:
production_url:

Output files are written to output_directory. The entry media_dir in the server section should point to the path of the Django media directory on the server, while production_url points to the root URL of the publication platform.

When using SQLite, you can specify the database file like this:

[sqlite]
database_file:

Insert the postgres database credentials like this:

[postgres]
database_name:
user:
host:
password: ""

If a test repository for DOIs is available, the prefix for testing can be given here:

[doi]
testprefix: "10.80956"