1 #+FLAGS: { FAILS(f) PARTLY(p) WORKS(w) }
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
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]].
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> | |
47 ** Text formatting :PARTLY:
59 #+COMMENT: this will never be exported
82 - [ ] be careful with that axe, Eugene
83 2. [ ] get rid of old stuff
85 - try to use rubbish as birthday presents for family
87 4. [ ] put stuff back in
89 ** Headings with TODO items :FAILS:
91 *** TODO Clean out garage [0/4]
93 **** TODO get stuff out
95 - be careful with that axe, Eugene
97 **** TODO get rid of old stuff
100 - try to use rubbish as birthday presents for family
102 **** TODO repaint garage
104 **** TODO put stuff back in
108 *** NEXT Test with category property :mytag:
110 :CATEGORY: mycategory
113 ** simple blocks ([[http://orgmode.org/org.html#Blocks][docu]]) :WORKS:
116 Some example from a text file.
119 - more of it in the Babel section later on
121 ** comments ([[http://orgmode.org/manual/Comment-lines.html#Comment-lines][docu]]) :WORKS:
129 space space hash space:
138 This is a multi line comment block.
139 This is the second line.
141 This is the second paragraph.
144 ** Noexport tag of heading :FAILS:noexport:
146 This heading is tagged with =noexport= and therefore should not be
147 exported. Whatever this means for GitHub. ;-)
149 ** links [[http://orgmode.org/org.html#Hyperlinks][(docu)]] :PARTLY:
155 - [[file:~/.zshrc.local]]
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]]
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]
166 [fn:myotherlabel] This is a footnote from reference above.
167 [fn:2] This is a footnote with a simple number as label.
169 *** heading with PROPERTIES drawer containing ID
176 ** states; TODO items ([[http://orgmode.org/org.html#TODO-Items][docu]]) :PARTLY:
178 *** making dependencies explicit
180 **** example with chain siblings
184 :TRIGGER: chain-siblings(NEXT)
191 *** priorities ([[http://orgmode.org/org.html#Priorities][docu]])
193 **** TODO [#A] example
194 **** NEXT [#B] example
196 *** breaking down in subtasks ([[http://orgmode.org/org.html#Breaking-down-tasks][docu]])
198 **** TODO example [1/3] [33%]
202 ** tags [[http://orgmode.org/org.html#Tags][(docu)]] :FAILS:
206 ** tables simple [[http://orgmode.org/org.html#Tables][(docu)]] :PARTLY:
208 | *Heading1* | *head2* |
209 |------------+---------|
212 |------------+---------|
215 ** tables complex ([[http://orgmode.org/org.html#The-spreadsheet][docu]], [[http://orgmode.org/worg/org-tutorials/org-spreadsheet-intro.html][tutorial]]) :PARTLY:
217 #+TBLNAME: mydemo-USD-EUR-rate
218 | *US-Dollar* | *EUR* |
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 |------------+------------------------+-------+-------|
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
233 ** column view ([[http://orgmode.org/org.html#Column-view][docu]]) :FAILS:
235 :COLUMNS: %25ITEM %FLAGS %PRIORITY %TODO %10MyProperties
236 :MyProperties_ALL: "Thomas" "Maria" "Susan" "Joe"
239 *** example sub-item :mytag1:
244 *** NEXT [#B] another example :mytag2:
246 :MyProperties: Thomas
249 ** dates & time ([[http://orgmode.org/org.html#Dates-and-Times][docu]]) :WORKS:
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])
254 ** clocking time ([[http://orgmode.org/org.html#Clocking-work-time][docu]]) :PARTLY:
256 *** example sub-hierarchy with report
258 #+BEGIN: clocktable :maxlevel 2 :scope subtree
259 Clock summary at [2012-11-19 Mon 11:17]
262 |--------------+---------|
263 | *Total time* | *27:16* |
264 |--------------+---------|
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
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
279 ** source code ([[http://orgmode.org/org.html#Working-With-Source-Code][docu]]) :PARTLY:
286 ** babel ([[http://orgmode.org/org.html#Library-of-Babel][docu]]) :FAILS:
288 *** babel simple ([[http://orgmode.org/org.html#Working-With-Source-Code][doc]])
290 - some examples are taken from [[http://orgmode.org/worg/org-contrib/babel/intro.html][Worg: Introduction to Babel]]
302 "This file was last evaluated on #{Date.today}"
313 #+begin_src ditaa :file blue.png :cmdline -r
325 **** session with shell and R
328 #+begin_src sh :results replace
329 cd ~/archive/events_memories && du -sc * |grep -v total
332 Using result set "directories" from above as "dirs" in R below:
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])
339 ** LaTeX ([[http://orgmode.org/org.html#Embedded-LaTeX][docu]]) :FAILS:
341 Greek characters \alpha \beta \phi \LaTeX{} $\varphi$
345 \section{Section Title}
347 This is \emph{emphasized} and $y=x^2$ is an equation.
355 ** heading with properties
357 :CREATED: <2011-10-09 Sun 15:16>
362 | *head1* | *head2* | *head3* |
363 |-----------------------+---------+---------|
364 | text | 42 | ----- |
365 | me@server.example.com | 23 | :-) |
366 |-----------------------+---------+---------|
368 #+TBLFM: @>$2 = vsum(@I$2..@II$2)
372 - direct URL: http://tagstore.org
373 [[http://tagstore.org][- indirect URL]]
374 - direct email: me@example.com
375 - [[me@server.com][indirect email]]
383 Very long line with many characters showing the wordwrap feature or the not existing word wrap feature
390 Very long line with many characters showing the wordwrap feature or the not existing word wrap feature
394 : This is an example.
396 : Very long line with many characters showing the wordwrap feature or the not existing word wrap feature
402 Very long line with many characters showing the wordwrap feature or the not existing word wrap feature
407 if VALUE and dummy < 42:
408 execute_something("Dummy text", 23)
413 ** Underscores_like_this
423 Das hier ist eine Erklärung von dem Ganzen:
425 :conf: ;; this is ELISP code
428 Und in der Org-mode-Datei wird das dann so angewendet:
431 :org: :ID: this-is-an-example