From ea842bb955b6d4a35b3f68c5ae8455e414eef516 Mon Sep 17 00:00:00 2001 From: Daniel Weschke Date: Tue, 16 Feb 2021 14:36:31 +0100 Subject: [PATCH] add more information about packages --- README.md | 269 ++++++++++++++++++++++++++++++++++------------------- README.org | 171 ++++++++++++++++++++++++++-------- 2 files changed, 309 insertions(+), 131 deletions(-) diff --git a/README.md b/README.md index 70c41e79..ca394ca6 100644 --- a/README.md +++ b/README.md @@ -1,32 +1,40 @@ # Table of Contents -1. [Requirements](#orgcb9390d) -2. [Installation](#orgf9a7dd2) -3. [Key bindings and functions](#org4741345) -4. [Packages](#org62b82b1) -5. [Information](#orgc744d51) -6. [Errors](#org27051a8) - 1. [failed execution of bibtex2html](#orga0059df) +1. [Requirements](#requirements) +2. [Installation](#installation) +3. [Packages](#packages) + 1. [Org](#org) + 2. [Multiple cursors](#multiple-cursors) + 3. [Other packages](#other-packages) +4. [Information](#information) +5. [Errors](#errors) +6. [TODOs](#todos) This is an ongoing evolution of Emacs configuration files, inspired by a bunch of online resources. - + # Requirements external packages: - # flyspell-buffer - yay -S aspell hunspell - # org-mode latex-mode - yay -S biber bibtex2html + # fonts (opensans in latex article preamble) + yay -S ttf-inconsolata ttf-opensans + # spelling flyspell-buffer + yay -S aspell aspell-de aspell-en \ + hunspell hunspell-de hunspell-en_US \ + languagetool + # org-mode latex-mode ox-latex + yay -S biber bibtex2html texlive-bibtexextra texlive-core \ + texlive-fontsextra texlive-formatsextra texlive-langgreek \ + texlive-langjapanese texlive-latexextra texlive-pgf-pie \ + texlive-pgfopts texlive-pictures texlive-pstricks \ + texlive-publishers texlive-science texlive-slashbox # ledger-mode yay -S ledger - # langtool - yay -S languagetool # python-mode yay -S python-pylint # emacs-application-famework EAF @@ -34,11 +42,13 @@ external packages: python-pyqt5 python-pyqt5-sip python-pyqtwebengine python-qrcode \ python-feedparser python-dbus python-pyinotify python-markdown \ python-grip filebrowser-bin python-epc + # other + yay -S ditaa plantuml r Optional package for EAF see in Installation. - + # Installation @@ -52,7 +62,8 @@ or copy all files of this directory into your ~/.config/emacs directory - `ln -s ~/.config/emacs/init ~/.emacs` (or `~/.emacs.el`, `~/.emacs.d/init.el`) -copy/merge the texmf directory into your home directory +LaTeX sytling files: copy/merge the `texmf` directory into your home +directory `~/texmf` optional for EAF @@ -66,12 +77,12 @@ edit `PGKBUILD` file for `python-pymupdf` to: } - + -# Key bindings and functions +# Packages - +@@ -142,11 +153,79 @@ edit `PGKBUILD` file for `python-pymupdf` to: + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Table 1: GeneralTable 1: General key bindings and functions
counsel-describe-funtion help text of function
C-rquery-replace-regexpreplace text. (former isearch-backward)
C-x C-bibufferlist buffers (former list-buffers)
C-x |toggle-window-splittoggle horizontal/vertical 2 window split
M-upmove-line-upmove current line up
M-downmove-line-downmove current line down
mouse-6 scroll right
mouse-7 scroll left
mouse-8previous-buffer 
mouse-9next-buffer 
+ + + +## Org + - +@@ -252,79 +331,18 @@ edit `PGKBUILD` file for `python-pymupdf` to: - -
Table 2: OrgTable 2: Org key bindings and functions
org-babel-tangle create a file with the content of the block, use in header: :tangle filename
- - - - --- -- -- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + @@ -344,8 +362,28 @@ edit `PGKBUILD` file for `python-pymupdf` to:
Table 3: Custom and changed keys
C-rquery-replace-regexpreplace text. (former isearch-backward)
C-x C-bibufferlist buffers (former list-buffers)
C-x |toggle-window-splittoggle horizontal/vertical 2 window split
M-upmove-line-upmove current line up
M-downmove-line-downmove current line down
mouse-6  scroll right
mouse-7  scroll left
mouse-8previous-buffer  
mouse-9next-bufferOrg export   
+**Important** + +- For **Gnuplot** source blocks: Do not use `%` inside Gnuplot source + block but `\%` or in 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. + - `\%` `\%%` can also be used for HTML SVG export + +Links + +- +- + + + + +## Multiple cursors + - +@@ -385,16 +423,16 @@ edit `PGKBUILD` file for `python-pymupdf` to:
Table 4: Multiple cursorsTable 3: Multiple cursors key bindings and functions
- + -# Packages +## Other packages - **rainbow-mode.el:** rainbow-mode is a minor mode for Emacs which displays strings representing colors with the color they represent as background. - + # Information @@ -404,18 +442,61 @@ but interlocks to prevent the simultaneous editing of the same file. See [Interlocking](https://www.emacswiki.org/info-ref?find=Interlocking) in the [EmacsManual](https://www.emacswiki.org/emacs/EmacsManual) for details. - + # Errors +- failed execution of bibtex2html + - see bib2htmlxxxxxx.blg for errors, e.g. + - I couldn’t open style file acmu.bst + - copy/merge the texmf directory into your home directory. +- when using this in an Org mode buffer: + `#+HEADER: :fit yes :imagemagick yes :iminoptions -density 300` + - can leads to: + - convert: attempt to perform an operation not allowed by the security policy \`gs’ @ error/delegate.c/ExternalDelegateCommand/378. + - convert: no images defined \`DESYlogotikz.png’ @ error/convert.c/ConvertImageCommand/3282. + - edit `/etc/ImageMagick-7/policy.xml` and comment out + - `` - -## failed execution of bibtex2html + -see bib2htmlxxxxxx.blg for errors, e.g. +# TODOs -- I couldn’t open style file acmu.bst - -copy/merge the texmf directory into your home directory. +- Org / global configuration + - Page formatting + - Modify HTML styling + - Printed page layout, white styled figures + - Custom export function for HTML and \(\LaTeX\), with; + - `Shift` - ``, `Shift` - `` with open file + - delete temp. generated export files +- Figures + - Gnuplot + - plot transposed files/tables + - preamble in function and call this function for every gnuplot block either + manually or automatically with a hook?! +- Tables + - Wrap Table in div element. For smartphone scrolling. +- Table of contents + - \(\LaTeX\); currently headers with no-number property means not included in TOC + - HTML; currently generated list, like lot and lol, are not included in toc + but own headers without numbers are. +- Equation cancel/strike out with color line + - hcancel[color]{} + - Example: `\(\hcancel[red]{f_{X_2}(x_2)}}\)` + - Definition: + - Preamle: `#+LATEX_HEADER: \usepackage{cancel}` + `#+LATEX_HEADER: \newcommand\hcancel[2][black]{\setbox0=\hbox{$#2$}%` + `#+LATEX_HEADER: \rlap{\raisebox{.45\ht0}{\textcolor{#1}{\rule{\wd0}{1pt}}}}#2}` + - `hcancel: [\"{\\\\setbox0=\\\\hbox{$#2$}\\\\rlap{\\\\raisebox{.45\\\\ht0}{\\\\textcolor{#1}{\\\\rule{\\\\wd0}{1pt}}}}#2}\",2]` + + MathJax.Ajax.config.path[\"Contrib\"] = \"https://cdn.mathjax.org/mathjax/contrib\"; + MathJax.Hub.Register.StartupHook(\"TeX Jax Ready\",function () { + MathJax.Hub.Insert(MathJax.InputJax.TeX.Definitions.macros,{ + cancel: [\"Extension\",\"cancel\"], + bcancel: [\"Extension\",\"cancel\"], + xcancel: [\"Extension\",\"cancel\"], + cancelto: [\"Extension\",\"cancel\"] + }); + }); diff --git a/README.org b/README.org index 962854a6..397fd8f4 100644 --- a/README.org +++ b/README.org @@ -6,16 +6,25 @@ This is an ongoing evolution of Emacs configuration files, inspired by a bunch of online resources. * Requirements + :PROPERTIES: + :CUSTOM_ID: requirements + :END: external packages: #+begin_src shell - # flyspell-buffer - yay -S aspell hunspell - # org-mode latex-mode - yay -S biber bibtex2html + # fonts (opensans in latex article preamble) + yay -S ttf-inconsolata ttf-opensans + # spelling flyspell-buffer + yay -S aspell aspell-de aspell-en \ + hunspell hunspell-de hunspell-en_US \ + languagetool + # org-mode latex-mode ox-latex + yay -S biber bibtex2html texlive-bibtexextra texlive-core \ + texlive-fontsextra texlive-formatsextra texlive-langgreek \ + texlive-langjapanese texlive-latexextra texlive-pgf-pie \ + texlive-pgfopts texlive-pictures texlive-pstricks \ + texlive-publishers texlive-science texlive-slashbox # ledger-mode yay -S ledger - # langtool - yay -S languagetool # python-mode yay -S python-pylint # emacs-application-famework EAF @@ -23,10 +32,15 @@ a bunch of online resources. python-pyqt5 python-pyqt5-sip python-pyqtwebengine python-qrcode \ python-feedparser python-dbus python-pyinotify python-markdown \ python-grip filebrowser-bin python-epc + # other + yay -S ditaa plantuml r #+end_src Optional package for EAF see in Installation. * Installation + :PROPERTIES: + :CUSTOM_ID: installation + :END: Install into =~/.config/emacs= (must be empty) #+begin_src sh git clone http://gogs.weseng.de/daniel/emacs.git ~/.config/emacs @@ -39,7 +53,8 @@ a bunch of online resources. - =ln -s ~/.config/emacs/init ~/.emacs= (or =~/.emacs.el=, =~/.emacs.d/init.el=) - copy/merge the texmf directory into your home directory + LaTeX sytling files: copy/merge the =texmf= directory into your home + directory =~/texmf= optional for EAF #+begin_src shell @@ -54,19 +69,35 @@ a bunch of online resources. } #+end_example -* Key bindings and functions -#+caption: General -| M-> | end-of-buffer | | -| M-< | beginning-of-buffer | | -| C-x h | mark-whole-buffer | mark the whole buffer | -| C-x TAB | indent-rigidly | indent selected region | -| C-x RET f | set-buffer-file-coding-system | e. g. set to utf-8 | -| | decode-coding-region | e. g. decode to utf-8 (郭富城Aaron Kwok) | -| | diff-buffer-with-file | show a diff between buffer and file | -| C-h v | counsel-describe-variable | help text of variable | -| C-h f | counsel-describe-funtion | help text of function | +* Packages + :PROPERTIES: + :CUSTOM_ID: packages + :END: +#+caption: General key bindings and functions +| M-> | end-of-buffer | | +| M-< | beginning-of-buffer | | +| C-x h | mark-whole-buffer | mark the whole buffer | +| C-x TAB | indent-rigidly | indent selected region | +| C-x RET f | set-buffer-file-coding-system | e. g. set to utf-8 | +| | decode-coding-region | e. g. decode to utf-8 (郭富城Aaron Kwok) | +| | diff-buffer-with-file | show a diff between buffer and file | +| C-h v | counsel-describe-variable | help text of variable | +| C-h f | counsel-describe-funtion | help text of function | +| C-r | query-replace-regexp | replace text. (former isearch-backward) | +| C-x C-b | ibuffer | list buffers (former list-buffers) | +| C-x \vert | toggle-window-split | toggle horizontal/vertical 2 window split | +| M-up | move-line-up | move current line up | +| M-down | move-line-down | move current line down | +| mouse-6 | | scroll right | +| mouse-7 | | scroll left | +| mouse-8 | previous-buffer | | +| mouse-9 | next-buffer | | -#+caption: Org +** Org + :PROPERTIES: + :CUSTOM_ID: org + :END: +#+caption: Org key bindings and functions | C-c \vert | org-table-create-or-convert-from-region | convert seperator 1. TAB, 2. comma, 3. space | | C-u C-c \vert | org-table-create-or-convert-from-region | convert using comma (CSV) seperator | | C-u C-u C-c \vert | org-table-create-or-convert-from-region | convert using TAB | @@ -81,39 +112,105 @@ a bunch of online resources. | | | | | Org src block | | | | C-c C-v t | org-babel-tangle | create a file with the content of the block, use in header: :tangle filename | +| | | | +| Org export | | | +| f5 | | in org export to html | +| f6 | | in org export to LaTeX | -#+caption: Custom and changed keys -| C-r | query-replace-regexp | replace text. (former isearch-backward) | -| C-x C-b | ibuffer | list buffers (former list-buffers) | -| C-x \vert | toggle-window-split | toggle horizontal/vertical 2 window split | -| M-up | move-line-up | move current line up | -| M-down | move-line-down | move current line down | -| mouse-6 | | scroll right | -| mouse-7 | | scroll left | -| mouse-8 | previous-buffer | | -| mouse-9 | next-buffer | | -| f5 | | in org export to html | -| f6 | | in org export to LaTeX | +*Important* +- For *Gnuplot* source blocks: Do not use =%= inside Gnuplot source + block but =\%= or in 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. + - =\%= =\%%= can also be used for HTML SVG export -#+caption: Multiple cursors +Links +- https://tex.stackexchange.com/questions/167583/include-custom-file-into-header-with-org-mode/201674 +- https://orgmode.org/manual/LaTeX-specific-export-settings.html + +** Multiple cursors + :PROPERTIES: + :CUSTOM_ID: multiple-cursors + :END: +#+caption: Multiple cursors key bindings and functions | M-m s m a | mc/mark-all-dwim | try to mark all at point | | C-v | | jump to next cursor | | M-v | | jump to previous cursor | | C-' | | hide/unhide lines without a cursor | -* Packages +** Other packages + :PROPERTIES: + :CUSTOM_ID: other-packages + :END: - rainbow-mode.el :: https://elpa.gnu.org/packages/rainbow-mode.html rainbow-mode is a minor mode for Emacs which displays strings representing colors with the color they represent as background. * Information + :PROPERTIES: + :CUSTOM_ID: information + :END: Interlock symlinks and auto-save files. Be aware that symbolic links of the form “.#*” are not auto-save files but interlocks to prevent the simultaneous editing of the same file. See [[https://www.emacswiki.org/info-ref?find=Interlocking][Interlocking]] in the [[https://www.emacswiki.org/emacs/EmacsManual][EmacsManual]] for details. * Errors -** failed execution of bibtex2html -see bib2htmlxxxxxx.blg for errors, e.g. -- I couldn't open style file acmu.bst -copy/merge the texmf directory into your home directory. + :PROPERTIES: + :CUSTOM_ID: errors + :END: +- failed execution of bibtex2html + - see bib2htmlxxxxxx.blg for errors, e.g. + - I couldn't open style file acmu.bst + - copy/merge the texmf directory into your home directory. +- when using this in an Org mode buffer: + =#+HEADER: :fit yes :imagemagick yes :iminoptions -density 300= + - can leads to: + - convert: attempt to perform an operation not allowed by the security policy `gs' @ error/delegate.c/ExternalDelegateCommand/378. + - convert: no images defined `DESY_logo_tikz.png' @ error/convert.c/ConvertImageCommand/3282. + - edit =/etc/ImageMagick-7/policy.xml= and comment out + - ~~ + +* TODOs + :PROPERTIES: + :CUSTOM_ID: todos + :END: +- Org / global configuration + - Page formatting + - Modify HTML styling + - Printed page layout, white styled figures + - Custom export function for HTML and \(\LaTeX\), with; + - =Shift= - ==, =Shift= - == with open file + - delete temp. generated export files +- Figures + - Gnuplot + - plot transposed files/tables + - preamble in function and call this function for every gnuplot block either + manually or automatically with a hook?! +- Tables + - Wrap Table in div element. For smartphone scrolling. +- Table of contents + - \(\LaTeX\); currently headers with no-number property means not included in TOC + - HTML; currently generated list, like lot and lol, are not included in toc + but own headers without numbers are. +- Equation cancel/strike out with color line + - hcancel[color]{} + - Example: ~\(\hcancel[red]{f_{X_2}(x_2)}}\)~ + - Definition: + - Preamle: ~#+LATEX_HEADER: \usepackage{cancel}~ \\ + ~#+LATEX_HEADER: \newcommand\hcancel[2][black]{\setbox0=\hbox{$#2$}%~ \\ + ~#+LATEX_HEADER: \rlap{\raisebox{.45\ht0}{\textcolor{#1}{\rule{\wd0}{1pt}}}}#2}~ \\ + - ~hcancel: [\"{\\\\setbox0=\\\\hbox{$#2$}\\\\rlap{\\\\raisebox{.45\\\\ht0}{\\\\textcolor{#1}{\\\\rule{\\\\wd0}{1pt}}}}#2}\",2]~ + #+Begin_example +MathJax.Ajax.config.path[\"Contrib\"] = \"https://cdn.mathjax.org/mathjax/contrib\"; +MathJax.Hub.Register.StartupHook(\"TeX Jax Ready\",function () { + MathJax.Hub.Insert(MathJax.InputJax.TeX.Definitions.macros,{ + cancel: [\"Extension\",\"cancel\"], + bcancel: [\"Extension\",\"cancel\"], + xcancel: [\"Extension\",\"cancel\"], + cancelto: [\"Extension\",\"cancel\"] + }); +}); + #+End_example