@@ -25,57 +25,64 @@ used to track progress through the queues when offline.
2525\--version
2626: show version and exit
2727
28+ -t, \--template *TEMPLATE.tex*
29+ : template file (default : template.tex)
30+
31+ -o, \--output *QUEUES.pdf*
32+ : output file
33+
2834# ARGUMENTS
2935
3036*QUEUES.yaml*
3137: YAML file specifying queue information
3238
3339# FILES
3440
35- # # `sections .yaml`
41+ # # `QUEUES .yaml`
3642
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.
3944
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.
4147
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 :
4450
45- name
51+ * name*
4652: name of the queue (string, required)
4753
48- section
54+ * section*
4955: name of the section (string, required)
5056
51- split
57+ * split*
5258: *true* to display items on separate lines (boolean, default *false*)
5359
54- tags
60+ * tags*
5561: list of tags (list of string, optional)
5662
57- date
63+ * date*
5864: date of last update (string, optional)
5965
60- prev
66+ * prev*
6167: previous (complete) item (string, optional)
6268
63- next
69+ * next*
6470: list of next items (list of string, optional)
6571
6672If both *prev* and *next* are specified, then *prev* is ignored.
6773
6874The following tags are supported :
6975
70- complete
76+ * complete*
7177: no new items will be added to the queue
7278
73- partial
79+ * partial*
7480: not all items of the source queue are added to the queue
7581
76- # # `template.tex`
82+ # # Template
7783
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.
7986
8087It is a Jinja2-style template using the following syntax :
8188
@@ -90,44 +97,44 @@ Comments
9097
9198The context contains a single value :
9299
93- sections
100+ * sections*
94101: list of sections
95102
96103A section is an object with the following properties :
97104
98- name
105+ * name*
99106: name of the section (string)
100107
101- queues
108+ * queues*
102109: list of queues
103110
104111A queue is an object with the following properties :
105112
106- name
113+ * name*
107114: name of the queue (string)
108115
109- isSplit
116+ * isSplit*
110117: *true* to display items on separate lines (boolean)
111118
112- isPartial
119+ * isPartial*
113120: *true* if the partial tag is set (boolean)
114121
115- isComplete
122+ * isComplete*
116123: *true* if the complete tag is set (boolean)
117124
118- date
125+ * date*
119126: date or empty string if no date (string)
120127
121- prevItem
128+ * prevItem*
122129: previous item or empty string if not set (string)
123130
124- nextItems
131+ * nextItems*
125132: list of next items (list of strings)
126133
127134# # `QUEUES.pdf`
128135
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.
131138
132139# EXIT CODES
133140
0 commit comments