summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/sdaps/README
blob: 3d955574b0b53ebbadf8efdf4266a7ae5435bacf (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
SDAPS Class and Package repository
==================================

This repository contains LaTeX classes and packages to create machine readable
questionnaires. Metadata is generated for the whole document and it is
possible to process created forms fully automatically using the SDAPS main
program.
As of now, this package is included in the SDAPS unstable (1.9.0) distribution.

Features
========

 * Flexible metadata generation
 * Different question types:
   - Freeform text
   - Multiple Choice Questions
     * may contain freeform text fields
       (TODO: some people would like a combined checkbox + textfield)
     * standalone
     * as a list (to be implemented)
     * array with questions in rows
     * array with questions in columns
   - Single Choice Qeustions:
     * standalone (to be implemented)
     * as a list (to be implemented)
     * array with questions in rows
     * array with questions in columns
   - Range (1-n answers with optionally further choices):
     * standalone
     * array with questions in rows
 * Array layout features (used for questions in arrays):
   - Can flow over multiple pages and repeats the header automatically
   - Optional document wide alignment of array environments
   - Has complex layout features like rotating the headers to safe space
   - Ability to exchange rows and columns on the fly
 * PDF form generation
 * Complex document wide and local setting handling
 * Possibility to pre-fill questionnaires directly in LaTeX
   (not yet easily usable by end users)

Documentation
=============

The most up to date documentation is in the sphinx directory. An online copy
can be found at http://sdaps.org/class-doc. The documentation in the files
is outdated at this point and likely to be stripped down rather than extended.

Created Files
-------------

 * sdapsbase.sty: Base functionality on which everything else is build.
 * sdapsclassic.cls: Class for creating questionnaires
                     (currently the only proper way of using these packages)
 * sdapspdf.sty: Makes any SDAPS document into a PDF form
 * sdapsarray.sty: Base functionality for tabular like layouts
 * sdapslayout.sty: Base functionality for complex question layouts
 * sdapscode128.tex: Code 128 barcode renderer (re-licensed upstream copy)