commit: 7691c3d30d290ffbd9be231884469bd49bba4ffe
parent: a85907104bdb5e2122b7946c25fcfdeea6443a9b
author: Chris Noxz <chris@noxz.tech>
date: Fri, 8 Nov 2019 20:08:46 +0100
Add software page about tapas (To APA +s)
2 files changed, 58 insertions(+), 3 deletions(-)
diff --git a/noxz.tech/software/index.md b/noxz.tech/software/index.md
@@ -28,13 +28,17 @@ into a CIDR, or returning an already valid CIDR if provided.
wikipedia pages in your terminal.
{% endcomment %}
-### [ztatus](./ztatus/)
-``ztatus`` creates a status bar for [dwm](https://dwm.suckless.org), and also
-acts as a simple notification daemon.
+### [tapas](./tapas/)
+``tapas`` is a small program used for compiling refer output into the APA
+reference format.
### [xrectdraw](./xrectdraw/)
``xrectdraw`` draws geometry of a rectangular screen region for X11.
+### [ztatus](./ztatus/)
+``ztatus`` creates a status bar for [dwm](https://dwm.suckless.org), and also
+acts as a simple notification daemon.
+
Tools and scripts
-----------------
diff --git a/noxz.tech/software/tapas/index.md b/noxz.tech/software/tapas/index.md
@@ -0,0 +1,51 @@
+tapas
+=====
+The name stands for **t**o **APA**, and the *s* is for added deliciousness.
+It's a small program used for compiling refer output into the APA reference
+format for groff or alike.
+
+The program reads refer output from *stdin* and prints the compiled result to
+*stdout*.
+
+**Note** that tapas doesn't currently fully implement APA. I wrote this program
+because I needed to reference articles using APA instead of MLA, and in time I
+intend to fully implement APA.
+
+Installation
+------------
+Edit config.mk to match your local setup (tapas is installed into the
+/usr/local namespace by default), then simply enter the following command to
+install (if necessary as root):
+
+ make clean install
+
+Customization
+-------------
+tapas can be customized by creating a custom config.h and (re)compiling the
+source code.
+
+Usage
+-----
+Tapas is intended to run in a pipe chain directly after refer, like so:
+
+ ... | refer | tapas | ... | troff
+
+I've added some customization using ds-strings for tapas. These are the
+following:
+
++ ``.ds APA_IN ...``<br/>
+ Used for specifying the word for "In" when referring to articles in books.
++ ``.ds APA_AN ...``<br/>
+ Used for specifying the word or symbol for "and/&" when concatenating
+ authors.
++ ``.ds APA_MS ...``<br/>
+ Used for specifying the macro set output e.g. 'ms'. This is not currently
+ fully developed, and only has support for 'ms'.
++ ``.ds APA_HE ...``<br/>
+ Used for specifying the heading text e.g. 'References'.
+
+License
+-------
+The program is licensed under the MIT license.
+
+get source [here](//git.noxz.tech/tapas/).
