worg-editing.org

   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:      bzg AT altern 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
  11
  12 [[file:index.org][{Back to Worg's index}]]
  13
  14 Since Worg is just starting now, these conventions are just suggestions,
  15 not recommendations.  Please improve this.
  16
  17 * Conventions
  18
  19 ** To-do keywords
  20
  21 Here is a table with default to-do keywords and their meaning.
  22
  23 | To-do keyword | Meaning                                  |
  24 |---------------+------------------------------------------|
  25 | TODO(t)       | Things to do                             |
  26 | INPROGRESS(i) | Thing being in the process of being done |
  27 | WAITING(w@)   | Tasks stuck at some point                |
  28 | DONE(d)       | Done task                                |
  29 | CANCELED(c@)  | Canceled task                            |
  30
  31 Feel free to discuss the relevance of these keywords and propose
  32 changes.
  33
  34 ** Tags
  35
  36 : Write(w) Update(u) Fix(f) Check(c)
  37
  38 ** Encoding
  39 ** Properties
  40 ** Link abbrevations
  41 ** Conventions about content?
  42 ** How rigit are these conventions?
  43
  44 (Suggestion: the farther from the index page you are, the more flexible
  45 the conventions should perhaps be.)
  46
  47 * What is the default header for new files?
  48
  49 You can find a default header here: [[file:worg-header.org][worg-header.org]]
  50
  51 * How do I create a file?
  52
  53 Just create it.  Before committing changes in Worg, make sure you add
  54 the file to the repository index with =git add *.org=
  55
  56 * What about dynamic blocks
  57
  58 If you are using dynamic blocks in Worg, please don't forget to add the
  59 relevant code in the =elisp/worg.el= file.  See for example the dynamic
  60 block for the timestamp in the [[file:index.org][index]] page.
  61
  62 * What about macros
  63
  64 If you are using macros, please add them to =macros.setupfile=.
  65
  66 ** COMMENT Defined macros explained
  67
  68 *** Environments
  69
  70     - BeginMiniPage ... EndMiniPage :: creates a mini page with a border. Used to
  71          demonstrate layouts (see: [[file:./org-tutorials/images-and-xhtml-export.org]] for
  72          an example).
  73
  74     - BeginInfoBox ... EndInfoBox :: inserts a box with a little info icon on the
  75          left. The text inside flows around the icon. Both, info and warning boxes,
  76          use the styles for =.org-info-box= in [[file:worg.css::org-info-box][worg.css]].
  77
  78     - BeginWarningBox ... EndWarningBox :: Like =BeginInfoBox= and =EndInfoBox=. The
  79          icon used is different.
  80
  81     - BeginBlindText ... EndBlindText :: creates a =<span></span>= element, that
  82          greys out the text. Used for text, that is just there to fill paragraphs
  83          to demonstrate text flow (see:
  84          [[file:./org-tutorials/images-and-xhtml-export.org]] for an example).
  85
  86 * COMMENT How do I rename a file?
  87 * COMMENT Can I create a directory?
  88 * COMMENT What about non-org files in the repository?
  89
  90 .el files ?
  91 .pdf files