sapupra project documentation
v0.50.0.98

This is the documentation home for the sapupra project, a simple management system for a personal library of books and other media: barcodes scanned with a smartphone, bibliographic information looked up on the Internet, a catalogue consulted from any browser of the local network.

Concept

goal, the collection, prior art, architecture, glossary

Design

the programs, their messages, the database, the configuration

Manual

the guide, by role: user, admin, developer and prototyping

Future Research

open questions and decisions, in order

Development Standard

coding, documentation, build, and packaging rules

Research Journal

dated witness of work done, newest first

The reference of each program: its options and its files.

sppgate(8)

the gateway: receives the scans of the scan devices by HTTP and hands them to the broker

sppwork(8)

the worker: records the scans, looks them up in the bibliographic sources and catalogues them

sppconsult(8)

the catalogue to read and nothing else: the pages of the search, to put behind a proxy for a reader outside the local network

sppentry(8)

the entry module: pages to settle by hand what the worker could not, to enter items without code and to import the history of Binary Eye

spplabel(1)

the printer of labels: location labels and labels of items, as codes with their text, on pages of SVG

spplist(1)

the printed lists: the catalogue as an Org-mode file with its tables by author, by title and by location, to be exported to PDF or HTML

orgdoc-check(1)

checks the Org-mode documents against the markup rules of the development standard (a maintainer tool, run by make check)