update documentation
This commit is contained in:
214
README.md
214
README.md
@@ -2,14 +2,11 @@
|
||||
# Table of Contents
|
||||
|
||||
1. [Installation](#installation)
|
||||
2. [Packages](#packages)
|
||||
1. [Org](#org)
|
||||
1. [Template for an article export (HTML and LaTeX)](#export-article)
|
||||
2. [Template for a letter export (LaTex)](#export-letter)
|
||||
2. [Other packages](#other-packages)
|
||||
3. [Information](#information)
|
||||
4. [Errors](#errors)
|
||||
5. [TODOs](#todos)
|
||||
2. [Usage](#usage)
|
||||
3. [Packages](#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.
|
||||
@@ -32,195 +29,40 @@ Installation path is `~/.config/emacs`. See details and other
|
||||
installed linux packages as requirements inside `sripts/install.sh`.
|
||||
|
||||
|
||||
<a id="usage"></a>
|
||||
|
||||
# Usage
|
||||
|
||||
See the emacs command `my-help` for some key-bindings and further
|
||||
commands and information.
|
||||
|
||||
- Org Templates
|
||||
- Article: `?article[TAB]` / YASnippet - org-mode - Article
|
||||
Templates - Article
|
||||
- Letter: `?letter[TAB]` / YASnippet - org-mode - Letter Templates -
|
||||
Letter
|
||||
- Org Export
|
||||
- To Article HTML (extended version)
|
||||
- `my-org-article-html-export-to-html` / My - Org Export - Article HTML
|
||||
- `my-org-article-html-export-to-html-notify-async` (`F5`) / My - Org Export - Article HTML async
|
||||
- To Article PDF (LaTeX, extended version)
|
||||
- `my-org-article-latex-export-to-pdf` / My - Org Export - Article PDF
|
||||
- `my-org-article-latex-export-to-pdf-notify-async` (`F6`) / My - Org Export - Article PDF async
|
||||
- To Letter (LaTeX)
|
||||
- `my-org-letter-latex-export-to-pdf` (`C-c C-e l t`)
|
||||
|
||||
|
||||
<a id="packages"></a>
|
||||
|
||||
# Packages
|
||||
|
||||
General key bindings and functions
|
||||
|
||||
- `C-x |` (`toggle-window-split`) toggle horizontal/vertical of 2 window split
|
||||
- `C-x TAB` (`indent-rigidly`) indent lines in the region
|
||||
- `C-r` (`query-replace-regexp`) replace text
|
||||
- `M-<up>` (`move-line-up`)
|
||||
- `M-<down>` (`move-line-down`)
|
||||
- `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 (current state) and file (saved state)
|
||||
|
||||
Spelling (flyspell ispell) bindings and functions
|
||||
|
||||
- (`flyspell-mode`) toggle spelling
|
||||
- (`flyspell-buffer`)
|
||||
- `C-;` (`flyspell-correct-wrapper`)
|
||||
|
||||
|
||||
<a id="org"></a>
|
||||
|
||||
## Org
|
||||
|
||||
|
||||
<a id="export-article"></a>
|
||||
|
||||
### Template for an article export (HTML and LaTeX)
|
||||
|
||||
Template for an article
|
||||
|
||||
# -*- ispell-local-dictionary: "english" -*-
|
||||
#+LANGUAGE: en
|
||||
#+TITLE: My article
|
||||
#+SUBTITLE:
|
||||
#+AUTHOR: Daniel
|
||||
#+EMAIL: name@example.org
|
||||
#+DATE: May 12, 2021
|
||||
#+KEYWORDS:
|
||||
#+DESCRIPTION:
|
||||
|
||||
* Abstract :ignore:noexport:
|
||||
#+BEGIN_ABSTRACT
|
||||
*Abstract*\\
|
||||
This is the abstract of the article.
|
||||
#+END_ABSTRACT
|
||||
|
||||
* List of contents & figures & tables & listings :ignore:
|
||||
:PROPERTIES:
|
||||
:VISIBILITY: folded
|
||||
:CLEARPAGE: t
|
||||
:END:
|
||||
#+LATEX: \begin{spacing}{1.25}\begingroup\renewcommand*{\addvspace}[1]{}
|
||||
|
||||
#+LATEX: \clearpage
|
||||
# #+LATEX: \tableofcontents
|
||||
#+TOC: headlines
|
||||
|
||||
#+LATEX: \clearpage
|
||||
#+LATEX: \listoffigures
|
||||
# #+LATEX: \phantomsection\addcontentsline{toc}{section}{Abbildungsverzeichnis}\listoffigures
|
||||
# #+TOC: figures is not implemented yet in the HTML backend. And not working with LaTeX, see listing
|
||||
# #+TOC: figures
|
||||
|
||||
# #+LATEX: \listoftables
|
||||
# #+LATEX: \phantomsection\addcontentsline{toc}{section}{Tabellenverzeichnis}
|
||||
#+TOC: tables
|
||||
|
||||
# for latex listing is figures
|
||||
# #+LATEX: \phantomsection\addcontentsline{toc}{section}{Programmausdrucke}
|
||||
#+TOC: listings
|
||||
#+LATEX: \endgroup\end{spacing}
|
||||
|
||||
* List of Symbols :ignore:
|
||||
:PROPERTIES:
|
||||
:CUSTOM_ID: list-of-symbols
|
||||
:UNNUMBERED: t
|
||||
:END:
|
||||
|
||||
#+LATEX: \pagenumbering{arabic}\setcounter{page}{1}
|
||||
|
||||
Examples for an article
|
||||
|
||||
# -*- ispell-local-dictionary: "german" -*-
|
||||
#+LANGUAGE: de
|
||||
|
||||
* Header not listed in toc :ignore:
|
||||
bla bla bla
|
||||
|
||||
* Section not exported :noexport:
|
||||
bla bla bla, this will not be exported
|
||||
|
||||
* Header listed unnumbered
|
||||
:PROPERTIES:
|
||||
:UNNUMBERED: t
|
||||
:END:
|
||||
bla bla bla
|
||||
|
||||
* Section will start on a clear page (LaTeX)
|
||||
: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'
|
||||
# is something like '\bibliography{references}'
|
||||
# reftex version
|
||||
# bibliography:references.bib
|
||||
# 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}
|
||||
|
||||
* 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}
|
||||
|
||||
* 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
|
||||
|
||||
|
||||
<a id="export-letter"></a>
|
||||
|
||||
### Template for a letter export (LaTex)
|
||||
|
||||
# -*- ispell-local-dictionary: "german" -*-
|
||||
:FORM:
|
||||
#+LANGUAGE: de
|
||||
#+FROM_ASSOCIATION: XYZ AG
|
||||
#+FROM_NAME: Max Mustermann
|
||||
#+FROM_STREET: Regenbogenstrasse 7
|
||||
#+FROM_PLACE: 12345 Hamburg
|
||||
#+FROM_PHONE: 0123456789
|
||||
#+FROM_URL: www.beispiel.de
|
||||
#+FROM_EMAIL: mail@example.de
|
||||
|
||||
#+TO_ASSOCIATION: Firma AG
|
||||
#+TO_NAME: Karl Marx
|
||||
#+TO_STREET: Firmstrasse 13
|
||||
#+TO_PLACE: Berlin
|
||||
|
||||
#+PLACE: Hamburg
|
||||
#+DATE: \today
|
||||
# #+DATE: 3. Januar 2020
|
||||
:END:
|
||||
|
||||
#+SUBJECT: Abrechnung
|
||||
#+SUBJECT: 2020
|
||||
#+SUBJECT_EXTRA: Kontonummer
|
||||
#+SUBJECT_EXTRA: März
|
||||
|
||||
#+OPENING: Sehr geehte Frau \toname,
|
||||
|
||||
hiermit sende ich Ihnen die angeforderten Unterlagen zu und ...
|
||||
|
||||
#+CLOSING: MfG,
|
||||
|
||||
#+ATTACHMENT: analage 1
|
||||
#+ATTACHMENT: anlage 2
|
||||
#+ATTACHMENT: analage 3
|
||||
#+ATTACHMENT: analage 6
|
||||
|
||||
|
||||
<a id="other-packages"></a>
|
||||
|
||||
## Other packages
|
||||
|
||||
- **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.
|
||||
|
||||
Reference in New Issue
Block a user