add missing default parameter also for the Org article html export and add a template and examples in the README

2021-05-13 13:33:57 +02:00
parent f69f1433c6
commit b1da339a20
3 changed files with 248 additions and 42 deletions
--- a/README.org
+++ b/README.org
@@ -76,9 +76,102 @@ a bunch of online resources.
      .eps (figure) files.
  - =\%= =\%%= can also be used for HTML SVG export

-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
+*** HTML export
+    :PROPERTIES:
+    :CUSTOM_ID: export-html
+    :END:
+    - =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
+
+*** LaTeX export
+    :PROPERTIES:
+    :CUSTOM_ID: export-latex
+    :END:
+    - =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
+
+*** Article export (HTML and LaTeX)
+    :PROPERTIES:
+    :CUSTOM_ID: export-article
+    :END:
+    - =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
+    #+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
+      # #+TOC: figures is not implemented yet in the HTML backend. And not working with LaTeX, see listing
+      # #+TOC: figures
+      # #+LATEX: \listoftables
+      ,#+TOC: tables
+      # for latex listing is figures
+      ,#+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
+    #+end_src

 ** Multiple cursors
   :PROPERTIES: