From e32159428b5d4da93ea924583b1deb2160ca4b95 Mon Sep 17 00:00:00 2001 From: gramanas Date: Sat, 26 Dec 2020 13:41:50 +0200 Subject: Organize repo and fix man path mistakes --- man/quart.5.scd | 90 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 90 insertions(+) create mode 100644 man/quart.5.scd (limited to 'man/quart.5.scd') diff --git a/man/quart.5.scd b/man/quart.5.scd new file mode 100644 index 0000000..3133185 --- /dev/null +++ b/man/quart.5.scd @@ -0,0 +1,90 @@ +quart(5) + +; Tabs are required for indentation ( in emacs) + +# NAME + +quart - document format for *quart*(1) schedules + +# SYNTAX + +*quart* files are inspired by emacs' org-mode. The header contains the time +that the schedule begins and each line represents a quarter of time, or 15 +minures. + +## HEADER + +Before any task, every *quart* file must contain a header with the starting +time of the schedule. It looks like this: + +``` +#+start: 9:15 +``` + +Use capital letters, or lowercase ones. No mixing. + +## COMMENTS + +Every line beginning with `#` is ignored. Comments must start at the beginning +of the line. + +## BODY + +The body of the document contains the tasks. Each task is a line starting with `\* ` +(asterisk and space). The full definition of a task looks like this: + + \* [_REPETITION_] [_FLAG_] <*DESCRIPTION*> + +_FLAG_ and _REPETION_ are optional. See the respective sections below. + +The description can be any arbitrary string. + +## FLAGS + +Each task can have a _flag_ set to make it pop out. There are three flags avaliable: + +|- *Char* +:] *Flag* +:[ *Description* +|- \! +: _Urgent_ +:[ Mark task as important. +|- ? +: _Maybe_ +:[ Mark task as mayhap. +|- @ +: _Depends_ +:[ Task that depends on someone else. + +Use them by adding the required _char_ after the `\* ` in a task: + +``` +#+start: 9:30 +\* ! Meet with Knuth. +``` + +If used with _repetition_ it must go *after* it. + +## REPETITION + +Allows repetition of a task for as many quarters as needed in succession. + +Use them by adding a number right after the `\* ` in a task: + +``` +#+start: 11:30 +* 8 Boring 2h meeting. +``` + +If used with _flags_ it must go *before* any. + +## SPECIAL + +There are two special symbols the _DESCRIPTION_ can contain: + +*=* + Repeat the previous task. It will only carry over the description + so it can contain a different _flag_ or _repetition_ number. + +*-* + None, blank, empty, the most important thing. 15 minutes of doing nothing. \ No newline at end of file -- cgit v1.2.3