Skip to content

UB-Heidelberg/anno-doi-bot-23-adapter-datacite

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

34 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

anno-doi-bot-23-adapter-datacite

DataCite adapter for anno-doi-bot-23.

Installation

  1. Ensure you have the prerequisites:
    • Ubuntu 22.04 or later
    • Node.js v20 or later
    • A clone of the anno-doi-bot-23. (This adapter module is mostly useless without the DOI bot itself.)
  2. Clone this repo and chdir to your clone's top directory.
  3. Create a symlink botfuncs that points to the funcs directory of your anno-doi-bot-23. Usually they should be sibling directories, so the command would be: ln --symbolic --no-target-directory -- ../anno-doi-bot-23/funcs botfuncs
  4. Run npm install .
  5. Continue at chapter "Configuration".

Configuration

  • You can modify the configuration at any time. Changes will take effect the next time the DOI bot runs.
  • The available config options can be found (not: modified) in the default settings file.
  • To customize configuration, create a subdirectory named config, and in there, one or more text files whose name ends in .rc (e.g. basics.rc).
    • All these files are read in your locale's sorting order, which may or may not be case-sensitive. For reliable ordering, start all filenames with a fixed number of digits, e.g. 010_basics.rc, 023_doi_format.rc, 080_hotfixes.rc.

Usage

In production, this adapter is not meant to be used directly. Instead, it should be invoked by your DOI bot.

For debugging, however, there are some useful invocations:

Known issues

  • Needs more/better tests and docs.

 

License

MIT

About

DataCite adapter for anno-doi-bot-23.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published