Add notes about inline comments and FIXME drawer
parent
ffe6ec9840
commit
7f7d5e1b92
7894
README.html
7894
README.html
File diff suppressed because it is too large
Load Diff
30
README.org
30
README.org
|
@ -1,4 +1,5 @@
|
||||||
#+TITLE: Org mode syntax quick reference card
|
#+TITLE: Org mode syntax
|
||||||
|
#+SUBTITLE: Quick reference card
|
||||||
#+AUTHOR: Fabrice Niessen
|
#+AUTHOR: Fabrice Niessen
|
||||||
#+EMAIL: (concat "fniessen" at-sign "pirilampo.org")
|
#+EMAIL: (concat "fniessen" at-sign "pirilampo.org")
|
||||||
#+DESCRIPTION: Org mode syntax example
|
#+DESCRIPTION: Org mode syntax example
|
||||||
|
@ -114,7 +115,8 @@ The ~ALT_TITLE~ property allows to set an alternate title (shorter, for example)
|
||||||
for a given headline in the table of contents and other running heads.
|
for a given headline in the table of contents and other running heads.
|
||||||
#+end_note
|
#+end_note
|
||||||
|
|
||||||
To insert the TOC at some random place, use:
|
To locally insert the TOC at some random place, use the ~#+TOC: headlines [n]~
|
||||||
|
feature; for example:
|
||||||
|
|
||||||
#+begin_src org :eval never-export
|
#+begin_src org :eval never-export
|
||||||
,#+TOC: headlines 2
|
,#+TOC: headlines 2
|
||||||
|
@ -729,6 +731,7 @@ This is a useful note.
|
||||||
#+end_src
|
#+end_src
|
||||||
|
|
||||||
# #+attr_html: :options [By the way...]
|
# #+attr_html: :options [By the way...]
|
||||||
|
# #+attr_latex: :options Test
|
||||||
# #+begin_note
|
# #+begin_note
|
||||||
# This is a useful note (with a title).
|
# This is a useful note (with a title).
|
||||||
# #+end_note
|
# #+end_note
|
||||||
|
@ -839,6 +842,17 @@ or:
|
||||||
Admonitiontodo
|
Admonitiontodo
|
||||||
#+end_admonitiontodo
|
#+end_admonitiontodo
|
||||||
|
|
||||||
|
Alternatively to the inline tasks (for creating "TODO" annotations), if you want
|
||||||
|
such notes not to show up in the published version, drawers may also do the job,
|
||||||
|
e.g.:
|
||||||
|
|
||||||
|
:FIXME:
|
||||||
|
...
|
||||||
|
:END:
|
||||||
|
|
||||||
|
You can then control what drawers are exported with
|
||||||
|
~org-export-with-drawers~ (or per document with d OPTIONS item).
|
||||||
|
|
||||||
* Centered text
|
* Centered text
|
||||||
|
|
||||||
#+begin_src org
|
#+begin_src org
|
||||||
|
@ -1010,6 +1024,12 @@ It's possible to add comments in the document.
|
||||||
# This Org comment here won't be displayed.
|
# This Org comment here won't be displayed.
|
||||||
#+end_src
|
#+end_src
|
||||||
|
|
||||||
|
#+begin_note
|
||||||
|
Org doesn't support *comments inside paragraphs* since a comment ends
|
||||||
|
a paragraph. However, you can mimic inline comments with export snippets, e.g.,
|
||||||
|
~@@comment:...@@~.
|
||||||
|
#+end_note
|
||||||
|
|
||||||
* Substitutions
|
* Substitutions
|
||||||
|
|
||||||
** General replacements
|
** General replacements
|
||||||
|
@ -1133,6 +1153,10 @@ int main(int arc, char **argv)
|
||||||
|
|
||||||
# See http://sphinxcontrib-emacs.readthedocs.org/en/latest/guide/domain.html
|
# See http://sphinxcontrib-emacs.readthedocs.org/en/latest/guide/domain.html
|
||||||
|
|
||||||
|
#+begin_note
|
||||||
|
You need =htmlize.el= in your ~load-path~, for the HTML export.
|
||||||
|
#+end_note
|
||||||
|
|
||||||
** Source mode
|
** Source mode
|
||||||
|
|
||||||
The following language strings are currently recognized:
|
The following language strings are currently recognized:
|
||||||
|
@ -1409,7 +1433,7 @@ That can be changed by adding such a line (into your Org document):
|
||||||
*** TODO [#B] Apply GTD methodoloy
|
*** TODO [#B] Apply GTD methodoloy
|
||||||
DEADLINE: <2014-12-01 Mon>
|
DEADLINE: <2014-12-01 Mon>
|
||||||
:PROPERTIES:
|
:PROPERTIES:
|
||||||
:HTML_CONTAINER_CLASS: hsCollapsed
|
:HTML_CONTAINER_CLASS: hsCollapsed
|
||||||
:END:
|
:END:
|
||||||
|
|
||||||
This section will be collapsed when loading the page because the entry has the
|
This section will be collapsed when loading the page because the entry has the
|
||||||
|
|
Loading…
Reference in New Issue