blob: 81a66ce1528bcc19b17846c4e19bfe5ee7253b8d (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
;;; infobox.el -- Infobox in a help buffer -*- lexical-binding: t -*-
;; Copyright (C) 2025 Free Software Foundation, Inc.
;; Author: Yuchen Pei <id@ypei.org>
;; Package-Requires: ((emacs "29.4"))
;; This file is part of dotted.
;; dotted is free software: you can redistribute it and/or modify it under
;; the terms of the GNU Affero General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; dotted is distributed in the hope that it will be useful, but WITHOUT
;; ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
;; or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General
;; Public License for more details.
;; You should have received a copy of the GNU Affero General Public
;; License along with dotted. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;; Infobox in a help buffer.
;;; Code:
(defun infobox-translate (info specs)
"Translate INFO according to SPECS.
TODO: allow multiple levels in specs keys using let-alist, i.e.
something like
(.channel.name . \"Channel name\")"
(seq-map
(lambda (pair)
(when-let ((val (alist-get (car pair) info)))
(if (or (stringp (cdr pair)) (symbolp (cdr pair)))
(cons (cdr pair) val)
(cons (cadr pair) (funcall (cddr pair) val)))))
specs))
(defun infobox-render (info item &optional interactive-p)
"Render and display a help buffer of INFO."
(help-setup-xref item interactive-p)
(with-help-window (help-buffer)
(with-current-buffer standard-output
(let ((n-rows 0))
(seq-do
(lambda (pair)
(when pair
(when (stringp (car pair))
(insert (car pair) ": ")
(setq n-rows (1+ n-rows)))
(insert (cdr pair) "\n")))
info)
(align-regexp
(point-min)
(progn (goto-line (1+ n-rows)) (point))
"\\(\\s-*\\):"))
(visual-line-mode))))
(provide 'infobox)
|