Skip to content

Commit

Permalink
commiting to main
Browse files Browse the repository at this point in the history
  • Loading branch information
rsdoiel committed Feb 26, 2024
1 parent 17d7357 commit e3c0993
Show file tree
Hide file tree
Showing 10 changed files with 230 additions and 424 deletions.
2 changes: 1 addition & 1 deletion CITATION.cff
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ maintainers:
orcid: "https://orcid.org/0000-0003-0900-6903"

repository-code: "https://github.com/caltechlibrary/eprinttools"
version: 1.3.6
version: 1.3.7
license-url: "https://caltechlibrary.github.io/eprinttools/license.html"
keywords: [ "metadata", "repository", "EPrints", "CrossRef", "DataCite", "software" ]
date-released: 2023-06-06
2 changes: 1 addition & 1 deletion installer.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# Set the package name and version to install
#
PACKAGE="eprinttools"
VERSION="1.3.6"
VERSION="1.3.7"
GIT_GROUP="caltechlibrary"
RELEASE="https://github.com/$GIT_GROUP/$PACKAGE/releases/tag/v$VERSION"

Expand Down
97 changes: 36 additions & 61 deletions man/man1/doi2eprintxml.1
Original file line number Diff line number Diff line change
@@ -1,29 +1,11 @@
.\" Automatically generated by Pandoc 3.1.4
.\" Automatically generated by Pandoc 3.1.12
.\"
.\" Define V font for inline verbatim, using C font in formats
.\" that render this, and otherwise B font.
.ie "\f[CB]x\f[]"x" \{\
. ftr V B
. ftr VI BI
. ftr VB B
. ftr VBI BI
.\}
.el \{\
. ftr V CR
. ftr VI CI
. ftr VB CB
. ftr VBI CBI
.\}
.TH "doi2eprintxml" "" "" "" ""
.hy
.SH NAME
.PP
doi2eprintxml
.SH SYNOPSIS
.PP
doi2eprintxml OPTIONS DOI
.SH DESCRIPTION
.PP
doi2eprintxml is a Caltech Library centric application that takes one or
more DOI, queries the CrossRef API and if that fails the DataCite API
and returns an EPrints XML document suitable for import into EPrints.
Expand All @@ -32,115 +14,108 @@ The DOI can be in either their canonical form or URL form
\[lq]https://doi.org/10.1021/acsami.7b15651\[rq]).
.SH OPTIONS
.TP
-help
\-help
display help
.TP
-license
\-license
display license
.TP
-version
\-version
display version
.TP
-D
\-D
attempt to download the digital object if object URL provided
.TP
-c
\-c
only search CrossRef API for DOI records
.TP
-clsrules
\-clsrules
Apply current Caltech Library Specific Rules to EPrintXML output
(default true)
.TP
-crossref
\-crossref
only search CrossRef API for DOI records
.TP
-d
\-d
only search DataCite API for DOI records
.TP
-datacite
\-datacite
only search DataCite API for DOI records
.TP
-dot-initials
\-dot\-initials
Add period to initials in given name
.TP
-download
\-download
attempt to download the digital object if object URL provided
.TP
-eprints-url string
\-eprints\-url string
Sets the EPRints API URL
.TP
-i, -input
\-i, \-input
(string) set input filename
.TP
-json
\-json
output EPrint structure as JSON
.TP
-m
\-m
(string) set the mailto value for CrossRef API access (default
\[lq]helpdesk\[at]library.caltech.edu\[rq])
.TP
-mailto
\-mailto
(string) set the mailto value for CrossRef API access (default
\[lq]helpdesk\[at]library.caltech.edu\[rq])
.TP
-normalize-publisher
\-normalize\-publisher
Use normalize publisher rule
.TP
-normalize-related-url
\-normalize\-related\-url
Use normlize related url rule
.TP
-normlize-publication
\-normlize\-publication
Use normalize publication rule
.TP
-o, -output
\-o, \-output
(string) set output filename
.TP
-quiet
\-quiet
set quiet output
.TP
-simple
\-simple
output EPrint structure as Simplified JSON
.TP
-trim-creators
\-trim\-creators
Use trim creators list rule
.TP
-trim-number
\-trim\-number
Use trim number rule
.TP
-trim-series
\-trim\-series
Use trim series rule
.TP
-trim-title
\-trim\-title
Use trim title rule
.TP
-trim-volume
\-trim\-volume
Use trim volume rule
.SH EXAMPLES
.PP
Example generating an EPrintsXML for one DOI
.IP
.nf
\f[C]
.EX
doi2eprintxml \[dq]10.1021/acsami.7b15651\[dq] > article.xml
\f[R]
.fi
.EE
.PP
Example generating an EPrintsXML for two DOI
.IP
.nf
\f[C]
.EX
doi2eprintxml \[dq]10.1021/acsami.7b15651\[dq] \[dq]10.1093/mnras/stu2495\[dq] > articles.xml
\f[R]
.fi
.EE
.PP
Example processing a list of DOIs in a text file into an XML document
called \[lq]import-articles.xml\[rq].
called \[lq]import\-articles.xml\[rq].
.IP
.nf
\f[C]
doi2eprintxml -i doi-list.txt -o import-articles.xml
\f[R]
.fi
.EX
doi2eprintxml \-i doi\-list.txt \-o import\-articles.xml
.EE
.PP
doi2eprintxml 1.2.4
.SH AUTHORS
Expand Down
Loading

0 comments on commit e3c0993

Please sign in to comment.