new package tdclock (22dec08)

git-svn-id: svn://tug.org/texlive/trunk@11691 c570f23f-e606-0410-a88d-b1316a301751

5 files changed, 431 insertions, 0 deletions

diff --git a/Master/texmf-dist/doc/latex/tdclock/README b/Master/texmf-dist/doc/latex/tdclock/README
new file mode 100644
index 00000000000..614b6527437
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tdclock/README
@@ -0,0 +1,17 @@
+Package name:		tdclock (The LaTeX tdclock)
+Package authors:	Luis Randez, Juan I. Montijano
+Version/Release:	2.0
+
+Features:
+
+The tdclock package allows the users to insert into a
+LATEX generated pdf document a ticking digital clock showing the date and/or
+time at the moment in which the document is being read.
+
+
+Installation:
+
+Copy the package file tdclock.sty to a directory where LATEX can find it.
+
+
+December 2008
\ No newline at end of file
diff --git a/Master/texmf-dist/doc/latex/tdclock/tdclock-beamer-example.pdf b/Master/texmf-dist/doc/latex/tdclock/tdclock-beamer-example.pdf
new file mode 100644
index 00000000000..249674a467b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tdclock/tdclock-beamer-example.pdf
diff --git a/Master/texmf-dist/doc/latex/tdclock/tdclock-beamer-example.tex b/Master/texmf-dist/doc/latex/tdclock/tdclock-beamer-example.tex
new file mode 100644
index 00000000000..ff802f4ffef
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tdclock/tdclock-beamer-example.tex
@@ -0,0 +1,169 @@
+\documentclass[10pt]{beamer}
+%\usepackage[font=Times, timeinterval=10]{tickingclock}
+%\usepackage[font=Cour, timeinterval=10]{tickingclock}
+%\usepackage[font=Helv, timeinterval=30]{tickingclock}
+\usepackage[timeinterval=10]{tdclock}
+%\usepackage{times}
+%\usepackage{helvet}
+
+\usetheme{Madrid}
+
+
+\title{An example of using Ticking Digital Clock in Beamer}
+\author{Luis R\'{a}ndez \& Juan I. Montijano}
+\institute[IUMA]{IUMA \\ Universidad de Zaragoza }
+\date{\today}
+
+
+\begin{document}
+
+\frame{\titlepage}
+
+\begin{frame}[t]
+\frametitle{Introduction}
+
+\initclock  % This must be used one time to initialize the clock
+
+We are putting here a clock with the macro  \quad
+\structure{\texttt{$\backslash$tdclock}}:
+
+\bigskip
+
+\tdclock
+
+\bigskip
+
+Before that, the macro \quad  \structure{\texttt{$\backslash$initclock}}
+\quad must have been used (only one time !).
+
+\end{frame}
+
+% This is an example of inserting
+% the clock at the place reserved to the date, the foot line in the
+% case of Madrid theme.
+%
+
+\date{\tddate\ \ \tdtime}
+
+\begin{frame}
+
+
+Here we have inserted the clock at the place reserved to the date, the foot line in the case of Madrid theme.
+
+\medskip
+
+To do that, we have redefined the date contents with the order
+\medskip
+
+\centerline{\structure{\texttt{$\backslash$date\{$\backslash$tddate$\backslash$ $\backslash$ $\backslash$tdtime\}}} }
+
+\medskip
+
+Note that color and font size are adjusted according to the theme.
+
+\medskip
+
+Look at the foot!, the clock must be running.
+
+\end{frame}
+
+\begin{frame}
+
+
+Next, we have inserted a button to toggle between clock and stopwatch,
+and a button to reset the stopwatch to zero.
+
+\medskip
+\toggleclock{\beamerbutton{toggle}}
+\tdtime
+\resetcrono{\beamerbutton{reset}}
+
+\medskip
+
+Click at the left button, see what happens (you must wait 10 seconds),
+then click at the right button and see the result.
+Finally, click at the left button again to recover the current time
+
+\bigskip
+
+To do that, we have used
+
+\medskip
+
+\structure{
+\texttt{$\backslash$toggleclock\{$\backslash$beamerbutton\{toggle\}\}} \\%
+\texttt{$\backslash$tdtime} \\
+\texttt{$\backslash$resetcrono\{$\backslash$beamerbutton\{reset\}\}}
+}
+
+
+\end{frame}
+
+%
+% Here we change the colors and size of the clock
+
+\begin{frame}
+
+Here we change the color and size of the clock with
+standard \LaTeX commands.
+
+\structure{\texttt{$\backslash$textcolor\{blue\}\{$\backslash$Large $\backslash$tdhours.$\backslash$tdminutes\}\}}}: %
+\textcolor{green}{\Large \tdhours.\tdminutes}
+
+\bigskip
+
+Here a huge yellow clock showing only hours and minutes, inside a red box
+
+\structure{$\backslash$hhmm $\backslash$factorclockfont\{6.0\} $\backslash$tdtime}
+
+\begin{center}
+\colorbox{red}{\color{yellow} \hhmm \factorclockfont{6.0} \tdtime}
+\end{center}
+
+\end{frame}
+
+\begin{frame}
+
+\centerline{Time-Date-Crono macros}
+\begin{tabular}{|l|l|l|}
+\hline
+ \structure{$\backslash$initclock}        &                                      & initialize  clock   \\ \hline
+ \structure{$\backslash$tickingclock}     & \tdclock                        & complete clock  \\ \hline
+ \structure{$\backslash$tickingtime}      & \tdtime                         & current time    \\ \hline
+ \structure{$\backslash$tickingdate}      & \tddate                         & current date    \\ \hline
+ \structure{$\backslash$tickingday}       & \tdday                          & current day     \\\hline
+ \structure{$\backslash$tickingmonth}     & \tdmonth                        & current month   \\\hline
+ \structure{$\backslash$tickingyear}      & \tdyear                         & current year    \\\hline
+ \structure{$\backslash$tickinghours}     & \tdhours                        & current hours   \\\hline
+ \structure{$\backslash$tickingminutes}   & \tdminutes                      & current minutes \\\hline
+ \structure{$\backslash$tickingseconds}   & \tdseconds                      & current seconds \\\hline
+ \structure{$\backslash$crono}            & \crono                               & stopwatch       \\ \hline
+ \structure{$\backslash$cronohours}       & \cronohours                          & crono hours   \\\hline
+ \structure{$\backslash$cronominutes}     & \cronominutes                        & crono minutes \\\hline
+ \structure{$\backslash$cronoseconds}     & \cronoseconds                        & crono seconds \\\hline
+ \structure{$\backslash$resetcrono}       & \resetcrono{\beamerbutton{reset}}     & sets crono time to zero    \\\hline
+ \structure{$\backslash$toggleclock}      & \toggleclock{\beamerbutton{toggle}}    & toggle time-crono   \\\hline
+\end{tabular}
+
+\end{frame}
+
+\begin{frame}
+
+\centerline{Formatting macros}
+\begin{tabular}{|l|l|l|}
+\hline
+ \structure{$\backslash$hhmm}             & \hhmm\tdtime                    & format time   \\ \hline
+ \structure{$\backslash$hhmmss}           & \hhmmss\tdtime                  & format time   \\ \hline
+ \structure{$\backslash$mmddyyyy}         & \mmddyyyy\tddate                & format date   \\ \hline
+ \structure{$\backslash$ddmmyyyy}         & \ddmmyyyy\tddate                & format date   \\ \hline
+ \structure{$\backslash$dateseparator}    & \def\dateseparator{--}\tddate   & separator for date   \\ \hline
+ \structure{$\backslash$timeseparator}    & \def\timeseparator{.}\tdtime    & separator for time   \\ \hline
+ \structure{$\backslash$pdfslash}         & \pdfslash                            & slash in pdf font  \\ \hline
+ \structure{$\backslash$pdfcolon}         & \pdfcolon                            & colon in pdf font   \\ \hline
+ \structure{$\backslash$factorclockfont\{factor\}}     & \factorclockfont{2.0}\tdtime          & format date   \\ \hline
+\end{tabular}
+
+\end{frame}
+
+\end{document}
+
diff --git a/Master/texmf-dist/doc/latex/tdclock/tdclock-doc.pdf b/Master/texmf-dist/doc/latex/tdclock/tdclock-doc.pdf
new file mode 100644
index 00000000000..cab6dbe21a7
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tdclock/tdclock-doc.pdf
diff --git a/Master/texmf-dist/doc/latex/tdclock/tdclock-doc.tex b/Master/texmf-dist/doc/latex/tdclock/tdclock-doc.tex
new file mode 100644
index 00000000000..35cc0b7041b
--- /dev/null
+++ b/Master/texmf-dist/doc/latex/tdclock/tdclock-doc.tex
@@ -0,0 +1,245 @@
+\documentclass{article}
+
+\usepackage{xcolor}
+\usepackage{hyperref}
+\usepackage{xkeyval}
+\usepackage[font=Times,timeinterval=1]{tdclock}
+
+\title{The Ticking Digital Clock \texttt{tdclock} package v2.0}
+\author{Luis R\'{a}ndez \& Juan I. Montijano}
+%\affiliation[IUMA]{IUMA \\ Universidad de Zaragoza }
+\date{\today}
+
+
+
+\begin{document}
+
+\maketitle
+
+\initclock
+
+\section{The package}
+The \texttt{tdclock} package is a \LaTeX2e package that
+allows the users to insert into a \LaTeX\/ generated pdf document
+a ticking digital clock showing the date and/or time at
+the moment in which the document
+is being read, for example the one next: \quad \tdclock.
+
+\smallskip
+The package is loaded by  \texttt{$\backslash$usepackage[``options'']\{tdclock\}}
+
+\medskip
+
+\noindent Options:
+
+\begin{itemize}
+\item  timeinterval=$n$
+\item[]
+$n$ can be any positive integer. The clock will update its internal status every $n$ seconds.  Thus, if we load
+the package with \texttt{[timeinterval=120]}, the clock will update its display every 2 minutes.
+The default time interval is set to 29 seconds.
+
+Note that for low values of $n$ the memory used by Adobe increases during the time the document remains opened and can
+become very high.  Then, values of $n$ below 10 are not recommended.
+
+\item  font=``adobe font''
+\item[]
+``adobe font''  is one of the following 9 adobe name fonts:\\[5pt]
+\begin{tabular}{llllll}
+Helv  & HelvI  & HelvBI &
+Times & TimesI & TimesBI \\
+Cour  & CourI  & CourBI &&&
+\end{tabular}
+
+\item[]By now no other fonts, like \TeX\ ones, can be used.  This restriction comes from the fact that the
+``dynamic'' clock is based on javascript code embedded into the pdf document.
+\end{itemize}
+
+\section{Restrictions--requirements}
+The package  requires hyperref, xkeyval and xcolor packages. It works with PDF\LaTeX\/ as well as with \LaTeX\/$\to$DviPs$\to$Ps2pdf sequence.
+In documents generated by Dvipdfm, the clock does not work properly.
+
+Since it uses javascript code, and not all pdf readers can interpret javascript,
+only some of them will display the documents properly.  We have tested the package with
+Adobe reader and Adobe acrobat under windows and Linux.
+
+\section{Installation}
+Copy the package file tdclock.sty to a directory where \LaTeX\/ can find it.
+
+\section{Getting the package}
+
+The package can be downloaded at  http://pcmap.unizar.es/numerico/software
+
+\section{Macros}
+
+The clock must be initialized with  \texttt{$\backslash$initclock}, usually at the beginning of the document, after
+\texttt{$\backslash$begin\{document\}}.
+
+The following macros display dynamically the current date and/or time:
+
+\begin{center}
+\begin{tabular}{|l|l|}
+\hline
+ \bf command & \bf  action \\
+\hline
+\texttt{ $\backslash$tdclock}       & displays a complete clock  \\ \hline
+\texttt{ $\backslash$tdtime}        & displays the current time    \\ \hline
+\texttt{ $\backslash$tddate}        & displays the current date    \\ \hline
+\texttt{ $\backslash$tdday}         & displays the current day     \\\hline
+\texttt{ $\backslash$tdmonth}       & displays the current month   \\\hline
+\texttt{ $\backslash$tdyear}        & displays the current year    \\\hline
+\texttt{ $\backslash$tdhours}       & displays the current hour   \\\hline
+\texttt{ $\backslash$tdminutes}     & displays the current minute \\\hline
+\texttt{ $\backslash$tdseconds}     & displays the current second \\\hline
+\end{tabular}
+\end{center}
+
+The package also provides macros to display a stopwatch.  This can be done
+by means of the following macros:
+
+\begin{center}
+\begin{tabular}{|l|l|}
+\hline
+\bf command  & \bf action \\
+\hline
+\texttt{ $\backslash$crono}              & displays a stopwatch       \\ \hline
+\texttt{ $\backslash$cronohours}         & displays a crono (only hours)   \\\hline
+\texttt{ $\backslash$cronominutes}       & displays a crono (only minutes) \\\hline
+\texttt{ $\backslash$cronoseconds}       & displays a crono (only seconds) \\\hline
+\end{tabular}
+\end{center}
+
+In addition, the package includes two macros that display buttons. With one of them, by pressing it,
+you reset the stopwatch to zero values.  The form of the command is \texttt{$\backslash$resetcrono\{``button''\}}.
+For example, \texttt{$\backslash$resetcrono\{$\backslash$fbox\{reset\}\} $\backslash$crono} produces (press the button to see what happens):
+\resetcrono{\fbox{reset}} \crono
+
+The other lets you  toggle from current time to stopwatch.  For example,
+\texttt{$\backslash$toggleclock\{$\backslash$fbox\{toggleclock\}\} $\backslash$tdtime} produces (press the button to see what happens):
+\toggleclock{\fbox{toggle}} \tdtime.
+
+Note that \texttt{$\backslash$toggleclock} only has effect on \texttt{$\backslash$tdtime} command, and not on \texttt{$\backslash$crono}.
+
+\subsection{Formatting the output}
+
+\subsubsection{Size and color}
+The size and color of the characters forming the time or date are the \LaTeX\/
+current font size and color.  Thus, for example
+
+\noindent\texttt{
+$\backslash$centerline\{$\backslash$textcolor\{blue\}\{$\backslash$Huge $\backslash$tdclock\}\}
+} gives:
+
+\centerline{\textcolor{blue}{\Huge \tdtime} }
+
+\smallskip
+
+There is another macro,  \texttt{$\backslash$factorclockfont\{``factor''\}}, that increases the size of the clock
+by a desired factor.  To set the size of the clock to its original size, use
+\texttt{$\backslash$factorclockfont\{1\}}
+
+\subsubsection{Formatting the display}
+There are two commands that change the effect of \texttt{$\backslash$time} and
+\texttt{$\backslash$crono}.
+\begin{itemize}
+\item \texttt{$\backslash$hhmmss} redefine the commands to show the hours,minutes and seconds (this is the default),
+\item \texttt{$\backslash$hhmm} redefine them so that they will only show hours and minutes.
+\end{itemize}
+
+Hours, minutes and seconds are separated by the character defined in the macro \texttt{$\backslash$timeseparator}.
+Therefore, the time separator can be set by redefining this macro.  For example,
+
+\centerline{\texttt{$\backslash$renewcommand\{$\backslash$timeseparator\}\{;\}$\backslash$tdtime}}
+
+gives
+
+\centerline{\renewcommand{\timeseparator}{;}\tdtime}
+
+Different types of formats for time can be achieved by means of the macros \texttt{$\backslash$tdhours}, \texttt{$\backslash$tdminutes} and\texttt{$\backslash$seconds}.  For example,
+
+\noindent\texttt{$\backslash$minutes}.\texttt{$\backslash$seconds}
+produces:  \quad \tdminutes.\tdseconds
+
+Different types of formats for the stopwatch can be achieved by means of the macros \texttt{$\backslash$cronohours}, \texttt{$\backslash$cronominutes} and\texttt{$\backslash$cronoseconds}.  For example,
+
+\noindent\texttt{$\backslash$cronominutes}.\texttt{$\backslash$cronoseconds}
+produces:  \quad \cronominutes.\cronoseconds
+
+In fact, \texttt{$\backslash$tdtime} and \texttt{$\backslash$crono} are defined by default to \\
+\texttt{$\backslash$tdhours$\backslash$timeseparator$\backslash$tdminutes$\backslash$timeseparator$\backslash$tdseconds}\\ and \\
+\texttt{$\backslash$cronohours$\backslash$timeseparator$\backslash$cronominutes$\backslash$timeseparator$\backslash$cronoseconds}\\ respectively.
+
+\bigskip
+
+Regarding the date, there are two commands that change the effect of \texttt{$\backslash$tddate}.
+\begin{itemize}
+\item \texttt{$\backslash$ddmmyyyy} redefine the command to show the day,month and year (this is the default),
+\item \texttt{$\backslash$mmddyyyy} redefine it to show month, day and year.
+\end{itemize}
+
+Day, month and year are separated by the character defined in the macro \texttt{$\backslash$dateseparator}.
+Therefore, the date separator can be set by redefining this macro.  For example,
+
+\centerline{\texttt{$\backslash$renewcommand\{$\backslash$dateseparator\}\{;\}$\backslash$tddate}}
+
+gives
+
+\centerline{\renewcommand{\dateseparator}{;}\tddate}
+
+Different types of formats for date can be achieved by means of the macros \texttt{$\backslash$tdday}, \texttt{$\backslash$tdmonth} and\texttt{$\backslash$tdyear}.  For example,
+
+\noindent\texttt{$\backslash$day}--\texttt{$\backslash$month}
+produces:  \quad \tdday--\tdmonth
+
+By default, \texttt{$\backslash$tddate} is defined by default to \\
+\texttt{$\backslash$tdday$\backslash$dateseparator$\backslash$tdmonth$\backslash$dateseparator$\backslash$tdyear}.
+
+Since the font used to display the dynamic date and time is one of the adobe fonts, we have included two commands \texttt{$\backslash$pdfslash} and \texttt{$\backslash$pdfcolon} to provide the charactrers ``slash'' and ``colon'' so that defining
+\texttt{$\backslash$renewcommand\{$\backslash$timeseparator\}\{$\backslash$pdfcolon\}}
+the command \texttt{$\backslash$tdtime} will have all their characters in the same font.
+The same for \texttt{$\backslash$tddate} if we use \texttt{$\backslash$pdfslash} as separator.
+
+\newpage
+\section{Summary of macros}
+
+\bigskip
+\centerline{Time-Date macros}
+\begin{tabular}{|l|l|l|}
+\hline
+macro  &  result  &  action \\
+\hline
+ $\backslash$initclock        &                                      & initialize  clock   \\ \hline
+ $\backslash$tdclock     & \tdclock                        & complete clock  \\ \hline
+ $\backslash$tdtime      & \tdtime                         & current time    \\ \hline
+ $\backslash$tddate      & \tddate                         & current date    \\ \hline
+ $\backslash$tdday       & \tdday                          & current day     \\\hline
+ $\backslash$tdmonth     & \tdmonth                        & current month   \\\hline
+ $\backslash$tdyear      & \tdyear                         & current year    \\\hline
+ $\backslash$tdhours     & \tdhours                        & current hours   \\\hline
+ $\backslash$tdminutes   & \tdminutes                      & current minutes \\\hline
+ $\backslash$tdseconds   & \tdseconds                      & current seconds \\\hline
+ $\backslash$crono            & \crono                               & stopwatch       \\ \hline
+ $\backslash$cronohours       & \cronohours                          & crono hours   \\\hline
+ $\backslash$cronominutes     & \cronominutes                        & crono minutes \\\hline
+ $\backslash$cronoseconds     & \cronoseconds                        & crono seconds \\\hline
+ $\backslash$resetcrono\{``button''\}       & \resetcrono{\fbox{reset}}     & sets crono time to zero    \\\hline
+ $\backslash$toggleclock\{``button''\}      & \toggleclock{\fbox{toggle}}    & toggle time-crono   \\\hline
+\end{tabular}
+
+\bigskip
+
+\centerline{Formatting macros}
+\begin{tabular}{|l|l|}
+\hline
+ \texttt{$\backslash$hhmm$\backslash$tdtime}          & \hhmm\tdtime                     \\ \hline
+ \texttt{$\backslash$hhmmss$\backslash$tdtime}        & \hhmmss\tdtime                   \\ \hline
+ \texttt{$\backslash$mmddyy$\backslash$tddate}        & \mmddyyyy\tddate                \\ \hline
+ \texttt{$\backslash$ddmmyy$\backslash$tddate}        & \ddmmyyyy\tddate                   \\ \hline
+ \texttt{$\backslash$renewcommand\{$\backslash$dateseparator\}\{--\}$\backslash$tddate}  & \renewcommand{\dateseparator}{--}\tddate     \\ \hline
+ \texttt{$\backslash$renewcommand\{$\backslash$timeseparator\}\{.\}$\backslash$tdtime}  & \renewcommand{\timeseparator}{.}\tdtime        \\ \hline
+ \texttt{$\backslash$pdfslash}         & \pdfslash                           \\ \hline
+ \texttt{$\backslash$pdfcolon}        & \pdfcolon                            \\ \hline
+  \texttt{$\backslash$factorclockfont\{2.0\}$\backslash$tdtime}     & \factorclockfont{2.0}\tdtime   \\ \hline
+\end{tabular}
+
+\end{document} 
\ No newline at end of file