1 Table of Contents

2 Introduction

• todo-lists
• work-breakdown-structures
• project planning
• time tracking
• document outlines
• markdown based documentation
• simple text databases
  

3 Prerequisites

On Windows it is recommended (but not required) to also install MSYS2 to get access to standard *nix tools like BASH and make. Alternatively, the WSL 2 Windows Subsystem for Linux can be used (although MSYS2 has a better integration into the Windows environment, in my opinion).

4 Command line options

-o outputfile	Set output pathname. The output file format is derived from the output file suffix (.org, .txt, .md, .smmx, .csv, .html)
-so,--stdout fmt	Write output to stdout. fmt must be one of org, txt, md, smmx, csv, html.
-d,--debug	Enable debug output
-n,--dry-run	Don't actually write any output files
-w,--warnings	Show warnings (e.g. unresolved other-project tasks)
-neh,--no-emacs-header	Don't write emacs -*-mode and #+TODO headers (e.g. when creating an include file)
-p,--private	Don't export sub-trees that are marked private
-raw,--rawutf8	Preserve UTF-8 characters (don't convert to CP1252)
-har,--html-auto-refresh	Add auto-refresh code to generated HTML page
-ht,--html-template	Select HTML template file. See templates
-t,--todo level	Force todo.txt style output for all nodes that are nested deeper than level
-g,--org level	Force org-mode style output for all nodes up to (and including) level
-psp,--prefer-simplified-properties	Use simplified syntax for special properties like depends, allocate, ..
-txf,--textformatting	Convert text formatting (bold, italic, underline, strike-through, subscript, superscript) without this option, all text-formatting will be passed on as-is
-tf,--tagsfirst	Place tags before topic title
-tl,--tagslast	Place tags after topic title (org-mode style, default)
-tarsc,--tags-always-require-start-colon	Do not allow tags without start colon
-dpso,--debugprintsuboutline	Print document outline to console (skip todo.txt style child nodes when parent is org-mode style node)
-pd,--preferred-date create|finish|scheduled|deadline	Sets preferred date source when exporting to .smmx mindmap
-siao,--smmx-info-as-org	Convert info nodes to .org formatted text note when exporting to .smmx (default)
-siat,--smmx-info-as-topics	Convert info nodes to actual nodes when exporting to .smmx
-f,--filter tags	Filter out all nodes whose tags do not include at least one of the given tags (comma or colon separated list)
-fa,--filterall tags	Filter out all nodes whose tags do not include all the given tags (comma or colon separated list)
-if,--inversefilter tags	Blacklist all nodes whose tags include at least one of the given tags (comma or colon separated list)
-sf,--state-filter states	Filter output by state(s), e.g. TODO, ACTV
-pf,--property-filter filter	Add property filter, e.g. allocate=*bsp*
-s,--schedule	Enable scheduler mode (project plan export, .csv or .html output)
-sy,--schedule-years	Set maximum project duration (default = 5 years)
-srv,--schedule-resource-view	Create resource view table (in addition to project plan)
-now,--now date	Override current date (default=today) (in scheduler mode)
-tsgp,--time-sheet-grace-period	Maximum number of calendar days until tracked working hours override planned / ideal task working hours (default=10)
-sbsd,--sort-by-start-date	Sort report tasks by start date (in scheduler mode)
-ssg,--schedule-skip-gantt]	Skip Gantt graph generation (in scheduler mode)
-ssgo,--schedule-skip-gantt-overview]	Skip Gantt graph overview generation (in scheduler mode)
-stl,--schedule-traffic-lights	Include traffic lights column in HTML plan (in scheduler mode)
-stls,--schedule-traffic-lights-state	Derive traffic light status from working state instead of status property
-stt,--schedule-task-titles	Show task titles instead of ids in HTML plan (in scheduler mode)
-ms,--milestone milestone_task_id	Create schedule only for the given milestone task
-sde,--set-default-effort-for-all-working-state-tasks	Assign default effort to all tasks with state TODO, ACTV, TEST or DONE. Useful for converting plain todo.txt files to HTML plans
-afg,--autofold-task-groups	Enabling effort folding when task has sub tasks. Useful for converting plain todo.txt files to HTML plans
-nr,--norisk	Ignore all risk properties (in scheduler mode)
-itt,--ignore-time-tracking	Ignore all time sheet entries (in scheduler mode)
-ttp,--time-tracking-project project-id	Filter out all time sheet entries for projects other than project-id
-ktcp,--keep-task-clock-properties	Re-export task clock properties without this switch, task clock properties will be exported as resource clock properties
-docs,--docs	Interpret node text as markdown and append to (HTML) output (via app:md)
-dnf,--docs-no-footer	Skip footer (TOC, foot notes, w3c validator)
-pt,--plain-todo	Convert plain todo.txt or minimal todo.org file to HTML or markdown report. auto-create default resource set allocate-default to default (#+allocate-default: default) set effort-default to 1h (#+effort-default: 1h, -sde) auto fold task groups (-afg) skip gantt charts (-ssg) show task titles instead of ids (-stt) derive traffic lights from task state (-stls) derive (default) document title from filename

5 Main file formats

5.1 Org / todo.txt (.org, .txt)

1. Org or todo.txt (.org, .txt)
2. Markdown (.md)
   • can then be converted to HTML, e.g. via app:md
     • HTML can then be imported into Word or LibreOffice (.docx)
2. SimpleMind Pro Mindmap (.smmx)
3. Comma-separated-value lists (.csv)
   • can be opened in Microsoft Excel or LibreOffice Calc
4. HTML (.html)
   • can be imported into Microsoft Word or LibreOffice Writer
     

• ASCII
• CP1252 (extended ASCII, for western-european languages)
• UTF-8 (unicode, for the rest (majority) of the world)
  

5.1.1 Structured text files

- bread 
- butter 
- milk 

* TODO bread 
* TODO butter 
* TODO milk 

5.1.2 Comments

this is mostly useful for auto-generated files, e.g. for debug-info, or temporary, auto-calculated data (e.g. total efforts). Please do not use this for regular comments (use a NOTE-type node instead).

5.1.3 Date formats

• <2020-12-31 Thu> - (org-mode)
• 2020-12-31 - (shorted org-mode)
• 20201231 - (integer)
• 31Dec2020 - (verbose)
• 31.Dec.2020 - (verbose with dots)
• 31.12.2020 - (Excel)
  
  

5.1.4 General node syntax

• Node header
  1. optional task state
  2. optional tag list (before node title, enclosed in ::)
  3. optional priority ([#<prio_ABC>])
  4. node title
  5. optional effort estimate (in round brackets)
  6. optional progress (in square brackets)
  7. optional tag list (after node title, enclosed in ::)
  8. Example:
     

     * [<task_state>] [<tag_list>] [<priority>] node title [<effort>] [<progress>] [<tag_list>] 

     Node header (org-mode style)

     <task_state_character> [<tag_list>] [<priority>] node title [<effort>] [<progress>] [<tag_list>] 

     Node header (todo.txt style)
     
     
• Node content
  • hash tags
  • simplified properties (scheduled, allocate, depends, ..)
  • :PROPERTIES: (terminated with :END:)
  • arbitrary number of text lines
  • child nodes
    

* [<task_state>] [<tag_list>] [<priority>] node title [<effort>] [<progres>] [<tag_list>] 
 
e.g. 
 
* DONE :ui: [#B] implement icon button (3h) [4/4] 
** DONE add icon attributes to button 
** DONE load icon 
** DONE layout icon 
** DONE render icon 

<task_state_character> [<tag_list>] [<priority>] node title [<effort>] [<tag_list>] 
 
e.g. 
 
* DONE :ui: [#B] implement icon button (3h) [4/4] 
   + add icon attributes to button 
   + load icon 
   + layout icon 
   + render icon 

5.1.5 Text lines

* My Node 
  Some 
  arbitrary 
  text 
  lines. 

5.1.5.1 Escaped text blocks via << .. >>

• ..will not be trimmed (leading and trailing whitespaces remain intact)
• ..are skipped by the parser, which means that
  • property keywords are passed on as regular text (e.g. clock:)
  • lines may begin with special characters like *, -, +, o, !, ..
    

* My Node 
  << 
  * This is an escaped text line 
   
  - this is a markdown list 
     - with a sub list 
      
  id: this will not be interpreted as a property assignment 
  >> 

5.1.6 Identifiers

• the title is converted to lower-case
• spaces are replaced by '-'
• special characters like '[{:' are deleted
• numbers are appended until the id is globally unique ("-1", "-2", ..)
  

* Org Spec 
   ; auto-generated id, 'org-spec' 
 
* Test 
   id: org-test 
 
* Release 
   :PROPERTIES: 
   :task_id: org-release 
   :END: 
    
    
* Staff 
   * Tom 
      ; auto-generated id, 'tom' 
      resource 
 
* Peter 
      resource: ppa 
 
   * Paul 
      id: pkr 
      resource 
 
   * Mary 
      :PROPERTIES: 
      :resource_id: msh 
      :END: 
       

5.1.6.1 Project id

5.1.7 States

5.1.7.1 Example

- bread 
+ butter 
- milk 

5.1.7.2 Example (SW)

5.1.7.2.1 simplified todo.txt syntax

+ write spec 
o implementation [1/5] 
   ; implementation is still work-in-progress 
   + feature 1 
      ; feature 1 is done 
   t feature 2 
      ; feature 2 is currently in testing 
   w wait for 3rd party supplier to send us that new lib 
   - feature 3 
      ! uses 'that new lib' 
   ? feature 4 
      ? do we really need this ? 
   x feature 5 
      ! scrapped. will implement feature 3 instead. 
- write documentation 
   ; why write documentation when more code could be written instead :-) 
% insert great idea for new feature here 

5.1.7.2.2 org-mode syntax

* DONE write spec 
 
* ACTV implementation [1/5] 
   ; implementation is still work-in-progress 
    
** DONE feature 1 
    ; feature 1 is done 
     
** TEST feature 2 
    ; feature 2 is currently in testing 
     
** WAIT wait for 3rd party supplier to send us that new lib 
 
** TODO feature 3 
*** NOTE uses 'that new lib' 
 
** QUES feature 4 
*** QUES do we really need this ? 
 
** DONT feature 5 
*** NOTE scrapped. will implement feature 3 instead. 
 
* TODO write documentation 
   ; why write documentation when more code could be written instead :-) 
    
* IDEA insert great idea for new feature here 

5.1.7.2.3 todo / org-mode mixed syntax

* DONE write spec 
 
* ACTV implementation [1/5] 
   ; implementation is still work-in-progress 
    
** DONE feature 1 
    ; feature 1 is done 
     
** TEST feature 2 
    ; feature 2 is currently in testing 
     
** WAIT wait for 3rd party supplier to send us that new lib 
 
** TODO feature 3 
    ! uses 'that new lib' 
     
** QUES feature 4 
    ? do we really need this ? 
     
** DONT feature 5 
    ! scrapped. will implement feature 3 instead. 
     
* TODO write documentation 
   ; why write documentation when more code could be written instead :-) 
    
* IDEA insert great idea for new feature here 

personally I prefer to use the org-mode syntax for top-level nodes, up to a nesting depth of 2 or maybe 3, then continue with the simplified todo.txt style syntax for the details

5.1.8 Priorities

- [#A] bread 
- [#B] butter 
- [#C] milk 

Assigning priority [#A] to tasks which have to be done next makes it easy to find them

5.1.9 Tags

- :bakery: [#A] bread 
- :farmersmarket: [#B] butter 
- :supermarket: [#C] milk 

5.1.9.1 org-mode style tags

• before the (optional) priority and topic / task title
• or after the topic / task title (emacs org-mode style)
  

- [#A] bread    :bakery: 
- [#B] butter   :farmersmarket: 
- [#C] milk     :supermarket: 

The -tf,—tagsfirst command line option can be used to force placement of the tags before the topic/task title when an .org file is created.

5.1.9.2 Tags without start colon

- bakery:        bread 
- farmersmarket: butter 
- supermarket:   milk 

this implicates that the node title must not contain : characters.

the command line switch -tarsc,--tags-always-requires-start-colon disables support for this tag-list style

5.1.9.3 Hash Tags

- [#A] bread 
   #bakery 
- [#B] butter 
   #farmersmarket 
- [#C] milk 
   #supermarket 

while it is possible for hash tags to contain spaces, it is not recommended to do so

5.1.9.4 allowed-tags

5.1.10 Progress

* My task group [1/4] 
   - subtask 1  
      - not started, yet 
   + subtask 2 
      ! already finished 
   o subtask 3 
      ! still work-in-progress 
   t subtask 4 
      ! currently in testing) 
   ! just a note 
   ? just a question 
   x canceled 

5.1.10.1 Recursive progress calculation

* My task group [3/6] 
   :PROPERTIES: 
   :cookie_data: todo recursive 
   :END 
   - subtask 1  
      - not started, yet 
   + subtask 2 
      ! already finished 
      + subtask 2.1 
      + subtask 2.2 
   o subtask 3 
      ! still work-in-progress 
   t subtask 4 
      ! currently in testing) 
   ! just a note 
   ? just a question 
   x canceled 

the (rather strangely named) cookie_data property stems from the Emacs org-mode format and is supported due to compatibility reasons

* My task group [3/6] 
   recursive 
   - subtask 1  
      - not started, yet 
   + subtask 2 
      ! already finished 
      + subtask 2.1 
      + subtask 2.2 
   o subtask 3 
      ! still work-in-progress 
   t subtask 4 
      ! currently in testing) 
   ! just a note 
   ? just a question 
   x canceled 

5.1.11 Properties

5.1.11.1 User-defined properties

- bread 
  :PROPERTIES: 
  :energy: ~265 kcal per 100g 
  :END: 
   
- butter 
  :PROPERTIES: 
  :energy: ~717 kcal per 100g 
  :fat: ~81g per 100g 
  :END: 
   
- milk 
  :PROPERTIES: 
  :energy: ~42 kcal per 100g 
  :fat: ~1g per 100g 
  :END: 

5.1.11.2 Reserved properties

5.1.11.2.1 Reserved scheduler properties

5.1.11.2.2 Reserved org properties

5.1.11.2.3 Reserved smmx mindmap properties

5.1.11.2.4 Simplified properties

5.1.11.2.4.1 Example

* ACTV write documentation 
          id: org_docs 
    allocate: me  
      effort: 2d 
        risk: 50% 
   scheduled: <2020-01-22 Wed> 
    
* me 
   resource 
   workinghours: mo-fr 19-22, sat-sun 10:00-17:00 
   vacation: <2020-07-03 Fri> - <2020-08-09 Sun> 
     ; if only 

5.1.12 Global Properties

#+title:      My Project 
#+start-date: 23Jan2020 

#+TODO: IDEA TODO ACTV TEST DONT IGNR NOTE QUES WAIT | DONE 

5.1.12.1 Simplified Global Properties

5.1.13 Directives

5.1.13.1 Include files

     title: test project 
start-date: <2020-02-03 Mon> 
 
#+include: staff.org 
 
- First task (1d) 
   allocate: peter 
   #+include: first_task.org 
    
- Second task (2d) 
   allocate: paul 
   #+include: second_task.org 
 
- Third task (5d) 
   allocate: mary 
   #+include: third_task.org 

Each line of an included file will be indentend by the number of spaces before the #+include directive.

5.1.13.2 Default resource allocation

#+allocate-default: me 
 
* me 
  resource 
   
* Task 1 (1d) 
* Task 2 (4d) 

5.1.13.3 Default effort

#+effort-default: 2d 
 
* Task 1 
* Task 2 

this is mostly useful during the early stages of a project when a work breakdown structure starts to form but efforts have not been estimated, yet

5.1.14 Links

* Build flux capacitor 
   ! see https://example.com/research_note.html 

* A list of rather useless web sites 
   ! http://www.rrrgggbbb.com 
   ! http://endless.horse 
   ! http://ihasabucket.com 
   ! https://pointerpointer.com 
   ! http://chihuahuaspin.com 
   ! http://www.blankwindows.com 
   ! http://www.hackertyper.com 
   ! http://notdayoftheweek.com 
   ! http://pixelsfighting.com 
   ! http://buildshruggie.com 

5.1.14.1 Link formats

• Setext / Markdown / Line-wrap protected links:
  • <http://example.com/external_file.org>
    • or other protocols, the parser looks for ://
  • <file.org>
  • <../path/to/file.org>
  • </path/to/file.org>
  • <c:/path/to/file.org>
• Wiki links:
  • [[other_file.org]]
  • [[file.org]]
  • [[../path/to/file.org]]
  • [[/path/to/file.org]]
  • [[c:/path/to/file.org]]
  • [[http://example.com/external_file.org]]
    • or other protocols, the parser looks for ://
• ./file.org
• ../path/to/file.org
• c:/path/to/file.org
• http://example.com/external_file.org
  • or other protocols, the parser looks for ://
    

5.1.14.2 Automatic file suffix replacement

5.1.15 Text Callouts

* My topic 
  > This is a brief description of my topic. 
  > This is the second line of the description. 

Multiple text callouts will be interpreted as separate lines of a single multi-line callout.

When an .org file is converted to an .smmx mind map, text callouts become actual callout boxes (e.g. speech bubbles).

When an .org file is converted to a .csv or .html project plan, text callouts will be converted to comment fields.

5.2 SimpleMind Pro Mindmap (.smmx)

1. Org or todo.txt (.org, .txt)
2. Markdown (.md)
   • can then be converted to HTML via app:md
     • HTML can then be imported into Word or LibreOffice (.docx)
3. SimpleMind Pro Mindmap (.smmx)
   
   

5.2.1 Why mindmaps

5.2.2 Conversion features

• relations between mindmap nodes
  • parent relation
  • relations between any two nodes
• links
  • local file system
  • URLs
  • cloud documents
  • (optional) conversion between .smmx and .org file suffixes
• icons
  • custom icons
  • automatic icon selection depending on task state, priority, or resource description
    • vice versa, the icon is converted back to a task state (and priority) when the mindmap is converted to an .org file
• images
  • scaling
  • rotation
  • thumbnails
• checkboxes and rollup-progress
• calendar date
• text callouts (for nodes and relations)
• image callouts
• top-down, list, and freeform layouts
• text formatting (bold, italic, underline, strike-through)
• position, style, shape and color info
  
  

5.2.3 Images

6 Scheduler

• each task node with a TODO, ACTV, TEST, or DONE state must be assigned
  • an estimated effort (effort)
  • a resource (allocate)
• there must be at least one milestone task (milestone)
• the project must have a start date (start-date global property)
  

6.1 Output formats

suffix	Name	Description
	Console	Console debug output (-d command line option)
.md	Markdown	Markdown tables
.csv	Excel	Excel comma-separated-value lists Can be converted to simple Gantt graphs via the sim_city.xlsx template file.
.html	HTML	HTML tables with Gantt graph(s) The Gantt graph can be disabled with the -ssg,—schedule-skip-gantt command line option The displayed tags can be limited via the schedule-tags global property

Scheduler output formats

6.1.1 Example

$ tks app:org -s myproject.org -o myproject.html 

6.1.2 Custom CSS files

$ tks app:org -s org_in/myproject.org -o html_out/myproject.html 

the CSS file content will be copied into the generated HTML document

6.2 Resources

* Peter Parker 
   ; Peter becomes a resource with the id 'peter-parker' 
   resource 
 
* Paul 
   ; Paul becomes a resource with the id 'pkr' 
   id: pkr 
   resource 
 
* Mary 
   ; Mary becomes a resource with the id 'msh' 
   resource: msh 
 
* Bruce 
   ; Bruce becomes a resource with the id 'batman' 
   :PROPERTIES: 
   :resource_id: batman 
   :END 

6.2.1 Multiple resource assignments

It is always better to assign only one resource to a task and split larger tasks into sub-tasks when necessary

6.3 Working hours

• mo-fr
• mon-fri
• mo-fr, 9:00-17:00
• mo-fr, 9-5
• mo-fr, 23-5
• mo-fr, 8h
• mon-tue 8h, wed off, thu 9h, fr 7h
• mon-tue 8-13, wed 6h, thu 8:00-17:00, fri off
  

6.4 Example

* Peter 
   resource 
   workinghours: mo-thu 8:00-16:30, fri off 

6.4.1 Out of Office periods

6.4.1.1 Vacation

* Peter 
   resource 
   vacation: <2020-01-28 Tue> - <2020-02-14 Fri> 
   vacation: <2020-07-09 Thu> - <2020-07-10 Fri> 

6.4.1.1.1 Public holidays

; x-mas 
#+public-holiday: <2020-12-25 Fri> - <2020-12-26 Sat> 
 
* Peter 
   resource 
    
* Paul 
   resource 
    
* Mary 
   resource 

6.4.1.1.1.1 no-public-holidays

#+public-holiday: <2020-12-25 Fri> - <2020-12-26 Sat> 
 
* Peter 
   resource 
   ; Peter is on holiday on the first day of x-mas but has to work on the second one 
   no-public-holidays 
   vacation: <2020-20-25> 

6.4.1.2 Sickness

* Paul 
   resource 
   sickness: 27.01.2020 

6.4.1.3 Other projects

* Mary 
   resource 
   other-project: <2020-05-25 Mon> - <2020-05-29 Fri> 

6.5 Task dependencies

6.5.1 Parallel sub tasks

* Vacation 
   - Book hotel 
   - Pack suitcase 
   - Apply for a passport 

Sub tasks on the same nesting level are considered parallel tasks by default. Parallel tasks can be assigned to different resources who can then work on them simultaneously.

6.5.2 Serial sub tasks

     title: Ordered Schedule 
start-date: <2020-02-03 Mon> 
 
#+include: staff.org 
 
* Build a house 
   ordered 
   - buy property (1d) 
      allocate: peter 
   - foundation (2d) 
      allocate: paul 
   - rough framing (3d) 
      allocate: mary 
   - plumbing (4d) 
      allocate: paul 
   - electrical installation (5d) 
      allocate: mary 
   - insulation 
      ; the following two tasks can be done in parallel 
      - insulate walls (3d) 
         allocate: peter 
      - insulate roof (3d) 
         allocate: mary 
   - finish interior (7d) 
      allocate: paul 
 
* Milestones 
 
** Move in 
   milestone 
   depends: build-a-house 

6.5.3 Explicit dependencies

6.5.3.1 depends

* Wood 
   - cut down another tree 
* Nails 
   - go to the hardware store 
* Rope 
   - plait some straw 
* Tree House 
   depends: wood, nails, rope 

The dependencies apply to the current node only. If all sub-tasks shall depend on the given task(s), the after property must be used instead.

6.5.3.2 for

* Wood 
   for: tree-house 
   - cut down another tree 
* Nails 
   for: tree-house 
   - go to the hardware store 
* Rope 
   for: tree-house 
   - plait some straw 
* Tree House 

6.5.3.3 after (inherit)

* Spec (1d) 
 
* Implementation 
  after: spec 
  fold 
 
  - module 1 (3d) 
  - module 2 (5d) 

6.6 Task start and end dates

• to the day on which all estimated working hours have been consumed (effort property)
• or to the finished date, in case the task was completed earlier than expected
• or to the day on which the last resource stopped worked on the task (if the task state is DONE)
  

The finished property must be set for all tasks which have been completed before the project even started

6.6.1 Early task starts

6.7 Milestones

; assign all following tasks to Peter 
allocate-default: peter 
 
* Peter 
   resource 
 
* Soup (1h) 
 
* Main Course (2h) 
 
* Dessert (0.5) 
 
* Supper 
   milestone 
   depends: soup, main-course, dessert 

Tasks that were already finished before the project start-date will be ignored by the scheduler

6.8 Folding

* Task 1 
   ; the 'fold' keyword will make the effort of this task the sum of all sub-tasks 
   ; i.e. "task-1" will require a total effort of (0.5+1+3+2) = 6.5h 
   fold 
   - micro sub-task1 (0.5h) 
   - micro sub-task2 (1h) 
   - micro sub-task3 (3h) 
   - micro sub-task4 (2h) 

time sheet entries must reference the parent task, no the the sub-tasks

6.8.1 private

6.8.2 ignore

a similar effect can be achieved by placing the sub-tasks in a sub-node that does not have a work state (TODO, ACTV, TEST, DONE)

7 Time Tracking

7.1 Syntax

* Peter 
   resource 
 
   ; date specifies first day of the week (usually a monday) 
   week 27Jan2020: 
     timetracking.task-1  4 5 6 7   7   insert arbitrary comment here 
     timetracking.task-2  0 1 1 1   0 
     admin                2 0 0 0   0 
     support              2 3 1 0.5 1 

7.1.1 week

while the project id is actually optional (the current project id will automatically be filled in if it's missing), it is highly recommended to prefix all task ids with explicit project ids to avoid any ambiguities.

instead of a unique task-id it is also possible to use an path pattern that consists of anchorfied task titles, separated by . characters. Example: module1.spec

7.1.2 clock

* Peter 
   resource 
    
   clock: timetracking.task-1  27Jan2020  4    insert arbitrary comment here 
   clock: admin                27Jan2020  2 
   clock: support              27Jan2020  2 
   clock: timetracking.task-1  28Jan2020  5 
   clock: timetracking.task-2  28Jan2020  1 
   clock: support              28Jan2020  3 
   clock: timetracking.task-1  29Jan2020  6 
   clock: timetracking.task-2  29Jan2020  1 
   clock: support              29Jan2020  1 
   clock: timetracking.task-1  30Jan2020  7 
   clock: timetracking.task-2  30Jan2020  1 
   clock: support              30Jan2020  0.5 
   clock: timetracking.task-1  31Jan2020  7 
   clock: support              31Jan2020  1 

This syntax is more suitable for auto-generated clock entries. It is used when re-exporting resources to org format.

7.1.3 Clock entries in task

* Peter 
   resource 
 
* Task 1 
   allocate: peter 
   clock: 27Jan2020 4h 

by default, all clock entries (both resource and task) will be exported as resource properties

the -ktcp,--keep-task-clock-properties command line switch can be used to keep the clock entries in their original locations (i.e. in the task definition).

support Emacs org-mode :LOGBOOK: entries

7.2 Now

7.2.1 Time sheet grace period

The default setting is 10 days.

7.3 Privacy

$ tks app:org -psp -neh -ttp sim-city tests_org/private_resource.org -o out_org/public_resource.org 

Re-exported time sheet entries will always be stripped off their comments (which may contain additional working hour details)

8 Documentation

The output format must be either HTML or markdown (output file name suffixes .html or .md).

Generating HTML documents from .org via the --docs switch results in a different output than without the switch. The default conversion creates a mind-map file first, converts that to .md, then to .html.

The markdown-to-HTML conversion uses app:md, which supports many extensions not found in common markdown or GIT flavoured markdown.

The inlined markdown text can include other pre-generated markdown or HTML content, or reference pre-generated documents and images. It is recommended to use a Makefile (or similar build tool) to generated the content as required (i.e. to avoid redundant content generation).

tks app:org --docs tests_org/markdown_docs.org -o out_html/markdown_docs.html 

9 Customizable HTML templates

10 License

Copyright 2020 bsp 
 
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 
 
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 

11 Downloads

• org.7z
• md.7z
  

org.tkx and md.tkx should be installed to the tks applications/ directory so they can be invoked via tks app:org and tks app:md

12 References

• Emacs org-mode - Home of the original Emacs org-mode (FOSS, cross platform)
• tks - Home of the TkScript language (FOSS, cross platform)
• app:md - the TkScript Markdown-to-HTML converter (FOSS, cross platform)
• Text editors:
  • Emacs - Emacs (the best :-)) (FOSS, cross platform)
  • VIM - VI Improved (FOSS, cross platform)
  • NotePad++ - Free and Open Source (FOSS) text editor for Windows
  • iA Writer - For Mac and iOS ("Plain text. Full ownership. Total focus"). Supports Markdown.
  • Byword - For Mac and iOS ("Markdown app for writing in plain text efficiently")
  • Ulysses - For Mac and iOS ("The Ultimate Writing App") (downside: expensive / subscription only)
  • Markor - For Android ("Simple and lightweight, supporting Markdown and todo.txt"). FOSS.
• WSL 2 - Windows Subsystem for Linux
• MSYS2 - a software distro and building platform for Windows (FOSS)