This repository has been archived by the owner on Aug 20, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
R. S. Doiel
committed
Aug 8, 2018
1 parent
58a4e7f
commit 5aa1d82
Showing
13 changed files
with
34 additions
and
22 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -4,7 +4,7 @@ | |
* | ||
* @author R. S. Doiel, <[email protected]> | ||
* | ||
* Copyright (c) 2016, Caltech | ||
* Copyright (c) 2018, Caltech | ||
* All rights not granted herein are expressly reserved by Caltech. | ||
* | ||
* Redistribution and use in source and binary forms, with or without | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -37,7 +37,7 @@ <h1>Documentation</h1> | |
|
||
<footer> | ||
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span> | ||
<span>© 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span> | ||
<span>© 2018 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span> | ||
<span><a href="mailto:[email protected]">Email Us</a></span> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -95,7 +95,7 @@ <h3>Fetch ORCID records</h3> | |
|
||
<footer> | ||
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span> | ||
<span>© 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span> | ||
<span>© 2018 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span> | ||
<span><a href="mailto:[email protected]">Email Us</a></span> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -90,7 +90,7 @@ <h2>EXAMPLES</h2> | |
|
||
<footer> | ||
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span> | ||
<span>© 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span> | ||
<span>© 2018 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span> | ||
<span><a href="mailto:[email protected]">Email Us</a></span> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -79,7 +79,7 @@ <h3>Example Shell commands</h3> | |
|
||
<footer> | ||
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span> | ||
<span>© 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span> | ||
<span>© 2018 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span> | ||
<span><a href="mailto:[email protected]">Email Us</a></span> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -115,7 +115,7 @@ <h1>Supported ORCID API v2.0 End Points</h1> | |
|
||
<footer> | ||
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span> | ||
<span>© 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span> | ||
<span>© 2018 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span> | ||
<span><a href="mailto:[email protected]">Email Us</a></span> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -38,7 +38,7 @@ <h1>Reference material</h1> | |
|
||
<footer> | ||
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span> | ||
<span>© 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span> | ||
<span>© 2018 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span> | ||
<span><a href="mailto:[email protected]">Email Us</a></span> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -41,10 +41,14 @@ <h2>Configuration</h2> | |
</ul> | ||
|
||
<p>If you want to use the API URL <a href="https://pub.orcid.org">https://pub.orcid.org</a> then you’ll need to register an application | ||
to generate your client id and secret. If you want to experiment with the orcid public api to | ||
test code (e.g. say test this package) you can use the example client id and secret describe on the | ||
orcid.org <a href="http://members.orcid.org/api/tutorial-retrieve-data-public-api-curl-12-and-earlier">website</a> | ||
along with the API URL <a href="https://pub.sandbox.orcid.org">https://pub.sandbox.orcid.org</a>.</p> | ||
to generate your client id and secret. This is free for most uses, if you | ||
follow the <a href="https://support.orcid.org/knowledgebase/articles/343182">instructions</a></p> | ||
|
||
<p>If you want to experiment with the orcid public api to | ||
test code (e.g. say test this package) you can use the Sandbox API which is | ||
full of fake data. ORCID has provided an example client id and | ||
secret described in their <a href="http://members.orcid.org/api/tutorial-retrieve-data-public-api-curl-12-and-earlier">documentation</a> | ||
along with the sandbox API URL of <a href="https://pub.sandbox.orcid.org">https://pub.sandbox.orcid.org</a>.</p> | ||
|
||
<p>The bash scripts provided in the repository rely on a few environment variables. | ||
You can define those variables in a Bash script, sourcing that script will then | ||
|
@@ -53,7 +57,7 @@ <h2>Configuration</h2> | |
<p>Below is an example of setup script that would be sourced to access the sandbox</p> | ||
|
||
<pre><code class="language-shell"> #!/bin/bash | ||
export ORCID_API_URL="https://pub.sandbox.orcid.rg" | ||
export ORCID_API_URL="https://pub.sandbox.orcid.org" | ||
export ORCID_CLIENT_ID="APP-01XX65MXBF79VJGF" | ||
export ORCID_CLIENT_SECRET="3a87028d-c84c-4d5f-8ad5-38a93181c9e1"" | ||
</code></pre> | ||
|
@@ -74,8 +78,16 @@ <h2>the ORCID tool</h2> | |
<a href="https://caltechlibrary.github.io/mkpage">mkpage</a> tool together with the templates included in this repository.</p> | ||
|
||
<pre><code class="language-shell"> . etc/sandbox.sh | ||
orcid -works 0000-0003-0900-6903 > 0000-0003-0900-6903-works.json | ||
mkpage "data=0000-0003-0900-6903-works.json" templates/orcid2bibtex.tmpl > 0000-0003-0900-6903.bib | ||
orcid -works-detailed 0000-0003-0900-6903 > 0000-0003-0900-6903-works.json | ||
mkpage "data=0000-0003-0900-6903-works.json" templates/works-detailed-to-bibtex.tmpl > 0000-0003-0900-6903.bib | ||
</code></pre> | ||
|
||
<p>We also include a simple example of tranferring an ORCID profile to a test | ||
file. This works on a record that has standard metadata present.</p> | ||
|
||
<pre><code class="language-shell">. etc/sandbox.sh | ||
orcid -works-detailed 0000-0003-4476-2464 > 0000-0003-4476-2464-works.json | ||
mkpage "data=0000-0003-4476-2464-works.json" templates/orcid2txt.tmpl > 0000-0003-0900-6903.txt | ||
</code></pre> | ||
|
||
<h2>Working with the scripts</h2> | ||
|
@@ -117,7 +129,7 @@ <h2>Reference</h2> | |
|
||
<footer> | ||
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span> | ||
<span>© 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span> | ||
<span>© 2018 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span> | ||
<span><a href="mailto:[email protected]">Email Us</a></span> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -201,7 +201,7 @@ <h2>Compiling from source</h2> | |
|
||
<footer> | ||
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span> | ||
<span>© 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span> | ||
<span>© 2018 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span> | ||
<span><a href="mailto:[email protected]">Email Us</a></span> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,7 +22,7 @@ | |
</nav> | ||
|
||
<section> | ||
<p>Copyright © 2016, Caltech | ||
<p>Copyright © 2018, Caltech | ||
All rights not granted herein are expressly reserved by Caltech.</p> | ||
|
||
<p>Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:</p> | ||
|
@@ -41,7 +41,7 @@ | |
|
||
<footer> | ||
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span> | ||
<span>© 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span> | ||
<span>© 2018 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span> | ||
<span><a href="mailto:[email protected]">Email Us</a></span> | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -3,7 +3,7 @@ | |
// | ||
// @author R. S. Doiel, <[email protected]> | ||
// | ||
// Copyright (c) 2017, Caltech | ||
// Copyright (c) 2018, Caltech | ||
// All rights not granted herein are expressly reserved by Caltech. | ||
// | ||
// Redistribution and use in source and binary forms, with or without | ||
|
@@ -52,7 +52,7 @@ const ( | |
LicenseText = ` | ||
%s %s | ||
Copyright (c) 2016, Caltech | ||
Copyright (c) 2018, Caltech | ||
All rights not granted herein are expressly reserved by Caltech. | ||
Redistribution and use in source and binary forms, with or without | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -19,7 +19,7 @@ | |
|
||
<footer> | ||
<span><h1><A href="http://caltech.edu">Caltech</a></h1></span> | ||
<span>© 2017 <a href="https://www.library.caltech.edu/copyright">Caltech library</a></span> | ||
<span>© 2018 <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>Phone: <a href="tel:+1-626-395-3405">(626)395-3405</a></span> | ||
<span><a href="mailto:[email protected]">Email Us</a></span> | ||
|