Wow -- adding images to an org file

Wow -- adding images to an org file

[Nathan Neff]

I just saw Andreas's screenshot here:

http://orgmode.org/worg/org-screenshots.php

If you zoom in to his screenshot,
http://orgmode.org/img/screenshots/org_andreas.jpg

You can see how he adds images to his org files.
All that I had to do was put this into my emacs init file:

(defun org-dblock-write:image (params)
  (let ((file (plist-get params :file)))
     (clear-image-cache file)
     (insert-image (create-image file) )))

Then, put this in an org-file:

#+BEGIN: image :file "~/Documents/personal/foo.png"
#+END

And run C-c C-c (or is it C-c C-x C-u)?

Anyway, Cool stuff!

--Nate

Re: Wow -- adding images to an org file

[Chris Thompson]

Nathan Neff <nathan.neff <at> gmail.com> writes:

> 
> I just saw Andreas's screenshot here:
> 
> http://orgmode.org/worg/org-screenshots.php
> 
> If you zoom in to his screenshot,
> http://orgmode.org/img/screenshots/org_andreas.jpg
> 
> You can see how he adds images to his org files.
> All that I had to do was put this into my emacs init file:
> 
> (defun org-dblock-write:image (params)
>   (let ((file (plist-get params :file)))
>      (clear-image-cache file)
>      (insert-image (create-image file) )))
> 
> Then, put this in an org-file:
> 
> #+BEGIN: image :file "~/Documents/personal/foo.png"
> #+END
> 
> And run C-c C-c (or is it C-c C-x C-u)?
> 
> Anyway, Cool stuff!
> 
> --Nate
> 


Another way to have images in org-mode documents is to use the "iimage"
minor mode, which handles  inline images:
http://www.netlaputa.ne.jp/~kose/Emacs/iimage.html

For additional documentation:
http://orgmode.org/worg/org-configs/org-config-examples.php#sec-2_2

It's pretty nifty.

-- Chris

Re: Wow -- adding images to an org file

[Dan Davison]

Russell Adams <RLAdams@AdamsInfoServ.Com> writes:

> On Sat, May 08, 2010 at 12:51:41PM +0200, Carsten Dominik wrote:
>> We have now native inline image display in Org-mode, you can toggle it  
>> with
>>
>> C-c C-x C-v
>>
>> This implementation uses overlays instead of text properties and  
>> therefore does not interfere with font-lock.
>>
>> - Carsten
>
> I'm using Org-Babel and R, and when I use C-c C-c to update the output
> from a block of code, the image in emacs doesn't change.
>
> Ideas? v6.36

Hi Russell,

I struggled with this when images were text properties, i.e. before
Carsten's implementation using overlays (thanks for C-c C-x C-v
Carsten!)

I think the answer may be clear-image-cache. I just tried that and C-c
C-x C-v showed the new image afterwards. I'm not sure whether the
following is acceptable in terms of emacs ecology, but it seems to do
the trick:

--8<---------------cut here---------------start------------->8---
diff --git a/lisp/org.el b/lisp/org.el
index c52aeb0..85f1219 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -15507,6 +15507,7 @@ with a description part will be inlined."
   "Remove inline display of images."
   (interactive)
   (mapc 'delete-overlay org-inline-image-overlays)
+  (clear-image-cache)
   (setq org-inline-image-overlays nil))
--8<---------------cut here---------------end--------------->8---

Note also that we can make image display happen automatically after
executing a babel block:

(add-hook 'org-babel-after-execute-hook 'org-display-inline-images)

In fact that was what I had in mind when adding that hook; it was just
waiting for Carsten's function. So in my mind this gets us some of the
way towards org-babel as an "interactive notebook", as discussed in
another recent thread.

Dan

p.s. For what its worth, here is the code I was using to make images
appear using text properties and Org font lock. I was intending to post
this when I was happy with the image refresh stuff, but it is probably
redundant in light of the new functions using overlays. A certain amount
of messing about with image redisplay and cache functions is evident.

--8<---------------cut here---------------start------------->8---
(defun dan/org-fontify-image-links (limit)
  "Display links to images as images.
If the description part of the link is empty display the image,
otherwise do nothing. This function is intended to be called
during font-lock fontification."
  (let ((case-fold-search t) file image)
    (and dan/org-display-inline-images
         (re-search-forward
          (concat "\\[\\[file:\\(" iimage-mode-image-filename-regex "\\)\\]\\]") limit t)
         (setq file (match-string 1))
         (setq file (iimage-locate-file file (list default-directory)))
         (setq image (create-image file))
         (add-text-properties (match-beginning 0) (match-end 0) (list 'display image))
         ;; (clear-image-cache)
         (image-refresh image)
         ;; (redisplay)
         ;; (redraw-frame)
         ;; (redraw-display)
         ;; (image-refresh image)
         )))

(setq dan/org-display-inline-images t)
(add-hook 'org-font-lock-hook 'dan/org-fontify-image-links)
--8<---------------cut here---------------end--------------->8---



>
> Thanks.
>
> ------------------------------------------------------------------
> Russell Adams                            RLAdams@AdamsInfoServ.com
>
> PGP Key ID:     0x1160DCB3           http://www.adamsinfoserv.com/
>
> Fingerprint:    1723 D8CA 4280 1EC9 557F  66E8 1154 E018 1160 DCB3
>
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: Re: Wow -- adding images to an org file

[robut]

[-- Attachment #1: Type: text/html, Size: 6564 bytes --]

[-- Attachment #2: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

[PATCH] Re: Wow -- adding images to an org file

[Baoqiu Cui]

[-- Attachment #1: Type: text/plain, Size: 1239 bytes --]

"robut@iinet.net.au" <robut@iinet.net.au> writes:

> I very much like the idea of native inline image display in Org-mode but  can't
> seem to make it work.
>
> Given a 6.36 snapshot or 6.36 release and these org file contents
>
> * Test image
> Test image
> [[Screenshot.png]]
>
>
> I hoped org would display that image after C-c C-x C-v. Rather Org-mode returns
> "No images to display inline".
>
> I've tried different ways of linking that image, different image formats,
> relative vs complete paths, and my regular .emacs vs  a near empty one and
> always the same result. If I toggle iimage-mode the image displays fine per se
> but does not affect how Org-mode works.
>
> Seems clear I am missing something simple. What?

I like the idea of inline image display too, but hit the similar
problems.  After reading the code in org.el, I found that the inline
image file link has to start with either "file:" or "./".

For example, the following two links are OK:

   [[file:~/images/myImage.png]]
   [[./figures/org-mode-unicorn.svg]]

but the following two are not:

   [[Screenshot.png]]
   [[~/images/myImage.png]]

Here is a small patch that seems to work well for me, but I'd like
Carsten to check whether it may break anything:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: inline-images.diff --]
[-- Type: text/x-patch, Size: 500 bytes --]

diff --git a/lisp/org.el b/lisp/org.el
index 0381a26..5efc162 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -15502,7 +15502,7 @@ with a description part will be inlined."
   (interactive "P")
   (org-remove-inline-images)
   (goto-char (point-min))
-  (let ((re (concat "\\[\\[\\(file:\\|\\./\\)\\(~?" "[-+./_0-9a-zA-Z]+"
+  (let ((re (concat "\\[\\[\\(file:\\)?\\(~?" "[-+./_0-9a-zA-Z]+"
 		    (substring (org-image-file-name-regexp) 0 -2)
 		    "\\)\\]" (if include-linked "" "\\]")))
 	file ov)

[-- Attachment #3: Type: text/plain, Size: 22 bytes --]


Regards,

-- 
Baoqiu

[-- Attachment #4: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: Wow -- adding images to an org file

[Baoqiu Cui]

[-- Attachment #1: Type: text/plain, Size: 1239 bytes --]

"robut@iinet.net.au" <robut@iinet.net.au> writes:

> I very much like the idea of native inline image display in Org-mode but  can't
> seem to make it work.
>
> Given a 6.36 snapshot or 6.36 release and these org file contents
>
> * Test image
> Test image
> [[Screenshot.png]]
>
>
> I hoped org would display that image after C-c C-x C-v. Rather Org-mode returns
> "No images to display inline".
>
> I've tried different ways of linking that image, different image formats,
> relative vs complete paths, and my regular .emacs vs  a near empty one and
> always the same result. If I toggle iimage-mode the image displays fine per se
> but does not affect how Org-mode works.
>
> Seems clear I am missing something simple. What?

I like the idea of inline image display too, but hit the similar
problems.  After reading the code in org.el, I found that the inline
image file link has to start with either "file:" or "./".

For example, the following two links are OK:

   [[file:~/images/myImage.png]]
   [[./figures/org-mode-unicorn.svg]]

but the following two are not:

   [[Screenshot.png]]
   [[~/images/myImage.png]]

Here is a small patch that seems to work well for me, but I'd like
Carsten to check whether it may break anything:


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: inline-images.diff --]
[-- Type: text/x-patch, Size: 500 bytes --]

diff --git a/lisp/org.el b/lisp/org.el
index 0381a26..5efc162 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -15502,7 +15502,7 @@ with a description part will be inlined."
   (interactive "P")
   (org-remove-inline-images)
   (goto-char (point-min))
-  (let ((re (concat "\\[\\[\\(file:\\|\\./\\)\\(~?" "[-+./_0-9a-zA-Z]+"
+  (let ((re (concat "\\[\\[\\(file:\\)?\\(~?" "[-+./_0-9a-zA-Z]+"
 		    (substring (org-image-file-name-regexp) 0 -2)
 		    "\\)\\]" (if include-linked "" "\\]")))
 	file ov)

[-- Attachment #3: Type: text/plain, Size: 22 bytes --]


Regards,

-- 
Baoqiu

[-- Attachment #4: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: Re: Wow -- adding images to an org file

[Carsten Dominik]

On May 12, 2010, at 7:39 AM, Baoqiu Cui wrote:

> "robut@iinet.net.au" <robut@iinet.net.au> writes:
>
>> I very much like the idea of native inline image display in Org- 
>> mode but  can't
>> seem to make it work.
>>
>> Given a 6.36 snapshot or 6.36 release and these org file contents
>>
>> * Test image
>> Test image
>> [[Screenshot.png]]
>>
>>
>> I hoped org would display that image after C-c C-x C-v. Rather Org- 
>> mode returns
>> "No images to display inline".
>>
>> I've tried different ways of linking that image, different image  
>> formats,
>> relative vs complete paths, and my regular .emacs vs  a near empty  
>> one and
>> always the same result. If I toggle iimage-mode the image displays  
>> fine per se
>> but does not affect how Org-mode works.
>>
>> Seems clear I am missing something simple. What?
>
> I like the idea of inline image display too, but hit the similar
> problems.  After reading the code in org.el, I found that the inline
> image file link has to start with either "file:" or "./".
>
> For example, the following two links are OK:
>
>   [[file:~/images/myImage.png]]
>   [[./figures/org-mode-unicorn.svg]]
>
> but the following two are not:
>
>   [[Screenshot.png]]

This one I do not want to support, because it limits what other things  
we
can do with links.

>   [[~/images/myImage.png]]

This one on the other hand should be supported, I like that.  Can you  
please modify the patch accordingly?  I believe this will also require  
corresponding changes in the exporter(s) somewhere...

Thanks!

- Carsten

>
> Here is a small patch that seems to work well for me, but I'd like
> Carsten to check whether it may break anything:
>
> diff --git a/lisp/org.el b/lisp/org.el
> index 0381a26..5efc162 100644
> --- a/lisp/org.el
> +++ b/lisp/org.el
> @@ -15502,7 +15502,7 @@ with a description part will be inlined."
>   (interactive "P")
>   (org-remove-inline-images)
>   (goto-char (point-min))
> -  (let ((re (concat "\\[\\[\\(file:\\|\\./\\)\\(~?" "[-+./_0-9a-zA- 
> Z]+"
> +  (let ((re (concat "\\[\\[\\(file:\\)?\\(~?" "[-+./_0-9a-zA-Z]+"
> 		    (substring (org-image-file-name-regexp) 0 -2)
> 		    "\\)\\]" (if include-linked "" "\\]")))
> 	file ov)
>
> Regards,
>
> -- 
> Baoqiu
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

- Carsten

Re: Wow -- adding images to an org file

[Baoqiu Cui]

[-- Attachment #1: Type: text/plain, Size: 1399 bytes --]

Hi Carsten,

Carsten Dominik <carsten.dominik@gmail.com> writes:

> On May 12, 2010, at 7:39 AM, Baoqiu Cui wrote:
>
> ...
>
>> I like the idea of inline image display too, but hit the similar
>> problems.  After reading the code in org.el, I found that the inline
>> image file link has to start with either "file:" or "./".
>>
>> For example, the following two links are OK:
>>
>>   [[file:~/images/myImage.png]]
>>   [[./figures/org-mode-unicorn.svg]]
>>
>> but the following two are not:
>>
>>   [[Screenshot.png]]
>
> This one I do not want to support, because it limits what other things
> we
> can do with links.
>
>>   [[~/images/myImage.png]]
>
> This one on the other hand should be supported, I like that.  Can you
> please modify the patch accordingly?  I believe this will also require
> corresponding changes in the exporter(s) somewhere...

OK, I modified the patch a little bit and came up with a version (see
below) that can handle the following 7 cases.  Please check if it looks
good to you.  I don't see any needed exporter changes so far...

------------------------------------------------------------------------
* Test Inline Images

1. [[file:~/Org/GNU.png]]
2. [[file:GNU.png]]
3. [[./figures/GNU.png]]
4. [[../tmp/figures/GNU.png]]
5. [[~/Org/GNU.png]]
6. [[~bcui/Org/GNU.png]]
7. [[/tmp/GNU.png]]
------------------------------------------------------------------------


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: inline-images-2.diff --]
[-- Type: text/x-patch, Size: 854 bytes --]

diff --git a/lisp/org.el b/lisp/org.el
index 0381a26..51230b3 100644
--- a/lisp/org.el
+++ b/lisp/org.el
@@ -15502,12 +15502,14 @@ with a description part will be inlined."
   (interactive "P")
   (org-remove-inline-images)
   (goto-char (point-min))
-  (let ((re (concat "\\[\\[\\(file:\\|\\./\\)\\(~?" "[-+./_0-9a-zA-Z]+"
+  (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([-+~./_0-9a-zA-Z]+"
 		    (substring (org-image-file-name-regexp) 0 -2)
 		    "\\)\\]" (if include-linked "" "\\]")))
 	file ov)
   (while (re-search-forward re nil t)
-    (setq file (expand-file-name (match-string 2)))
+    (setq file (expand-file-name
+		(concat (or (match-string 3) "")
+			(match-string 4))))
     (when (file-exists-p file)
       (setq ov (make-overlay (match-beginning 0) (match-end 0)))
       (overlay-put ov 'display (create-image file))

[-- Attachment #3: Type: text/plain, Size: 21 bytes --]


Thanks,

-- 
Baoqiu

[-- Attachment #4: Type: text/plain, Size: 201 bytes --]

_______________________________________________
Emacs-orgmode mailing list
Please use `Reply All' to send replies to the list.
Emacs-orgmode@gnu.org
http://lists.gnu.org/mailman/listinfo/emacs-orgmode

Re: Re: Wow -- adding images to an org file

[Carsten Dominik]

Hi Baoqiu,

thanks for the patch, I have applied it.  Hopefully this will work in  
the
export backends, but it might - otherwise we will see bug reports soon  
enough...

- Carsten


On May 12, 2010, at 9:55 AM, Baoqiu Cui wrote:

> Hi Carsten,
>
> Carsten Dominik <carsten.dominik@gmail.com> writes:
>
>> On May 12, 2010, at 7:39 AM, Baoqiu Cui wrote:
>>
>> ...
>>
>>> I like the idea of inline image display too, but hit the similar
>>> problems.  After reading the code in org.el, I found that the inline
>>> image file link has to start with either "file:" or "./".
>>>
>>> For example, the following two links are OK:
>>>
>>>  [[file:~/images/myImage.png]]
>>>  [[./figures/org-mode-unicorn.svg]]
>>>
>>> but the following two are not:
>>>
>>>  [[Screenshot.png]]
>>
>> This one I do not want to support, because it limits what other  
>> things
>> we
>> can do with links.
>>
>>>  [[~/images/myImage.png]]
>>
>> This one on the other hand should be supported, I like that.  Can you
>> please modify the patch accordingly?  I believe this will also  
>> require
>> corresponding changes in the exporter(s) somewhere...
>
> OK, I modified the patch a little bit and came up with a version (see
> below) that can handle the following 7 cases.  Please check if it  
> looks
> good to you.  I don't see any needed exporter changes so far...
>
> ------------------------------------------------------------------------
> * Test Inline Images
>
> 1. [[file:~/Org/GNU.png]]
> 2. [[file:GNU.png]]
> 3. [[./figures/GNU.png]]
> 4. [[../tmp/figures/GNU.png]]
> 5. [[~/Org/GNU.png]]
> 6. [[~bcui/Org/GNU.png]]
> 7. [[/tmp/GNU.png]]
> ------------------------------------------------------------------------
>
> diff --git a/lisp/org.el b/lisp/org.el
> index 0381a26..51230b3 100644
> --- a/lisp/org.el
> +++ b/lisp/org.el
> @@ -15502,12 +15502,14 @@ with a description part will be inlined."
>   (interactive "P")
>   (org-remove-inline-images)
>   (goto-char (point-min))
> -  (let ((re (concat "\\[\\[\\(file:\\|\\./\\)\\(~?" "[-+./_0-9a-zA- 
> Z]+"
> +  (let ((re (concat "\\[\\[\\(\\(file:\\)\\|\\([./~]\\)\\)\\([-+~./ 
> _0-9a-zA-Z]+"
> 		    (substring (org-image-file-name-regexp) 0 -2)
> 		    "\\)\\]" (if include-linked "" "\\]")))
> 	file ov)
>   (while (re-search-forward re nil t)
> -    (setq file (expand-file-name (match-string 2)))
> +    (setq file (expand-file-name
> +		(concat (or (match-string 3) "")
> +			(match-string 4))))
>     (when (file-exists-p file)
>       (setq ov (make-overlay (match-beginning 0) (match-end 0)))
>       (overlay-put ov 'display (create-image file))
>
> Thanks,
>
> -- 
> Baoqiu
> _______________________________________________
> Emacs-orgmode mailing list
> Please use `Reply All' to send replies to the list.
> Emacs-orgmode@gnu.org
> http://lists.gnu.org/mailman/listinfo/emacs-orgmode

- Carsten

Re: Wow -- adding images to an org file

[Baoqiu Cui]

Carsten Dominik <carsten.dominik@gmail.com> writes:

> Hi Baoqiu,
>
> thanks for the patch, I have applied it.  Hopefully this will work in
> the
> export backends, but it might - otherwise we will see bug reports soon
> enough...

Thanks, Carsten.  I have tried my test case for LaTeX, DocBook, and HTML
exporters and everything seemed to work.

-- 
Baoqiu