Browse Source

Fix some documentation issues for BEAMER export

Carsten Dominik 15 years ago
parent
commit
c9cb315fab
4 changed files with 16 additions and 5 deletions
  1. 1 0
      doc/ChangeLog
  2. 3 0
      doc/org.texi
  3. 3 0
      lisp/ChangeLog
  4. 9 5
      lisp/org-beamer.el

+ 1 - 0
doc/ChangeLog

@@ -1,6 +1,7 @@
 2010-03-26  Carsten Dominik  <carsten.dominik@gmail.com>
 
 	* org.texi (Publishing options): Document the :email option.
+	(Beamer class export): Fix bug in the BEAMER example.
 
 2010-03-25  Carsten Dominik  <carsten.dominik@gmail.com>
 

+ 3 - 0
doc/org.texi

@@ -9762,6 +9762,9 @@ Here is a simple example Org document that is intended for beamer export.
 ** Frame 2 \\ where we will not use columns
 *** Request                                                   :B_block:
     Please test this stuff!
+    :PROPERTIES:
+    :BEAMER_env: block
+    :END:
 @end smallexample
 
 For more information, see the documentation on Worg.

+ 3 - 0
lisp/ChangeLog

@@ -1,5 +1,8 @@
 2010-03-26  Carsten Dominik  <carsten.dominik@gmail.com>
 
+	* org-beamer.el (org-beamer-select-environment): Renamed from
+	`org-beamer-set-environment-tag'.  Improve docstring.
+
 	* org-freemind.el (org-freemind-write-mm-buffer): Fix another
 	problem with odd levels.
 

+ 9 - 5
lisp/org-beamer.el

@@ -124,7 +124,7 @@ For example
 Each entry has 4 elements:
 
 name    Name of the environment
-key     Selection key for `org-beamer-set-environment-tag'
+key     Selection key for `org-beamer-select-environment'
 open    The opening template for the environment, with the following excapes
         %a   the action/overlay specification
         %A   the default action/overlay specification
@@ -176,9 +176,13 @@ close   The closing string of the environment."
     (setq org-beamer-columns-open nil)
     (insert "\\end{columns}\n")))
 
-(defun org-beamer-set-environment-tag ()
-  "Set an environment tag, to determine the beamer environment to be used.
-This makes use of the fast tag selection interface."
+(defun org-beamer-select-environment ()
+  "Select the environment to be used by beamer for this entry.
+While this uses (for convenince) a tag selection interface, the result
+of this command will be that the BEAMER_env *property* of the entry is set.
+
+In addition to this, the command will also set a tag as a visual aid, but
+the tag does not have any semantic meaning."
   (interactive)
   (let* ((envs (append org-beamer-environments-extra
 		       org-beamer-environments-default))
@@ -344,7 +348,7 @@ this function dynamically."
 
 (defvar org-beamer-mode-map (make-sparse-keymap)
   "The keymap for `org-beamer-mode'.")
-(define-key org-beamer-mode-map "\C-c\C-b" 'org-beamer-set-environment-tag)
+(define-key org-beamer-mode-map "\C-c\C-b" 'org-beamer-select-environment)
 
 (define-minor-mode org-beamer-mode
   "Special support for editing Org-mode files made to export to beamer."