update documentation

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