Skip to content

Commit fd34fb1

Browse files
author
R. S. Doiel
committed
Quick Save
1 parent 40aff9b commit fd34fb1

27 files changed

+1811
-0
lines changed

‎INSTALL.html‎

Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<title>articlefetch</title>
5+
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
6+
<link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
7+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
8+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
9+
</head>
10+
<body>
11+
<header>
12+
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
13+
</header>
14+
<nav>
15+
<ul>
16+
<li><a href="/">Home</a></li>
17+
<li><a href="index.html">README</a></li>
18+
<li><a href="LICENSE">LICENSE</a></li>
19+
<li><a href="INSTALL.html">INSTALL</a></li>
20+
<li><a href="user_manual.html">User Manual</a></li>
21+
<li><a href="about.html">About</a></li>
22+
<li><a href="search.html">Search</a></li>
23+
<li><a href="https://github.com/caltechlibrary/articlefetch">GitHub</a></li>
24+
</ul>
25+
</nav>
26+
<section>
27+
<h1 id="installation-for-development-of-articlefetch">Installation for
28+
development of <strong>articlefetch</strong></h1>
29+
<p><strong>articlefetch</strong> A client that will submit an search to
30+
an RDM instance and retrieve the articles in the results.</p>
31+
<h2 id="quick-install-with-curl-or-irm">Quick install with curl or
32+
irm</h2>
33+
<p>There is an experimental installer.sh script that can be run with the
34+
following command to install latest table release. This may work for
35+
macOS, Linux and if you’re using Windows with the Unix subsystem. This
36+
would be run from your shell (e.g. Terminal on macOS).</p>
37+
<pre class="shell"><code>curl https://caltechlibrary.github.io/articlefetch/installer.sh | sh</code></pre>
38+
<p>This will install the programs included in articlefetch in your
39+
<code>$HOME/bin</code> directory.</p>
40+
<p>If you are running Windows 10 or 11 use the Powershell command
41+
below.</p>
42+
<div class="sourceCode" id="cb2"><pre
43+
class="sourceCode ps1"><code class="sourceCode powershell"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="fu">irm</span> https<span class="op">://</span>caltechlibrary<span class="op">.</span><span class="fu">github</span><span class="op">.</span><span class="fu">io</span><span class="op">/</span>articlefetch<span class="op">/</span>installer<span class="op">.</span><span class="fu">ps1</span> <span class="op">|</span> <span class="fu">iex</span></span></code></pre></div>
44+
<h3 id="if-your-are-running-macos-or-windows">If your are running macOS
45+
or Windows</h3>
46+
<p>You may get security warnings if you are using macOS or Windows. See
47+
the notes for the specific operating system you’re using to fix
48+
issues.</p>
49+
<ul>
50+
<li><a href="INSTALL_NOTES_macOS.html">INSTALL_NOTES_macOS.md</a></li>
51+
<li><a
52+
href="INSTALL_NOTES_Windows.html">INSTALL_NOTES_Windows.md</a></li>
53+
</ul>
54+
<h2 id="installing-from-source">Installing from source</h2>
55+
<h3 id="required-software">Required software</h3>
56+
<h3 id="steps">Steps</h3>
57+
<ol type="1">
58+
<li>git clone https://github.com/caltechlibrary/articlefetch</li>
59+
<li>Change directory into the <code>articlefetch</code> directory</li>
60+
<li>Make to build, test and install</li>
61+
</ol>
62+
<pre class="shell"><code>git clone https://github.com/caltechlibrary/articlefetch
63+
cd articlefetch
64+
make
65+
make test
66+
make install</code></pre>
67+
</section>
68+
<footer-global></footer-global>
69+
</body>
70+
</html>

‎INSTALL_NOTES_Windows.html‎

Lines changed: 93 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,93 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<title>articlefetch</title>
5+
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
6+
<link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
7+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
8+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
9+
</head>
10+
<body>
11+
<header>
12+
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
13+
</header>
14+
<nav>
15+
<ul>
16+
<li><a href="/">Home</a></li>
17+
<li><a href="index.html">README</a></li>
18+
<li><a href="LICENSE">LICENSE</a></li>
19+
<li><a href="INSTALL.html">INSTALL</a></li>
20+
<li><a href="user_manual.html">User Manual</a></li>
21+
<li><a href="about.html">About</a></li>
22+
<li><a href="search.html">Search</a></li>
23+
<li><a href="https://github.com/caltechlibrary/articlefetch">GitHub</a></li>
24+
</ul>
25+
</nav>
26+
<section>
27+
<p>Installing an unsigned executable on Windows can also pose security
28+
risks, as Windows has built-in mechanisms to protect users from
29+
potentially harmful software. Here’s a general guide on how to do
30+
it:</p>
31+
<h3 id="steps-to-install-an-unsigned-executable-on-windows">Steps to
32+
Install an Unsigned Executable on Windows</h3>
33+
<ol type="1">
34+
<li><p><strong>Download the Executable</strong>: Download the unsigned
35+
executable file you want to install from a trusted source.</p></li>
36+
<li><p><strong>Locate the File</strong>: Use File Explorer to locate the
37+
downloaded file, which is often in the <code>Downloads</code> folder
38+
unless you specified a different location.</p></li>
39+
<li><p><strong>Attempt to Open the File</strong>: Double-click the file
40+
to open it. Windows may show a warning that the file is not commonly
41+
downloaded and could harm your computer.</p></li>
42+
<li><p><strong>Override Security Settings</strong>:</p>
43+
<ul>
44+
<li><strong>Option 1: Run Anyway</strong>
45+
<ul>
46+
<li>When you see the warning, click on <code>More info</code> in the
47+
dialog box.</li>
48+
<li>A new option will appear to <code>Run anyway</code>. Click this to
49+
proceed with the installation.</li>
50+
</ul></li>
51+
<li><strong>Option 2: Disable Windows Defender SmartScreen
52+
(Temporarily)</strong>
53+
<ul>
54+
<li>Open the Start menu and go to <code>Settings</code>.</li>
55+
<li>Navigate to <code>Update &amp; Security</code> &gt;
56+
<code>Windows Security</code> &gt;
57+
<code>App &amp; browser control</code>.</li>
58+
<li>Under <code>Check apps and files</code>, select <code>Off</code>.
59+
This will disable SmartScreen temporarily.</li>
60+
<li>Try running the executable again.</li>
61+
<li>Remember to turn SmartScreen back on after installation for
62+
continued protection.</li>
63+
</ul></li>
64+
</ul></li>
65+
<li><p><strong>Use Command Prompt (Advanced Users)</strong>: If the
66+
above methods don’t work, you can use the Command Prompt to run the
67+
executable directly:</p>
68+
<ul>
69+
<li>Open Command Prompt as an administrator.</li>
70+
<li>Navigate to the directory where the file is located using the
71+
<code>cd</code> command.</li>
72+
<li>Run the file by typing its name and pressing Enter.</li>
73+
</ul></li>
74+
</ol>
75+
<h3 id="important-considerations">Important Considerations</h3>
76+
<ul>
77+
<li><strong>Security Risks</strong>: Running unsigned executables can
78+
expose your system to malware and other security risks. Only proceed if
79+
you trust the source of the software.</li>
80+
<li><strong>User Account Control (UAC)</strong>: UAC might prompt you
81+
for permission to run the executable. Ensure you have administrative
82+
rights to proceed.</li>
83+
<li><strong>Antivirus Software</strong>: Your antivirus software might
84+
also block unsigned executables. You may need to temporarily disable it
85+
or add an exception for the file.</li>
86+
</ul>
87+
<p>If you’re unsure about any of these steps or the safety of the file,
88+
it’s best to consult with someone who has more experience with Windows
89+
or to contact the software developer for support.</p>
90+
</section>
91+
<footer-global></footer-global>
92+
</body>
93+
</html>

‎INSTALL_NOTES_macOS.html‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<title>articlefetch</title>
5+
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
6+
<link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
7+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
8+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
9+
</head>
10+
<body>
11+
<header>
12+
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
13+
</header>
14+
<nav>
15+
<ul>
16+
<li><a href="/">Home</a></li>
17+
<li><a href="index.html">README</a></li>
18+
<li><a href="LICENSE">LICENSE</a></li>
19+
<li><a href="INSTALL.html">INSTALL</a></li>
20+
<li><a href="user_manual.html">User Manual</a></li>
21+
<li><a href="about.html">About</a></li>
22+
<li><a href="search.html">Search</a></li>
23+
<li><a href="https://github.com/caltechlibrary/articlefetch">GitHub</a></li>
24+
</ul>
25+
</nav>
26+
<section>
27+
<p>Installing an unsigned executable on macOS can be a bit tricky due to
28+
macOS’s security features designed to protect users from potentially
29+
harmful software. Here’s a general guide on how to do it:</p>
30+
<ol type="1">
31+
<li><p><strong>Download the Executable</strong>: First, download the
32+
unsigned executable file you want to install.</p></li>
33+
<li><p><strong>Locate the File</strong>: Use Finder to locate the
34+
downloaded file. It’s often in the <code>Downloads</code> folder unless
35+
you specified a different location.</p></li>
36+
<li><p><strong>Attempt to Open the File</strong>: Double-click the file
37+
to open it. macOS will likely show a warning that the file cannot be
38+
opened because it is from an unidentified developer.</p></li>
39+
<li><p><strong>Override Security Settings</strong>:</p>
40+
<ul>
41+
<li><strong>Option 1: Open via Context Menu</strong>
42+
<ul>
43+
<li>Right-click (or Control-click) the file.</li>
44+
<li>Select <code>Open</code> from the context menu.</li>
45+
<li>You’ll see another warning, but this time there will be an option to
46+
<code>Open</code> the file anyway. Click <code>Open</code>.</li>
47+
</ul></li>
48+
<li><strong>Option 2: Allow Apps from Anywhere (Temporarily)</strong>
49+
<ul>
50+
<li>Open <code>System Preferences</code> and go to
51+
<code>Security &amp; Privacy</code>.</li>
52+
<li>Click the lock icon in the bottom left corner and enter your
53+
password to make changes.</li>
54+
<li>Under the <code>General</code> tab, you might see a message about
55+
the app being blocked. Click <code>Open Anyway</code>.</li>
56+
<li>If you don’t see this option, you can temporarily change the setting
57+
to allow apps downloaded from <code>Anywhere</code>. However, this
58+
option is not available in the latest versions of macOS by default. You
59+
may need to use the Terminal to do this:
60+
<ul>
61+
<li>Open Terminal and type:
62+
<code>sudo spctl --master-disable</code></li>
63+
<li>Press Enter and provide your password.</li>
64+
<li>This will allow you to run apps from anywhere, but it’s recommended
65+
to re-enable security by typing <code>sudo spctl --master-enable</code>
66+
after installing your app.</li>
67+
</ul></li>
68+
</ul></li>
69+
</ul></li>
70+
<li><p><strong>Use Terminal (Advanced Users)</strong>: If the above
71+
methods don’t work, you can use the Terminal to run the executable
72+
directly:</p>
73+
<ul>
74+
<li>Open Terminal.</li>
75+
<li>Navigate to the directory where the file is located using the
76+
<code>cd</code> command.</li>
77+
<li>Make the file executable by typing:
78+
<code>chmod +x filename</code></li>
79+
<li>Run the file by typing: <code>./filename</code></li>
80+
</ul></li>
81+
<li><p><strong>Check for Updates</strong>: Sometimes, developers will
82+
sign their apps later. Check if there’s a signed version available to
83+
avoid these steps in the future.</p></li>
84+
</ol>
85+
<h3 id="important-considerations">Important Considerations</h3>
86+
<ul>
87+
<li><strong>Security Risks</strong>: Running unsigned executables can
88+
expose your system to malware and other security risks. Only proceed if
89+
you trust the source of the software.</li>
90+
<li><strong>System Integrity Protection (SIP)</strong>: Some steps might
91+
be restricted by SIP, which is designed to protect your system.
92+
Disabling SIP is not recommended unless absolutely necessary.</li>
93+
</ul>
94+
<p>If you’re unsure about any of these steps or the safety of the file,
95+
it’s best to consult with someone who has more experience with macOS or
96+
to contact the software developer for support.</p>
97+
</section>
98+
<footer-global></footer-global>
99+
</body>
100+
</html>

‎about.html‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<title>articlefetch</title>
5+
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
6+
<link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
7+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
8+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
9+
</head>
10+
<body>
11+
<header>
12+
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
13+
</header>
14+
<nav>
15+
<ul>
16+
<li><a href="/">Home</a></li>
17+
<li><a href="index.html">README</a></li>
18+
<li><a href="LICENSE">LICENSE</a></li>
19+
<li><a href="INSTALL.html">INSTALL</a></li>
20+
<li><a href="user_manual.html">User Manual</a></li>
21+
<li><a href="about.html">About</a></li>
22+
<li><a href="search.html">Search</a></li>
23+
<li><a href="https://github.com/caltechlibrary/articlefetch">GitHub</a></li>
24+
</ul>
25+
</nav>
26+
<section>
27+
<h1 id="about-this-software">About this software</h1>
28+
<h2 id="articlefetch-0.0.0">articlefetch 0.0.0</h2>
29+
<h3 id="authors">Authors</h3>
30+
<ul>
31+
<li>R. S. Doiel, <a href="https://orcid.org/0000-0003-0900-6903"
32+
class="uri">https://orcid.org/0000-0003-0900-6903</a></li>
33+
</ul>
34+
<p>A client that will submit an search to an RDM instance and retrieve
35+
the articles in the results.</p>
36+
<ul>
37+
<li>GitHub: <a href="https://github.com/caltechlibrary/articlefetch"
38+
class="uri">https://github.com/caltechlibrary/articlefetch</a></li>
39+
<li>Issues: <a
40+
href="https://github.com/caltechlibrary/articlefetch/issues"
41+
class="uri">https://github.com/caltechlibrary/articlefetch/issues</a></li>
42+
</ul>
43+
</section>
44+
<footer-global></footer-global>
45+
</body>
46+
</html>

‎articlefetch.1.html‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<title>articlefetch</title>
5+
<link rel="stylesheet" href="https://caltechlibrary.github.io/css/site.css">
6+
<link rel="stylesheet" href="https://media.library.caltech.edu/cl-webcomponents/css/code-blocks.css">
7+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/copyToClipboard.js"></script>
8+
<script type="module" src="https://media.library.caltech.edu/cl-webcomponents/footer-global.js"></script>
9+
</head>
10+
<body>
11+
<header>
12+
<a href="https://library.caltech.edu"><img src="https://media.library.caltech.edu/assets/caltechlibrary-logo.png" alt="Caltech Library logo"></a>
13+
</header>
14+
<nav>
15+
<ul>
16+
<li><a href="/">Home</a></li>
17+
<li><a href="index.html">README</a></li>
18+
<li><a href="LICENSE">LICENSE</a></li>
19+
<li><a href="INSTALL.html">INSTALL</a></li>
20+
<li><a href="user_manual.html">User Manual</a></li>
21+
<li><a href="about.html">About</a></li>
22+
<li><a href="search.html">Search</a></li>
23+
<li><a href="https://github.com/caltechlibrary/articlefetch">GitHub</a></li>
24+
</ul>
25+
</nav>
26+
<section>
27+
<h1 id="name">NAME</h1>
28+
<p>articlefetch</p>
29+
<h1 id="synopsis">SYNOPSIS</h1>
30+
<p>articlefetch <a href="#options">OPTIONS</a> HOSTNAME QUERY_STRING</p>
31+
<h1 id="description">DESCRIPTION</h1>
32+
<p>Take the HOSTNAME and QUERY_STRING values, retrieve the results from
33+
RDM and then using the results retrieve the PDFs.</p>
34+
<h1 id="options">OPTIONS</h1>
35+
<dl>
36+
<dt>-help</dt>
37+
<dd>
38+
display this help page
39+
</dd>
40+
<dt>-version</dt>
41+
<dd>
42+
display version info
43+
</dd>
44+
<dt>-license</dt>
45+
<dd>
46+
display license
47+
</dd>
48+
</dl>
49+
<h1 id="example">EXAMPLE</h1>
50+
<pre class="shell"><code>articlefetch authors.library.caltech.edu &quot;Grubbs, Robert&quot;</code></pre>
51+
</section>
52+
<footer-global></footer-global>
53+
</body>
54+
</html>

0 commit comments

Comments
 (0)