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:      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 f:t *:t tex:t 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   :PROPERTIES:
  19   :CUSTOM_ID: worg-conventions
  20   :END:
  21 ** To-do keywords
  22
  23 Here is a table with default to-do keywords and their meaning.
  24
  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)       | Completed task                           |
  31 | CANCELED(c@)  | Canceled task                            |
  32
  33 Feel free to discuss the relevance of these keywords and propose
  34 changes.
  35
  36 ** Tags
  37
  38 : Write(w) Update(u) Fix(f) Check(c)
  39
  40 ** Encoding
  41 ** Properties
  42 ** Link abbrevations
  43 ** Conventions about content?
  44   :PROPERTIES:
  45   :CUSTOM_ID: conventions-about-content
  46   :END:
  47
  48 Where you want to follow a documentation convention you may consider the
  49 [[https://code.orgmode.org/bzg/org-mode/raw/master/doc/Documentation_Standards.org][Org documentation standards]].
  50
  51 ** How rigid are these conventions?
  52
  53 (Suggestion: the farther from the index page you are, the more flexible
  54 the conventions should perhaps be.)
  55
  56 * How do I link to other Worg files?
  57   :PROPERTIES:
  58   :CUSTOM_ID: creating-links
  59   :END:
  60
  61 Links to other Worg pages should have the following format:
  62
  63 : [[file:index.org][Worg's home page]]
  64
  65 This link will converted to a relative html link on export that looks
  66 like this:
  67
  68 [[file:index.org][Worg's home page]]
  69
  70 The filename should be a relative path. Thus, if you are creating a
  71 link to the index from within the org-tutorials directory, you should
  72 enter the path as follows:
  73
  74 : [[file:../index.org][Worg's home page]]
  75
  76 The easiest way to create links to files is by typing =C-c C-l= while
  77 editing an org file. This will prompt you for both components of the
  78 link. (Be sure to enter =file:= before the path; this indicates the
  79 type of link.)
  80
  81 To enter file links more easily, you can simply type =C-u C-c C-l=. This
  82 will allow you to locate the file using emacs' built-in completion
  83 facilities and will automatically add the =file:= prefix.
  84
  85 One note of caution here: the path of the resulting link created
  86 depends on the setting of =org-link-file-path-type=. To ensure that you
  87 always use relative links, you can add the following to your =.emacs=
  88 file:
  89
  90 #+begin_src emacs-lisp
  91 (setq org-link-file-path-type 'relative)
  92 #+end_src
  93
  94 * What is the default header for new files?
  95
  96 You can find a default header here: [[file:worg-header.org][worg-header.org]]
  97
  98 * How do I create a file?
  99
 100 Just create it.  Before committing changes in Worg, make sure you add
 101 the file to the repository index with =git add *.org=.
 102
 103 * What about dynamic blocks
 104
 105 If you are using dynamic blocks in Worg, please don't forget to add the
 106 relevant code in the [[file:code/elisp/worg.el][code/elisp/worg.el]] file.  See for example the dynamic
 107 block for the timestamp in the [[file:index.org][index]] page.
 108
 109 * What about macros
 110
 111 If you are using macros, please add them to =macros.setupfile=.
 112
 113 ** COMMENT Defined macros explained
 114
 115 *** Environments
 116
 117     - BeginMiniPage ... EndMiniPage :: creates a mini page with a border. Used to
 118          demonstrate layouts (see: [[file:./org-tutorials/images-and-xhtml-export.org]] for
 119          an example).
 120
 121     - BeginInfoBox ... EndInfoBox :: inserts a box with a little info icon on the
 122          left. The text inside flows around the icon. Both, info and warning boxes,
 123          use the styles for =.org-info-box= in [[file:worg.css::org-info-box][worg.css]].
 124
 125     - BeginWarningBox ... EndWarningBox :: Like =BeginInfoBox= and =EndInfoBox=. The
 126          icon used is different.
 127
 128     - BeginBlindText ... EndBlindText :: creates a =<span></span>= element, that
 129          greys out the text. Used for text that is there just to fill paragraphs
 130          to demonstrate text flow (see:
 131          [[file:./org-tutorials/images-and-xhtml-export.org]] for an example).
 132
 133 * How do I link to the Org version of the file?
 134
 135 The raw Org versions of the files are published [[https://orgmode.org/worg/sources/][here]].
 136
 137 * COMMENT How do I rename a file?
 138 * COMMENT Can I create a directory?
 139 * COMMENT What about non-org files in the repository?
 140
 141 .el files ?
 142 .pdf files