Since Worg is just starting now, these conventions are just suggestions, not recommendations. Please improve this.
:PROPERTIES: :CUSTOM_ID: worg-conventions :END:
Here is a table with default to-do keywords and their meaning.
|TODO(t)||Things to do|
|INPROGRESS(i)||Thing being in the process of being done|
|WAITING(w@)||Tasks stuck at some point|
Feel free to discuss the relevance of these keywords and propose changes.
Write(w) Update(u) Fix(f) Check(c)
:PROPERTIES: :CUSTOM_ID: conventions-about-content :END:
Where you want to follow a documentation convention you may consider the Org documentation standards.
(Suggestion: the farther from the index page you are, the more flexible the conventions should perhaps be.)
:PROPERTIES: :CUSTOM_ID: creating-links :END:
Links to other Worg pages should have the following format:
[[file:index.org][Worg's home page]]
This link will converted to a relative html link on export that looks like this:
The filename should be a relative path. Thus, if you are creating a link to the index from within the org-tutorials directory, you should enter the path as follows:
[[file:../index.org][Worg's home page]]
The easiest way to create links to files is by typing
C-c C-l while
editing an org file. This will prompt you for both components of the
link. (Be sure to enter
file: before the path; this indicates the
type of link.)
To enter file links more easily, you can simply type
C-u C-c C-l. This
will allow you to locate the file using emacs' built-in completion
facilities and will automatically add the
One note of caution here: the path of the resulting link created
depends on the setting of
org-link-file-path-type. To ensure that you
always use relative links, you can add the following to your =.emacs=
(setq org-link-file-path-type 'relative)
See also: External links in the Org manual for details on how to link to a specific location within another Worg page.
You can find a default header here:
Just create it. Before committing changes in Worg, make sure you add
the file to the repository index with
git add *.org.
If you are using dynamic blocks in Worg, please don't forget to add the relevant code in the file. See for example the dynamic block for the timestamp in the page.
If you are using macros, please add them to
The raw Org versions of the files are published here.
.el files ? .pdf files