Skip to content

Commit

Permalink
Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
withanage committed May 20, 2020
1 parent 84adb65 commit 35897b3
Show file tree
Hide file tree
Showing 4 changed files with 31 additions and 6 deletions.
18 changes: 16 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@ This plugin registers DOIS for monographs and chapters for DOI provider [Dataci

Additionally it supports [da|ra](https://www.da-ra.de/home/) registration; Germany based Datacite DOI registration agency.

Avaliable in : [German](README_DE.md)

###### Installation
```bash
OMP=/path/to/OMP_INSTALLATION
Expand All @@ -14,18 +16,30 @@ git clone https://github.com/withanage/datacite

###### Setup Datacite
![datacite](www/datacite.png)

* Navigate to {OMP_SERVER}/index.php/{MY_PRESS}/management/importexport/plugin/DataciteExportPlugin
* Use da|ra as DOI provider: Leave unchecked
* Datacite URL : Use the test or production URL
* Username : Username
* Password: Password
* Only for testing: Use the DataCite test prefix for DOI registration. Please do not forget to remove this option for the production.
* Test registry: (Only for testing), procided by datacite or da|ra
* Test registry: (Only for testing), provided by datacite
* Test URL: (Only for testing) Production URL for overwriting the XML entries

###### Setup Dara
![dara](www/dara.png)

* Use da|ra as DOI provider: Please click this button
* Datacite URL : Use the test or production URL of DARA API
* Username : Username
* Password: Password
* Only for testing: Use the da|ra test prefix for DOI registration. Please do not forget to remove this option for the production.
* Test registry: (Only for testing), provided by da|ra
* Test URL: (Only for testing) Production URL for overwriting the XML entries

###### Usage
![usage](www/usage.gif)
###### Credits

* Main developer and Designer

[https://github.com/withanage](https://github.com/withanage)
19 changes: 15 additions & 4 deletions README_DE.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,28 @@ git clone https://github.com/withanage/datacite

###### Setup Datacite
![datacite](www/datacite.png)
* Navigieren zu {OMP_SERVER}/index.php/{MY_PRESS}/management/importexport/plugin/DataciteExportPlugin
* Verwenden Sie da|ra als DOI-Anbieter: Dieses Kontrollkästchen deaktivierern
* Datacite-URL: Verwenden Sie die Test- oder Produktions-URL
* Benutzername: Benutzername
* Passwort: Passwort
* Nur zum Testen: Verwenden Sie das DataCite-Testpräfix für die DOI-Registrierung. Bitte vergessen Sie nicht, diese Option für die Produktion zu entfernen.
* Test registry: (Nur zum Testen), bereitgestellt von datacite oder da|ra
* Test registry: (Nur zum Testen), bereitgestellt von datacite
* Test-URL: (nur zum Testen) Produktions-URL zum Überschreiben der XML-Einträge
###### Setup Da|ra
![dara](www/dara.png)
* Verwenden Sie da|ra als DOI-Anbieter: Dieses Kontrollkästchen aktivierern
* Datacite-URL: Verwenden Sie die Test- oder Produktions API von da|ra
* Benutzername: Benutzername
* Passwort: Passwort
* Nur zum Testen: Verwenden Sie das da|ra-Testpräfix für die DOI-Registrierung. Bitte vergessen Sie nicht, diese Option für die Produktion zu entfernen.
* Test registry: (Nur zum Testen), bereitgestellt von da|ra
* Test-URL: (nur zum Testen) Produktions-URL zum Überschreiben der XML-Einträge


####### Production server
####### Test Server
###### Usage
![usage](www/usage.gif)

###### Credits
*Hauptentwickler und Designer

[https://github.com/withanage](https://github.com/withanage)
Binary file added www/dara.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added www/usage.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 35897b3

Please sign in to comment.