-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathcrossrefapi.1.html
102 lines (99 loc) · 3.44 KB
/
crossrefapi.1.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
<!DOCTYPE html>
<html>
<head>
<title>crossrefapi.1</title>
<link href='https://fonts.googleapis.com/css?family=Open+Sans' rel='stylesheet' type='text/css'>
<link rel="stylesheet" href="/css/site.css">
</head>
<body>
<header>
<a href="http://library.caltech.edu" title="link to Caltech Library Homepage"><img src="/assets/liblogo.gif" alt="Caltech Library logo"></a>
</header>
<nav>
<ul>
<li><a href="/">Home</a></li>
<li><a href="README.html">README</a></li>
<li><a href="LICENSE">LICENSE</a></li>
<li><a href="install.html">INSTALL</a></li>
<li><a href="user-manual.html">User Manual</a></li>
<li><a href="search.html">Search Docs</a></li>
<li><a href="about.html">About</a></li>
<li><a href="https://github.com/caltechlibrary/crossrefapi">GitHub</a></li>
</ul>
</nav>
<section>
<h1 id="name">NAME</h1>
<p>crossrefapi</p>
<h1 id="synopsis">SYNOPSIS</h1>
<p>crossrefapi <a href="#options">OPTIONS</a> types|works DOI</p>
<h1 id="description">DESCRIPTION</h1>
<p>crossrefapi can retrieve “types” and “works” from the CrossRef API.
Is also has the ability to compare the current “works” document with a
JSON document retrieved previously. The program uses the CrossRef REST
API. It follows the etiquette suggested at</p>
<pre><code> http://api.crossref.org/swagger-ui/index.html</code></pre>
<h1 id="options">OPTIONS</h1>
<dl>
<dt>-help</dt>
<dd>
display help
</dd>
<dt>-license</dt>
<dd>
display license
</dd>
<dt>-diff JSON_FILENAME</dt>
<dd>
compares the JSON_FILENAME with the current works retrieved and displays
a diff between them as a JSON array where the first element is the old
values and the second element is the new values.
</dd>
<dt>-mailto string</dt>
<dd>
set the mailto value for API access
</dd>
<dt>-version</dt>
<dd>
display app version
</dd>
</dl>
<h1 id="examples">EXAMPLES</h1>
<p>Return the types of objects in CrossRef (e.g. journal articles)</p>
<pre><code> crossrefapi -mailto="jdoe@example.edu" types</code></pre>
<p>Return the works for the doi “10.1037/0003-066x.59.1.29”</p>
<pre><code> crossrefapi -mailto="jdoe@example.edu" \
works "10.1037/0003-066x.59.1.29"</code></pre>
<p>Compare a previously retrieved “works.json” with the current
version.</p>
<pre><code>crossrefapi -mailto="jdoe@example.edu" -diff works.json \
works "10.1037/0003-066x.59.1.29"</code></pre>
</section>
<footer>
<span>© 2021 <a href="https://www.library.caltech.edu/copyright">Caltech Library</a></span>
<address>1200 E California Blvd, Mail Code 1-32, Pasadena, CA 91125-3200</address>
<span><a href="mailto:library@caltech.edu">Email Us</a></span>
<span>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span>
</footer>
<!-- START: PrettyFi from https://github.com/google/code-prettify -->
<script>
/* We want to add the class "prettyprint" to all the pre elements */
var pre_list = document.querySelectorAll("pre");
pre_list.forEach(function(elem) {
elem.classList.add("prettyprint");
elem.classList.add("linenums");/**/
elem.classList.add("json"); /**/
});
</script>
<style>
li.L0, li.L1, li.L2, li.L3, li.L4, li.L5, li.L6, li.L7, li.L8, li.L9
{
color: #555;
list-style-type: decimal;
}
</style>
<link rel="stylesheet" type="text/css" href="/css/prettify.css">
<script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_
prettify.js"></script>
<!-- END: PrettyFi from https://github.com/google/code-prettify -->
</body>
</html>