Support via Liberapay

How to edit Worg files?

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


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.


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

Conventions about content?

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

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.

Defined macros explained


BeginMiniPage … EndMiniPage
creates a mini page with a border. Used to demonstrate layouts (see: ./org-tutorials/images-and-xhtml-export.html for an example).
BeginInfoBox … EndInfoBox
inserts a box with a little info icon on the left. The text inside flows around the icon. Both, info and warning boxes, use the styles for .infobox in worg.css.
BeginWarningBox … EndWarningBox
Like BeginInfoBox and EndInfoBox. The icon used is different.
BeginBlindText … EndBlindText
creates a <span></span> element, that greys out the text. Used for text that is there just to fill paragraphs to demonstrate text flow (see: ./org-tutorials/images-and-xhtml-export.html for an example).

What about special blocks

Just like Environments, you can use special blocks for special highlighting:

A highlighted indented text box
A box with info.svg image
A box with warning.svg image
A bordered box
Greyed-out text

Documentation from the 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.