Skip to content

Commit

Permalink
chore: bumped up version number.
Browse files Browse the repository at this point in the history
  • Loading branch information
odkr committed Jan 16, 2022
1 parent 0e95e9a commit 83bab09
Show file tree
Hide file tree
Showing 5 changed files with 77 additions and 83 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,11 @@ You use **pandoc-zotxt.lua** at your own risk.
1. Download the
[latest release](https://github.com/odkr/pandoc-zotxt.lua/releases/latest).
2. Unpack it.
3. Move the `pandoc-zotxt.lua-1.1.0b9` directory into the
3. Move the `pandoc-zotxt.lua-1.1.0` directory into the
`filters` sub-directory of your Pandoc data directory
(`pandoc --version` tells you where that is).
4. Symlink or move the file `pandoc-zotxt.lua` from the
`pandoc-zotxt.lua-1.1.0b9` directory up to the `filters` directory.
`pandoc-zotxt.lua-1.1.0` directory up to the `filters` directory.

If you are running a POSIX-compliant operating system (e.g., *BSD,
Linux, or macOS) and have [curl](https://curl.haxx.se/) or
Expand All @@ -47,7 +47,7 @@ into a Bourne-compatible shell:
```sh
( set -eu
: "${HOME:?}" "${XDG_DATA_HOME:="$HOME/.local/share"}"
name=pandoc-zotxt.lua vers=1.1.0b9
name=pandoc-zotxt.lua vers=1.1.0
url="https://github.com/odkr/$name/releases/download/v$vers/$name-$vers.tgz"
for data_dir in "$HOME/.pandoc" "$XDG_DATA_HOME/pandoc"; do
[ -d "$data_dir" ] && break
Expand All @@ -60,7 +60,7 @@ into a Bourne-compatible shell:
```

If you want to use the manual page that ships with this release, you
can add `<Pandoc data directory>/filters/pandoc-zotxt.lua-1.1.0b9/man`
can add `<Pandoc data directory>/filters/pandoc-zotxt.lua-1.1.0/man`
to your `MANPATH`.


Expand Down
44 changes: 21 additions & 23 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,28 +70,26 @@ <h1>Script <code>pandoc-zotxt.lua</code></h1>

<h2> DESCRIPTION</h2>

<p> <strong>pandoc-zotxt.lua</strong> is a Lua filter for Pandoc that looks up citations
in Zotero and adds their bibliographic data to the &ldquo;references&rdquo; metadata
field or a bibliography file, where Pandoc can pick it up.</p></p>
<p> <strong>pandoc-zotxt.lua</strong> is a Lua filter for Pandoc that looks up citations in
Zotero and adds their bibliographic data to the &ldquo;references&rdquo; metadata field
or a bibliography file, where Pandoc can pick it up.</p></p>
<p> You cite your sources using so-called &ldquo;Better BibTeX citation keys&rdquo;
(provided by Better BibTeX for Zotero) or &ldquo;Easy Citekeys&rdquo; (provided
by zotxt) and then tell <strong>pandoc</strong> to filter your document through
<strong>pandoc-zotxt.lua</strong> before processing citations. That&rsquo;s all there
is to it.</p>
(provided by Better BibTeX for Zotero) or &ldquo;Easy Citekeys&rdquo; (provided by
zotxt) and then tell <strong>pandoc</strong> to filter your document through
<strong>pandoc-zotxt.lua</strong> before processing citations. That&rsquo;s all there is to it.</p>

<p> If the &ldquo;references&rdquo; metadata field or a bibliography file already
contains bibliographic data for a citation, that citation will be
ignored.</p>
<p> If the &ldquo;references&rdquo; metadata field or a bibliography file already contains
bibliographic data for a citation, that citation will be ignored.</p>

<h2> CONNECTING TO ZOTERO</h2>

<h2> Desktop client</h2>

<p> By default, bibliographic data is fetched from the Zotero desktop client,
which must be running when you invoke <strong>pandoc</strong>. This is the faster,
easier, and less error-prone method to lookup citations in Zotero.
However, you need to install the zotxt add-on for the Zotero desktop
client to use it.</p>
easier, and less error-prone method to lookup citations in Zotero. However,
you need to install the zotxt add-on for the Zotero desktop client to use
it.</p>

<h2> Web API</h2>

Expand All @@ -109,8 +107,8 @@ <h2> Web API</h2>
Zotero item IDs. Therefore, BetterBibTeX citation keys and Easy Citekeys
have to be translated into search terms: Better BibTeX citation keys are
split up at the first of each series of digits and at uppercase letters
(&ldquo;DoeTitle2020&rdquo; becomes &ldquo;Doe&rdquo;, &ldquo;Title&rdquo;, &ldquo;2020&rdquo;). Easy Citekeys are split
up at the first colon and at the last digit (&ldquo;doe:2020title&rdquo; becomes &ldquo;doe&rdquo;,
(&ldquo;DoeTitle2020&rdquo; becomes &ldquo;Doe&rdquo;, &ldquo;Title&rdquo;, &ldquo;2020&rdquo;). Easy Citekeys are split up
at the first colon and at the last digit (&ldquo;doe:2020title&rdquo; becomes &ldquo;doe&rdquo;,
&ldquo;2020&rdquo;, &ldquo;title&rdquo;).</p>

<p> If a search yields more than one item, you need to add its citation key to
Expand Down Expand Up @@ -220,10 +218,10 @@ <h2> CONFIGURATION</h2>

<ul>
<li><p><code>zotero-api-key</code>: A Zotero API key. Only applies to the Zotero Web API.</p></li>
<li><p><code>zotero-bibliography</code>: A bibliography filename.
Fetched data is added to this file.</p></li>
<li><p><code>zotero-citekey-types</code>: A list of citation key types.
Citation keys are treated as being of any of the listed types only.</p></li>
<li><p><code>zotero-bibliography</code>: A bibliography filename. Fetched data is added to
this file.</p></li>
<li><p><code>zotero-citekey-types</code>: A list of citation key types. Citation keys are
treated as being of any of the listed types only.</p></li>
<li><p><code>zotero-connectors</code>: One or more Zotero connectors:</p>

<table>
Expand Down Expand Up @@ -329,8 +327,8 @@ <h2> KNOWN ISSUES</h2>

<p> A citation key may pick out the wrong item if it picks out a different
items depending on whether it is interpreted as a Better BibTeX citation
key or as an Easy Citekey. Set the &lsquo;zotero-citekey-types&rsquo; metadata field
to fix this.</p>
key or as an Easy Citekey. Set the &lsquo;zotero-citekey-types&rsquo; metadata field to
fix this.</p>

<p> <strong>pandoc-zotxt.lua</strong> creates a temporary file when it adds bibliographic
data to a bibliography file. If Pandoc exits because it catches a signal
Expand Down Expand Up @@ -372,7 +370,7 @@ <h2> SEE ALSO</h2>
<h3>Info:</h3>
<ul>
<li><strong>Copyright</strong>: 2018, 2019, 2020, 2021, 2022 Odin Kroeger</li>
<li><strong>Release</strong>: 1.1.0b9</li>
<li><strong>Release</strong>: 1.1.0</li>
<li><strong>License</strong>: MIT</li>
<li><strong>Author</strong>: Odin Kroeger</li>
</ul>
Expand Down Expand Up @@ -6091,7 +6089,7 @@ <h3>Raises:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-01-16 13:32:38 </i>
<i style="float:right;">Last updated 2022-01-16 13:42:26 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
44 changes: 21 additions & 23 deletions docs/scripts/pandoc-zotxt.lua.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,28 +70,26 @@ <h1>Script <code>pandoc-zotxt.lua</code></h1>

<h2> DESCRIPTION</h2>

<p> <strong>pandoc-zotxt.lua</strong> is a Lua filter for Pandoc that looks up citations
in Zotero and adds their bibliographic data to the &ldquo;references&rdquo; metadata
field or a bibliography file, where Pandoc can pick it up.</p></p>
<p> <strong>pandoc-zotxt.lua</strong> is a Lua filter for Pandoc that looks up citations in
Zotero and adds their bibliographic data to the &ldquo;references&rdquo; metadata field
or a bibliography file, where Pandoc can pick it up.</p></p>
<p> You cite your sources using so-called &ldquo;Better BibTeX citation keys&rdquo;
(provided by Better BibTeX for Zotero) or &ldquo;Easy Citekeys&rdquo; (provided
by zotxt) and then tell <strong>pandoc</strong> to filter your document through
<strong>pandoc-zotxt.lua</strong> before processing citations. That&rsquo;s all there
is to it.</p>
(provided by Better BibTeX for Zotero) or &ldquo;Easy Citekeys&rdquo; (provided by
zotxt) and then tell <strong>pandoc</strong> to filter your document through
<strong>pandoc-zotxt.lua</strong> before processing citations. That&rsquo;s all there is to it.</p>

<p> If the &ldquo;references&rdquo; metadata field or a bibliography file already
contains bibliographic data for a citation, that citation will be
ignored.</p>
<p> If the &ldquo;references&rdquo; metadata field or a bibliography file already contains
bibliographic data for a citation, that citation will be ignored.</p>

<h2> CONNECTING TO ZOTERO</h2>

<h2> Desktop client</h2>

<p> By default, bibliographic data is fetched from the Zotero desktop client,
which must be running when you invoke <strong>pandoc</strong>. This is the faster,
easier, and less error-prone method to lookup citations in Zotero.
However, you need to install the zotxt add-on for the Zotero desktop
client to use it.</p>
easier, and less error-prone method to lookup citations in Zotero. However,
you need to install the zotxt add-on for the Zotero desktop client to use
it.</p>

<h2> Web API</h2>

Expand All @@ -109,8 +107,8 @@ <h2> Web API</h2>
Zotero item IDs. Therefore, BetterBibTeX citation keys and Easy Citekeys
have to be translated into search terms: Better BibTeX citation keys are
split up at the first of each series of digits and at uppercase letters
(&ldquo;DoeTitle2020&rdquo; becomes &ldquo;Doe&rdquo;, &ldquo;Title&rdquo;, &ldquo;2020&rdquo;). Easy Citekeys are split
up at the first colon and at the last digit (&ldquo;doe:2020title&rdquo; becomes &ldquo;doe&rdquo;,
(&ldquo;DoeTitle2020&rdquo; becomes &ldquo;Doe&rdquo;, &ldquo;Title&rdquo;, &ldquo;2020&rdquo;). Easy Citekeys are split up
at the first colon and at the last digit (&ldquo;doe:2020title&rdquo; becomes &ldquo;doe&rdquo;,
&ldquo;2020&rdquo;, &ldquo;title&rdquo;).</p>

<p> If a search yields more than one item, you need to add its citation key to
Expand Down Expand Up @@ -220,10 +218,10 @@ <h2> CONFIGURATION</h2>

<ul>
<li><p><code>zotero-api-key</code>: A Zotero API key. Only applies to the Zotero Web API.</p></li>
<li><p><code>zotero-bibliography</code>: A bibliography filename.
Fetched data is added to this file.</p></li>
<li><p><code>zotero-citekey-types</code>: A list of citation key types.
Citation keys are treated as being of any of the listed types only.</p></li>
<li><p><code>zotero-bibliography</code>: A bibliography filename. Fetched data is added to
this file.</p></li>
<li><p><code>zotero-citekey-types</code>: A list of citation key types. Citation keys are
treated as being of any of the listed types only.</p></li>
<li><p><code>zotero-connectors</code>: One or more Zotero connectors:</p>

<table>
Expand Down Expand Up @@ -329,8 +327,8 @@ <h2> KNOWN ISSUES</h2>

<p> A citation key may pick out the wrong item if it picks out a different
items depending on whether it is interpreted as a Better BibTeX citation
key or as an Easy Citekey. Set the &lsquo;zotero-citekey-types&rsquo; metadata field
to fix this.</p>
key or as an Easy Citekey. Set the &lsquo;zotero-citekey-types&rsquo; metadata field to
fix this.</p>

<p> <strong>pandoc-zotxt.lua</strong> creates a temporary file when it adds bibliographic
data to a bibliography file. If Pandoc exits because it catches a signal
Expand Down Expand Up @@ -372,7 +370,7 @@ <h2> SEE ALSO</h2>
<h3>Info:</h3>
<ul>
<li><strong>Copyright</strong>: 2018, 2019, 2020, 2021, 2022 Odin Kroeger</li>
<li><strong>Release</strong>: 1.1.0b9</li>
<li><strong>Release</strong>: 1.1.0</li>
<li><strong>License</strong>: MIT</li>
<li><strong>Author</strong>: Odin Kroeger</li>
</ul>
Expand Down Expand Up @@ -6091,7 +6089,7 @@ <h3>Raises:</h3>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-01-16 13:32:38 </i>
<i style="float:right;">Last updated 2022-01-16 13:42:26 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
10 changes: 5 additions & 5 deletions docs/topics/README.md.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,11 +92,11 @@ <h2>Installation</h2>
<li>Download the
<a href="https://github.com/odkr/pandoc-zotxt.lua/releases/latest">latest release</a>.</li>
<li>Unpack it.</li>
<li>Move the <code>pandoc-zotxt.lua-1.1.0b9</code> directory into the
<li>Move the <code>pandoc-zotxt.lua-1.1.0</code> directory into the
<code>filters</code> sub-directory of your Pandoc data directory
(<code>pandoc --version</code> tells you where that is).</li>
<li>Symlink or move the file <code>pandoc-zotxt.lua</code> from the
<code>pandoc-zotxt.lua-1.1.0b9</code> directory up to the <code>filters</code> directory.</li>
<code>pandoc-zotxt.lua-1.1.0</code> directory up to the <code>filters</code> directory.</li>
</ol>


Expand All @@ -109,7 +109,7 @@ <h2>Installation</h2>
<pre>
( set -eu
: <span class="string">"${HOME:?}"</span> <span class="string">"${XDG_DATA_HOME:="</span>$HOME/.<span class="keyword">local</span>/share<span class="string">"}"</span>
name=pandoc-zotxt.lua vers=<span class="number">1.1</span>.<span class="number">0</span>b9
name=pandoc-zotxt.lua vers=<span class="number">1.1</span>.<span class="number">0</span>
url=<span class="string">"https://github.com/odkr/$name/releases/download/v$vers/$name-$vers.tgz"</span>
<span class="keyword">for</span> data_dir <span class="keyword">in</span> <span class="string">"$HOME/.pandoc"</span> <span class="string">"$XDG_DATA_HOME/pandoc"</span>; <span class="keyword">do</span>
[ -d <span class="string">"$data_dir"</span> ] &amp;&amp; <span class="keyword">break</span>
Expand All @@ -123,7 +123,7 @@ <h2>Installation</h2>


<p>If you want to use the manual page that ships with this release, you
can add <code>&lt;Pandoc data directory&gt;/filters/pandoc-zotxt.lua-1.1.0b9/man</code>
can add <code>&lt;Pandoc data directory&gt;/filters/pandoc-zotxt.lua-1.1.0/man</code>
to your <code>MANPATH</code>.</p>

<p><a name="Documentation"></a></p>
Expand Down Expand Up @@ -219,7 +219,7 @@ <h2>Further Information</h2>
</div> <!-- id="main" -->
<div id="about">
<i>generated by <a href="http://github.com/stevedonovan/LDoc">LDoc 1.4.6</a></i>
<i style="float:right;">Last updated 2022-01-16 13:32:38 </i>
<i style="float:right;">Last updated 2022-01-16 13:42:26 </i>
</div> <!-- id="about" -->
</div> <!-- id="container" -->
</body>
Expand Down
54 changes: 26 additions & 28 deletions pandoc-zotxt.lua
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,17 @@
-- DESCRIPTION
-- ===========
--
-- **pandoc-zotxt.lua** is a Lua filter for Pandoc that looks up citations
-- in Zotero and adds their bibliographic data to the "references" metadata
-- field or a bibliography file, where Pandoc can pick it up.
-- **pandoc-zotxt.lua** is a Lua filter for Pandoc that looks up citations in
-- Zotero and adds their bibliographic data to the "references" metadata field
-- or a bibliography file, where Pandoc can pick it up.
--
-- You cite your sources using so-called "Better BibTeX citation keys"
-- (provided by Better BibTeX for Zotero) or "Easy Citekeys" (provided
-- by zotxt) and then tell **pandoc** to filter your document through
-- **pandoc-zotxt.lua** before processing citations. That's all there
-- is to it.
-- (provided by Better BibTeX for Zotero) or "Easy Citekeys" (provided by
-- zotxt) and then tell **pandoc** to filter your document through
-- **pandoc-zotxt.lua** before processing citations. That's all there is to it.
--
-- If the "references" metadata field or a bibliography file already
-- contains bibliographic data for a citation, that citation will be
-- ignored.
-- If the "references" metadata field or a bibliography file already contains
-- bibliographic data for a citation, that citation will be ignored.
--
-- CONNECTING TO ZOTERO
-- ====================
Expand All @@ -29,9 +27,9 @@
--
-- By default, bibliographic data is fetched from the Zotero desktop client,
-- which must be running when you invoke **pandoc**. This is the faster,
-- easier, and less error-prone method to lookup citations in Zotero.
-- However, you need to install the zotxt add-on for the Zotero desktop
-- client to use it.
-- easier, and less error-prone method to lookup citations in Zotero. However,
-- you need to install the zotxt add-on for the Zotero desktop client to use
-- it.
--
-- Web API
-- -------
Expand All @@ -50,8 +48,8 @@
-- Zotero item IDs. Therefore, BetterBibTeX citation keys and Easy Citekeys
-- have to be translated into search terms: Better BibTeX citation keys are
-- split up at the first of each series of digits and at uppercase letters
-- ("DoeTitle2020" becomes "Doe", "Title", "2020"). Easy Citekeys are split
-- up at the first colon and at the last digit ("doe:2020title" becomes "doe",
-- ("DoeTitle2020" becomes "Doe", "Title", "2020"). Easy Citekeys are split up
-- at the first colon and at the last digit ("doe:2020title" becomes "doe",
-- "2020", "title").
--
-- If a search yields more than one item, you need to add its citation key to
Expand Down Expand Up @@ -124,11 +122,11 @@
--
-- * `zotero-api-key`: A Zotero API key. Only applies to the Zotero Web API.
--
-- * `zotero-bibliography`: A bibliography filename.
-- Fetched data is added to this file.
-- * `zotero-bibliography`: A bibliography filename. Fetched data is added to
-- this file.
--
-- * `zotero-citekey-types`: A list of citation key types.
-- Citation keys are treated as being of any of the listed types only.
-- * `zotero-citekey-types`: A list of citation key types. Citation keys are
-- treated as being of any of the listed types only.
--
-- * `zotero-connectors`: One or more Zotero connectors:
--
Expand All @@ -144,15 +142,15 @@
-- could not be found, the Zotero Web API is searched next.
--
-- * `zotero-groups`: A list of Zotero group IDs. Only the given groups are
-- searched. By default, all groups you are a member of are searched. Only
-- applies to the Zotero Web API.
-- searched. By default, all groups you are a member of are searched. Only
-- applies to the Zotero Web API.
--
-- * `zotero-public-groups`: A list of Zotero group IDs. The given groups are
-- searched in addition to non-public groups. Groups must be public. Only
-- applies to the Zotero Web API.
-- searched in addition to non-public groups. Groups must be public. Only
-- applies to the Zotero Web API.
--
-- * `zotero-user-id`: A Zotero user ID. Looked up automatically if not given.
-- Only applies to the Zotero Web API.
-- Only applies to the Zotero Web API.
--
-- If a metadata field takes a list of values, but you only want to give one,
-- you can enter that value as a scalar.
Expand Down Expand Up @@ -208,8 +206,8 @@
--
-- A citation key may pick out the wrong item if it picks out a different
-- items depending on whether it is interpreted as a Better BibTeX citation
-- key or as an Easy Citekey. Set the 'zotero-citekey-types' metadata field
-- to fix this.
-- key or as an Easy Citekey. Set the 'zotero-citekey-types' metadata field to
-- fix this.
--
-- **pandoc-zotxt.lua** creates a temporary file when it adds bibliographic
-- data to a bibliography file. If Pandoc exits because it catches a signal
Expand Down Expand Up @@ -250,7 +248,7 @@
-- pandoc(1)
--
-- @script pandoc-zotxt.lua
-- @release 1.1.0b9
-- @release 1.1.0
-- @author Odin Kroeger
-- @copyright 2018, 2019, 2020, 2021, 2022 Odin Kroeger
-- @license MIT
Expand Down Expand Up @@ -631,7 +629,7 @@ end
NAME = 'pandoc-zotxt.lua'

--- The version of this script.
VERSION = '1.1.0b9'
VERSION = '1.1.0'

do
local script_dir, script_name = path_split(PANDOC_SCRIPT_FILE)
Expand Down

0 comments on commit 83bab09

Please sign in to comment.