daniel/emacs
1
2
Fork 0
Code Issues 7 Pull Requests Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Daniel Weschke
2021-05-13 13:33:57 +02:00
parent f69f1433c6
commit b1da339a20
3 changed files with 248 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

97
README.md
View File

@@ -4,6 +4,9 @@
1. [Installation](#installation)
2. [Packages](#packages)
1. [Org](#org)
1. [HTML export](#export-html)
2. [LaTeX export](#export-latex)
3. [Article export (HTML and LaTeX)](#export-article)
2. [Multiple cursors](#multiple-cursors)
3. [Other packages](#other-packages)
3. [Information](#information)
@@ -323,12 +326,106 @@ installed linux packages as requirements inside `sripts/install.sh`.
.eps (figure) files.
- `\%` `\%%` can also be used for HTML SVG export
<a id="export-html"></a>
### HTML export
- `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
<a id="export-latex"></a>
### LaTeX export
- `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>
<a id="export-article"></a>
### Article export (HTML and LaTeX)
- `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
# -*- 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}
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
<a id="multiple-cursors"></a>
## Multiple cursors

99
README.org
View File

@@ -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:

94
lisp/my/my-org-article.el
View File

@@ -15,12 +15,63 @@
;; #+DESCRIPTION:
;; * Header :ignore:
;; article-latex is based on latex
;; article-html is based on tufte-html
;; internal
;; `translate-alist' defines Org export function with own function
;;; Code:
(require 'ob-latex)
(require 'ob-gnuplot)
(require 'ox-latex)
(require 'ox-tufte)
;; General
(defvar my-org-article-export-headline-levels)
(defvar my-org-article-export-with-sub-superscripts)
(defvar my-org-article-export-with-toc)
;;; User Configurable Variables
(defgroup my-org-export-article nil
"Options for exporting Org mode files."
:tag "Org Export"
:group 'org)
(defcustom my-org-article-export-headline-levels 5
"See `org-export-headline-levels'."
:group 'my-org-export-article
:type 'integer
:safe #'integerp)
(defcustom my-org-article-export-with-sub-superscripts {}
"See `org-export-with-sub-superscripts'."
:group 'my-org-export-article
:version "24.4"
:package-version '(Org . "8.0")
:type '(choice
(const :tag "Interpret them" t)
(const :tag "Curly brackets only" {})
(const :tag "Do not interpret them" nil))
:safe (lambda (x) (memq x '(t nil {}))))
(defcustom my-org-article-export-with-toc nil
"See `org-export-with-toc'."
:group 'my-org-export-article
:type '(choice
(const :tag "No Table of Contents" nil)
(const :tag "Full Table of Contents" t)
(integer :tag "TOC to level"))
:safe (lambda (x)
(or (booleanp x)
(integerp x))))
;; LaTeX
;;(setq org-babel-latex-htlatex "htlualatex")
;;(setq org-babel-latex-htlatex "htlatex")
;; (executable-find org-babel-latex-htlatex)
@@ -256,9 +307,6 @@
;; LaTeX
;;; Function Declarations
(defvar my-org-article-export-headline-levels)
(defvar my-org-article-export-with-sub-superscripts)
(defvar my-org-article-export-with-toc)
(defvar my-org-article-latex-default-packages-alist)
(defvar my-org-article-latex-packages-alist)
(defvar my-org-article-latex-compiler)
@@ -302,41 +350,6 @@
'((template . my-org-article-latex-template)))
;;; User Configurable Variables
(defgroup my-org-export-article nil
"Options for exporting Org mode files."
:tag "Org Export"
:group 'org)
(defcustom my-org-article-export-headline-levels 5
"See `org-export-headline-levels'."
:group 'my-org-export-article
:type 'integer
:safe #'integerp)
(defcustom my-org-article-export-with-sub-superscripts "{}"
"See `org-export-with-sub-superscripts'."
:group 'my-org-export-article
:version "24.4"
:package-version '(Org . "8.0")
:type '(choice
(const :tag "Interpret them" t)
(const :tag "Curly brackets only" {})
(const :tag "Do not interpret them" nil))
:safe (lambda (x) (memq x '(t nil {}))))
(defcustom my-org-article-export-with-toc nil
"See `org-export-with-toc'."
:group 'my-org-export-article
:type '(choice
(const :tag "No Table of Contents" nil)
(const :tag "Full Table of Contents" t)
(integer :tag "TOC to level"))
:safe (lambda (x)
(or (booleanp x)
(integerp x))))
;;;; Compilation
(defcustom my-org-article-latex-compiler "lualatex"
@@ -2306,7 +2319,10 @@ default."
(org-open-file (my-org-article-html-export-to-html nil s v b)))))))
:options-alist
'((:html-doctype "HTML_DOCTYPE" nil my-org-article-html-doctype)
'((:headline-levels nil "H" my-org-article-export-headline-levels)
(:with-sub-superscript nil "^" my-org-article-export-with-sub-superscripts)
(:with-toc nil "toc" my-org-article-export-with-toc)
(:html-doctype "HTML_DOCTYPE" nil my-org-article-html-doctype)
(:html-head "HTML_HEAD" nil my-org-article-html-head newline))
;;:translate-alist