Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rougier/svg-tag-mode
A minor mode for Emacs that replace keywords with nice SVG labels
https://github.com/rougier/svg-tag-mode
emacs melpa minor-mode quelpa svg tags
Last synced: about 2 months ago
JSON representation
A minor mode for Emacs that replace keywords with nice SVG labels
- Host: GitHub
- URL: https://github.com/rougier/svg-tag-mode
- Owner: rougier
- License: gpl-3.0
- Created: 2020-10-17T13:23:23.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-04-29T10:52:40.000Z (5 months ago)
- Last Synced: 2024-05-08T16:18:35.544Z (4 months ago)
- Topics: emacs, melpa, minor-mode, quelpa, svg, tags
- Language: Emacs Lisp
- Homepage:
- Size: 1.34 MB
- Stars: 465
- Watchers: 12
- Forks: 27
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
## svg-tag-mode
A minor mode to replace keywords or regular expression with SVG tags.
[](examples/example-1.el)
[](examples/example-2.el)
### Usage example
You need first to set `svg-tag-tags` that is a list of item here each
item has the form `(KEYWORD (TAG COMMAND HELP))` where:
- **KEYWORD** is a regular expression including a matched group of
the form `\\(xxx\\)`. If this is not the case the whole
string will be used a the matched group.
- **TAG** is either a SVG image that will be displayed using the
'display property or a function that accepts a unique string
argument (match-string 1) and returns an SVG image.
- **COMMAND** is a command to be executed when user clicks on the tag.
It can be nil if no command is associated with the tag.
- **HELP** is a string to be displayed when mouse pointer is over
the tag. It can be nil if no command is associated with the tag.
then you can invoke mode with `M-x svg-tag-mode`. Here are some examples:
1. Replace any occurrence of `:TODO:` with a static SVG tag displaying `TODO`
```lisp
(setq svg-tag-tags
'((":TODO:" . ((lambda (tag) (svg-tag-make "TODO"))))))
```
2. Replace any occurrence of `:HELLO:` with a static SVG tag displaying
`HELLO` that can be clicked to execute the specified command. Help
message is displayed when the tag is hovered with the pointer.
```lisp
(setq svg-tag-tags
'((":HELLO:" . ((lambda (tag) (svg-tag-make "HELLO"))
(lambda () (interactive) (message "Hello world!"))
"Print a greeting message"))))
```
3. Replace any occurrence of `:TODO:` with a dynamic SVG tag displaying
`:TODO:`
```lisp
(setq svg-tag-tags
'((":TODO:" . ((lambda (tag) (svg-tag-make tag))))))
```
4. Replace any occurrence of `:TODO:` with a dynamic SVG tag displaying `TODO`
```lisp
(setq svg-tag-tags
'((":TODO:" . ((lambda (tag)
(svg-tag-make tag :beg 1 :end -1))))))
```
5. Replaces any occurrence of `:XXX:` with a dynamic SVG tag displaying `XXX`
```lisp
(setq svg-tag-tags
'(("\\(:[A-Z]+:\\)" . ((lambda (tag)
(svg-tag-make tag :beg 1 :end -1))))))
```
6. Replaces any occurrence of `:XXX|YYY:` with two adjacent dynamic SVG
tags displaying `XXX` and `YYY`
```lisp
(setq svg-tag-tags
'(("\\(:[A-Z]+\\)\|[a-zA-Z#0-9]+:" . ((lambda (tag)
(svg-tag-make tag :beg 1 :inverse t
:margin 0 :crop-right t))))
(":[A-Z]+\\(\|[a-zA-Z#0-9]+:\\)" . ((lambda (tag)
(svg-tag-make tag :beg 1 :end -1
:margin 0 :crop-left t))))))
```
7. This replaces any occurrence of `:#TAG1:#TAG2:…:$` (`$` means end of
line) with a dynamic collection of SVG tags. Note the `#` symbol in
front of tags. This is mandatory because Emacs cannot do regex look
ahead.
```lisp
(setq svg-tag-tags
'(("\\(:#[A-Za-z0-9]+\\)" . ((lambda (tag)
(svg-tag-make tag :beg 2))))
("\\(:#[A-Za-z0-9]+:\\)$" . ((lambda (tag)
(svg-tag-make tag :beg 2 :end -1))))))
```
## Known Problems
### SVG tags cannot render in org-agenda
As [issue #27](https://github.com/rougier/svg-tag-mode/issues/27) mentioned, SVG tags cannot render in org-agenda, because
`svg-tag-mode` uses `font-lock-mode` to show SVG tags. However, `org-agenda`
does not use `font-lock-mode`, so it only shows rendered SVG tags in visited
buffers. One way to solve this problem is to use overly:
```
(defun org-agenda-show-svg ()
(let* ((case-fold-search nil)
(keywords (mapcar #'svg-tag--build-keywords svg-tag--active-tags))
(keyword (car keywords)))
(while keyword
(save-excursion
(while (re-search-forward (nth 0 keyword) nil t)
(overlay-put (make-overlay
(match-beginning 0) (match-end 0))
'display (nth 3 (eval (nth 2 keyword)))) ))
(pop keywords)
(setq keyword (car keywords)))))
(add-hook 'org-agenda-finalize-hook #'org-agenda-show-svg)
```