summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicolas Goaziou <n.goaziou@gmail.com>2012-11-19 20:29:00 (GMT)
committer Nicolas Goaziou <n.goaziou@gmail.com>2012-11-19 20:32:59 (GMT)
commitdadde768f740b79d258e4b1f472aeb5454f38972 (patch)
tree5eba844826687e5d7d66a8510bdd52821b848f17
parentf8a69a4250df2fc0d2b7aa89e7e2c0463e31864a (diff)
downloadorg-mode-dadde768f740b79d258e4b1f472aeb5454f38972.zip
org-mode-dadde768f740b79d258e4b1f472aeb5454f38972.tar.gz
org-export: Fix docstring
* contrib/lisp/org-export.el (org-export-smart-quotes-alist): Fix docstring.
-rw-r--r--contrib/lisp/org-export.el15
1 files changed, 13 insertions, 2 deletions
diff --git a/contrib/lisp/org-export.el b/contrib/lisp/org-export.el
index 49d07e3..59f3f60 100644
--- a/contrib/lisp/org-export.el
+++ b/contrib/lisp/org-export.el
@@ -4279,6 +4279,17 @@ Return a list of src-block elements with a caption."
;;;; Smart Quotes
+;;
+;; The main function for the smart quotes sub-system is
+;; `org-export-activate-smart-quotes', which replaces every quote in
+;; a given string from the parse tree with its "smart" counterpart.
+;;
+;; Dictionary for smart quotes is stored in
+;; `org-export-smart-quotes-alist'.
+;;
+;; Internally, regexps matching potential smart quotes (checks at
+;; string boundaries are also necessary) are defined in
+;; `org-export-smart-quotes-regexps'.
(defconst org-export-smart-quotes-alist
'(("de"
@@ -4356,8 +4367,8 @@ In every regexp, quote or apostrophe matched is put in group 1.")
(defun org-export-activate-smart-quotes (s encoding info &optional original)
"Replace regular quotes with \"smart\" quotes in string S.
-ENCODING is a symbol among `:html', `:latex' and `:utf-8'. INFO
-is a plist used as a communication channel.
+ENCODING is a symbol among `:html', `:latex', `:texinfo' and
+`:utf-8'. INFO is a plist used as a communication channel.
The function has to retrieve information about string
surroundings in parse tree. It can only happen with an