aboutsummaryrefslogtreecommitdiff
path: root/Readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'Readme.md')
-rw-r--r--Readme.md23
1 files changed, 23 insertions, 0 deletions
diff --git a/Readme.md b/Readme.md
index 9ddf6b3..23b9169 100644
--- a/Readme.md
+++ b/Readme.md
@@ -41,6 +41,29 @@ All command line options are supported in the configuration file.
Additionally, an array of ICS calendar URIs can be specified with the `icalendars` key.
A sample configuration file is included in the repository.
+The probably most interesting configuration options are `output_header`, `output_footer` and `fmt` that control the format of the gathered lessons and events.
+
+I personally use
+
+```toml
+output_header = """
+Woche Datum LP-Abschnitt Std. LP-A. Unterrichtseinheit
+----- --------- ------------ ---------- ------------------------"""
+fmt = "{week:>5} {date.strftime('%d.%m'):>9} {' '*12} {' '*10} {period_events}"
+```
+
+to generate a formatted simple table to use with pandoc.
+
+To generate a latex table one could use:
+
+```toml
+output_header = '''
+\begin{tabular}{l l l l l}
+Woche & Datum & LP-Abschnitt & Std. LP-A. & Unterrichtseinheit \\'''
+fmt = "{week} & {date.strftime('%d.%m')} & & & {period_events} \\"
+output_footer = '\end{tabular}'
+```
+
## Usage
To obtain a list of future lessons for an example (5A) math class run `./lessons.py --class 5A --subject M`.