update readme

This commit is contained in:
2022-01-11 02:08:02 +01:00
parent 50fd2b06ed
commit 2ffe448212
2 changed files with 288 additions and 456 deletions

241
README.md
View File

@@ -4,10 +4,8 @@
1. [Installation](#installation) 1. [Installation](#installation)
2. [Packages](#packages) 2. [Packages](#packages)
1. [Org](#org) 1. [Org](#org)
1. [HTML export](#export-html) 1. [Template for an article export (HTML and LaTeX)](#export-article)
2. [LaTeX export](#export-latex) 2. [Template for a letter export (LaTex)](#export-letter)
3. [Article export (HTML and LaTeX)](#export-article)
4. [Letter export (LaTex)](#export-letter)
2. [Multiple cursors](#multiple-cursors) 2. [Multiple cursors](#multiple-cursors)
3. [Other packages](#other-packages) 3. [Other packages](#other-packages)
3. [Information](#information) 3. [Information](#information)
@@ -57,148 +55,50 @@ General key bindings and functions
- `mouse-8` (`previous-buffer`) - `mouse-8` (`previous-buffer`)
- `mouse-9` (`next-buffer`) - `mouse-9` (`next-buffer`)
Spelling (flyspell ispell) bindings and functions
- (`flyspell-mode`) toggle spelling
- (`flyspell-buffer`)
- `C-;` (`flyspell-correct-wrapper`)
<a id="org"></a> <a id="org"></a>
## Org ## Org
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> Org key bindings and functions
<caption class="t-above"><span class="table-number">Table 1:</span> Org key bindings and functions</caption>
<colgroup> - `C-c |` (`org-table-create-or-convert-from-region`) convert seperator 1. TAB, 2. comma, 3. space
<col class="org-left" /> - `C-u C-c |` (`org-table-create-or-convert-from-region`) convert using comma (CSV) seperator
- `C-u C-u C-c |` (`org-table-create-or-convert-from-region`) convert using TAB
- `C-u <integer> C-c |` (`org-table-create-or-convert-from-region`) convert using N spaces
- `C-u REGEX C-c |` (`org-table-create-or-convert-from-region`) convert using regex to match seperator
- `C-c C-x \` (`org-toggle-pretty-entries`) e.g. displays `\pm` as ±
<col class="org-left" /> Org table
<col class="org-left" /> - `S-<right>` (`org-shiftright`) move cell right
</colgroup> - `S-<left>` (`org-shiftleft`) move cell left
<tbody> - `S-<up>` (`org-shiftup`) move cell up
<tr> - `S-<down>` (`org-shiftdown`) move cell down
<td class="org-left">C-c &vert;</td> - (`org-table-blank-field`) clear cell
<td class="org-left">org-table-create-or-convert-from-region</td>
<td class="org-left">convert seperator 1. TAB, 2. comma, 3. space</td>
</tr>
Org src block
<tr> - `C-c C-v t` (`org-babel-tangle`) create a file with the content of the block; use in `header:` `:tangle filename`
<td class="org-left">C-u C-c &vert;</td>
<td class="org-left">org-table-create-or-convert-from-region</td>
<td class="org-left">convert using comma (CSV) seperator</td>
</tr>
Org export
<tr> - `<f5>` (`my-org-export-html`)
<td class="org-left">C-u C-u C-c &vert;</td> - `<f6>` (`my-org-export-pdf`)
<td class="org-left">org-table-create-or-convert-from-region</td> - `C-<f5>` (`my-org-export-html-async`)
<td class="org-left">convert using TAB</td> - `C-<f6>` (`my-org-export-pdf-async`)
</tr> - `C-c C-e h h` (`org-html-export-to-html`)
- `C-c C-e T t` (`org-tufte-export-to-file`) HTML export with tufte syling
- `C-c C-e h a` (`my-org-article-html-export-to-html`) HTML-article file, see also Article export
<tr> - `C-c C-e l l` (`org-latex-export-to-pdf`)
<td class="org-left">C-u N C-c &vert;</td> - `C-c C-e l a` (`my-org-article-latex-export-to-pdf`) PDF-article file, see also Article export
<td class="org-left">org-table-create-or-convert-from-region</td> - `C-c C-e l t` (`my-org-article-latex-export-to-letter`) PDF-letter file
<td class="org-left">convert using N spaces</td>
</tr>
<tr>
<td class="org-left">C-u REGEX C-c &vert;</td>
<td class="org-left">org-table-create-or-convert-from-region</td>
<td class="org-left">convert using regex to match seperator</td>
</tr>
<tr>
<td class="org-left">C-c C-x \</td>
<td class="org-left">org-toggle-pretty-entries</td>
<td class="org-left">e. g. displays <code>\pm</code> as ±</td>
</tr>
<tr>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">Org table</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">S-right</td>
<td class="org-left">org-shiftright</td>
<td class="org-left">move a single cell right</td>
</tr>
<tr>
<td class="org-left">S-left</td>
<td class="org-left">org-shiftleft</td>
<td class="org-left">move a single cell left</td>
</tr>
<tr>
<td class="org-left">C-c SPC</td>
<td class="org-left">org-table-blank-field</td>
<td class="org-left">clear cell</td>
</tr>
<tr>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">Org src block</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">C-c C-v t</td>
<td class="org-left">org-babel-tangle</td>
<td class="org-left">create a file with the content of the block, use in header: :tangle filename</td>
</tr>
<tr>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">Org export</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">&#xa0;</td>
</tr>
<tr>
<td class="org-left">f5</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">in org export to html</td>
</tr>
<tr>
<td class="org-left">f6</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">in org export to LaTeX</td>
</tr>
</tbody>
</table>
**Important** **Important**
@@ -211,35 +111,9 @@ General key bindings and functions
- `\%` `\%%` can also be used for HTML SVG export - `\%` `\%%` can also be used for HTML SVG export
<a id="export-html"></a>
### HTML export
- `C-c C-e h h` (org-html-export-to-html) to export Org document as HTML file, i.e. no spectial settings.
- `C-c C-e T t` (org-tufte-export-to-file) to export Org document as Tufte-HTML file, i.e. with tufte syling.
- `C-c C-e h a` (my-org-article-html-export-to-html) to export Org document as HTML-article file, see also Article export
<a id="export-latex"></a>
### LaTeX export
- `C-c C-e l l` (org-latex-export-to-pdf) to export Org document as PDF file, i.e. no spectial settings.
- `C-c C-e l a` (my-org-article-latex-export-to-pdf) to export Org document as PDF-article file, see also Article export.
- `C-c C-e l t` (my-org-article-latex-export-to-letter) to export Org document as PDF-letter file.
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>
<a id="export-article"></a> <a id="export-article"></a>
### Article export (HTML and LaTeX) ### Template for an article export (HTML and LaTeX)
- `C-c C-e h a` (my-org-article-html-export-to-html) to export Org document as HTML-article file.
- `C-c C-e l a` (my-org-article-latex-export-to-pdf) to export Org document as PDF-article file.
Template for an article Template for an article
@@ -355,7 +229,7 @@ Examples for an article
<a id="export-letter"></a> <a id="export-letter"></a>
### Letter export (LaTex) ### Template for a letter export (LaTex)
# -*- ispell-local-dictionary: "german" -*- # -*- ispell-local-dictionary: "german" -*-
:FORM: :FORM:
@@ -399,45 +273,12 @@ Examples for an article
## Multiple cursors ## Multiple cursors
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides"> Multiple cursors key bindings and functions
<caption class="t-above"><span class="table-number">Table 2:</span> Multiple cursors key bindings and functions</caption>
<colgroup> - `M-m s m a` (`mc/mark-all-dwim`) try to mark all at point
<col class="org-left" /> - `C-v` jump to next cursor
- `M-v` jump to previous cursor
<col class="org-left" /> - `C-'` hide/unhide lines without a cursor
<col class="org-left" />
</colgroup>
<tbody>
<tr>
<td class="org-left">M-m s m a</td>
<td class="org-left">mc/mark-all-dwim</td>
<td class="org-left">try to mark all at point</td>
</tr>
<tr>
<td class="org-left">C-v</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">jump to next cursor</td>
</tr>
<tr>
<td class="org-left">M-v</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">jump to previous cursor</td>
</tr>
<tr>
<td class="org-left">C-&rsquo;</td>
<td class="org-left">&#xa0;</td>
<td class="org-left">hide/unhide lines without a cursor</td>
</tr>
</tbody>
</table>
<a id="other-packages"></a> <a id="other-packages"></a>

View File

@@ -23,7 +23,6 @@ a bunch of online resources.
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: packages :CUSTOM_ID: packages
:END: :END:
#+caption:
General key bindings and functions General key bindings and functions
- =M->= (=end-of-buffer=) - =M->= (=end-of-buffer=)
- =M-<= (=begin-of-buffer=) - =M-<= (=begin-of-buffer=)
@@ -44,29 +43,44 @@ General key bindings and functions
- =mouse-8= (=previous-buffer=) - =mouse-8= (=previous-buffer=)
- =mouse-9= (=next-buffer=) - =mouse-9= (=next-buffer=)
Spelling (flyspell ispell) bindings and functions
- (=flyspell-mode=) toggle spelling
- (=flyspell-buffer=)
- =C-;= (=flyspell-correct-wrapper=)
** Org ** Org
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: org :CUSTOM_ID: org
:END: :END:
#+caption: Org key bindings and functions Org key bindings and functions
| C-c \vert | 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 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-c |= (=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 | - =C-u C-u C-c |= (=org-table-create-or-convert-from-region=) convert using TAB
| C-u N C-c \vert | org-table-create-or-convert-from-region | convert using N spaces | - =C-u <integer> C-c |= (=org-table-create-or-convert-from-region=) convert using N spaces
| C-u REGEX C-c \vert | org-table-create-or-convert-from-region | convert using regex to match seperator | - =C-u REGEX C-c |= (=org-table-create-or-convert-from-region=) convert using regex to match seperator
| C-c C-x \ | org-toggle-pretty-entries | e. g. displays =\pm= as ± | - =C-c C-x \= (=org-toggle-pretty-entries=) e.g. displays =\pm= as ±
| | | |
| Org table | | | Org table
| S-right | org-shiftright | move a single cell right | - =S-<right>= (=org-shiftright=) move cell right
| S-left | org-shiftleft | move a single cell left | - =S-<left>= (=org-shiftleft=) move cell left
| C-c SPC | org-table-blank-field | clear cell | - =S-<up>= (=org-shiftup=) move cell up
| | | | - =S-<down>= (=org-shiftdown=) move cell down
| Org src block | | | - (=org-table-blank-field=) clear cell
| C-c C-v t | org-babel-tangle | create a file with the content of the block, use in header: :tangle filename |
| | | | Org src block
| Org export | | | - =C-c C-v t= (=org-babel-tangle=) create a file with the content of the block; use in =header:= =:tangle filename=
| f5 | | in org export to html |
| f6 | | in org export to LaTeX | Org export
- =<f5>= (=my-org-export-html=)
- =<f6>= (=my-org-export-pdf=)
- =C-<f5>= (=my-org-export-html-async=)
- =C-<f6>= (=my-org-export-pdf-async=)
- =C-c C-e h h= (=org-html-export-to-html=)
- =C-c C-e T t= (=org-tufte-export-to-file=) HTML export with tufte syling
- =C-c C-e h a= (=my-org-article-html-export-to-html=) HTML-article file, see also Article export
- =C-c C-e l l= (=org-latex-export-to-pdf=)
- =C-c C-e l a= (=my-org-article-latex-export-to-pdf=) PDF-article file, see also Article export
- =C-c C-e l t= (=my-org-article-latex-export-to-letter=) PDF-letter file
*Important* *Important*
- For *Gnuplot* source blocks: Do not use =%= inside Gnuplot source - For *Gnuplot* source blocks: Do not use =%= inside Gnuplot source
@@ -77,33 +91,10 @@ General key bindings and functions
.eps (figure) files. .eps (figure) files.
- =\%= =\%%= can also be used for HTML SVG export - =\%= =\%%= can also be used for HTML SVG export
*** HTML export *** Template for an article export (HTML and LaTeX)
:PROPERTIES:
:CUSTOM_ID: export-html
:END:
- =C-c C-e h h= (org-html-export-to-html) to export Org document as HTML file, i.e. no spectial settings.
- =C-c C-e T t= (org-tufte-export-to-file) to export Org document as Tufte-HTML file, i.e. with tufte syling.
- =C-c C-e h a= (my-org-article-html-export-to-html) to export Org document as HTML-article file, see also Article export
*** LaTeX export
:PROPERTIES:
:CUSTOM_ID: export-latex
:END:
- =C-c C-e l l= (org-latex-export-to-pdf) to export Org document as PDF file, i.e. no spectial settings.
- =C-c C-e l a= (my-org-article-latex-export-to-pdf) to export Org document as PDF-article file, see also Article export.
- =C-c C-e l t= (my-org-article-latex-export-to-letter) to export Org document as PDF-letter file.
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
*** Article export (HTML and LaTeX)
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: export-article :CUSTOM_ID: export-article
:END: :END:
- =C-c C-e h a= (my-org-article-html-export-to-html) to export Org document as HTML-article file.
- =C-c C-e l a= (my-org-article-latex-export-to-pdf) to export Org document as PDF-article file.
Template for an article Template for an article
#+begin_src org #+begin_src org
# -*- ispell-local-dictionary: "english" -*- # -*- ispell-local-dictionary: "english" -*-
@@ -217,7 +208,7 @@ General key bindings and functions
,#+BIBLIOGRAPHY: references rottbibsty option:-a option:-unicode option:-nobibsource ,#+BIBLIOGRAPHY: references rottbibsty option:-a option:-unicode option:-nobibsource
#+end_src #+end_src
*** Letter export (LaTex) *** Template for a letter export (LaTex)
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: export-letter :CUSTOM_ID: export-letter
:END: :END:
@@ -264,11 +255,11 @@ General key bindings and functions
:PROPERTIES: :PROPERTIES:
:CUSTOM_ID: multiple-cursors :CUSTOM_ID: multiple-cursors
:END: :END:
#+caption: Multiple cursors key bindings and functions Multiple cursors key bindings and functions
| M-m s m a | mc/mark-all-dwim | try to mark all at point | - =M-m s m a= (=mc/mark-all-dwim=) try to mark all at point
| C-v | | jump to next cursor | - =C-v= jump to next cursor
| M-v | | jump to previous cursor | - =M-v= jump to previous cursor
| C-' | | hide/unhide lines without a cursor | - =C-'= hide/unhide lines without a cursor
** Other packages ** Other packages
:PROPERTIES: :PROPERTIES: