summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/varsfromjobname/README.md
blob: d9506c5d93546214e30a89e6f61583d1d7a8c21f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
# VarsFromJobname

Sources for my varsfromjobname LaTeX package, available also from CTAN: 

[https://www.ctan.org/tex-archive/macros/latex/contrib/varsfromjobname](https://www.ctan.org/tex-archive/macros/latex/contrib/varsfromjobname "CTAN varsfromjobname")

# Credits

varsfromjobname.sty is based on code by supplied by Friedrich Vosberg, Enrico Gregorio and Markus Kohm,  help from Rolf Niepraschk, Sven Naumann, Ulrich Schwarz 
and Andreas Mathias was greatly appreciated.

# What does this package do?

Using `varsfromjobname.sty` one can easily extract information from the filename, if it follows a certain form. 

The standard LaTeX command `\jobname` returns the name of the LaTeX (master) file. If the filename consists of tokens separated by hyphen we can easily extract certain tokens that can be used _inside_ the document. 

The package expects the filename to be of the form
`one-two-three-four-five-six-seven-eight-nine.tex` and offers the following commands:

* `\getfromjobname{param}`, with `param` in the range of 1 to 9 (a highlevel
interface to the following commands)
* `\getonefromjobname`
* `\gettwofromjobname`
* `\getthreefromjobname`
* `\getfourfromjobname`
* `\getfivefromjobname`
* `\getsixfromjobname`
* `\getsevenfromjobname`
* `\geteightfromjobname`
* `\getninefromjobname`

# Why can it be useful?


You can use this package for example to define the date of the document in the filename, personally I use it e.g. for `scrlttr2` letters.

# Shortcomings

* `\getfromjobname` is not fully expandable, use one of the other commands if you need expansion
* Version 1.0 cannot extract information from included sub-documents
* The package cannot handle more than nine tokens, see the reference to egreg's answer on TSX below for an updated version

# References

* [https://tex.stackexchange.com/questions/212169/qr-code-from-jobname/212171#212171](https://tex.stackexchange.com/questions/212169/qr-code-from-jobname/212171#212171 "QR-code from jobname")

Remark: [egreg](https://tex.stackexchange.com/users/4427/egreg "egreg") gave an improved version of the code written with expl3 which also overcomes the limitation of nine parameters.

* [https://tex.stackexchange.com/questions/116755/timestamp-in-document-pdf-name/116805#116805](https://tex.stackexchange.com/questions/116755/timestamp-in-document-pdf-name/116805#116805 "Timestamp in document / pdf name")

* German article in the DTK on pagewise versioning with Subversion (to be published)


# Change History

- Version 0.5, as of January 11th 2009: Initial version published

- Version 1.0, to be published May 2017: 
	- Added various commands which extract necessary information also from included documents
	- Modified code as suggested by egreg



2017-04-30, Uwe Ziegenhagen