summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/getfiledate
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-07-20 00:56:48 +0000
committerKarl Berry <karl@freefriends.org>2009-07-20 00:56:48 +0000
commit87d018dbd1eaffee149bb84d9f3a15f61ec55860 (patch)
treeaa2247d4c8796b08aac908fae4c2919537f835ca /Master/texmf-dist/doc/latex/getfiledate
parentec54778b6f178371dcf1392b3f8b02e31604f0ed (diff)
getfiledate update (18jul09)
git-svn-id: svn://tug.org/texlive/trunk@14334 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/getfiledate')
-rw-r--r--Master/texmf-dist/doc/latex/getfiledate/README12
-rw-r--r--Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.pdfbin99013 -> 99645 bytes
-rw-r--r--Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.tex99
3 files changed, 51 insertions, 60 deletions
diff --git a/Master/texmf-dist/doc/latex/getfiledate/README b/Master/texmf-dist/doc/latex/getfiledate/README
index bcc9d1ce310..87c2665d30b 100644
--- a/Master/texmf-dist/doc/latex/getfiledate/README
+++ b/Master/texmf-dist/doc/latex/getfiledate/README
@@ -1,11 +1,11 @@
-The 'getfiledate' package fetches from the system the date of last
+The 'getfiledate' package fetches from the system the date of last
modification or opening of a resident file.
-This work may be distributed and/or modified under the conditions of
-the LaTeX Project Public License, either version 1.3 of this license or
-any later version. The latest version of this license is in
-http://www.latex-project.org/lppl.txt and version 1.3 or later is
-part of all distributions of LaTeX version 2005/12/01 or later.
+This work may be distributed and/or modified under the conditions of
+the LaTeX Project Public License, either version 1.3 of this license or
+any later version. The latest version of this license is in
+http://www.latex-project.org/lppl.txt and version 1.3 or later is
+part of all distributions of LaTeX version 2005/12/01 or later.
Ahmed Musa 2009
diff --git a/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.pdf b/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.pdf
index 37ef45cba53..35ad45bcb74 100644
--- a/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.pdf
+++ b/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.tex b/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.tex
index 19141cd4a87..8d535cb32a3 100644
--- a/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.tex
+++ b/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.tex
@@ -1,58 +1,58 @@
+%+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%
+% This is file getfiledate-guide.tex, the documentation for the %
+% getfiledate package. %
+% %
+% For illustration only: may not be run %
+% %
+% (c) Ahmed Musa 2009 %
+%+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++%
\documentclass[a4paper,11pt,final]{article}
\usepackage[scaled=0.9]{helvet}
\usepackage{getfiledate}
\usepackage[left=3.5cm,right=3.5cm,top=3.5cm,bottom=3.5cm]{geometry}
-\usepackage{fancyvrb,shortvrb}
\usepackage{array,longtable,colortbl}
\usepackage{calc}
\usepackage{multicol}
+\usepackage{shortvrb,fancyvrb}
\usepackage{parskip}
\usepackage{xspace}
-\usepackage{fancyhdr}
\usepackage{lastpage}
\usepackage{hyperref}
\usepackage{doipubmed}
-\definecolor{amagenta}{rgb}{0.50,0.00,0.50}
-\definecolor{adarkgreen}{rgb}{0.00,0.59,0.00}
-\definecolor{bmagenta}{rgb}{0.50,0.00,1.00}
+\interactionmode=1
+\xglobal\definecolorset{rgb}{x}{1}{agreen,0.00,0.59,0.00;%
+ bgreen,0.84,0.84,0.00;blue,0.50,0.00,1.00;amagenta,0.50,0.00,0.50;%
+ bmagenta,0.50,0.00,1.00}
\hypersetup{colorlinks=true,linkcolor=red,pdfpagemode=UseThumbs,
implicit=true,breaklinks=true,citecolor=purple}
\CustomVerbatimEnvironment{gfdverbatim}{Verbatim}{numbers=left,
numberblanklines=false,firstnumber=last,frame=single,
rulecolor=\color{orange},framerule=2pt,
- framesep=2pt,fillcolor=\color{violet!55},formatcom=\color{bmagenta},
- xrightmargin=0pc,commandchars=\|\(\),commentchar=\?}
-\newcommand*\tezt[1]{\textcolor{adarkgreen}{\texttt{#1}}}
+ framesep=2pt,fillcolor=\color{violet!55},formatcom=\color{xbmagenta1},
+ xrightmargin=0pc,commandchars=\(\),commentchar=\?}
+\newcommand*\tezt[1]{\textcolor{xagreen1}{\texttt{#1}}}
\newcommand*\temt[1]{\textcolor{teal}{\texttt{#1}}}
\def\ie{i.e.\xspace}
\newcounter{examplecnt}[section]
-\newcommand\example[1]{%
+\newcommand\example{%
\refstepcounter{examplecnt}
\par\vspace*{.5\baselineskip}
- \textcolor{purple}{\textbf{Example~\theexamplecnt}}
+ \textcolor{purple}{\textbf{Example~\thesection.\theexamplecnt}}
\par%
}
\date{\textcolor{purple}{June 10, 2009}\vadjust{\kern2ex\hrule}}
-\def\helv{\fontfamily{phv}\selectfont\color{amagenta}}
+\def\helv{\fontfamily{phv}\selectfont\color{xamagenta1}}
\def\eg{e.g.\xspace}
\def\ie{i.e.\xspace}
\def\etc{etc.\xspace}
-\fancyhf{}
-\fancyhfoffset[R,L]{\marginparsep+\marginparwidth}
-\lhead{\helv The \texttt{\textcolor{blue}{getfiledate}} Package}
-\rhead{\helv Page~\thepage~of~\pageref*{LastPage}}
-\renewcommand\headrule{\color{blue}\hrule height1pt width\headwidth\relax
- \vspace{2pt}\hrule height1pt width\headwidth\vspace{-2pt}}
-\renewcommand\footrule{\color{green}\hrule height1pt width\headwidth\relax
- \vspace{2pt}\hrule height1pt width\headwidth\vspace{2pt}}
-\pagestyle{fancyplain}
+\pagestyle{plain}
\begin{document}
\MakeShortVerb{\+}
\title{{\bfseries The \textcolor{blue}{\texttt{getfiledate}} Package}\\[1ex]
-Version 0.1}
+Version 1.0}
\author{Ahmed Musa\\[.5ex]University of Central Lancashire\\
- Preston, UK\\[1ex]\url{a.musa@rocketmail.com}
+ Preston, United Kingdom\\[1ex]\url{a.musa@rocketmail.com}
}
\maketitle
@@ -62,14 +62,9 @@ Version 0.1}
\end{multicols}
\bigskip
-\begin{center}
-\fboxsep3pt\fboxrule2.5pt
-\fcolorbox{red}{yellow}{\fcolorbox{bmagenta}{gray!15}{%
-\parbox{\hsize-4\fboxsep-4\fboxrule}{%
-\hfil\fcolorbox{cyan}{white}{\hspace{1cm}\textbf{Summary}\hspace{1cm}}\hfill\\[.5ex]
-The \tezt{getfiledate} package fetches from the system the date of last modification or opening of a resident file. It is based on an idea by Heiko Oberdiek \citeurl{oberdiek@uni-freiburg.de} that appeared in February 2009 on the discussion/newsgroup website \url{comp.text.tex}, namely, using the \tezt{\string\pdffilemoddate} command of pdf\TeX. My contribution has been to create a user-friendly interface for obtaining and presenting the needed filedate in several formats.
-}}}
-\end{center}
+\begin{abstract}
+\noindent The \tezt{getfiledate} package fetches from the system the date of last modification or opening of a resident file. It is based on an idea by Heiko Oberdiek \citeurl{oberdiek@uni-freiburg.de} that appeared in February 2009 on the discussion/newsgroup website \url{comp.text.tex}, namely, using the \tezt{\string\pdffilemoddate} command of pdf\TeX. This package creates a user-friendly interface for obtaining and presenting the needed filedate in several formats.
+\end{abstract}
\section{User interface}
The package may be loaded without options as in
@@ -89,7 +84,6 @@ The package options are listed in Table~\ref{tab:Package-options} below.
\small
\rowcolors{3}{yellow!20}{gray!25}
\extrarowheight2pt
-\arrayrulecolor{purple}
\begin{longtable}{m{3cm}m{3.5cm}m{\hsize-8cm}}
\caption{Package options\label{tab:Package-options}}\\
\rowcolor{green!55}
@@ -117,11 +111,12 @@ The package options are listed in Table~\ref{tab:Package-options} below.
+framesep+ & +3pt+ & The +\fboxsep+ for the boxedminipage.\\
+framerule+ & +0.4pt+ & The +\fboxrule+ for the boxedminipage.\\
+align+ & +justified+ & Alignment of the boxedminipage (possible values are \tezt{center}, \tezt{left}, \tezt{right} and \tezt{justified}).\\
++boxed+ & +false+ & The boolean switch for enclosing the filedate in a box. If the user simply enters this option without value, it will be assumed to be +true+. If it doesn't appear in the options list, its value is +false+.
\end{longtable}
\endgroup
\section{Examples}
-\example{}
+\example
The simplest example is to use the \tezt{\string\getfiledate} macro in the following way:
\begin{gfdverbatim}
@@ -134,12 +129,11 @@ for which the default values of the package options will be used. For the sample
\bigskip
You can, however, use package options to customize the format of the result. The following examples illustrate the most important issues in using this package.
-\example{}
-%\section{Example}
+\example
The example in this section was obtained with the following settings. There are values specified for \tezt{head} and \tezt{foot}.
\begin{gfdverbatim}
\getfiledate{file={test1.tex},head=.1\baselineskip,
- foot=2\baselineskip,markercolor=magenta,filenamecolor=brown,
+ foot=2\baselineskip,markercolor=magenta,filenamecolor=purple,
datecolor=orange,inlinespace=.5em,marker=$\blacktriangleright$,
separator
}
@@ -148,29 +142,29 @@ The example in this section was obtained with the following settings. There are
The outcome of this is:
\getfiledate{file={test1.tex},head=.1\baselineskip,
foot=2\baselineskip,
- markercolor=magenta,filenamecolor=brown,datecolor=orange,
+ markercolor=magenta,filenamecolor=purple,datecolor=orange,
inlinespace=.5em,marker=$\blacktriangleright$,separator
}
If you don't need the \tezt{marker}, you can set \tezt{marker=\{\}} as follows
\begin{gfdverbatim}
\getfiledate{file={test1.tex},head=\baselineskip,
- foot=\baselineskip,width=.6\hsize,filenamecolor=brown,
+ foot=\baselineskip,width=.6\hsize,filenamecolor=xagreen1,
prefix=The date of final changes to file,
datecolor=orange,inlinespace=.5em,boxed=false,
separator=$\spadesuit$,separatorcolor=green,
- |color(red)marker={}|color(bmagenta),align=center
+ |color(red)marker={}|color(xbmagenta1),align=center
}
\end{gfdverbatim}
to get:
\getfiledate{file={test1.tex},head=\baselineskip,
foot=\baselineskip,width=.6\hsize,
prefix=The date of final changes to file,
- marker={},filenamecolor=brown,datecolor=orange,
+ marker={},filenamecolor=xagreen1,datecolor=orange,
inlinespace=.5em,align=center,boxed=false,
separator=$\spadesuit$,separatorcolor=green
}
-If you simply remove \tezt{marker} from the key-value list, the \tezt{marker} will retain the last value you set for it rather than the default value (which is nil).
+If you simply remove \tezt{marker} from the key-value list, the \tezt{marker} will retain the last value you set for it rather than the default value (which is nil).
The user should note:
@@ -182,16 +176,13 @@ The user should note:
\item The use of the key-value \tezt{align=center} above. The key \tezt{align} can assume values of \tezt{center}, \tezt{left}, \tezt{right}, and \tezt{justified}. Any other value for \tezt{align} will be rejected by the package.
\end{itemize}
-\example{}
-%\section{Example}
+\example
The example in this section was obtained with the following settings:
\begin{gfdverbatim}
-\colorlet{redgreen}{red!55!green!65}
-
\getfiledate{file={test2.tex},head=0ex,foot=\baselineskip,
prefix,width=\hsize,markercolor=magenta,filenamecolor=red,
datecolor=violet,inlinespace=.5em,marker=$\triangleright$,
- separator=$\clubsuit$,separatorcolor=redgreen
+ separator=$\clubsuit$,separatorcolor=xbgreen1
}
\end{gfdverbatim}
@@ -204,8 +195,7 @@ The outcome is:
}
Here we simply passed the \tezt{prefix} without value so that its default value was used.
-\example{}
-%\section{Example}
+\example
The example in this section was obtained with the following settings:
\begin{gfdverbatim}
\getfiledate{file={test3.tex},head=\baselineskip,
@@ -222,7 +212,7 @@ The outcome is:
separator=$\Diamond$,separatorcolor=red
}
-\example{}
+\example
The example in this section was obtained with the following settings:
\begin{gfdverbatim}
\getfiledate{file={test4.tex},head=\baselineskip,foot=2ex,
@@ -239,8 +229,7 @@ The outcome is:
markercolor=cyan,separator=$\heartsuit$,separatorcolor
}
-\example{}
-%\section{Example}
+\example
The example in this section was obtained with the following settings:
\begin{gfdverbatim}
\getfiledate{file={test5.tex},head=1ex,foot=1ex,
@@ -257,8 +246,7 @@ The outcome of this is:
separator={}
}
-\example{}
-%\section{Example}
+\example
Instead of keeping \tezt{head} and \tezt{foot}, you may instead decide to frame your result, as follows:
\begin{gfdverbatim}
\getfiledate{file={test5.tex},head=.5\baselineskip,
@@ -285,7 +273,7 @@ For the boxed filedates, you can set the options \tezt{framesep} and \tezt{frame
foot=1ex,marker={$\blacktriangleright$},markercolor=purple,
filenamecolor=blue,width=.9\hsize,datecolor=orange,
inlinespace=.5em,align=left,boxed,separator=$\blacklozenge$,
- |color(red)framesep=5pt,framerule=2pt|color(bmagenta)
+ |color(red)framesep=5pt,framerule=2pt|color(xbmagenta1)
} |color(black) % marker has no effect here.
\end{gfdverbatim}
@@ -303,7 +291,7 @@ You can change the box color as in
\getfiledate{file={test5.tex},head=\baselineskip,
foot=\baselineskip,markercolor=purple,filenamecolor=blue,
datecolor=orange,width=8cm,align=right,boxed,framesep=5pt,
- framerule=2pt,separator=$\Diamond$,|color(red)framecolor=green|color(bmagenta)
+ framerule=2pt,separator=$\Diamond$,|color(red)framecolor=green|color(xbmagenta1)
}
\end{gfdverbatim}
@@ -317,4 +305,7 @@ The outcome of this is:
This box color will remain in force until it is changed again. The default value of \tezt{framecolor} is \tezt{black}.
+\vfil
+\centering\fboxrule=2pt\fcolorbox{red}{xbgreen1}{\textbf{Bye}}
+\vfil
\end{document} \ No newline at end of file