update readme
This commit is contained in:
323
README.md
323
README.md
@@ -4,10 +4,8 @@
|
||||
1. [Installation](#installation)
|
||||
2. [Packages](#packages)
|
||||
1. [Org](#org)
|
||||
1. [HTML export](#export-html)
|
||||
2. [LaTeX export](#export-latex)
|
||||
3. [Article export (HTML and LaTeX)](#export-article)
|
||||
4. [Letter export (LaTex)](#export-letter)
|
||||
1. [Template for an article export (HTML and LaTeX)](#export-article)
|
||||
2. [Template for a letter export (LaTex)](#export-letter)
|
||||
2. [Multiple cursors](#multiple-cursors)
|
||||
3. [Other packages](#other-packages)
|
||||
3. [Information](#information)
|
||||
@@ -57,148 +55,50 @@ General key bindings and functions
|
||||
- `mouse-8` (`previous-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>
|
||||
|
||||
## Org
|
||||
|
||||
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<caption class="t-above"><span class="table-number">Table 1:</span> Org key bindings and functions</caption>
|
||||
Org key bindings and functions
|
||||
|
||||
<colgroup>
|
||||
<col class="org-left" />
|
||||
- `C-c |` (`org-table-create-or-convert-from-region`) convert seperator 1. TAB, 2. comma, 3. space
|
||||
- `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" />
|
||||
</colgroup>
|
||||
<tbody>
|
||||
<tr>
|
||||
<td class="org-left">C-c |</td>
|
||||
<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>
|
||||
- `S-<right>` (`org-shiftright`) move cell right
|
||||
- `S-<left>` (`org-shiftleft`) move cell left
|
||||
- `S-<up>` (`org-shiftup`) move cell up
|
||||
- `S-<down>` (`org-shiftdown`) move cell down
|
||||
- (`org-table-blank-field`) clear cell
|
||||
|
||||
Org src block
|
||||
|
||||
<tr>
|
||||
<td class="org-left">C-u C-c |</td>
|
||||
<td class="org-left">org-table-create-or-convert-from-region</td>
|
||||
<td class="org-left">convert using comma (CSV) seperator</td>
|
||||
</tr>
|
||||
- `C-c C-v t` (`org-babel-tangle`) create a file with the content of the block; use in `header:` `:tangle filename`
|
||||
|
||||
Org export
|
||||
|
||||
<tr>
|
||||
<td class="org-left">C-u C-u C-c |</td>
|
||||
<td class="org-left">org-table-create-or-convert-from-region</td>
|
||||
<td class="org-left">convert using TAB</td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td class="org-left">C-u N C-c |</td>
|
||||
<td class="org-left">org-table-create-or-convert-from-region</td>
|
||||
<td class="org-left">convert using N spaces</td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td class="org-left">C-u REGEX C-c |</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"> </td>
|
||||
<td class="org-left"> </td>
|
||||
<td class="org-left"> </td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td class="org-left">Org table</td>
|
||||
<td class="org-left"> </td>
|
||||
<td class="org-left"> </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"> </td>
|
||||
<td class="org-left"> </td>
|
||||
<td class="org-left"> </td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td class="org-left">Org src block</td>
|
||||
<td class="org-left"> </td>
|
||||
<td class="org-left"> </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"> </td>
|
||||
<td class="org-left"> </td>
|
||||
<td class="org-left"> </td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td class="org-left">Org export</td>
|
||||
<td class="org-left"> </td>
|
||||
<td class="org-left"> </td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td class="org-left">f5</td>
|
||||
<td class="org-left"> </td>
|
||||
<td class="org-left">in org export to html</td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td class="org-left">f6</td>
|
||||
<td class="org-left"> </td>
|
||||
<td class="org-left">in org export to LaTeX</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
- `<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**
|
||||
|
||||
@@ -211,35 +111,9 @@ General key bindings and functions
|
||||
- `\%` `\%%` 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>
|
||||
|
||||
### 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 export (HTML and LaTeX)
|
||||
|
||||
Template for an article
|
||||
|
||||
@@ -260,10 +134,10 @@ Template for an article
|
||||
#+END_ABSTRACT
|
||||
|
||||
* List of contents & figures & tables & listings :ignore:
|
||||
:PROPERTIES:
|
||||
:VISIBILITY: folded
|
||||
:CLEARPAGE: t
|
||||
:END:
|
||||
:PROPERTIES:
|
||||
:VISIBILITY: folded
|
||||
:CLEARPAGE: t
|
||||
:END:
|
||||
#+LATEX: \begin{spacing}{1.25}\begingroup\renewcommand*{\addvspace}[1]{}
|
||||
|
||||
#+LATEX: \clearpage
|
||||
@@ -286,10 +160,10 @@ Template for an article
|
||||
#+LATEX: \endgroup\end{spacing}
|
||||
|
||||
* List of Symbols :ignore:
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: list-of-symbols
|
||||
:UNNUMBERED: t
|
||||
:END:
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: list-of-symbols
|
||||
:UNNUMBERED: t
|
||||
:END:
|
||||
|
||||
#+LATEX: \pagenumbering{arabic}\setcounter{page}{1}
|
||||
|
||||
@@ -299,22 +173,22 @@ Examples for an article
|
||||
#+LANGUAGE: de
|
||||
|
||||
* Header not listed in toc :ignore:
|
||||
bla bla bla
|
||||
bla bla bla
|
||||
|
||||
* Section not exported :noexport:
|
||||
bla bla bla, this will not be exported
|
||||
bla bla bla, this will not be exported
|
||||
|
||||
* Header listed unnumbered
|
||||
:PROPERTIES:
|
||||
:UNNUMBERED: t
|
||||
:END:
|
||||
bla bla bla
|
||||
:PROPERTIES:
|
||||
:UNNUMBERED: t
|
||||
:END:
|
||||
bla bla bla
|
||||
|
||||
* Section will start on a clear page (LaTeX)
|
||||
:PROPERTIES:
|
||||
:CLEARPAGE: t
|
||||
:END:
|
||||
bla bla bla
|
||||
:PROPERTIES:
|
||||
:CLEARPAGE: t
|
||||
:END:
|
||||
bla bla bla
|
||||
|
||||
# For PDF/LaTeX export we do not want to use org-ref ox-bibtex, as its output is
|
||||
# already defined in the preamble. The output for 'bibliography:references.bib'
|
||||
@@ -324,38 +198,38 @@ Examples for an article
|
||||
# ox-bibtex version
|
||||
# #+BIBLIOGRAPHY: references mbunsrtdin option:-a option:-unicode option:-nobibsource limit:t
|
||||
* References-en :ignore:
|
||||
:PROPERTIES:
|
||||
:VISIBILITY: folded
|
||||
:END:
|
||||
#+LATEX: \newpage\thispagestyle{plain}
|
||||
#+LATEX: \sloppy\printbibliography
|
||||
#+LATEX: \begin{comment}
|
||||
#+BIBLIOGRAPHY: references acmu option:-a option:-unicode option:-nobibsource limit:t
|
||||
#+LATEX: \end{comment}
|
||||
:PROPERTIES:
|
||||
:VISIBILITY: folded
|
||||
:END:
|
||||
#+LATEX: \newpage\thispagestyle{plain}
|
||||
#+LATEX: \sloppy\printbibliography
|
||||
#+LATEX: \begin{comment}
|
||||
#+BIBLIOGRAPHY: references acmu option:-a option:-unicode option:-nobibsource limit:t
|
||||
#+LATEX: \end{comment}
|
||||
|
||||
* References-de :ignore:
|
||||
:PROPERTIES:
|
||||
:VISIBILITY: folded
|
||||
:END:
|
||||
#+LATEX: \newpage\thispagestyle{plain}
|
||||
#+LATEX: \sloppy\printbibliography
|
||||
#+LATEX: \begin{comment}
|
||||
#+BIBLIOGRAPHY: references mbunsrtdin option:-a option:-unicode option:-nobibsource limit:t
|
||||
#+LATEX: \end{comment}
|
||||
:PROPERTIES:
|
||||
:VISIBILITY: folded
|
||||
:END:
|
||||
#+LATEX: \newpage\thispagestyle{plain}
|
||||
#+LATEX: \sloppy\printbibliography
|
||||
#+LATEX: \begin{comment}
|
||||
#+BIBLIOGRAPHY: references mbunsrtdin option:-a option:-unicode option:-nobibsource limit:t
|
||||
#+LATEX: \end{comment}
|
||||
|
||||
* References-rott :ignore:
|
||||
:PROPERTIES:
|
||||
:VISIBILITY: folded
|
||||
:END:
|
||||
#+LATEX: \newpage\thispagestyle{plain}
|
||||
# all references from the bib
|
||||
#+LATEX: \nocite{*}
|
||||
#+BIBLIOGRAPHY: references rottbibsty option:-a option:-unicode option:-nobibsource
|
||||
:PROPERTIES:
|
||||
:VISIBILITY: folded
|
||||
:END:
|
||||
#+LATEX: \newpage\thispagestyle{plain}
|
||||
# all references from the bib
|
||||
#+LATEX: \nocite{*}
|
||||
#+BIBLIOGRAPHY: references rottbibsty option:-a option:-unicode option:-nobibsource
|
||||
|
||||
|
||||
<a id="export-letter"></a>
|
||||
|
||||
### Letter export (LaTex)
|
||||
### Template for a letter export (LaTex)
|
||||
|
||||
# -*- ispell-local-dictionary: "german" -*-
|
||||
:FORM:
|
||||
@@ -399,45 +273,12 @@ Examples for an article
|
||||
|
||||
## Multiple cursors
|
||||
|
||||
<table border="2" cellspacing="0" cellpadding="6" rules="groups" frame="hsides">
|
||||
<caption class="t-above"><span class="table-number">Table 2:</span> Multiple cursors key bindings and functions</caption>
|
||||
Multiple cursors key bindings and functions
|
||||
|
||||
<colgroup>
|
||||
<col class="org-left" />
|
||||
|
||||
<col class="org-left" />
|
||||
|
||||
<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"> </td>
|
||||
<td class="org-left">jump to next cursor</td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td class="org-left">M-v</td>
|
||||
<td class="org-left"> </td>
|
||||
<td class="org-left">jump to previous cursor</td>
|
||||
</tr>
|
||||
|
||||
|
||||
<tr>
|
||||
<td class="org-left">C-’</td>
|
||||
<td class="org-left"> </td>
|
||||
<td class="org-left">hide/unhide lines without a cursor</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
- `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
|
||||
|
||||
|
||||
<a id="other-packages"></a>
|
||||
|
||||
Reference in New Issue
Block a user