update documentation

2022-12-14 14:47:05 +01:00
parent 7771216a9c
commit 7335908d80
6 changed files with 215 additions and 408 deletions
--- 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 "<file_name>")= 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
--- 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*