Documentation patch

Documentation patch

[Christian Egli]

[-- Attachment #1: Type: text/plain, Size: 800 bytes --]

Hi

I was trying to catch up on all the new features of org-mode, reread the
manual and found a few typos in the process. Attached is a patch to
correct them.

The first change is the deletion of a reference which seems to refer to
itself.

Also I would suggest to move the bit about exporting a iCalendar file
under MacOS X to the FAQ as this gives a little bit too much prominence
to a non-free system. The section on iCalendar export would then contain
a link to the FAQ where we can also place instructions on how to import
the ics into Evolution for example.

If the suggested change is ok I can produce a patch.

Thanks.
-- 
Christian Egli, Senior Consultant
Novell (Schweiz) AG, Leutschenbachstrasse 41, 8050 Zürich
Tel. +41 43 299 75 46 direct, Tel. +41 43 299 78 00, Fax: +41 43 299 75 01


[-- Attachment #2: org.texi.diff --]
[-- Type: text/x-patch, Size: 1826 bytes --]

Index: org.texi
===================================================================
RCS file: /cvsroot/emacs/emacs/man/org.texi,v
retrieving revision 1.56
diff -u -r1.56 org.texi
--- org.texi	24 May 2006 07:56:03 -0000	1.56
+++ org.texi	24 May 2006 09:41:33 -0000
@@ -2814,7 +2814,6 @@
 agenda files (@pxref{Agenda views}) into a single buffer.  The buffer is in
 @code{agenda-mode}, so there are commands to examine and manipulate
 the TODO entries directly from that buffer (@pxref{Agenda commands}).
-@xref{Global TODO list}, for more information.
 @kindex C-c a T
 @item C-c a T
 Like the above, but allows selection of a specific TODO keyword.  You can
@@ -3166,7 +3165,7 @@
 at a different level, specify it with a prefix argument.  For example,
 
 @example
-@kbd{C-1 C-c C-x a org-export-as-ascii}
+@kbd{C-1 C-c C-x a}
 @end example
 
 @noindent
@@ -3868,7 +3867,7 @@
 Org-mode uses special lines in the buffer to define settings on a
 per-file basis.  These lines start with a @samp{#+} followed by a
 keyword, a colon, and then individual words defining a setting.  Several
-settings words con be in the same line, but you can also have multiple
+setting words can be in the same line, but you can also have multiple
 lines for the keyword.  While these settings are described throughout
 the manual, here is a summary.  After changing any of those lines in the
 buffer, press @kbd{C-c C-c} with the cursor still in the line to
@@ -3912,7 +3911,7 @@
 oddeven    @r{allow all outline levels}
 @end example
 @item #+SEQ_TODO:   #+TYP_TODO:
-These lines that the TODO keywords and their interpretation in the
+These lines set the TODO keywords and their interpretation in the
 current file.  The corresponding variables are @code{org-todo-keywords}
 and @code{org-todo-interpretation}.
 @item #+TAGS:  TAG1(c1) TAG2(c2)

[-- Attachment #3: Type: text/plain, Size: 149 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: Documentation patch

[Carsten Dominik]

Yes, please go ahead and make a patch, saves me some work. If you want 
to write a FAQ entry about Evolution, go right ahead.

Thanks, also for the other fixes.  There are always more bugs, 
unbelievable!

- Carsten

On May 24, 2006, at 11:57, Christian Egli wrote:

> Hi
>
> I was trying to catch up on all the new features of org-mode, reread 
> the
> manual and found a few typos in the process. Attached is a patch to
> correct them.
>
> The first change is the deletion of a reference which seems to refer to
> itself.
>
> Also I would suggest to move the bit about exporting a iCalendar file
> under MacOS X to the FAQ as this gives a little bit too much prominence
> to a non-free system. The section on iCalendar export would then 
> contain
> a link to the FAQ where we can also place instructions on how to import
> the ics into Evolution for example.
>
> If the suggested change is ok I can produce a patch.
>
> Thanks.
> -- 
> Christian Egli, Senior Consultant
> Novell (Schweiz) AG, Leutschenbachstrasse 41, 8050 Zürich
> Tel. +41 43 299 75 46 direct, Tel. +41 43 299 78 00, Fax: +41 43 299 
> 75 01
>
> <org.texi.diff>_______________________________________________
> Emacs-orgmode mailing list
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode
>

--
Carsten Dominik
Sterrenkundig Instituut "Anton Pannekoek"
Universiteit van Amsterdam
Kruislaan 403
NL-1098SJ Amsterdam
phone: +31 20 525 7477

Documentation patch

[Thomas S. Dye]

[-- Attachment #1.1: Type: text/plain, Size: 218 bytes --]

Aloha all,

The attached patch documents multi-line headers for source code blocks:



Thomas S. Dye, Ph.D.
T. S. Dye & Colleagues, Archaeologists, Inc.
Phone: (808) 529-0866 Fax: (808) 529-0884
http://www.tsdye.com



[-- Attachment #1.2.1: Type: text/html, Size: 256 bytes --]

[-- Attachment #1.2.2: babel-multi-line-header.patch --]
[-- Type: application/octet-stream, Size: 1170 bytes --]

Changes in HEAD
	Modified doc/org.texi
diff --git a/doc/org.texi b/doc/org.texi
index f324d04..efa892e 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -11601,6 +11601,33 @@ Similarly, it is possible to set header arguments for inline code blocks:
 src_haskell[:exports both]@{fac 5@}
 @end example
 
+Code block header arguments can span multiple lines using =#+header:= or
+=#+headers:= lines preceding a code block or nested in between the name and
+body of a named code block.
+
+Multi-line header arguments on an un-named code block:
+@example
+ #+headers: :var data1=1
+ #+begin_src emacs-lisp :var data2=2
+   (message "data1:%S, data2:%S" data1 data2)
+ #+end_src
+
+ #+results:
+ : data1:1, data2:2
+@end example
+
+Multi-line header arguments on a named code block:
+@example
+   #+source: named-block
+   #+header: :var data=2
+   #+begin_src emacs-lisp
+     (message "data:%S" data)
+   #+end_src
+
+   #+results: named-block
+   : data:2
+@end example
+
 @node Header arguments in function calls,  , Code block specific header arguments, Using header arguments
 @comment  node-name,  next,  previous,  up
 @subsubheading Header arguments in function calls


[-- Attachment #1.2.3: Type: text/html, Size: 2109 bytes --]

[-- Attachment #2: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: Documentation patch

[Eric Schulte]

Hi Tom,

Thanks for this patch, it has now been applied.

-- Eric

"Thomas S. Dye" <tsd@tsdye.com> writes:

> Aloha all,
>
> The attached patch documents multi-line headers for source code blocks:
>
>
> Thomas S. Dye, Ph.D.
>
> T. S. Dye & Colleagues, Archaeologists, Inc.
>
> Phone: (808) 529-0866 Fax: (808) 529-0884
>
> http://www.tsdye.com
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Documentation patch

[Thomas S. Dye]

[-- Attachment #1: Type: text/plain, Size: 111 bytes --]

Aloha all,

Add a clause to indicate some languages don't support multiple Babel
sessions.

All the best,
Tom


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Patch org.texi --]
[-- Type: text/x-patch, Size: 880 bytes --]

From 4898a641571fa82b1e1351b74feea6e9d56994aa Mon Sep 17 00:00:00 2001
From: tsdye <tsd@tsdye.com>
Date: Sun, 26 Jul 2015 14:39:23 -1000
Subject: [PATCH] Some languages don't support multiple sessions

---
 doc/org.texi | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/doc/org.texi b/doc/org.texi
index d420259..e4a6ad4 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -15995,7 +15995,8 @@ session a name.  For example, @code{:session mysession}.  If @code{:session}
 is given but no name string is specified, the session is named according to
 the language used in the block.  All blocks with the same session name share
 the same session.  Using different session names enables concurrent sessions
-(even for the same interpreted language).
+(even for the same interpreted language, if the language supports multiple
+sessions).
 
 @end itemize
 
-- 
2.4.5


[-- Attachment #3: Type: text/plain, Size: 40 bytes --]


-- 
Thomas S. Dye
http://www.tsdye.com

Re: Documentation patch

[Rasmus]

Thomas S. Dye <tsd@tsdye.com> writes:

> Add a clause to indicate some languages don't support multiple Babel
> sessions.

Thanks.  Pushed!

-- 
Dobbelt-A

Documentation patch

[Thomas S. Dye]

[-- Attachment #1: Type: text/plain, Size: 168 bytes --]

Aloha all,

The attached patch changes "keybinding" to "key binding" in org.texi to
make that file consistent internally and with the Emacs manual.

All the best,
Tom


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Patch for org.texi --]
[-- Type: text/x-patch, Size: 2698 bytes --]

From 932fd7c2f51b5f492e4542fa32c91abbbe7c2437 Mon Sep 17 00:00:00 2001
From: tsdye <tsd@tsdye.com>
Date: Wed, 6 Jan 2016 07:18:00 -1000
Subject: [PATCH] Change "keybinding" to "key binding"

---
 doc/org.texi | 14 +++++++-------
 1 file changed, 7 insertions(+), 7 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index 14ac5ee..d4f0a64 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -1123,15 +1123,15 @@ enhance its readability, but you can use lowercase in your Org
 files@footnote{Easy templates insert lowercase keywords and Babel dynamically
 inserts @code{#+results}.}.
 
-@subsubheading Keybindings and commands
+@subsubheading Key bindings and commands
 @kindex C-c a
 @findex org-agenda
 @kindex C-c c
 @findex org-capture
 
-The manual suggests a few global keybindings, in particular @kbd{C-c a} for
+The manual suggests a few global key bindings, in particular @kbd{C-c a} for
 @code{org-agenda} and @kbd{C-c c} for @code{org-capture}.  These are only
-suggestions, but the rest of the manual assumes that these keybindings are in
+suggestions, but the rest of the manual assumes that these key bindings are in
 place in order to list commands by key access.
 
 Also, the manual lists both the keys and the corresponding commands for
@@ -6567,7 +6567,7 @@ the agenda (@pxref{Weekly/daily agenda}) to show which tasks have been
 worked on or closed during a day.
 
 @strong{Important:} note that both @code{org-clock-out} and
-@code{org-clock-in-last} can have a global keybinding and will not
+@code{org-clock-in-last} can have a global key binding and will not
 modify the window disposition.
 
 @node The clock table
@@ -6984,7 +6984,7 @@ suggestion.}  for capturing new material.
 
 @table @kbd
 @orgcmd{C-c c,org-capture}
-Call the command @code{org-capture}.  Note that this keybinding is global and
+Call the command @code{org-capture}.  Note that this key binding is global and
 not active by default: you need to install it.  If you have templates
 @cindex date tree
 defined @pxref{Capture templates}, it will offer these templates for
@@ -16758,8 +16758,8 @@ In an Org mode buffer, the following key bindings are active:
 @item @kbd{C-c C-v x} @ @ @r{or} @ @ @kbd{C-c C-v C-x} @tab @code{org-babel-do-key-sequence-in-edit-buffer}
 @end multitable
 
-@c When possible these keybindings were extended to work when the control key is
-@c kept pressed, resulting in the following additional keybindings.
+@c When possible these key bindings were extended to work when the control key is
+@c kept pressed, resulting in the following additional key bindings.
 
 @c @multitable @columnfractions 0.25 0.75
 @c @item @kbd{C-c C-v C-a} @tab @code{org-babel-sha1-hash}
-- 
2.6.4


[-- Attachment #3: Type: text/plain, Size: 40 bytes --]


-- 
Thomas S. Dye
http://www.tsdye.com

Re: Documentation patch

[Nicolas Goaziou]

Hello,

Thomas S. Dye <tsd@tsdye.com> writes:

> The attached patch changes "keybinding" to "key binding" in org.texi to
> make that file consistent internally and with the Emacs manual.

Applied. Thank you.

Regards,

-- 
Nicolas Goaziou