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?
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.
19 :CUSTOM_ID: worg-conventions
23 Here is a table with default to-do keywords and their meaning.
25 | To-do keyword | Meaning |
26 |---------------+------------------------------------------|
27 | TODO(t) | Things to do |
28 | INPROGRESS(i) | Thing being in the process of being done |
29 | WAITING(w@) | Tasks stuck at some point |
30 | DONE(d) | Done task |
31 | CANCELED(c@) | Canceled task |
33 Feel free to discuss the relevance of these keywords and propose
38 : Write(w) Update(u) Fix(f) Check(c)
43 ** Conventions about content?
44 ** How rigid are these conventions?
46 (Suggestion: the farther from the index page you are, the more flexible
47 the conventions should perhaps be.)
49 * How do I link to other Worg files?
51 :CUSTOM_ID: creating-links
54 Links to other Worg pages should have the following format:
56 : [[file:index.org][Worg's home page]]
58 This link will converted to a relative html link on export that looks
61 [[file:index.org][Worg's home page]]
63 The filename should be a relative path. Thus, if you are creating a
64 link to the index from within the org-tutorials directory, you should
65 enter the path as follows:
67 : [[file:../index.org][Worg's home page]]
69 The easiest way to create links to files is by typing =C-c C-l= while
70 editing an org file. This will prompt you for both components of the
71 link. (Be sure to enter =file:= before the path; this indicates the
74 To enter file links more easily, you can simply type =C-u C-c C-l=. This
75 will allow you to locate the file using emacs' built-in completion
76 facilities and will automatically add the =file:= prefix.
78 One note of caution here: the path of the resulting link created
79 depends on the setting of =org-link-file-path-type=. To ensure that you
80 always use relative links, you can add the following to your =.emacs=
83 (setq org-link-file-path-type 'relative)
85 * What is the default header for new files?
87 You can find a default header here: [[file:worg-header.org][worg-header.org]]
89 * How do I create a file?
91 Just create it. Before committing changes in Worg, make sure you add
92 the file to the repository index with =git add *.org=.
94 * What about dynamic blocks
96 If you are using dynamic blocks in Worg, please don't forget to add the
97 relevant code in the [[file:code/elisp/worg.el][code/elisp/worg.el]] file. See for example the dynamic
98 block for the timestamp in the [[file:index.org][index]] page.
102 If you are using macros, please add them to =macros.setupfile=.
104 ** COMMENT Defined macros explained
108 - BeginMiniPage ... EndMiniPage :: creates a mini page with a border. Used to
109 demonstrate layouts (see: [[file:./org-tutorials/images-and-xhtml-export.org]] for
112 - BeginInfoBox ... EndInfoBox :: inserts a box with a little info icon on the
113 left. The text inside flows around the icon. Both, info and warning boxes,
114 use the styles for =.org-info-box= in [[file:worg.css::org-info-box][worg.css]].
116 - BeginWarningBox ... EndWarningBox :: Like =BeginInfoBox= and =EndInfoBox=. The
117 icon used is different.
119 - BeginBlindText ... EndBlindText :: creates a =<span></span>= element, that
120 greys out the text. Used for text that is there just to fill paragraphs
121 to demonstrate text flow (see:
122 [[file:./org-tutorials/images-and-xhtml-export.org]] for an example).
124 * How do I link to the Org version of the file?
125 The raw Org versions of the files are published [[http://orgmode.org/worg/sources/][here]].
126 * COMMENT How do I rename a file?
127 * COMMENT Can I create a directory?
128 * COMMENT What about non-org files in the repository?