Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add options to insert a version history table #279

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/build-examples.yml
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
# trial and error
tlmgr install letltxmacro zref everypage framed collectbox
# packages needed for the template
tlmgr install xecjk filehook unicode-math ucharcat pagecolor babel-german ly1 mweights sourcecodepro sourcesanspro mdframed needspace fvextra footmisc footnotebackref background
tlmgr install xecjk filehook unicode-math ucharcat pagecolor babel-german ly1 mweights sourcecodepro sourcesanspro mdframed needspace fvextra footmisc footnotebackref background vhistory
# packages only needed for some examples (that include packages via header-includes)
tlmgr install awesomebox fontawesome5
# packages only needed for some examples (example boxes-with-pandoc-latex-environment-and-tcolorbox)
Expand Down
2 changes: 1 addition & 1 deletion .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ before_install:
- tlmgr install letltxmacro zref everypage framed collectbox

# packages needed for the template
- tlmgr install xecjk filehook unicode-math ucharcat pagecolor babel-german ly1 mweights sourcecodepro sourcesanspro mdframed needspace fvextra footmisc footnotebackref background
- tlmgr install xecjk filehook unicode-math ucharcat pagecolor babel-german ly1 mweights sourcecodepro sourcesanspro mdframed needspace fvextra footmisc footnotebackref background vhistory

# packages only needed for some examples (that include packages via header-includes)
- tlmgr install awesomebox fontawesome5
Expand Down
25 changes: 20 additions & 5 deletions eisvogel.tex
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,9 @@
\makesavenoteenv{longtable}
$endif$
$endif$
$if(vhistory)$
\usepackage[$vhistory-options$]{vhistory}
$endif$
% add backlinks to footnote references, cf. https://tex.stackexchange.com/questions/302266/make-footnote-clickable-both-ways
$if(footnotes-disable-backlinks)$
$else$
Expand Down Expand Up @@ -517,7 +520,7 @@
\subtitle{$subtitle$}
$endif$
\author{$for(author)$$author$$sep$ \and $endfor$}
\date{$date$}
\date{$if(date)$$date$$elseif(vhistory)$\vhCurrentDate$endif$}
$if(beamer)$
$if(institute)$
\institute{$for(institute)$$institute$$sep$ \and $endfor$}
Expand Down Expand Up @@ -646,7 +649,7 @@
\usepackage{titling}
\title{$title$}
\author{$for(author)$$author$$sep$, $endfor$}
\date{$date$}
\date{$if(date)$$date$$elseif(vhistory)$\vhCurrentDate$endif$}
$endif$

%
Expand Down Expand Up @@ -832,7 +835,7 @@
\clearpairofpagestyles
\ihead*{$if(header-left)$$header-left$$else$$title$$endif$}
\chead*{$if(header-center)$$header-center$$else$$endif$}
\ohead*{$if(header-right)$$header-right$$else$$date$$endif$}
\ohead*{$if(header-right)$$header-right$$else$$if(date)$$date$$elseif(vhistory)$\vhCurrentDate$endif$$endif$}
\ifoot*{$if(footer-left)$$footer-left$$else$$for(author)$$author$$sep$, $endfor$$endif$}
\cfoot*{$if(footer-center)$$footer-center$$else$$endif$}
\ofoot*{$if(footer-right)$$footer-right$$else$\thepage$endif$}
Expand Down Expand Up @@ -905,7 +908,8 @@
{\Large \textsf{$subtitle$}}
$endif$
\vskip 2em
\noindent {\Large \textsf{$for(author)$$author$$sep$, $endfor$} \vskip 0.6em \textsf{$date$}}
\noindent {\Large \textsf{$for(author)$$author$$sep$, $endfor$} \vskip 0.6em \textsf{$if(date)$$date$$elseif(vhistory)$\vhCurrentDate$endif$}
$if(vhistory-label)$\vskip 0.6em \textsf{$vhistory-label$ \vhCurrentVersion}$endif$}
\vfill
}
$else$
Expand All @@ -930,7 +934,11 @@

$if(titlepage-background)$
$else$
\textsf{$date$}
\textsf{$if(date)$$date$$elseif(vhistory)$\vhCurrentDate$endif$}
$if(vhistory-label)$
\par
$vhistory-label$ \vhCurrentVersion
$endif$
$endif$
\end{flushleft}
\end{titlepage}
Expand Down Expand Up @@ -966,6 +974,13 @@
$include-before$

$endfor$
$if(vhistory)$
\begin{versionhistory}
$for(vhistory)$
\vhEntry$for(it)${$it$}$endfor$
$endfor$
\end{versionhistory}
$endif$
$if(toc)$
$if(toc-title)$
\renewcommand*\contentsname{$toc-title$}
Expand Down
Binary file modified examples/basic-example/document.pdf
Binary file not shown.
Binary file modified examples/beamer/document.pdf
Binary file not shown.
Binary file modified examples/book/document.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified examples/code-blocks-listings/document.pdf
Binary file not shown.
Binary file modified examples/code-blocks-without-listings/document.pdf
Binary file not shown.
Binary file modified examples/header-and-footer/document.pdf
Binary file not shown.
Binary file modified examples/images-and-tables/document.pdf
Binary file not shown.
Binary file modified examples/language-german/document.pdf
Binary file not shown.
Binary file modified examples/page-background/document.pdf
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
1 change: 1 addition & 0 deletions examples/title-page-background-vhistory/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pandoc "document.md" -o "document.pdf" --from markdown --template "../../eisvogel.tex" --listings
65 changes: 65 additions & 0 deletions examples/title-page-background-vhistory/document.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
---
title: "Vinaque sanguine metuenti cuiquam Alcyone fixus"
author: [Author Name]
subject: "Markdown"
keywords: [Markdown, Example]
subtitle: "Aesculeae domus vincemur et Veneris adsuetus lapsum"
lang: "en"
titlepage: true,
titlepage-rule-color: "360049"
titlepage-background: "backgrounds/background1.pdf"
vhistory-label: "Revision : "
vhistory:
- ["1.0", "2017-01-22", "JPW|KW","created"]
- ["1.1", "2017-01-23", "DP|JPW", "correction"]
- ["1.2", "2017-02-15", "DP|JPW", "revised after review"]
...

# Vinaque sanguine metuenti cuiquam Alcyone fixus

## Aesculeae domus vincemur et Veneris adsuetus lapsum

Lorem markdownum Letoia, et alios: figurae flectentem annis aliquid Peneosque ab
esse, obstat gravitate. Obscura atque coniuge, per de coniunx, sibi **medias
commentaque virgine** anima tamen comitemque petis, sed. In Amphion vestros
hamos ire arceor mandere spicula, in licet aliquando.

```java
public class Example implements LoremIpsum {
public static void main(String[] args) {
if(args.length < 2) {
System.out.println("Lorem ipsum dolor sit amet");
}
} // Obscura atque coniuge, per de coniunx
}
```

Porrigitur et Pallas nuper longusque cratere habuisse sepulcro pectore fertur.
Laudat ille auditi; vertitur iura tum nepotis causa; motus. Diva virtus! Acrota
destruitis vos iubet quo et classis excessere Scyrumve spiro subitusque mente
Pirithoi abstulit, lapides.

## Lydia caelo recenti haerebat lacerum ratae at

Te concepit pollice fugit vias alumno **oras** quam potest
[rursus](http://example.com#rursus) optat. Non evadere orbem equorum, spatiis,
vel pede inter si.

1. De neque iura aquis
2. Frangitur gaudia mihi eo umor terrae quos
3. Recens diffudit ille tantum

\begin{equation}\label{eq:neighbor-propability}
p_{ij}(t) = \frac{\ell_j(t) - \ell_i(t)}{\sum_{k \in N_i(t)}^{} \ell_k(t) - \ell_i(t)}
\end{equation}

Tamen condeturque saxa Pallorque num et ferarum promittis inveni lilia iuvencae
adessent arbor. Florente perque at condeturque saxa et ferarum promittis tendebat. Armos nisi obortas refugit me.

Et nepotes poterat, se qui. Euntem ego pater desuetaque aethera Maeandri, et
[Dardanio geminaque](http://example.com#Dardanio_geminaque) cernit. Lassaque poenas
nec, manifesta $\pi r^2$ mirantia captivarum prohibebant scelerato gradus unusque
dura.

- Permulcens flebile simul
- Iura tum nepotis causa motus diva virtus Acrota. Tamen condeturque saxa Pallorque num et ferarum promittis inveni lilia iuvencae adessent arbor. Florente perque at ire arcum.
Binary file modified examples/title-page-background/document.pdf
Binary file not shown.
Binary file not shown.
1 change: 1 addition & 0 deletions examples/title-page-custom-vhistory/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pandoc "document.md" -o "document.pdf" --from markdown --template "../../eisvogel.tex" --listings
67 changes: 67 additions & 0 deletions examples/title-page-custom-vhistory/document.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: "Vinaque sanguine metuenti cuiquam Alcyone fixus"
author: [Author Name]
subject: "Markdown"
keywords: [Markdown, Example]
subtitle: "Aesculeae domus vincemur et Veneris adsuetus lapsum"
lang: "en"
titlepage: true,
titlepage-text-color: "FFFFFF"
titlepage-rule-color: "360049"
titlepage-rule-height: 0
titlepage-background: "background.pdf"
vhistory-label: "Revision : "
vhistory:
- ["1.0", "2017-01-22", "JPW|KW","created"]
- ["1.1", "2017-01-23", "DP|JPW", "correction"]
- ["1.2", "2017-02-15", "DP|JPW", "revised after review"]
...

# Vinaque sanguine metuenti cuiquam Alcyone fixus

## Aesculeae domus vincemur et Veneris adsuetus lapsum

Lorem markdownum Letoia, et alios: figurae flectentem annis aliquid Peneosque ab
esse, obstat gravitate. Obscura atque coniuge, per de coniunx, sibi **medias
commentaque virgine** anima tamen comitemque petis, sed. In Amphion vestros
hamos ire arceor mandere spicula, in licet aliquando.

```java
public class Example implements LoremIpsum {
public static void main(String[] args) {
if(args.length < 2) {
System.out.println("Lorem ipsum dolor sit amet");
}
} // Obscura atque coniuge, per de coniunx
}
```

Porrigitur et Pallas nuper longusque cratere habuisse sepulcro pectore fertur.
Laudat ille auditi; vertitur iura tum nepotis causa; motus. Diva virtus! Acrota
destruitis vos iubet quo et classis excessere Scyrumve spiro subitusque mente
Pirithoi abstulit, lapides.

## Lydia caelo recenti haerebat lacerum ratae at

Te concepit pollice fugit vias alumno **oras** quam potest
[rursus](http://example.com#rursus) optat. Non evadere orbem equorum, spatiis,
vel pede inter si.

1. De neque iura aquis
2. Frangitur gaudia mihi eo umor terrae quos
3. Recens diffudit ille tantum

\begin{equation}\label{eq:neighbor-propability}
p_{ij}(t) = \frac{\ell_j(t) - \ell_i(t)}{\sum_{k \in N_i(t)}^{} \ell_k(t) - \ell_i(t)}
\end{equation}

Tamen condeturque saxa Pallorque num et ferarum promittis inveni lilia iuvencae
adessent arbor. Florente perque at condeturque saxa et ferarum promittis tendebat. Armos nisi obortas refugit me.

Et nepotes poterat, se qui. Euntem ego pater desuetaque aethera Maeandri, et
[Dardanio geminaque](http://example.com#Dardanio_geminaque) cernit. Lassaque poenas
nec, manifesta $\pi r^2$ mirantia captivarum prohibebant scelerato gradus unusque
dura.

- Permulcens flebile simul
- Iura tum nepotis causa motus diva virtus Acrota. Tamen condeturque saxa Pallorque num et ferarum promittis inveni lilia iuvencae adessent arbor. Florente perque at ire arcum.
Binary file not shown.
60 changes: 60 additions & 0 deletions examples/title-page-custom-vhistory/logo-inverted.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified examples/title-page-custom/document.pdf
Binary file not shown.
Binary file modified examples/title-page-default/document.pdf
Binary file not shown.
Binary file modified examples/title-page-green/document.pdf
Binary file not shown.
Binary file modified examples/title-page-logo/document.pdf
Binary file not shown.
1 change: 1 addition & 0 deletions examples/versions-history/build.sh
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
pandoc "document.md" -o "document.pdf" --from markdown --template "../../eisvogel.tex" --listings --top-level-division="chapter"
Loading