summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/latex/getfiledate
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-11-27 01:31:08 +0000
committerKarl Berry <karl@freefriends.org>2009-11-27 01:31:08 +0000
commit791133138a9bd0f02696c3ebce66bc7b9a29e6c2 (patch)
treef4f30a9125b0b49d7f58111520348ad159ae703c /Master/texmf-dist/doc/latex/getfiledate
parentfc5af52f05a1b38ceecdf30ba7a5cb0cd5b9dfb5 (diff)
getfiledateupdate (26nov09)
git-svn-id: svn://tug.org/texlive/trunk@16189 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/latex/getfiledate')
-rw-r--r--Master/texmf-dist/doc/latex/getfiledate/README15
-rw-r--r--Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.pdfbin113586 -> 112605 bytes
-rw-r--r--Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.tex49
3 files changed, 38 insertions, 26 deletions
diff --git a/Master/texmf-dist/doc/latex/getfiledate/README b/Master/texmf-dist/doc/latex/getfiledate/README
index 178979d9396..fe47750f47b 100644
--- a/Master/texmf-dist/doc/latex/getfiledate/README
+++ b/Master/texmf-dist/doc/latex/getfiledate/README
@@ -1,13 +1,22 @@
+This is the README file for getfiledate.sty, version 1.2.
+
The 'getfiledate' package fetches from the system the date of last
-modification or opening of a resident file and displays the result
+modification or opening of a resident file and displays the result
using a user-friendly interface.
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
+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 (c) 2009
+The LPPL maintenance status of this software is 'author-maintained'.
+
+This software is provided 'as it is', without warranty of any
+kind, either expressed or implied, including, but not limited to,
+the implied warranties of merchantability and fitness for a
+particular purpose.
+
+Copyright (c) 2009 Ahmed Musa (a.musa@rocketmail.com).
End of README file.
diff --git a/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.pdf b/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.pdf
index 4f0fe29e5d0..a62b1f26e5b 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 dd7803b18c2..d6a7ec6e610 100644
--- a/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.tex
+++ b/Master/texmf-dist/doc/latex/getfiledate/getfiledate-guide.tex
@@ -10,12 +10,14 @@
\usepackage{getfiledate}
\usepackage[left=3.5cm,right=3.5cm,top=3.5cm,bottom=3.5cm]{geometry}
\usepackage{fancyvrb,shortvrb}
-\usepackage{array,longtable,colortbl}
+\usepackage{array,colortbl}
\usepackage{multicol}
\usepackage{parskip}
\usepackage{xspace}
\usepackage{fancyhdr}
\usepackage{lastpage}
+\usepackage{ltablex}
+\keepXColumns
\usepackage{hyperref}
\usepackage{doipubmed}
\new\let\TC\textcolor
@@ -35,13 +37,14 @@
\new\def\cmda#1{\stya{\string#1}}
\new\def\cmdb#1{\styb{\string#1}}
\new\def\cmdc#1{\stya{#1\string\hsize}}
+\newcommand*\email[1]{\href{mailto:#1}{#1}}
\def\ie{i.e.\xspace}
\newcounter{examplecnt}[section]
-\new\def\example{%
+\new\def\gfdexample{%
\refstepcounter{examplecnt}
- \endgraf\vspace*{.5\baselineskip}
- \TC{purple}{\textbf{Example~\thesection.\theexamplecnt}}
- \endgraf%
+ \endgraf\vspace*{.5\baselineskip}%
+ \TC{purple}{\textbf{Example~\thesection.\theexamplecnt}}%
+ \endgraf\nobreak
}
\date{\TC{purple}{\today}\vadjust{\kern2ex\hrule}}
\new\def\helv{\fontfamily{phv}\selectfont\color{xmagenta10}}
@@ -61,9 +64,9 @@
\begin{document}
\MakeShortVerb{\+}
\title{{\bfseries The \TC{blue}{\texttt{getfiledate}} Package}\\[1ex]
-Version 1.0}
+Version 1.2}
\author{Ahmed Musa\\[.5ex]University of Central Lancashire\\
- Preston, United Kingdom\\[1ex]\url{a.musa@rocketmail.com}
+ Preston, United Kingdom\\[1ex]\email{a.musa@rocketmail.com}
}
\maketitle
@@ -100,15 +103,15 @@ The package options are listed in Table~\ref{tab:Package-options} below.
\small
\rowcolors{3}{yellow!20}{gray!25}
\extrarowheight2pt
-\begin{longtable}{m{3cm}m{3.5cm}m{\dimexpr\hsize-8cm}}
+\begin{tabularx}{\linewidth}{m{3cm}m{3.5cm}X}
\caption{Package options\label{tab:Package-options}}\\
\rowcolor{green!55}
\bf Option & \bf Default & \bf Meaning\\
\endfirsthead
-\multicolumn{3}{|l|}{\emph{Continued from last page}}\\
+\multicolumn{3}{l}{\emph{Continued from last page}}\\
\bf Option & \bf Default & \bf Meaning\\
\endhead
-\multicolumn{3}{|r|}{\emph{Continued on next page}}\\
+\multicolumn{3}{r}{\emph{Continued on next page}}\\
\endfoot
\endlastfoot
+file+ & +getfiledate.sty+ & The file for which the date of last modification is required.\\
@@ -117,7 +120,7 @@ The package options are listed in Table~\ref{tab:Package-options} below.
+width+ & +\hsize+ & The width of the parbox or boxedminipage containing the filedate.\\
+head+ & +0ex+ & The vertical separation between the paragraph before the filedate and the filedate itself. When this option is passed to package without value, its default becomes the +\baselineskip+.\\
+foot+ & +0ex+ & The vertical skip between the filedate's line and the paragraph after filedate. When this option is passed to package without value, its default becomes the +\baselineskip+.\\
-+marker+ & +\@empty+ & The mark before the filename, on the same line with the filedate.\\
++marker+ & +\empty+ & The mark before the filename, on the same line with the filedate.\\
+markercolor+ & +blue+ & The color of the marker.\\
+filenamecolor+ & +blue+ & The color of the filename.\\
+datecolor+ & +blue+ & The color of filedate.\\
@@ -131,11 +134,11 @@ The package options are listed in Table~\ref{tab:Package-options} below.
+putprefix+ & +true+ & The boolean switch for placing prefix and postfix before the filedate. If this option is not entered in the call to \cmda{\getfiledate}, or if it is entered as \stya{putprefix=true}, both prefix and postfix will be inserted. On the other hand, if the user sets \stya{putprefix=false}, then no prefix and postfix will be inserted (even if the user specifies prefix and postfix in the call to \cmda{\getfiledate}). This option has been necessitated by users who just want to get filedate without any prefix, postfix or filename.\\
+notime+ & +false+ & The boolean switch for turning the display of time on or off.\\
+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}
+\end{tabularx}
\endgroup
\section{Examples}
-\example
+\gfdexample
The simplest example is to use the \cmda{\getfiledate} macro in the following way:
\begin{gfdverbatim}
@@ -193,7 +196,7 @@ to get
\bigskip
You can use all package options to customize the format of the result. The following examples illustrate the most important issues in using this package.
-\example
+\gfdexample
The example in this section was obtained with the following settings. There are values specified for \stya{head} and \stya{foot}.
\begin{gfdverbatim}
\getfiledate[putprefix,postfix,head=.1\baselineskip,
@@ -229,13 +232,13 @@ to get
foot=\baselineskip,width=.6\hsize,
prefix=The date of final changes to file,
marker,filenamecolor=xgreen10,datecolor=orange,
- inlinespace=.5em,align=center,boxed=false,
+ inlinespace=1em,align=center,boxed=false,
separator=$\spadesuit$,sepcolor=green
]{misc-test1.tex}
If you simply remove \stya{marker} from the key-value list, the \stya{marker} will retain the last value you assigned to it rather than the default value (which is nil).
-\example
+\gfdexample
Unlike the case of the \stya{marker}, if you don't need the \stya{separator}, you would have to enter \stya{separator=\{\}} or simply \stya{separator=} as follows
@@ -254,7 +257,7 @@ to get
foot=\baselineskip,width=.6\hsize,
prefix=The date of final changes to file,
marker,filenamecolor=xgreen10,datecolor=orange,
- inlinespace=.5em,align=center,boxed=false,
+ inlinespace=2em,align=center,boxed=false,
separator=,sepcolor=green
]{misc-test1.tex}
@@ -288,7 +291,7 @@ The same trick can be applied to some other keys. If you simply remove the \stya
\item Some of the package options (\eg, \stya{putprefix}, \stya{notime}) can be submitted globally via the options list of \cmdb{\documentclass}.
\end{itemize}
-\example
+\gfdexample
The example in this section was obtained with the following settings:
\begin{gfdverbatim}
\getfiledate[head=0ex,foot=\baselineskip,
@@ -307,7 +310,7 @@ The outcome is:
]{misc-test2.tex}
Here we simply passed the \stya{prefix} without value so that its default value was used.
-\example
+\gfdexample
The example in this section was obtained with the following settings:
\begin{gfdverbatim}
\getfiledate[head=\baselineskip,foot=\baselineskip,
@@ -324,7 +327,7 @@ The outcome is:
separator=$\Diamond$,sepcolor=red
]{misc-test3.tex}
-\example
+\gfdexample
The example in this section was obtained with the following settings:
\begin{gfdverbatim}
@@ -342,7 +345,7 @@ The outcome is:
separator=$\heartsuit$,sepcolor
]{misc-test4.tex}
-\example
+\gfdexample
The example in this section was obtained with the following settings:
\begin{gfdverbatim}
\getfiledate[head=1ex,foot=1ex,
@@ -359,7 +362,7 @@ The outcome of this is:
separator={}
]{misc-test5.tex}
-\example
+\gfdexample
Instead of keeping \stya{head} and \stya{foot}, you may instead decide to frame your result, as follows:
\begin{gfdverbatim}
\getfiledate[head=.5\baselineskip,
@@ -418,7 +421,7 @@ The outcome of this is:
This frame color will remain in force until it is changed again. The default value of \stya{framecolor} is \stya{black}.
-\example
+\gfdexample
The display of time can be avoided by using the switch \stya{notime}, as follows.
\begin{gfdverbatim}