org-hacks.org: reschedule agenda items to today with a single command
[Worg.git] / worg-editing.org
blob0930d951a361a1859f80df441f3a50875d78ff2e
1 #+STARTUP:    align fold nodlcheck hidestars oddeven lognotestate
2 #+SEQ_TODO:   TODO(t) INPROGRESS(i) WAITING(w@) | DONE(d) CANCELED(c@)
3 #+TAGS:       Write(w) Update(u) Fix(f) Check(c)
4 #+EMAIL:      mdl AT imapmail DOT org
5 #+TITLE:      How to edit Worg files?
6 #+AUTHOR:     Worg people
7 #+LANGUAGE:   en
8 #+PRIORITIES: A C B
9 #+CATEGORY:   worg
10 #+OPTIONS:    H:3 num:nil toc:t \n:nil @:t ::t |:t ^:t -:t f:t *:t TeX:t LaTeX:t skip:nil d:(HIDE) tags:not-in-toc
12 [[file:index.org][{Back to Worg's index}]]
14 Since Worg is just starting now, these conventions are just suggestions,
15 not recommendations.  Please improve this.
17 * Conventions
18 ** To-do keywords
20 Here is a table with default to-do keywords and their meaning.
22 | To-do keyword | Meaning                                  |
23 |---------------+------------------------------------------|
24 | TODO(t)       | Things to do                             |
25 | INPROGRESS(i) | Thing being in the process of being done |
26 | WAITING(w@)   | Tasks stuck at some point                |
27 | DONE(d)       | Done task                                |
28 | CANCELED(c@)  | Canceled task                            |
30 Feel free to discuss the relevance of these keywords and propose
31 changes.
33 ** Tags
35 : Write(w) Update(u) Fix(f) Check(c)
37 ** Encoding
38 ** Properties
39 ** Link abbrevations
40 ** Conventions about content?
41 ** How rigid are these conventions?
43 (Suggestion: the farther from the index page you are, the more flexible
44 the conventions should perhaps be.)
46 * What is the default header for new files?
48 You can find a default header here: [[file:worg-header.org][worg-header.org]]
50 * How do I create a file?
52 Just create it.  Before committing changes in Worg, make sure you add
53 the file to the repository index with =git add *.org=
55 * What about dynamic blocks
57 If you are using dynamic blocks in Worg, please don't forget to add the
58 relevant code in the [[file:code/elisp/worg.el][code/elisp/worg.el]] file.  See for example the dynamic
59 block for the timestamp in the [[file:index.org][index]] page.
61 * What about macros
63 If you are using macros, please add them to =macros.setupfile=.
65 ** COMMENT Defined macros explained
67 *** Environments
69     - BeginMiniPage ... EndMiniPage :: creates a mini page with a border. Used to
70          demonstrate layouts (see: [[file:./org-tutorials/images-and-xhtml-export.org]] for
71          an example).
73     - BeginInfoBox ... EndInfoBox :: inserts a box with a little info icon on the
74          left. The text inside flows around the icon. Both, info and warning boxes,
75          use the styles for =.org-info-box= in [[file:worg.css::org-info-box][worg.css]].
77     - BeginWarningBox ... EndWarningBox :: Like =BeginInfoBox= and =EndInfoBox=. The
78          icon used is different.
80     - BeginBlindText ... EndBlindText :: creates a =<span></span>= element, that
81          greys out the text. Used for text that is there just to fill paragraphs
82          to demonstrate text flow (see:
83          [[file:./org-tutorials/images-and-xhtml-export.org]] for an example).
85 * How do I link to the Org version of the file?
86   The raw Org versions of the files are published [[http://orgmode.org/worg/sources/][here]].
87 * COMMENT How do I rename a file?
88 * COMMENT Can I create a directory?
89 * COMMENT What about non-org files in the repository?
91 .el files ?
92 .pdf files