瀏覽代碼

Improve some docstrings

Carsten Dominik 15 年之前
父節點
當前提交
6755141562
共有 2 個文件被更改,包括 9 次插入1 次删除
  1. 2 0
      lisp/ChangeLog
  2. 7 1
      lisp/org-exp.el

+ 2 - 0
lisp/ChangeLog

@@ -1,5 +1,7 @@
 2010-01-28  Carsten Dominik  <carsten.dominik@gmail.com>
 
+	* org-exp.el (org-export-preprocess-hook): Improve documentation.
+
 	* org-latex.el (org-export-latex-preprocess): More consistent
 	conversion and protection of the words LaTeX and TeX.
 	(org-export-latex-fontify-headline, org-export-latex-preprocess):

+ 7 - 1
lisp/org-exp.el

@@ -359,11 +359,17 @@ drawer names to export."
 
 (defvar org-export-first-hook nil
   "Hook called as the first thing in each exporter.
+Point will be still in the original buffer.
 Good for general initialization")
 
 (defvar org-export-preprocess-hook nil
   "Hook for preprocessing an export buffer.
-Pretty much the first thing when exporting is running this hook.")
+Pretty much the first thing when exporting is running this hook.
+Point will be in a temporary buffer that contains a copy of
+the original buffer, or of the section that is being export.
+All the other hooks in the org-export-preprocess... category
+also work in that temporary buffer, already modified by various
+stages of the processing.")
 
 (defvar org-export-preprocess-after-include-files-hook nil
   "Hook for preprocessing an export buffer.