content/post/testorg.org

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