From 9c111f63d3e43e5ca9aed60b0bba2cbfad6b5aa0 Mon Sep 17 00:00:00 2001 From: Kyle Meyer Date: Tue, 24 Jan 2017 23:54:58 -0500 Subject: [PATCH] ob-core: Add org-babel-uppercase-example-markers option * lisp/ob-core.el (org-babel-capitalize-example-region-markers): Mark as obsolete. (org-babel-uppercase-example-markers): New defcustom to replace defvar org-babel-capitalize-example-region-markers. (org-babel-examplify-region): Use new option. Rather than moving org-babel-capitalize-example-region-markers to a defcustom, give the option a new name that makes it clearer that all characters, not just the first, will be in upper case. Suggested-by: Vicente Vera --- etc/ORG-NEWS | 7 +++++++ lisp/ob-core.el | 13 +++++++++---- lisp/org-compat.el | 3 +++ 3 files changed, 19 insertions(+), 4 deletions(-) diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS index fdce28b1d..58875009f 100644 --- a/etc/ORG-NEWS +++ b/etc/ORG-NEWS @@ -218,6 +218,13 @@ document with ~org-mark-ring-goto~ (default binding =C-c &=). *** ~org-get-heading~ accepts two more optional arguments See docstring for details. + +*** New option ~org-babel-uppercase-example-markers~ + +This variable is a ~defcustom~ and replaces the variable +~org-babel-capitalize-example-region-markers~, which is a ~defvar~ and +is now obselete. + * Version 9.0 ** Incompatible changes diff --git a/lisp/ob-core.el b/lisp/ob-core.el index e8356934c..9f6700017 100644 --- a/lisp/ob-core.el +++ b/lisp/ob-core.el @@ -179,6 +179,14 @@ This string must include a \"%s\" which will be replaced by the results." :package-version '(Org . "9.0") :safe #'booleanp) +(defcustom org-babel-uppercase-example-markers nil + "When non-nil, begin/end example markers will be inserted in upper case." + :group 'org-babel + :type 'boolean + :version "26.1" + :package-version '(Org . "9.1") + :safe #'booleanp) + (defun org-babel-noweb-wrap (&optional regexp) (concat org-babel-noweb-wrap-start (or regexp "\\([^ \t\n].+?[^ \t]\\|[^ \t\n]\\)") @@ -2435,15 +2443,12 @@ file's directory then expand relative links." result) (if description (concat "[" description "]") "")))) -(defvar org-babel-capitalize-example-region-markers nil - "Make true to capitalize begin/end example markers inserted by code blocks.") - (defun org-babel-examplify-region (beg end &optional results-switches inline) "Comment out region using the inline `==' or `: ' org example quote." (interactive "*r") (let ((maybe-cap (lambda (str) - (if org-babel-capitalize-example-region-markers (upcase str) str)))) + (if org-babel-uppercase-example-markers (upcase str) str)))) (if inline (save-excursion (goto-char beg) diff --git a/lisp/org-compat.el b/lisp/org-compat.el index 597cb7411..6c6c2562d 100644 --- a/lisp/org-compat.el +++ b/lisp/org-compat.el @@ -195,6 +195,9 @@ Counting starts at 1." 'org-agenda-today-p "Org 9.0") (define-obsolete-function-alias 'org-babel-examplize-region 'org-babel-examplify-region "Org 9.0") +(define-obsolete-variable-alias 'org-babel-capitalize-example-region-markers + 'org-babel-uppercase-example-markers "Org 9.1") + (define-obsolete-function-alias 'org-babel-trim 'org-trim "Org 9.0") (define-obsolete-variable-alias 'org-html-style 'org-html-head "24.4") (define-obsolete-function-alias 'org-insert-columns-dblock