tscholarref.txt: change heading style - adamsgaard.dk - my academic webpage
(HTM) git clone git://src.adamsgaard.dk/adamsgaard.dk
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 3d728665c7ec2a79d7098c5a3794892ec9797054
(DIR) parent 0080badf3662fe353cb0e07ec8b1761d3f1e13b8
(HTM) Author: Anders Damsgaard <anders@adamsgaard.dk>
Date: Tue, 15 Dec 2020 10:22:54 +0100
scholarref.txt: change heading style
Diffstat:
M pages/002-scholarref.txt | 29 +++++++++++++++--------------
1 file changed, 15 insertions(+), 14 deletions(-)
---
(DIR) diff --git a/pages/002-scholarref.txt b/pages/002-scholarref.txt
t@@ -1,4 +1,5 @@
--- Rationale --
+
+## Rationale
During the writing phase of an academic paper, common tasks include
downloading PDFs of publications and getting their references into
your bibliography. However, I am not a fan of navigating the slow,
t@@ -41,7 +42,7 @@ parties. What is demonstrated here are examples only. Use of the
tools is entirely your own responsibility.
--- Installation --
+## Installation
$ git clone git://src.adamsgaard.dk/scholarref
$ cd scholarref
t@@ -52,7 +53,7 @@ install the tools to /usr/local. Prefix with doas(1) or sudo(1),
whatever is appropriate for the target system.
--- The scholarref toolset --
+## The scholarref toolset
The core functionality is provided by the scripts getdoi, getref,
and shdl. All programs accept input as command-line arguments or
t@@ -62,7 +63,7 @@ and it is encouraged to explore the help text (invoke with option
all communication through Tor via torsocks(1) (if available on the
system).
-- getdoi -
+### getdoi
This tool accepts either names of PDF files or arbitrary search
queries. If a PDF file name is supplied, getdoi scans the PDF text
in order to find the first occuring DOI entry, which typically is
t@@ -78,7 +79,7 @@ journal name, etc. Examples:
The -o option will open the resultant DOI in the system web browser.
-- getref -
+### getref
The getref tool fetches the BibTeX citation for a given DOI from
doi.org. By default, the journal names and author first names are
abbreviated, which is what most journals want. I have taken
t@@ -117,7 +118,7 @@ Do not abbreviate journal title with -j option:
}
-- shdl -
+### shdl
This tool takes a DOI as input and attempts to download the
corresponding publication as a PDF through sci-hub[3]. Unfortunately,
the sci-hub web interface often puts up captias to restrict automated
t@@ -127,7 +128,7 @@ the download. Output PDF files are saved in the present working
directory.
--- Usage examples --
+## Usage examples
The scholarref tools are meant to be chained together. For example,
if you want a BibTeX reference a search query, simply use UNIX pipes
t@@ -158,13 +159,13 @@ environment variable, for instance defined in the user ~/.profile.
Citation Damsgaard2016 added to /home/ad/articles/own/BIBnew.bib
--- Integrating into your favorite $EDITOR --
+## Integrating into your favorite $EDITOR
The scholarref tool is particularly useful if called from within a
text editor. Below I demonstrate how keyboard bindings can be bound
in various editors to provide scholarref functionality.
-- vi -
+### vi
My editor of choice is the plain, old, and simple (n)vi(1). I have
the following binding in my ~/.exrc, including a trailing space:
t@@ -173,7 +174,7 @@ the following binding in my ~/.exrc, including a trailing space:
The rest of my editor configuration can be found under my dotfiles
source code repository[4].
-- vim -
+### vim
You can add the following bindings to ~/.vimrc or ~/.vim/vimrc in
order to get scholarref functionality within vim(1):
t@@ -182,18 +183,18 @@ order to get scholarref functionality within vim(1):
" append reference into $BIB file
nnoremap <leader>R :r !scholarref --add<space>
-- vis -
+### vis -
The vis(1) editor[5] is an interesting combination of modal editing
and structural regular expressions from the plan9 editor sam(1)[6].
Add the following binding to ~/.config/vis/visrc.lua:
vis:map(vis.modes.NORMAL, leader..'r', '< scholarref ')
-- emacs -
+### emacs
Don't know, figure it out yourself.
--- Integrating into your pdf viewer --
+## Integrating into your pdf viewer
My PDF viewer of choice is zathura(1)[7], which has a minimal
graphical user interface and is keyboard-centric. The following
t@@ -208,7 +209,7 @@ accompanying reference and adds it directly to the bibliography.
My full zathura configuration is available here: [8]
--- Questions/bugs/feedback/improvements --
+## Questions/bugs/feedback/improvements
Please get in touch if you encounter any. Improvement suggestions
are best sent as patches by e-mail.