Fix comma-escaping in Org blocks.
authorBastien Guerry <bzg@altern.org>
Wed, 28 Aug 2013 09:59:47 +0000 (11:59 +0200)
committerBastien Guerry <bzg@altern.org>
Wed, 28 Aug 2013 09:59:47 +0000 (11:59 +0200)
Thanks to Adam Porter for reporting this.

org-faq.org

index 0943abe..e455c63 100644 (file)
@@ -1482,21 +1482,21 @@ See the following threads:
 The desired behavior looks something like this:
 
 #+begin_src org
-  ,* Section one
+,* Section one
 
-  ,Some text
+Some text
 
-  ,** Subsection one
+,** Subsection one
 
-  ,Some text
+Some text
 
-  ,** Subsection two
+,** Subsection two
 
-  ,Some text
+Some text
 
-  ,# end Subsection Two
+,# end Subsection Two
 
-  ,Continue text in section one.
+Continue text in section one.
 #+end_src
 
 The short answer to the question is no. Org-mode adheres to the
@@ -1526,11 +1526,11 @@ You can, however, use a status cookie together with checkboxes to
 monitor your progress on a series of subtasks:
 
 #+begin_src org
-  ,** TODO Big task [1/3]
+,** TODO Big task [1/3]
 
-  ,   - [X] Subtask 1
-  ,   - [ ] Subtask 2
-  ,   - [ ] Subtask 3
+   - [X] Subtask 1
+   - [ ] Subtask 2
+   - [ ] Subtask 3
 #+end_src
 
 If you would like to embed a TODO within text without treating it as
@@ -2128,24 +2128,24 @@ character set.
 Here is how: Use a field formula to set the first value in the column:
 
 #+begin_src org
-,| N   |   |
-,|-----+---|
-,| :=1 |   |
-,|     |   |
-,|     |   |
-,|     |   |
+| N   |   |
+|-----+---|
+| :=1 |   |
+|     |   |
+|     |   |
+|     |   |
 ,#+TBLFM: @2$1=1
 #+end_src
 
 Then define a column formula in the second field:
 
 #+begin_src org
-,| N        |   |
-,|----------+---|
-,| 1        |   |
-,| =@-1 + 1 |   |
-,|          |   |
-,|          |   |
+| N        |   |
+|----------+---|
+| 1        |   |
+| =@-1 + 1 |   |
+|          |   |
+|          |   |
 ,#+TBLFM: @2$1=1
 #+end_src
 
@@ -2153,12 +2153,12 @@ After recomputing the table, the column will be filled with
 incremental numbers:
 
 #+begin_src org
-,| N |   |
-,|---+---|
-,| 1 |   |
-,| 2 |   |
-,| 3 |   |
-,| 4 |   |
+| N |   |
+|---+---|
+| 1 |   |
+| 2 |   |
+| 3 |   |
+| 4 |   |
 ,#+TBLFM: $1=@-1 + 1::@2$1=1
 #+end_src
 
@@ -2167,9 +2167,9 @@ Note that you could use arbitrary starting values and column formulas.
 Alternatively, you can just start the table
 
 #+begin_src org
-,| N |   |
-,|---+---|
-,| 1 |   |
+| N |   |
+|---+---|
+| 1 |   |
 #+end_src
 
 and with the cursor on the 1, use S-RET (bound to org-table-copy-down). That
@@ -2571,9 +2571,9 @@ automatically.
 If the following occurs:
 
 #+begin_src org
-  ,#+OPTIONS: toc:nil
-  ,Some entered text.
-  ,# More entered tex.
+,#+OPTIONS: toc:nil
+Some entered text.
+,# More entered tex.
 #+end_src
 
 Make sure that the variable comment-start is nil.
@@ -2589,9 +2589,9 @@ documents or using the contributed package [[file:org-contrib/babel/index.org][o
 of code.)
 
 #+begin_src org
-  ,#+begin_src perl
-  ,  print "Hello, world!\n";
-  ,#+end_src
+,#+begin_src perl
+print "Hello, world!\n";
+,#+end_src
 #+end_src
 
 It can be tiresome to enter the block comment lines manually. There are
@@ -3042,13 +3042,13 @@ timestamps to an item for scheduling.  Thus, either of the following work
 would work to schedule an item at 10:00am:
 
 #+begin_src org
-  ,** 10:00am Get dried ice at the magic store
-  ,   SCHEDULED: <2009-05-27 Wed>
+,** 10:00am Get dried ice at the magic store
+   SCHEDULED: <2009-05-27 Wed>
 #+end_src
 
 #+begin_src org
-  ,** Get dried ice at the magic store
-  ,   SCHEDULED: <2009-05-27 Wed 10:00>
+,** Get dried ice at the magic store
+   SCHEDULED: <2009-05-27 Wed 10:00>
 #+end_src
 
 To enable this flexibility, org-mode scans the entire headline for time of
@@ -3056,8 +3056,8 @@ day notation. A potential problem can arise if you use inactive timestamps
 in the headline to note when an item was created.  For example :
 
 #+begin_src org
-  ,** Get dried ice at the magic store [2009-05-26 Tue 12:58]
-  ,   SCHEDULED: <2009-05-27 Wed>
+,** Get dried ice at the magic store [2009-05-26 Tue 12:58]
+   SCHEDULED: <2009-05-27 Wed>
 #+end_src
 
 Org-mode would interpret the time in the inactive timestamp as a
@@ -3180,20 +3180,21 @@ Org-mode's active timestamps work very well for scheduling individual
 or recurring appointments, such as:
 
 #+begin_src org
-  ,* 8:00am Dentist appointment <2009-01-16 Fri>
+,* 8:00am Dentist appointment <2009-01-16 Fri>
 #+end_src
 
 or
+
 #+begin_src org
-  ,* Vacation
-  ,  <2009-03-20 Fri>--<2009-04-01 Wed>
+,* Vacation
+  <2009-03-20 Fri>--<2009-04-01 Wed>
 #+end_src
 
 or
 
 #+begin_src org
-  ,* Weekly meeting with boss
-  ,  <2009-01-20 Tue 14:00 +1w>
+,* Weekly meeting with boss
+  <2009-01-20 Tue 14:00 +1w>
 #+end_src
 
 Sometimes, however, you need to set up more complicated recurring
@@ -3205,8 +3206,8 @@ evening between February 16 and April 20, 2009. The way to enter this an
 org-mode file is:
 
 #+begin_src org
-  ,** Class 7:00pm-9:00pm
-  ,   <%%(and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009))>
+,** Class 7:00pm-9:00pm
+   <%%(and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009))>
 #+end_src
 
 The expression above designates all Mondays that fall between February
@@ -3229,8 +3230,8 @@ because of holidays, for instance, you could add another condition to the
 sexp:
 
 #+begin_src org
-  ,** Class 7:00pm-9:00pm
-  ,   <%%(unless (diary-block 3 9 2009 3 13 2009) (and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009)))>
+,** Class 7:00pm-9:00pm
+   <%%(unless (diary-block 3 9 2009 3 13 2009) (and (= 1 (calendar-day-of-week date)) (diary-block 2 16 2009 4 20 2009)))>
 #+end_src
 
 The sexp above would omit Monday during the week of March 9, 2009. For
@@ -3240,8 +3241,8 @@ Another diary function commonly used for more complex scheduling is
 diary-float. For instance,
 
 #+begin_src org
-  ,* Monthly meeting
-  ,  <%%(diary-float t 3 3)>
+,* Monthly meeting
+  <%%(diary-float t 3 3)>
 #+end_src
 
 ... would appear on the third Wednesday of every month.
@@ -3259,8 +3260,8 @@ appointment that lasts for a certain period of time, such as a class. It is
 called org-class and it can be entered as follows:
 
 #+begin_src org
-  ,** Class 7:00pm-9:00pm
-  ,   <%%(org-class 2009 2 16 2009 4 20 1 10)>
+,** Class 7:00pm-9:00pm
+   <%%(org-class 2009 2 16 2009 4 20 1 10)>
 #+end_src
 
 The function above schedules an appointment for every Monday (1)
@@ -3271,8 +3272,8 @@ If you would prefer not to place the timestamp in the headline, you can use
 the following format:
 
 #+begin_src org
-  ,** Class
-  ,<%%(org-class 2009 2 16 2009 4 20 1 10)> 7:00pm-9:00pm Class
+,** Class
+   <%%(org-class 2009 2 16 2009 4 20 1 10)> 7:00pm-9:00pm Class
 #+end_src
 
 In this case, the string following the sexp will be displayed in the
@@ -3318,15 +3319,15 @@ To schedule the Spanish classes, put the following in your =.emacs=:
 The item in the org file looks like this:
 
 #+begin_src org
-  ,** 19:00-21:00 Spanish lessons
-  ,   <%%(diary-limited-cyclic 8 7 8 18 2010)>
+,** 19:00-21:00 Spanish lessons
+   <%%(diary-limited-cyclic 8 7 8 18 2010)>
 #+end_src
 
 ** How can I set an event to occur every day except Saturday and Sunday?
 
 #+begin_src org
-  ,** Daily meeting
-  ,   <%%(memq (calendar-day-of-week date) '(1 2 3 4 5))>
+,** Daily meeting
+   <%%(memq (calendar-day-of-week date) '(1 2 3 4 5))>
 #+end_src
 
 ** How do I schedule events relative to Easter Sunday?
@@ -3376,14 +3377,14 @@ The item in the org file looks like this:
     is one day after.
 
     #+begin_src org
-      ,* Good Friday
-      ,  <%%(= -2 (calendar-days-from-easter))>
-
-      ,* Easter Sunday
-      ,  <%%(= 0 (calendar-days-from-easter))>
-
-      ,* Easter Monday
-      ,  <%%(= 1 (calendar-days-from-easter))>
+    ,* Good Friday
+      <%%(= -2 (calendar-days-from-easter))>
+    
+    ,* Easter Sunday
+      <%%(= 0 (calendar-days-from-easter))>
+    
+    ,* Easter Monday
+      <%%(= 1 (calendar-days-from-easter))>
     #+end_src
 
    [Source: Posted by Paul Sexton on Org-mode mailing list.]
@@ -3420,8 +3421,8 @@ The item in the org file looks like this:
    This does not require any additions to =.emacs=:
 
 #+begin_src org
-  ,* Labour Day (NZ)
-  ,  <%%(diary-float 10 1 4)>
+,* Labour Day (NZ)
+  <%%(diary-float 10 1 4)>
 #+end_src
 
 ** Why isn't the agenda showing all the times I put under a single entry?
@@ -3437,9 +3438,9 @@ The default value of this variable is t, which means that entries with
 multiple timestamps, such as the following...
 
 #+begin_src org
-  ,* Work really, really hard
-  ,  <2010-11-20 Sat 10:00>
-  ,  <2010-11-20 Sat 14:00>
+,* Work really, really hard
+  <2010-11-20 Sat 10:00>
+  <2010-11-20 Sat 14:00>
 #+end_src
 
 ... will only appear in the agenda at the time specified by the first
@@ -3861,12 +3862,12 @@ With this setup, =C-c )= will invoke =reftex-citation= which will
 insert a reference in the usual way:
 
 #+begin_src org
-  ,* test reftex
+,* test reftex
 
-  ,This is a citation \cite{tierney90}.
+This is a citation \cite{tierney90}.
 
-  ,\bibliographystyle{plain}
-  ,\bibliography{tsd}
+\bibliographystyle{plain}
+\bibliography{tsd}
 #+end_src
 
 This Org-mode file will export the following LaTeX output:
@@ -3930,7 +3931,7 @@ Org-mode file as before and define a TODO keyword, =WRITE=, perhaps
 like this:
 
 #+begin_src org
-  ,#+TODO: TODO(t) STARTED(s) WRITE | DONE(d) DEFERRED(f)
+,#+TODO: TODO(t) STARTED(s) WRITE | DONE(d) DEFERRED(f)
 #+end_src
 
 With this setup, you insert a citation with =M-x reftex-citation RET=.
@@ -3963,7 +3964,7 @@ Add the following lines to .emacs (adapted from  Kevin Brubeck Unhammer's [[http
 Then add a line like the following line to the top of your org-mode file:
 
 #+begin_src org
-  ,#+TODO: TODO(t) STARTED(s) | DONE(d) DEFERRED(f) REFTEX
+,#+TODO: TODO(t) STARTED(s) | DONE(d) DEFERRED(f) REFTEX
 #+end_src
 
 When you open an org-mode file with a line like this, RefTeX will