@@ -25,57 +25,64 @@ used to track progress through the queues when offline.
25
25
\--version
26
26
: show version and exit
27
27
28
+ -t, \--template *TEMPLATE.tex*
29
+ : template file (default : template.tex)
30
+
31
+ -o, \--output *QUEUES.pdf*
32
+ : output file
33
+
28
34
# ARGUMENTS
29
35
30
36
*QUEUES.yaml*
31
37
: YAML file specifying queue information
32
38
33
39
# FILES
34
40
35
- # # `sections .yaml`
41
+ # # `QUEUES .yaml`
36
42
37
- This file defines the names and order of sections. It is a list of section
38
- names (strings).
43
+ This file is an object with two properties.
39
44
40
- # # `QUEUES.yaml`
45
+ The *sections* property is a list of section names (strings). Note that the
46
+ order determines the order in the output.
41
47
42
- This file defines the queues. It is a list of queue objects, which have the
43
- following properties :
48
+ The * queues* property is a list of queue objects with the following
49
+ properties :
44
50
45
- name
51
+ * name*
46
52
: name of the queue (string, required)
47
53
48
- section
54
+ * section*
49
55
: name of the section (string, required)
50
56
51
- split
57
+ * split*
52
58
: *true* to display items on separate lines (boolean, default *false*)
53
59
54
- tags
60
+ * tags*
55
61
: list of tags (list of string, optional)
56
62
57
- date
63
+ * date*
58
64
: date of last update (string, optional)
59
65
60
- prev
66
+ * prev*
61
67
: previous (complete) item (string, optional)
62
68
63
- next
69
+ * next*
64
70
: list of next items (list of string, optional)
65
71
66
72
If both *prev* and *next* are specified, then *prev* is ignored.
67
73
68
74
The following tags are supported :
69
75
70
- complete
76
+ * complete*
71
77
: no new items will be added to the queue
72
78
73
- partial
79
+ * partial*
74
80
: not all items of the source queue are added to the queue
75
81
76
- # # `template.tex`
82
+ # # Template
77
83
78
- This file is the LaTeX template used to build the PDF, with XeTeX.
84
+ A LaTeX template is used to build the PDF, using XeTeX. Unless specified
85
+ otherwise, `template.tex` is used.
79
86
80
87
It is a Jinja2-style template using the following syntax :
81
88
@@ -90,44 +97,44 @@ Comments
90
97
91
98
The context contains a single value :
92
99
93
- sections
100
+ * sections*
94
101
: list of sections
95
102
96
103
A section is an object with the following properties :
97
104
98
- name
105
+ * name*
99
106
: name of the section (string)
100
107
101
- queues
108
+ * queues*
102
109
: list of queues
103
110
104
111
A queue is an object with the following properties :
105
112
106
- name
113
+ * name*
107
114
: name of the queue (string)
108
115
109
- isSplit
116
+ * isSplit*
110
117
: *true* to display items on separate lines (boolean)
111
118
112
- isPartial
119
+ * isPartial*
113
120
: *true* if the partial tag is set (boolean)
114
121
115
- isComplete
122
+ * isComplete*
116
123
: *true* if the complete tag is set (boolean)
117
124
118
- date
125
+ * date*
119
126
: date or empty string if no date (string)
120
127
121
- prevItem
128
+ * prevItem*
122
129
: previous item or empty string if not set (string)
123
130
124
- nextItems
131
+ * nextItems*
125
132
: list of next items (list of strings)
126
133
127
134
# # `QUEUES.pdf`
128
135
129
- The output is a file with the same base name as the queues file, but with a
130
- ` .pdf` extension.
136
+ Unless specified otherwise, the built PDF is output to a file with the same
137
+ base name as the queues file but with a `.pdf` extension.
131
138
132
139
# EXIT CODES
133
140
0 commit comments