How to edit Worg files?

Table of Contents

{Back to Worg's index}

Since Worg is just starting now, these conventions are just suggestions, not recommendations. Please improve this.

Conventions

To-do keywords

Here is a table with default to-do keywords and their meaning.

To-do keyword Meaning
TODO(t) Things to do
INPROGRESS(i) Thing being in the process of being done
WAITING(w@) Tasks stuck at some point
DONE(d) Completed task
CANCELED(c@) Canceled task

Feel free to discuss the relevance of these keywords and propose changes.

Tags

Write(w) Update(u) Fix(f) Check(c)

Encoding

Properties

Link abbrevations

Conventions about content?

Where you want to follow a documentation convention you may consider the Org documentation standards.

How rigid are these conventions?

(Suggestion: the farther from the index page you are, the more flexible the conventions should perhaps be.)

What is the default header for new files?

You can find a default header here: worg-header.org

How do I create a file?

Just create it. Before committing changes in Worg, make sure you add the file to the repository index with git add *.org.

What about dynamic blocks

If you are using dynamic blocks in Worg, please don't forget to add the relevant code in the code/elisp/worg.el file. See for example the dynamic block for the timestamp in the index page.

What about macros

If you are using macros, please add them to macros.setupfile.

How do I link to the Org version of the file?

The raw Org versions of the files are published here.

Documentation from the http://orgmode.org/worg/ website (either in its HTML format or in its Org format) is licensed under the GNU Free Documentation License version 1.3 or later. The code examples and css stylesheets are licensed under the GNU General Public License v3 or later.