From 7335908d80574db6756d3b92d8fda51ed8d2ca47 Mon Sep 17 00:00:00 2001 From: Daniel Weschke Date: Wed, 14 Dec 2022 14:47:05 +0100 Subject: [PATCH] update documentation --- README.md | 214 +++++-------------------------------- README.org | 201 ++++------------------------------ lisp/my/my-org-article.org | 123 ++++++++++++++++----- lisp/my/my.el | 37 ++++--- snippets/org-mode/article | 9 +- snippets/org-mode/letter | 39 +++++++ 6 files changed, 215 insertions(+), 408 deletions(-) create mode 100644 snippets/org-mode/letter diff --git a/README.md b/README.md index 2aca448f..b52eef18 100644 --- a/README.md +++ b/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`. + + +# 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`) + + # 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-` (`move-line-up`) -- `M-` (`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`) - - - - -## Org - - - - -### 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 - - - - -### 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 - - - - -## 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. diff --git a/README.org b/README.org index 31896916..865a62be 100644 --- a/README.org +++ b/README.org @@ -21,194 +21,39 @@ sh -c "$(fetch -o - http://gitea.weseng.de/daniel/emacs/raw/master/scripts/insta Installation path is =~/.config/emacs=. See details and other installed linux packages as requirements inside =sripts/install.sh=. +* Usage +:PROPERTIES: +:CUSTOM_ID: usage +:END: + +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=) + * Packages :PROPERTIES: :CUSTOM_ID: packages :END: 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-= (=move-line-up=) -- =M-= (=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=) - -** Org -:PROPERTIES: -:CUSTOM_ID: org -:END: - -*** Template for an article export (HTML and LaTeX) -:PROPERTIES: -:CUSTOM_ID: export-article -:END: -Template for an article -#+begin_src org -# -*- 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} -#+end_src - -Examples for an article -#+begin_src org -# -*- 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 -#+end_src - -*** Template for a letter export (LaTex) -:PROPERTIES: -:CUSTOM_ID: export-letter -:END: -#+begin_src org -# -*- 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 -#+end_src - -** 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. diff --git a/lisp/my/my-org-article.org b/lisp/my/my-org-article.org index b1864130..7f217d8e 100644 --- a/lisp/my/my-org-article.org +++ b/lisp/my/my-org-article.org @@ -33,59 +33,124 @@ sub makeacn2acr { * Preamble The preamble is defined by Org-keywords. -#+begin_example -# The title (also used in pdf metadata field) +First line of the file can be used to define the spelling language of +the document. +#+begin_src org +# -*- ispell-local-dictionary: "english" -*- +# -*- ispell-local-dictionary: "german" -*- +#+end_src + +The title (also used in pdf metadata field) +#+begin_src org #+TITLE: The title +#+end_src -# The subtitle +The subtitle +#+begin_src org #+SUBTITLE: The subtitle +#+end_src -# The date +The date +#+begin_src org #+DATE: May 16, 2022 #+DATE: \today +#+end_src -# Author(s) (also used in pdf metadata field) -#+AUTHOR: Max Mustermann -#+AUTHOR: Max Mustermann and Maxi Mustermann -#+AUTHOR: Max Mustermann, Maxi Mustermann +Author(s) (also used in pdf metadata field) +#+begin_src org +#+AUTHOR: Max Muster +#+AUTHOR: Max Muster and Maxi Muster +#+AUTHOR: Max Muster, Maxi Muster +#+end_src -# Email(s) -#+EMAIL: max.mustermann@example.com -#+EMAIL: max.mustermann@example.com and maxi.mustermann@example.com -#+EMAIL: max.mustermann@example.com, maxi.mustermann@example.com +Email(s) +#+begin_src org +#+EMAIL: max.muster@example.com +#+EMAIL: max.muster@example.com and maxi.muster@example.com +#+EMAIL: max.muster@example.com, maxi.muster@example.com +#+end_src -# Keywords (also used in pdf metadata field) +Keywords (also used in pdf metadata field) +#+begin_src org #+KEYWORDS: manual, examples +#+end_src -# Options -## draft:t - display a block at the end of a line, which is too long (bad line break) +Export options +#+begin_src org +# draft:t - display a block at the end of a line, which is too long (indication bad line break) #+OPTIONS: draft:t +#+end_src -# Language (en default) +Language (en default) +#+begin_src org #+LANGUAGE: en #+LANGUAGE: de +#+end_src -# Description (also used in pdf metadata field: subject) +Description (also used in pdf metadata field: subject). Keyword can be +used multiple times to extend the description. +#+begin_src org #+DESCRIPTION: Multiline #+DESCRIPTION: description +#+end_src -# Type of the document. Used for abstract template. +Type of the document. (The abstract template uses or can reference to +the keyword variable 'document_type' via the macro 'title-name') +#+begin_src org #+DOCUMENT_TYPE: Seminararbeit +#+end_src -# Overwrite references setup +Overwrite references setup +#+begin_src org #+BIBLATEX: \usepackage[backend=biber,citestyle=alphabetic,bibstyle=authoryear,sorting=nyt,sortcase=false]{biblatex}\setlength{\bibhang}{0pt}\addbibresource{references.bib} +#+end_src -# Additional peamble setup +Additional peamble setup +#+begin_src org #+LATEX_HEADER_EXTRA: \usepackage{layout} -#+end_example +#+end_src * Text ** Headline -#+begin_example - * 1st level heading - ** this is 2nd level heading - *** this is 3rd level heading -#+end_example +#+begin_src org +,* 1st level heading +,** this is 2nd level heading +,*** this is 3rd level heading +#+end_src + +To have a headline in Org but not in an export set the header tag +=:ignore:=. +#+begin_src org +,* Header not listed in toc but its content :ignore: +bla bla bla +#+end_src + +To have a headline with its content in Org but not in an export set +the header tag =:noexport:=. +#+begin_src org +,* Section not exported :noexport: +bla bla bla, this will not be exported +#+end_src + +To have a headline unnumbered in the table of contents set the header +property =:UNNUMBERED: t=. +#+begin_src org +,* Header listed unnumbered +:PROPERTIES: +:UNNUMBERED: t +:END: +bla bla bla +#+end_src + +To have a headline in a LaTeX export started on a new page use the +header property =:CLEARPAGE: t=. +#+begin_src org +,* Section will start on a clear page (LaTeX) +:PROPERTIES: +:CLEARPAGE: t +:END: +bla bla bla +#+end_src ** Formatting #+begin_example @@ -425,6 +490,9 @@ SRC block header =:var fname=(mpl-var "")= to export figure as .pgf for latex and .svg otherwise, like HTML. **** using my.mplstyle +Python matplotlib figure using matplotlib =my=. The style =my= renders +without LaTeX but using the kpfonts. + #+HEADER: :prologue (mpl-prologue) #+HEADER: :var fname=(mpl-var "img/figure-matplotlib") #+begin_src python :results output file @@ -456,6 +524,9 @@ print(fname, end='') [[file:img/figure-matplotlib.svg]] **** using my-tex.mplstyle +Python matplotlib figure using matplotlib =my-tex=. The style =my-tex= +renders with LaTeX and uses the kpfonts. + #+HEADER: :prologue (mpl-prologue "my-tex") #+HEADER: :var fname=(mpl-var "img/figure-matplotlib-tex") #+begin_src python :results output file diff --git a/lisp/my/my.el b/lisp/my/my.el index 40cf9638..2adde182 100644 --- a/lisp/my/my.el +++ b/lisp/my/my.el @@ -43,21 +43,23 @@ [[help:counsel-recentf][Open recent]] ............ =C-x= =C-r= [[help:kill-buffer][Close buffer]] ............. =C-x= =k= [[help:dired][Browse directory]] ......... =C-x= =d= [[help:counsel-switch-buffer][Switch buffer]] ............ =C-x= =b= [[help:previous-buffer][Previous buffer]] ....... =C-x= =left= [[help:next-buffer][Next buffer]] .......... =C-x= =right= - [[help:save-buffers-kill-terminal][Quit]] ................... =C-x= =C-c= + [[help:save-buffers-kill-terminal][Quit]] ................... =C-x= =C-c= [[toggle-window-split][Toggle 2 window split]] ... =C-x= =|= [[help:swiper][Search]] ..................... =C-s= [[help:goto-line][Go to line]] ............. =M-g= =M-g= [[help:query-replace][Replace]] .................... =M-%= [[help:counsel-M-x][Execute]] .................... =M-x= [[help:begin-of-buffer][Begin of buffer]] ............ =M-<= [[help:beginning-of-line][Begin of line]] .............. =C-a= [[help:end-of-buffer][End of buffer]] .............. =M->= [[help:end-of-line][End of line]] ................ =C-e= - Mark ..................... =C-spc= [[help:kill-ring-save][Copy]] ....................... =M-w= - [[help:kill-region][Cut]] ........................ =C-w= [[help:yank][Paste]] ...................... =C-y= - [[help:kill-line][Cut rest of line]] ........... =C-k= [[help:counsel-yank-pop][Paste older]] ................ =M-y= - [[help:mark-whole-buffer][Mark whole buffer]] ........ =C-x= =h= + [[help:set-mark-command][Mark]] ..................... =C-SPC= [[help:kill-ring-save][Copy]] ....................... =M-w= + [[help:rectangle-mark-mode][Mark rectangular]] ....... =C-x SPC= [[help:yank][Paste]] ...................... =C-y= + [[help:mark-whole-buffer][Mark whole buffer]] ........ =C-x= =h= [[help:counsel-yank-pop][Paste older]] ................ =M-y= + [[help:kill-region][Cut]] ........................ =C-w= [[help:move-line-up][Move line up]] .............. =M-up= + [[help:kill-line][Cut rest of line]] ........... =C-k= [[move-line-down][Move line down]] .......... =M-down= + [[help:indent-rigidly][Indent lines]] ........... =C-x= =TAB= *Multiple cursors* [[help:mc/mark-all-dwim][Mark all at point]] .... =M-m= =s= =m= =a= - Jump to next cursor ........ =C-v= (un)hide lines w/o a cursor =C-'= - Jump to previous cursor .... =M-v= + , Jump to next cursor ...... =C-v= , (un)hide other lines ..... =C-'= + , Jump to previous cursor .. =M-v= /[[info:emacs#Key%2520Bindings][Other key bindings]]/ *Mouse* [[help:mwheel-scroll][Scroll right]] ........... =mouse-6= [[help:previous-buffer][Previous buffer]] ........ =mouse-8= @@ -65,8 +67,14 @@ [[help:mouse-wheel-text-scale][Zoom in]] ............. =C-wheel-up= [[help:mouse-wheel-global-text-scale][Zoom in global]] .... =C-M-wheel-up= [[help:mouse-wheel-text-scale][Zoom out]] .......... =C-wheel-down= [[help:mouse-wheel-global-text-scale][Zoom out global]] . =C-M-wheel-down= + *Spelling* (flyspell ispell) + Spell check whole buffer ........................... [[help:flyspell-buffer][flyspell-buffer]] + On-the-fly spell checking ............................ [[help:flyspell-mode][flyspell-mode]] + , [[help:flyspell-correct-wrapper][Correct word]] ............. =C-;= , [[help:flyspell-goto-next-error][Next error]] ............... =C-,= + , [[help:flyspell-correct-word][Correct word]] ......... =mouse-2= -*Org* + +*Org* see also [[elisp:(my-org-article-help)][Article help]] and YASnippet templates [[help:org-toggle-pretty-entities][Pretty entities]] (\\xyz to UTF8 char) ...................... =C-c= =C-x= =\\= [[help:org-redisplay-images][Redisplay inline images]] .............................. =C-c= =C-x= =C-M-v= @@ -74,11 +82,11 @@ *Table* [[help:org-shiftleft][Move cell left]] .......... =S-left= [[help:org-shiftup][Move cell up]] .............. =S-up= [[help:org-shiftright][Move cell right]] ........ =S-right= [[help:org-shiftdown][Move cell down]] .......... =S-down= - [[help:org-table-blank-field][Clear cell]] ............... =space= + [[help:org-table-blank-field][Clear cell]] ................. =SPC= [[help:org-table-create-or-convert-from-region][Convert seperator (1. tab, 2. comma, 3. space)]] ............... =C-c= =|= - - comma .............. =C-u= =C-c= =|= - tab separator .. =C-u= =C-u= =C-c= =|= - - spaces ..... =C-u= =INTEGER= =C-c= =|= - regex ........ =C-u= =REGEX= =C-c= =|= + , comma .............. =C-u= =C-c= =|= , tab separator .. =C-u= =C-u= =C-c= =|= + , spaces ..... =C-u= =INTEGER= =C-c= =|= , regex ........ =C-u= =REGEX= =C-c= =|= *SRC* [[help:org-babel-tangle][write src block to file]] (=:tangle filename=) ............... =C-c= =C-v= =t= @@ -91,12 +99,13 @@ .eps (figure) files. - =\\%= and =\\%%= can also be used for HTML SVG export - *Export* [[elisp:(my-org-article-help)][Article help]] + *Export* [[help:org-html-export-to-html][HTML]] ............... =C-c= =C-e= =h= =h= [[help:org-latex-export-to-pdf][PDF (LaTeX)]] ........ =C-c= =C-e= =l= =l= [[help:my-org-article-html-export-to-html][HTML article]] ....... =C-c= =C-e= =h= =a= [[help:my-org-article-latex-export-to-pdf][PDF article (LaTeX)]] =C-c= =C-e= =l= =a= - [[help:my-org-article-html-export-to-html][HTML article (async)]] ........ =F5= [[help:my-org-article-latex-export-to-pdf][PDF article (LaTeX, async)]] .. =F6= + [[help:my-org-article-html-export-to-html-notify-async][HTML article (async)]] ........ =F5= [[help:my-org-article-latex-export-to-pdf-notify-async][PDF article (LaTeX, async)]] .. =F6= + [[help:my-org-letter-latex-export-to-pdf][PDF letter (LaTeX)]] . =C-c= =C-e= =l= =t= - *Export LaTeX* [[help:org-latex-remove-logfiles][Logfiles are removed]] (Deactivate for debugging) + *Export LaTeX* [[help:org-latex-remove-logfiles][Logfiles are removed]] (deactivate for debugging) *Elisp* diff --git a/snippets/org-mode/article b/snippets/org-mode/article index 0bc53c81..d42d6800 100644 --- a/snippets/org-mode/article +++ b/snippets/org-mode/article @@ -3,14 +3,15 @@ # group: Article Templates # key: ?article # -- +# -*- ispell-local-dictionary: "english" -*- #+TITLE: ${1:Title} #+SUBTITLE: ${2:Subtitle} #+DATE: ${3:13. April 2022} -#+AUTHOR: ${4:Daniel Weschke} -#+EMAIL: ${5:daniel.weschke@gmail.com} +#+AUTHOR: ${4:My Name} +#+EMAIL: ${5:my.name@example.com} #+KEYWORDS: #+DESCRIPTION: -#+LANGUAGE: +#+LANGUAGE: en #+OPTIONS: draft:t * BOP :ignore: @@ -24,7 +25,7 @@ :VISIBILITY: folded :END: #+LATEX: \clearpage\thispagestyle{empty} -# uses keyword document_type +# macro 'title-name' uses keyword document_type #+BEGIN_abstract *{{{author}}}* diff --git a/snippets/org-mode/letter b/snippets/org-mode/letter new file mode 100644 index 00000000..2e0477f9 --- /dev/null +++ b/snippets/org-mode/letter @@ -0,0 +1,39 @@ +# -*- mode: snippet -*- +# name: Letter +# group: Letter Templates +# key: ?letter +# -- +# -*- ispell-local-dictionary: "greman" -*- +: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.example.com +#+FROM_EMAIL: mail@example.com + +#+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: Anlage 1 +#+ATTACHMENT: Anlage 2