summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/varsfromjobname/README.md
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
committerNorbert Preining <norbert@preining.info>2019-09-02 13:46:59 +0900
commite0c6872cf40896c7be36b11dcc744620f10adf1d (patch)
tree60335e10d2f4354b0674ec22d7b53f0f8abee672 /macros/latex/contrib/varsfromjobname/README.md
Initial commit
Diffstat (limited to 'macros/latex/contrib/varsfromjobname/README.md')
-rw-r--r--macros/latex/contrib/varsfromjobname/README.md65
1 files changed, 65 insertions, 0 deletions
diff --git a/macros/latex/contrib/varsfromjobname/README.md b/macros/latex/contrib/varsfromjobname/README.md
new file mode 100644
index 0000000000..d9506c5d93
--- /dev/null
+++ b/macros/latex/contrib/varsfromjobname/README.md
@@ -0,0 +1,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 \ No newline at end of file