Sorry for this hard work on this patch. And thanks for your carefully code reviewing. I have not contribute to org-mode for a long time, already forgot most guidelines. Regards
Ihor Radchenko <yanta...@gmail.com> writes: > "Christopher M. Miles" <numbch...@gmail.com> writes: > >>> Also, this change should be documented in etc/NEWS and also in >>> "12.7 Images" section of the manual. >> >> Done. (the manual, you mean org-manual.org right? I found too many >> documents under doc/ folder, confused for a while....) > > I meant doc/org-manual.org > Note doc/Documentation_Standards.org for the conventions we use in the > manual. Your patch does not follow those conventions (double space > between sentences). Done > >> P.S: I merged two commits into one for clear. > > Let's not do it. They are two distinct changes and I will have > significant comments regarding subtree cycling. (I had plans to > implement <TAB> cycling at point for images, and we may as well take this > chance to create some generic infrastructure for showing/hiding the > inline images). > > For now, lets sort out the ORG-IMAGE-ACTUAL-WIDTH property and get it > merges. Then, we can move ahead to the subtree cycling feature. > Ok, I will submit the first patch of new property at first. If you're going to implement this <TAB> cycling inline image display feature, that's great! >> * lisp/org.el (org-display-inline-image--width): support subtree-level > ^S > >> +If you want to override global variable ~org-image-actual-width~ of >> +inline image display width, you can specify property >> +"=ORG-IMAGE-ACTUAL-WIDTH=" in subtree level. It will only affect >> +inline images under the specified subtree. > > Could you also add a paragraph describing what org-image-actual-width > does? Done in doc/org-manual.org > >> +*** New default property =ORG-IMAGE-ACTUAL-WIDTH= for overriding global >> ~org-image-actual-width~ > > I think that people may be confused by "default property" here. Just say > "new property". Done > >> +The subtree-level property "ORG-IMAGE-ACTUAL-WIDTH" can override the >> +global variable ~org-image-actual-width~ settings for inline images >> +width under current property specified subtree. > > It is not necessarily subtree-level. You can as well set it in > document-wide property drawer. Just say "The new property ... > overrides ...". Done
From 1bc3224220ec71292e08ebc6b25e0064f7243f2e Mon Sep 17 00:00:00 2001
From: stardiviner <numbch...@gmail.com>
Date: Thu, 15 Sep 2022 17:25:13 +0800
Subject: [PATCH] org.el: Support subtree-level org-image-actual-width
overriding
* lisp/org.el (org-display-inline-image--width): Support new property
"ORG-IMAGE-ACTUAL-WIDTH" overriding global variable
`org-image-actual-width'.
---
doc/org-manual.org | 21 +++++++++++
etc/ORG-NEWS | 4 +++
lisp/org.el | 89 ++++++++++++++++++++++++----------------------
3 files changed, 71 insertions(+), 43 deletions(-)
diff --git a/doc/org-manual.org b/doc/org-manual.org
index a37b8390c..2d2b93694 100644
--- a/doc/org-manual.org
+++ b/doc/org-manual.org
@@ -11314,6 +11314,27 @@ command:
startup by configuring the variable
~org-startup-with-inline-images~[fn:119].
+ #+vindex: org-image-actual-width
+ Control the display size of inline images.
+ The value can be bellowing formats:
+ - When non-nil, use the actual width of images when inlining them.
+ - When set to a number, use imagemagick (when available) to set the
+ image's width to this value.
+ - When set to a number in a list, try to get the width from any
+ =#+ATTR.*= keyword if it matches a width specification like:
+ #+ATTR_HTML: :width 300px
+ and fall back on that number if none is found.
+ - When set to nil, try to get the width from an =#+ATTR.*= keyword
+ and fall back on the original width if none is found.
+ - When set to any other non-nil value, always use the image width.
+
+ This requires Emacs >= 24.1, built with imagemagick support.
+
+ #+cindex: @samp{NOBLOCKING}, property
+ If you want to override the global variable ~org-image-actual-width~
+ of inline image display width, you can specify property
+ "=ORG-IMAGE-ACTUAL-WIDTH=".
+
** Captions
:PROPERTIES:
:DESCRIPTION: Describe tables, images...
diff --git a/etc/ORG-NEWS b/etc/ORG-NEWS
index a7f32671e..f30809973 100644
--- a/etc/ORG-NEWS
+++ b/etc/ORG-NEWS
@@ -296,6 +296,10 @@ headings in HTML export.
Use the header argument =:var x=code-block[]= or
: #+CALL: fn(x=code-block[])
to pass the contents of a named code block as a string argument.
+*** New property =ORG-IMAGE-ACTUAL-WIDTH= for overriding global ~org-image-actual-width~
+
+The new property "=ORG-IMAGE-ACTUAL-WIDTH=" can override the global
+variable ~org-image-actual-width~ value for inline images display width.
** New options
*** New custom settings =org-icalendar-scheduled-summary-prefix= and =org-icalendar-deadline-summary-prefix=
diff --git a/lisp/org.el b/lisp/org.el
index 6e6c437d5..d2d66038d 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -12199,7 +12199,8 @@ but in some other way.")
"EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
"EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
"ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
- "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
+ "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS"
+ "ORG-IMAGE-ACTUAL-WIDTH")
"Some properties that are used by Org mode for various purposes.
Being in this list makes sure that they are offered for completion.")
@@ -16228,48 +16229,50 @@ buffer boundaries with possible narrowing."
If the value is a float between 0 and 2, it interpreted as that proportion
of the text width in the buffer."
;; Apply `org-image-actual-width' specifications.
- (cond
- ((eq org-image-actual-width t) nil)
- ((listp org-image-actual-width)
- (let* ((case-fold-search t)
- (par (org-element-lineage link '(paragraph)))
- (attr-re "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)")
- (par-end (org-element-property :post-affiliated par))
- ;; Try to find an attribute providing a :width.
- (attr-width
- (when (and par (org-with-point-at
- (org-element-property :begin par)
- (re-search-forward attr-re par-end t)))
- (match-string 1)))
- (width
- (cond
- ;; Treat :width t as if `org-image-actual-width' were t.
- ((string= attr-width "t") nil)
- ;; Fallback to `org-image-actual-width' if no interprable width is given.
- ((or (null attr-width)
- (string-match-p "\\`[^0-9]" attr-width))
- (car org-image-actual-width))
- ;; Convert numeric widths to numbers, converting percentages.
- ((string-match-p "\\`[0-9.]+%" attr-width)
- (/ (string-to-number attr-width) 100.0))
- (t (string-to-number attr-width)))))
- (if (and (floatp width) (<= 0.0 width 2.0))
- ;; A float in [0,2] should be interpereted as this portion of
- ;; the text width in the window. This works well with cases like
- ;; #+attr_latex: :width 0.X\{line,page,column,etc.}width,
- ;; as the "0.X" is pulled out as a float. We use 2 as the upper
- ;; bound as cases such as 1.2\linewidth are feasible.
- (round (* width
- (window-pixel-width)
- (/ (or (and (bound-and-true-p visual-fill-column-mode)
- (or visual-fill-column-width auto-fill-function))
- (when auto-fill-function fill-column)
- (- (window-text-width) (line-number-display-width)))
- (float (window-total-width)))))
- width)))
- ((numberp org-image-actual-width)
- org-image-actual-width)
- (t nil)))
+ ;; support subtree-level property "ORG-IMAGE-ACTUAL-WIDTH" specified width.
+ (let ((org-image-actual-width (org-property-or-variable-value 'org-image-actual-width)))
+ (cond
+ ((eq org-image-actual-width t) nil)
+ ((listp org-image-actual-width)
+ (let* ((case-fold-search t)
+ (par (org-element-lineage link '(paragraph)))
+ (attr-re "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)")
+ (par-end (org-element-property :post-affiliated par))
+ ;; Try to find an attribute providing a :width.
+ (attr-width
+ (when (and par (org-with-point-at
+ (org-element-property :begin par)
+ (re-search-forward attr-re par-end t)))
+ (match-string 1)))
+ (width
+ (cond
+ ;; Treat :width t as if `org-image-actual-width' were t.
+ ((string= attr-width "t") nil)
+ ;; Fallback to `org-image-actual-width' if no interprable width is given.
+ ((or (null attr-width)
+ (string-match-p "\\`[^0-9]" attr-width))
+ (car org-image-actual-width))
+ ;; Convert numeric widths to numbers, converting percentages.
+ ((string-match-p "\\`[0-9.]+%" attr-width)
+ (/ (string-to-number attr-width) 100.0))
+ (t (string-to-number attr-width)))))
+ (if (and (floatp width) (<= 0.0 width 2.0))
+ ;; A float in [0,2] should be interpereted as this portion of
+ ;; the text width in the window. This works well with cases like
+ ;; #+attr_latex: :width 0.X\{line,page,column,etc.}width,
+ ;; as the "0.X" is pulled out as a float. We use 2 as the upper
+ ;; bound as cases such as 1.2\linewidth are feasible.
+ (round (* width
+ (window-pixel-width)
+ (/ (or (and (bound-and-true-p visual-fill-column-mode)
+ (or visual-fill-column-width auto-fill-function))
+ (when auto-fill-function fill-column)
+ (- (window-text-width) (line-number-display-width)))
+ (float (window-total-width)))))
+ width)))
+ ((numberp org-image-actual-width)
+ org-image-actual-width)
+ (t nil))))
(defun org-display-inline-remove-overlay (ov after _beg _end &optional _len)
"Remove inline-display overlay if a corresponding region is modified."
--
2.37.2
-- [ stardiviner ] I try to make every word tell the meaning that I want to express without misunderstanding. Blog: https://stardiviner.github.io/ IRC(libera.chat, freenode): stardiviner, Matrix: stardiviner GPG: F09F650D7D674819892591401B5DF1C95AE89AC3
signature.asc
Description: PGP signature
