summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/varsfromjobname/varsfromjobname.tex
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-05-02 21:41:13 +0000
committerKarl Berry <karl@freefriends.org>2017-05-02 21:41:13 +0000
commit6e4c9895b91d909b7d6f65553dbb41186f54b8da (patch)
treede50c0bacab3cd575964c0a4a4a847e4bd75a4f0 /Master/texmf-dist/doc/latex/varsfromjobname/varsfromjobname.tex
parent81f07c7a915e291b32a374633d29f64be74c1c88 (diff)
varsfromjobname (2may17)
git-svn-id: svn://tug.org/texlive/trunk@44154 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/varsfromjobname/varsfromjobname.tex')
-rw-r--r--Master/texmf-dist/doc/latex/varsfromjobname/varsfromjobname.tex148
1 files changed, 133 insertions, 15 deletions
diff --git a/Master/texmf-dist/doc/latex/varsfromjobname/varsfromjobname.tex b/Master/texmf-dist/doc/latex/varsfromjobname/varsfromjobname.tex
index f3a4028b63c..55516a138ad 100644
--- a/Master/texmf-dist/doc/latex/varsfromjobname/varsfromjobname.tex
+++ b/Master/texmf-dist/doc/latex/varsfromjobname/varsfromjobname.tex
@@ -1,34 +1,152 @@
-\documentclass{article}
-
+\documentclass[12pt]{article}
+\usepackage{listings}
\nofiles
\usepackage{varsfromjobname}
+\usepackage[default]{sourcesanspro}
+\setlength{\parskip}{1em}
+\setlength{\parindent}{0em}
+\usepackage[left=3cm, right=3cm, top=3cm, bottom=3cm]{geometry}
-\date{January 11th 2009}
-\author{Uwe Ziegenhagen}
+
+\date{May 1st 2016}
+\author{Uwe Ziegenhagen, ziegenhagen@gmail.com}
\title{\texttt{varsfromjobname} Description}
+
+
\begin{document}
\maketitle
-\noindent Using \texttt{varsfromjobname.sty} one can easily extract information from the filename, if it follows a certain form. The LaTeX command \verb|\|jobname returns the name of the LaTeX 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
+\noindent Using \texttt{varsfromjobname.sty} one can easily extract information from the filename, if it follows a certain form. The LaTeX command \verb|\|jobname returns the name of the LaTeX 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
\noindent\texttt{one-two-three-four-five-six-seven-eight-nine.tex}
\noindent and offers the following commands:
\begin{itemize}
- \item \verb|\|getfromjobname\{\textit{param}\}, with \textit{param} in the range of 1 to 9 (highlevel interface to the following commands)
- \item \verb|\|getonefromjobname
- \item \verb|\|gettwofromjobname
- \item \verb|\|getthreefromjobname
- \item \verb|\|getfourfromjobname
- \item \verb|\|getfivefromjobname
- \item \verb|\|getsixfromjobname
- \item \verb|\|getsevenfromjobname
- \item \verb|\|geteightfromjobname
- \item \verb|\|getninefromjobname
+ \item \verb|\getfromjobname|\{\textit{param}\}, with \textit{param} in the
+ range of 1 to 9 (highlevel interface to the following commands)
+ \item \verb|\getonefromjobname|
+ \item \verb|\gettwofromjobname|
+ \item \verb|\getthreefromjobname|
+ \item \verb|\getfourfromjobname|
+ \item \verb|\getfivefromjobname|
+ \item \verb|\getsixfromjobname|
+ \item \verb|\getsevenfromjobname|
+ \item \verb|\geteightfromjobname|
+ \item \verb|\getninefromjobname|
\end{itemize}
+For included documents the package uses the \texttt{currfile} package to provide the following commands:
+
+\begin{itemize}
+ \item \verb|\getfromcurrfilename|\{\textit{param}\}, with \textit{param} in the
+ range of 1 to 9 (highlevel interface to the following commands)
+ \item \verb|\getonefromcurrfilename|
+ \item \verb|\gettwofromcurrfilename|
+ \item \verb|\getthreefromcurrfilename|
+ \item \verb|\getfourfromcurrfilename|
+ \item \verb|\getfivefromcurrfilename|
+ \item \verb|\getsixfromcurrfilename|
+ \item \verb|\getsevenfromcurrfilename|
+ \item \verb|\geteightfromcurrfilename|
+ \item \verb|\getninefromcurrfilename|
+\end{itemize}
+
+\section*{Example}
+
+Place the code from Listing 1 in a file \textbf{a-b-c-d-e-f-g-h-i-j.tex} and the code from
+ Listing~2 in a file named \textbf{z-y-x-w-v-u-t-s-r-q.tex}. Then compile the first file with pdflatex.
+
+\begin{lstlisting}[caption={\textbf{a-b-c-d-e-f-g-h-i-j.tex}}]
+% testfiles for varsfromjobname.sty
+\documentclass{article}
+\listfiles
+\usepackage[utf8]{inputenc}
+\usepackage[T1]{fontenc}
+\usepackage{varsfromjobname}
+\begin{document}
+
+a: \getonefromjobname % a
+
+b: \gettwofromjobname % b
+
+c: \getthreefromjobname % c
+
+d: \getfourfromjobname % d
+
+e: \getfivefromjobname % e
+
+f: \getsixfromjobname % f
+
+g: \getsevenfromjobname % g
+
+h: \geteightfromjobname %h
+
+i-j: \getninefromjobname % i-j
+
+a: \getfromjobname{1} % a
+
+b: \getfromjobname{2} % b
+
+c: \getfromjobname{3} % c
+
+d: \getfromjobname{4} % d
+
+e: \getfromjobname{5} % e
+
+f: \getfromjobname{6} % f
+
+g: \getfromjobname{7} % g
+
+h: \getfromjobname{8} % h
+
+i-j: \getfromjobname{9} % i-j
+
+\input{z-y-x-w-v-u-t-s-r-q}
+
+\end{document}
+\end{lstlisting}
+
+
+
+
+\begin{lstlisting}[caption={\textbf{z-y-x-w-v-u-t-s-r-q.tex}}]
+z: \getonefromcurrfilename
+
+y: \gettwofromcurrfilename
+
+x: \getthreefromcurrfilename
+
+w: \getfourfromcurrfilename
+
+v: \getfivefromcurrfilename
+
+u: \getsixfromcurrfilename
+
+t: \getsevenfromcurrfilename
+
+s: \geteightfromcurrfilename
+
+r-q: \getninefromcurrfilename
+\end{lstlisting}
+
+
+\section*{Change History}
+
+\begin{description}
+ \item [Version 0.5] as of January 11th 2009: Initial version published
+ \item [Version 1.0] published May 2017:
+ Added various commands which extract necessary information also from included documents
+ Modified code as suggested by egreg
+\end{description}
+
+
+\vfill 2017-05-01, Uwe Ziegenhagen
\end{document}