[PATCH] org.texi: Document quick insertion of empty structural elements

From: Jambunathan K <kjambunathan@gmail.com>
To: emacs-orgmode@gnu.org
Subject: [PATCH] org.texi: Document quick insertion of empty structural elements
Date: Sat, 14 Aug 2010 05:25:14 +0530	[thread overview]
Message-ID: <814oeyax0d.fsf@gmail.com> (raw)

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


org.texi: Document quick insertion of empty structural elements

Sources:

1. http://article.gmane.org/gmane.emacs.orgmode/6670/
   See section titled 'Completion of structure elements'

2. http://article.gmane.org/gmane.emacs.orgmode/18004/
   

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

From 540d8f2c03d300b6007c0d8595bb78ad172d8eac Mon Sep 17 00:00:00 2001
From: Jambunathan K <kjambunathan@gmail.com>
Date: Sat, 14 Aug 2010 04:24:34 +0530
Subject: [PATCH] org.texi: Document quick insertion of empty structural elements

* org.texi (Easy Templates): New section. Documents quick insertion of empty
structural elements.

TINYCHANGE
---
 doc/org.texi |   49 ++++++++++++++++++++++++++++++++++++++++++++++++-
 1 files changed, 48 insertions(+), 1 deletions(-)

diff --git a/doc/org.texi b/doc/org.texi
index ac52c70..508d2ce 100644
--- a/doc/org.texi
+++ b/doc/org.texi
@@ -12320,6 +12320,7 @@ emacsclient \
 @chapter Miscellaneous
 
 @menu
+* Easy Templates::		Quick insertion of structural elements
 * Completion::			M-TAB knows what you need
 * Speed keys::			Electric commands at the beginning of a headline
 * Code evaluation security::	Org mode files evaluate inline code
@@ -12331,8 +12332,54 @@ emacsclient \
 * Interaction::			Other Emacs packages
 @end menu
 
+@node Easy Templates, Completion, Miscellaneous, Miscellaneous
+@section Easy Templates
+@cindex insertion, of '#+begin_src #+end_src' 
+@cindex insertion, of '#+begin_example #+end_example' 
+@cindex insertion, of '#+begin_quote #+end_quote' 
+@cindex insertion, of '#+begin_verse #+end_verse' 
+@cindex insertion, of '#+begin_center #+end_center' 
+@cindex insertion, of '#+begin_latex #+end_latex' 
+@cindex insertion, of '#+latex:' 
+@cindex insertion, of '#+begin_html #+end_html'
+@cindex insertion, of '#+html:'  
+@cindex insertion, of '#+begin_ascii #+end_ascii' 
+@cindex insertion, of '#+ascii:' 
+@cindex insertion, of '#+include:' 
+
+Org-mode supports insertion of empty structural elements (like #+BEGIN_SRC
+and #+END_SRC pairs) with just a few key strokes. This is achieved through a
+native template expansion mechanism.
+
+To insert a structural element, type a '<', followed by a template selector
+and TAB. Completion takes effect only when the above keystrokes are typed on
+a line by itself.
+
+Following template selectors are currently supported.
+
+@multitable @columnfractions 0.1 0.9
+@item s @tab Insert '#+begin_src #+end_src'
+@item e @tab Insert '#+begin_example #+end_example'
+@item q @tab Insert '#+begin_quote #+end_quote' 
+@item v @tab Insert '#+begin_verse #+end_verse' 
+@item c @tab Insert '#+begin_center #+end_center' 
+@item l @tab Insert '#+begin_latex #+end_latex' 
+@item L @tab Insert '#+latex:' line 
+@item h @tab Insert '#+begin_html #+end_html' 
+@item H @tab Insert '#+html:' line
+@item a @tab Insert '#+begin_ascii #+end_ascii' 
+@item A @tab Insert '#+ascii:' line
+@item i @tab Insert '#+include:' line
+@end multitable
+
+For example, on an empty line, typing "<e" and then pressing TAB, will expand
+into a complete EXAMPLE template.
+
+You can install additional templates by customizing the variable
+@code{org-structure-template-alist}. Refer docstring of the variable for
+additional details.
 
-@node Completion, Speed keys, Miscellaneous, Miscellaneous
+@node Completion, Speed keys, Easy Templates, Miscellaneous
 @section Completion
 @cindex completion, of @TeX{} symbols
 @cindex completion, of TODO keywords
-- 
1.7.0.4


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


Jambunathan K.

[-- Attachment #4: 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
