content/post/testorg.org

   1 #+TAGS: { FAILS(f) PARTLY(p) WORKS(w) }
   2
   3 *Note:* a complete list of these features including keyboard
   4   shortcuts, links, and descriptions is available on
   5   https://github.com/novoid/github-orgmode-tests
   6
   7 This page demonstrates Org-mode features that are (or are not)
   8 supported by github which is using an (old) version of [[https://github.com/bdewey/org-ruby][org-ruby]].
   9
  10 | *Feature*                           | *failed*         | *worked*         |
  11 |-------------------------------------+------------------+------------------|
  12 | simple text formatting              |                  | <2013-02-26 Tue> |
  13 | comment lines                       |                  | <2017-09-17 Sun> |
  14 | multi line comment block            |                  | <2017-09-17 Sun> |
  15 | simple lists                        |                  | <2013-02-26 Tue> |
  16 | lists with checkboxes               | <2014-04-13 Sun> |                  |
  17 | nested lists                        |                  | <2013-10-17 Thu> |
  18 | Headings with TODO items            | <2014-04-13 Sun> |                  |
  19 | hide Drawers                        |                  | <2013-10-17 Thu> |
  20 | simple blocks                       |                  | <2013-02-26 Tue> |
  21 | simple links                        |                  | <2013-02-26 Tue> |
  22 | footnotes                           | <2014-04-13 Sun> |                  |
  23 | custom links                        | <2014-04-13 Sun> |                  |
  24 | link to ID                          | <2014-04-13 Sun> |                  |
  25 | states                              | <2014-04-13 Sun> |                  |
  26 | chain siblings                      | <2014-04-13 Sun> |                  |
  27 | priorities                          |                  | <2013-02-26 Tue> |
  28 | subtask statistics                  |                  | <2013-02-26 Tue> |
  29 | tags                                | <2014-04-13 Sun> |                  |
  30 | simple tables                       |                  | <2013-02-26 Tue> |
  31 | tables formatting: bold             |                  | <2013-10-17 Thu> |
  32 | tables formatting: align numbers    | <2014-04-13 Sun> |                  |
  33 | hiding TBLFM                        |                  | <2013-02-26 Tue> |
  34 | column view                         | <2014-04-13 Sun> |                  |
  35 | showing timestamps                  |                  | <2013-02-26 Tue> |
  36 | showing clocking summaries          |                  | <2013-02-26 Tue> |
  37 | showing clocking drawers            | <2014-04-13 Sun> |                  |
  38 | simple SRC blocks                   |                  | <2013-02-26 Tue> |
  39 | SRC block formatting as verbatim    | <2013-02-26 Tue> |                  |
  40 | SRC blocks with syntax highlighting |                  | <2014-04-13 Sun> |
  41 | LaTeX \alpha \beta \phi             |                  | <2013-10-17 Thu> |
  42 | LaTeX simple formulas               | <2014-04-13 Sun> |                  |
  43 | LaTeX blocks                        | <2014-04-13 Sun> |                  |
  44
  45
  46 * Featuretest
  47 ** Text formatting                                                  :PARTLY:
  48
  49 - *bold*
  50 - /italic/
  51 - _underline_
  52 - +strike through+
  53 - =code=
  54 - ~commands~
  55 - http://orgmode.org
  56
  57 : small example
  58
  59 #+COMMENT: this will never be exported
  60
  61 #+BEGIN_COMMENT
  62 multi
  63 line
  64 comment
  65 #+END_COMMENT
  66
  67
  68 ** Lists                                                            :PARTLY:
  69
  70 simple list:
  71 - Emacs
  72 - Org-mode
  73 - Lists
  74
  75 enumerate:
  76 1. Emacs
  77 2. Org-mode
  78 3. Lists
  79
  80 - Clean out garage
  81   1. [ ] get stuff out
  82      - [ ] be careful with that axe, Eugene
  83   2. [ ] get rid of old stuff
  84      - using eBay?
  85      - try to use rubbish as birthday presents for family
  86   3. [ ] repaint garage
  87   4. [ ] put stuff back in
  88
  89 ** Headings with TODO items                                          :FAILS:
  90
  91 *** TODO Clean out garage [0/4]
  92
  93 **** TODO get stuff out
  94
  95 - be careful with that axe, Eugene
  96
  97 **** TODO get rid of old stuff
  98
  99 - using eBay?
 100 - try to use rubbish as birthday presents for family
 101
 102 **** TODO repaint garage
 103
 104 **** TODO put stuff back in
 105
 106 ** Drawers                                                           :FAILS:
 107
 108 *** NEXT Test with category property                                :mytag:
 109 :PROPERTIES:
 110 :CATEGORY: mycategory
 111 :END:
 112
 113 ** simple blocks ([[http://orgmode.org/org.html#Blocks][docu]])                                              :WORKS:
 114
 115 #+BEGIN_EXAMPLE
 116 Some example from a text file.
 117 #+END_EXAMPLE
 118
 119 - more of it in the Babel section later on
 120
 121 ** comments ([[http://orgmode.org/manual/Comment-lines.html#Comment-lines][docu]])                                                                           :WORKS:
 122
 123 Comment lines:
 124
 125 space hash space:
 126
 127  # This is a comment
 128
 129 space space hash space:
 130
 131   # This is a comment
 132
 133 -----------
 134
 135 Comment block:
 136
 137 #+BEGIN_COMMENT
 138 This is a multi line comment block.
 139 This is the second line.
 140
 141 This is the second paragraph.
 142 #+END_COMMENT
 143
 144 ** Noexport tag of heading                                                          :FAILS:noexport:
 145
 146 This heading is tagged with =noexport= and therefore should not be
 147 exported. Whatever this means for GitHub. ;-)
 148
 149 ** links [[http://orgmode.org/org.html#Hyperlinks][(docu)]]                                                     :PARTLY:
 150
 151 todo: target
 152 : # <<link>>
 153
 154 - id:myexampleid
 155 - [[file:~/.zshrc.local]]
 156 - http://orgmode.org
 157   - [[http://orgmode.org/org.html#External-links][docu: list of external links]]
 158 - custom links: [[contact:John%20Smith][contact:John Smith]]
 159   - [[http://orgmode.org/org.html#Link-abbreviations][docu: link abbrevations]]
 160
 161 - footnotes ([[http://orgmode.org/org.html#Footnotes][docu]])
 162   - plain          [fn::great content here]
 163   - with own label [fn:mylabel:great content here]
 164   - reference      [fn:myotherlabel] [fn:2]
 165
 166 [fn:myotherlabel] This is a footnote from reference above.
 167 [fn:2] This is a footnote with a simple number as label.
 168
 169 *** heading with PROPERTIES drawer containing ID
 170 :PROPERTIES:
 171 :ID: myexampleid
 172 :END:
 173
 174 foo bar
 175
 176 ** states; TODO items ([[http://orgmode.org/org.html#TODO-Items][docu]])                                        :PARTLY:
 177
 178 *** making dependencies explicit
 179
 180 **** example with chain siblings
 181
 182 ***** NEXT buy bike
 183 :PROPERTIES:
 184 :TRIGGER: chain-siblings(NEXT)
 185 :END:
 186
 187 ***** take tour
 188
 189 ***** goto hospital
 190
 191 *** priorities ([[http://orgmode.org/org.html#Priorities][docu]])
 192
 193 **** TODO [#A] example
 194 **** NEXT [#B] example
 195
 196 *** breaking down in subtasks ([[http://orgmode.org/org.html#Breaking-down-tasks][docu]])
 197
 198 **** TODO example [1/3] [33%]
 199 ***** DONE subtask 1
 200 ***** TODO subtask 2
 201 ***** TODO subtask 3
 202 ** tags [[http://orgmode.org/org.html#Tags][(docu)]]                                                       :FAILS:
 203
 204 *** example                                                           :tag:
 205
 206 ** tables simple [[http://orgmode.org/org.html#Tables][(docu)]]                                             :PARTLY:
 207
 208 | *Heading1* | *head2* |
 209 |------------+---------|
 210 | entry      |      42 |
 211 | foo        |    21.7 |
 212 |------------+---------|
 213 | end        |   99.99 |
 214
 215 ** tables complex ([[http://orgmode.org/org.html#The-spreadsheet][docu]], [[http://orgmode.org/worg/org-tutorials/org-spreadsheet-intro.html][tutorial]])                                  :PARTLY:
 216
 217 #+TBLNAME: mydemo-USD-EUR-rate
 218 | *US-Dollar* |      *EUR* |
 219 |           1 | 0.76481836 |
 220
 221 |     *When* | *What*                 | *USD* | *EUR* |
 222 |------------+------------------------+-------+-------|
 223 | 2012-02-03 | Taxi Graz-Airport      |       | 18.00 |
 224 | 2012-02-03 | Taxi Seattle Airport   | 25.00 | 19.12 |
 225 | 2012-02-13 | Taxi                   |  7.00 |  5.35 |
 226 | 2012-02-14 | Taxi                   |  8.00 |  6.12 |
 227 | 2012-02-17 | Taxi to Airport SeaTac | 35.00 | 26.77 |
 228 | 2012-02-22 | Taxi Airport-Graz      |       | 16.00 |
 229 |------------+------------------------+-------+-------|
 230 |            |                        |       | 91.36 |
 231 #+TBLFM: @>$4=vsum(@I$4..@II$4);%.2f::@3$4=@3$3*remote(mydemo-USD-EUR-rate,@2$2);%.2f::@4$4=@4$3*remote(mydemo-USD-EUR-rate,@2$2);%.2f::@5$4=@5$3*remote(mydemo-USD-EUR-rate,@2$2);%.2f::@6$4=@6$3*remote(mydemo-USD-EUR-rate,@2$2);%.2f
 232
 233 ** column view ([[http://orgmode.org/org.html#Column-view][docu]])                                                :FAILS:
 234 :PROPERTIES:
 235 :COLUMNS:  %25ITEM %TAGS %PRIORITY %TODO %10MyProperties
 236 :MyProperties_ALL: "Thomas" "Maria" "Susan" "Joe"
 237 :END:
 238
 239 *** example sub-item                                               :mytag1:
 240 :PROPERTIES:
 241 :MyProperties: Susan
 242 :END:
 243
 244 *** NEXT [#B] another example                                      :mytag2:
 245 :PROPERTIES:
 246 :MyProperties: Thomas
 247 :END:
 248
 249 ** dates & time ([[http://orgmode.org/org.html#Dates-and-Times][docu]])                                               :WORKS:
 250
 251 - ~C-c .~    *insert active* <2012-04-23 Mon>  (with ~C-u~: <2012-04-23 Mon 19:14>)
 252 - ~C-c !~    insert inactive [2012-04-23 Mon]  (with ~C-u~: [2012-04-23 Mon 19:14])
 253
 254 ** clocking time ([[http://orgmode.org/org.html#Clocking-work-time][docu]])                                             :PARTLY:
 255
 256 *** example sub-hierarchy with report
 257
 258 #+BEGIN: clocktable :maxlevel 2 :scope subtree
 259 Clock summary at [2012-11-19 Mon 11:17]
 260
 261 | Headline     | Time    |
 262 |--------------+---------|
 263 | *Total time* | *27:16* |
 264 |--------------+---------|
 265 #+END:
 266
 267 **** example item
 268 :LOGBOOK:
 269 CLOCK: [2012-11-19 Mon 11:16]--[2012-11-19 Mon 11:17] =>  0:01
 270 CLOCK: [2012-11-18 Sun 19:15]--[2012-11-18 Sun 19:23] =>  0:08
 271 :END:
 272
 273 **** another item
 274 :LOGBOOK:
 275 CLOCK: [2012-11-18 Sun 19:26]--[2012-11-18 Sun 19:33] =>  0:07
 276 CLOCK: [2012-11-17 Sat 16:25]--[2012-11-18 Sun 19:25] => 27:00
 277 :END:
 278
 279 ** source code ([[http://orgmode.org/org.html#Working-With-Source-Code][docu]])                                               :PARTLY:
 280
 281 #+BEGIN_SRC python
 282   def foo(argument):
 283        print "Hello World"
 284  #+END_SRC
 285
 286 ** babel ([[http://orgmode.org/org.html#Library-of-Babel][docu]])                                                      :FAILS:
 287
 288 *** babel simple ([[http://orgmode.org/org.html#Working-With-Source-Code][doc]])
 289
 290 - some examples are taken from [[http://orgmode.org/worg/org-contrib/babel/intro.html][Worg: Introduction to Babel]]
 291
 292 **** shell
 293
 294 #+BEGIN_SRC sh
 295 pwd
 296 #+END_SRC
 297
 298 **** ruby
 299
 300 #+begin_src ruby
 301 require 'date'
 302 "This file was last evaluated on #{Date.today}"
 303 #+end_src
 304
 305 **** python
 306
 307 #+BEGIN_SRC python
 308 return 42 + 7
 309 #+END_SRC
 310
 311 **** ditaa
 312
 313 #+begin_src ditaa :file blue.png :cmdline -r
 314   +---------+
 315   | cBLU    |
 316   |         |
 317   |    +----+
 318   |    |cPNK|
 319   |    |    |
 320   +----+----+
 321 #+end_src
 322
 323 *** babel advanced
 324
 325 **** session with shell and R
 326
 327 #+name: directories
 328 #+begin_src sh :results replace
 329   cd ~/archive/events_memories && du -sc * |grep -v total
 330 #+end_src
 331
 332 Using result set "directories" from above as "dirs" in R below:
 333
 334 #+name: directory-pie-chart(dirs = directories)
 335 #+begin_src R :session R-pie-example :file ./dirs.png
 336   pie(dirs[,1], labels = dirs[,2])
 337 #+end_src
 338
 339 ** LaTeX ([[http://orgmode.org/org.html#Embedded-LaTeX][docu]])                                                      :FAILS:
 340
 341 Greek characters \alpha \beta \phi \LaTeX{}  $\varphi$
 342
 343 #+BEGIN_LaTeX
 344
 345   \section{Section Title}
 346
 347   This is \emph{emphasized} and $y=x^2$ is an equation.
 348
 349 #+END_LaTeX
 350
 351
 352 * Testing
 353 ** Headings
 354
 355 ** heading with properties
 356 :PROPERTIES:
 357 :CREATED: <2011-10-09 Sun 15:16>
 358 :END:
 359
 360 ** tables
 361
 362 | *head1*               | *head2* | *head3* |
 363 |-----------------------+---------+---------|
 364 | text                  |      42 | -----   |
 365 | me@server.example.com |      23 | :-)     |
 366 |-----------------------+---------+---------|
 367 |                       |      65 |         |
 368 #+TBLFM: @>$2 = vsum(@I$2..@II$2)
 369
 370 ** links
 371
 372 - direct URL: http://tagstore.org
 373 [[http://tagstore.org][- indirect URL]]
 374 - direct email: me@example.com
 375 - [[me@server.com][indirect email]]
 376
 377 ** examples
 378
 379 verse:
 380 #+begin_verse
 381 This is an example.
 382     Second line.
 383 Very long line with many characters showing the wordwrap feature or the not existing word wrap feature
 384 #+end_verse
 385
 386 quote:
 387 #+begin_quote
 388 This is an example.
 389     Second line.
 390 Very long line with many characters showing the wordwrap feature or the not existing word wrap feature
 391 #+end_quote
 392
 393 only colon:
 394 : This is an example.
 395 :     Second line.
 396 : Very long line with many characters showing the wordwrap feature or the not existing word wrap feature
 397
 398 non-specific source:
 399 #+begin_src
 400 This is an example.
 401     Second line.
 402 Very long line with many characters showing the wordwrap feature or the not existing word wrap feature
 403 #+end_src
 404
 405 python source:
 406 #+begin_src python
 407 if VALUE and dummy < 42:
 408     execute_something("Dummy text", 23)
 409 #+end_src
 410
 411
 412
 413 ** Underscores_like_this
 414
 415 - me_low
 416 - 2_8
 417 - ~*.org_archive~
 418 - ~*.org\_archive~
 419 - *.org\_archive
 420
 421 ** Orgmode examples
 422
 423 Das hier ist eine Erklärung von dem Ganzen:
 424
 425 :conf: ;; this is ELISP code
 426 :conf: (foo (bar))
 427
 428 Und in der Org-mode-Datei wird das dann so angewendet:
 429
 430 :org: :PROPERTIES:
 431 :org: :ID: this-is-an-example
 432 :org: :END: