Org-imagine is a visualization decorator for org-mode element, its purpose is to make inserting images/src-blocks in emacs org-mode easier, programmatic, and more fun
cd ~/.emacs.d/site-lisp/; git clone [email protected]:metaescape/org-imagine.git
cd org-imagine; git submodule update --init if you want to use predifined visulization scripts in org-imagine/view/
then install it with use-package or your favorite emacs package manager:
(use-package org-imagine
:load-path "~/.emacs.d/site-lisp/org-imagine/")Here are few examples for explaining how to use org-imagine.
Downloads and preview random images from picsum:
- before executing org-imagine-view:
#+IMAGINE: wget -O %{%o.png} %f
[[https://picsum.photos/1366/768/\?random]]
#+ATTR_HTML: :width 800 :align center
- put cursor on
#+IMAGINEor below and M-x org-imagine-view, then
#+IMAGINE: wget -O %{%o.png} %f
[[https://picsum.photos/1366/768/\?random]]
#+ATTR_HTML: :width 800 :align center
[[file:./.org-imagine/N-T-7bbbd1174f.png]]
%o, %{} and %f are special %-escapes allow dynamic insertion/substitution of content
%owill be substituted by an image name in the form offilename-last_modified-hash%{}is an anchor to tell org-imagine that the content within it will be used as an image path which will be inserted later, allowing user-specified image path, e.g.#+IMAGINE: wget -O %{/tmp/cover.png} %f%fwill be substituted by the first org link in the next line of#+IMAGINEcomment line, currently support link formats:[[file:path_of_file::page]]extractpath_of_file[[pdf:file.pdf]]extractfile.pdf[[id:xxxxx]]extract the file path of org idxxxxx[[http://url_of_image.jpg]]extracthttp://url_of_image.jpg[[https://url_of_image.png]]extracthttps://url_of_image.png
other templates:
%l: substituted by the content of the next line
- before executing org-imagine-view:
#+IMAGINE: pptsnap.py -p 2
this is my [[file:~/keyboards.pptx][custom keybinding]]-
put cursor on
#+IMAGINEor below and M-x org-imagine-view-
when detecting a command without
%s-escape, org-imagine will add-l=linkand-d=org-imagine-cache-diroptions so after parsing, the real command ispptsnap.py -p 2 -l="[[file:~/keyboards.pptx]]" -d=./.org-imagine -
pptsnap.py is an executable python script (command-line interface) in
org-imagine-dir, it usesLibreOfficeandpdftoppm(orpyMupdf) to generate the preview of the second page of~/keyboards.pptxinorg-imagine-cache-dirwith naming conventionfilename-last_modified-hash.png
-
-
after executing org-imagine-view:
#+IMAGINE: pptsnap.py -p 2
this is my [[file:~/keyboards.pptx][custom keybinding]]
[[file:./.org-imagine/keyboards-20220903232619-25822.png]]#+IMAGINE: "~/codes/parsing/lexer.py::class Lexer"-
after executing org-imagine-view:
the source code of class Lexer in ~/codes/parsing/lexer.py will be inserted below:
#+BEGIN_SRC python
class Lexer:
'''
A Abstract Lexer class
'''
# string with < > is the token and the string without < > is the token type
type_map = {"<NA>": "NA", "<EOF>": "EOF"}
def __init__(self, input: str):
self.input = input
# set all key, value in type_map to class attribute
for token, token_type in self.type_map.items():
setattr(self, token_type, token)
setattr(self, f"{token_type}_TYPE", token_type)
self.p = 0 # Index into input of current character
self.c = self.input[self.p] if self.input else self.EOF # Prime lookahead
def consume(self):
"""Move one character; detect 'end of file'."""
self.p += 1
if self.p >= len(self.input):
self.c = self.EOF
else:
self.c = self.input[self.p]
def match(self, x):
"""Ensure x is next character on the input stream."""
if self.c == x:
self.consume()
else:
raise ValueError(f"Expecting {x}; found {self.c}")
def get_type(self, token_type):
"""Abstract method to get the token name."""
raise NotImplementedError
#+END_SRC- support org link abbreviation:
#+LINK: lexer ~/codes/parsing/lexer.py::%s then you can represent the Lexer class with the following simplified link
#+IMAGINE: "lexer:class Lexer"-
org-imagine use indentations to discern the code section in python, so it can extract:
- function
- for/while loop
- if block (exclude else block)
- single expression
-
support
:only-contentsargument for python code#+IMAGINE: "~/codes/parsing/lexer.py::class Lexer :only-contents"or
#+IMAGINE: "~/codes/parsing/lexer.py::class Lexer :only-contents t"these will remove the docstrings (comments will still be included in the src block)
-
suport Emacs Lisp S-expressions
-
When cursor is on the IMAGINE line, use
C-c 'to jump to the buffer of target link.
org-imagine-view-dir: where user-defined visualiser locate, default is "/path/to/org-imagine/view/"
(use-package org-imagine
:load-path "~/.emacs.d/site-lisp/org-imagine/"
:config
(setq
org-imagine-cache-dir "./.org-imagine"
org-imagine-is-overwrite nil)
)Using org-imagine-clear-cache to clear unlinked image files (like garbage-collection)
- stable-diffusion webui api:
#+IMAGINE: sdtext2img.py -e 192.168.168.2:7861 -o %{%o.png} -j %f
[[file:~/.emacs.d/site-lisp/org-imagine/view/stable_diffusion_demo.json]]
- preview of drawio
#+IMAGINE: drawio -x %f -o %{%o.png} -p 4 --width 800
[[file:~/org/lib/scratch.drawio]]
- preview of fonts
#+IMAGINE: pango-view --font="Slidefu" -qo %{/tmp/image3.png} -t %l --dpi 400
但愿人长久，千里共婵娟
- preview of pdf
#+IMAGINE: pdfsnap.py -s 70
[[pdf:/book/2020-Causal_Inference-Hernan-Robins.pdf::1]]
or
#+IMAGINE: pdftoppm -png -f 1 -scale-to 100 -singlefile %f %{%o}
[[pdf:/book/2020-Causal_Inference-Hernan-Robins.pdf::1]]
- streak of org jounal
#+IMAGINE: timemap.py
this is my [[file:~/org/journal/j2021.org][2021 journal]] streak:
[[file:./.org-imagine/j2021-20220804002339-051d8.png]]
Yasnippets for quick decoration:
#+IMAGINE: ${0:pdfsnap.py} -s 300
[[pdf:$0]]
#+IMAGINE: wget -O %{%o.png} %f
[[$0]]
#+ATTR_HTML: :width ${0:800} :align center
中文的说明和讨论： org-imagine： 对 org 对象进行可视化的插件
中文 Blog： org imagine: 在 org-mode 中想象
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent