add help function, moving readme help content to help function

This commit is contained in:
2022-11-28 22:20:06 +01:00
parent 64835396e2
commit 2f2d32cbbc
3 changed files with 76 additions and 78 deletions

View File

@@ -26,6 +26,82 @@
:prefix "my-"
:group 'emacs)
(defun my-help ()
"Display help"
(interactive)
(let ((buffer-name "*Quick Help*"))
(with-current-buffer (get-buffer-create buffer-name)
(define-derived-mode my-org-help-mode org-mode "Org help mode"
"Major mode for help buffers using Org mode")
(insert "\
*General Commands* /S: shift, C: control, M: alt or ⌘/
[[save-buffer][Save]] ............... =[C-x]= =[C-s]= Help ..................... =[C-h]=
[[write-file][Save as]] ............ =[C-x]= =[C-w]= [[keyboard-quit][Cancel]] ................... =[C-g]=
[[find-file][Open file]] .......... =[C-x]= =[C-f]= [[undo][Undo]] ..................... =[C-/]=
[[counsel-recentf][Open recent]] ........ =[C-x]= =[C-r]= [[kill-buffer][Close buffer]] ......... =[C-x]= =[k]=
[[dired][Browse directory]] ..... =[C-x]= =[d]= [[counsel-switch-buffer][Switch buffer]] ........ =[C-x]= =[b]=
[[previous-buffer][Previous buffer]] ... =[C-x]= =[left]= [[next-buffer][Next buffer]] ...... =[C-x]= =[right]=
[[save-buffers-kill-terminal][Quit]] ............... =[C-x]= =[C-c]=
[[swiper][Search]] ................... =[C-s]= [[goto-line][Go to line]] ......... =[M-g]= =[M-g]=
Replace .................. =[M-%]= Execute .................. =[M-x]=
[[begin-of-buffer][Begin of buffer]] .......... =[M-<]= [[end-of-buffer][End of buffer]] ............ =[M->]=
[[beginning-of-line][Begin of line]] ............ =[C-a]= [[end-of-line][End of line]] .............. =[C-e]=
Mark ................... =[C-spc]= Copy from mark............ =[M-w]=
Kill from mark............ =[C-w]= Kill from cursor.......... =[C-k]=
[[yank][Paste]] .................... =[C-y]= Paste older .............. =[M-y]=
[[mark-whole-buffer][Mark whole buffer]] .... =[C-x]= =[h]=
/[[info:emacs#Key%2520Bindings][Other key bindings]]/
*Mouse*
Scroll right ......... =[mouse-6]= Scroll left .......... =[mouse-7]=
[[previous-buffer][Previous buffer]] ...... =[mouse-8]= [[next-buffer][Next buffer]] .......... =[mouse-9]=
*Org*
[[org-toggle-pretty-entities][Pretty entities]] (\\xyz to UTF8 char) ................ =[C-c]= =[C-x]= =[\\]=
/TABLE/
[[org-shiftleft][Move cell left]] ........ =[S-left]= [[org-shiftright][Move cell right]] ....... =[S-right]=
[[org-shiftup][Move cell up]] ............ =[S-up]= [[org-shiftdown][Move cell down]] ......... =[S-down]=
[[org-table-blank-field][Clear cell]] ............. =[space]=
[[org-table-create-or-convert-from-region][Convert]] seperator (1. tab, 2. comma, 3. space) ........... =[C-c]= =[|]=
[[org-table-create-or-convert-from-region][Convert]] using comma separator ...................... =[C-u]= =[C-c]= =[|]=
[[org-table-create-or-convert-from-region][Convert]] using tab separator .................. =[C-u]= =[C-u]= =[C-c]= =[|]=
[[org-table-create-or-convert-from-region][Convert]] using N spaces separator ........... =[C-u]= =INTEGER= =[C-c]= =[|]=
[[org-table-create-or-convert-from-region][Convert]] using regex to match separator ....... =[C-u]= =REGEX= =[C-c]= =[|]=
/SRC/
[[org-babel-tangle][write src block to file]] (=:tangle filename=) ......... =[C-c]= =[C-v]= =[t]=
For *Gnuplot* source blocks: Do not use =%= but =\\%= or in a format
command =\\%%=
- =%= starts a comment in LaTeX and therefore stops further
interpretations like a closing bracket =}= etc.
- Gnuplot graphics are imported as .tex (text, axis, legend) and
.eps (figure) files.
- =\\%= and =\\%%= can also be used for HTML SVG export
[[elisp:(my-org-article-help)][Article]] help
")
(my-org-help-mode)
(goto-char (point-min))
(local-set-key (kbd "q") 'kill-buffer-and-window)
(local-set-key (kbd "C-g") 'kill-buffer-and-window)
(not-modified)
(read-only-mode))
(pop-to-buffer buffer-name '((display-buffer-below-selected)
(window-parameters . ((no-other-window . nil)))
(window-height . fit-window-to-buffer)))
(message "C-g - Quit, q - Quit")))
(defun my-eval-string (string)
"Evaluate elisp code stored in a string."
(eval (car (read-from-string (format "(progn %s)" string)))))