summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex')
-rw-r--r--Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex129
1 files changed, 55 insertions, 74 deletions
diff --git a/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex b/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex
index f64ee91d37d..2cd16e0229d 100644
--- a/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex
+++ b/Master/texmf-dist/source/latex/koma-script/doc/english/scrdatetime.tex
@@ -1,6 +1,6 @@
% ======================================================================
% scrdatetime.tex
-% Copyright (c) Markus Kohm, 2001-2015
+% Copyright (c) Markus Kohm, 2001-2017
%
% This file is part of the LaTeX2e KOMA-Script bundle.
%
@@ -18,7 +18,7 @@
% This work consists of all files listed in manifest.txt.
% ----------------------------------------------------------------------
% scrdatetime.tex
-% Copyright (c) Markus Kohm, 2001-2015
+% Copyright (c) Markus Kohm, 2001-2017
%
% Dieses Werk darf nach den Bedingungen der LaTeX Project Public Lizenz,
% Version 1.3c, verteilt und/oder veraendert werden.
@@ -46,14 +46,15 @@
% ============================================================================
\KOMAProvidesFile{scrdatetime.tex}
- [$Date: 2015-03-31 11:10:59 +0200 (Tue, 31 Mar 2015) $
+ [$Date: 2017-01-02 13:30:07 +0100 (Mon, 02 Jan 2017) $
KOMA-Script guide (chapter: scrdate, scrtime)]
\translator{Markus Kohm\and Gernot Hassenpflug}
-% Date of translated German file: 2015-03-31
+% Date of the translated German file: 2017-01-02
\chapter{The Day of the Week Using \Package{scrdate}}
\labelbase{scrdate}
+\BeginIndexGroup
\BeginIndex{Package}{scrdate}
With version~3.05a the functionality of this package enhanced a lot. Beside of
@@ -64,8 +65,6 @@ day of the week of every date of the Gregorian calendar now.
\Macro{CenturyPart}\Parameter{year}\\%
\Macro{DecadePart}\Parameter{year}%
\end{Declaration}%
-\BeginIndex{Cmd}{CenturyPart}%
-\BeginIndex{Cmd}{DecadePart}%
The\ChangedAt{v3.05a}{\Package{scrdate}} command \Macro{CenturyPart} offers
the value of the century digits\,---\,hundreds and thousands\,---\,of a
\PName{year}. The command \Macro{DecadePart} in difference offers the other
@@ -73,8 +72,7 @@ digits which are the units and tens. The number of digits of \PName{year} does
not care. The value may be assigned to a counter or may be used for
calculations, i.\,e., using \Macro{numexpr}\IndexCmd{numexpr}. For
output\textnote{Attention!} of an Arabic number of the value prefix it with
-\Macro{the}
-\IndexCmd{the}.
+\Macro{the}\IndexCmd{the}.
\begin{Example}
You want to calculate and output the century of the current year.
@@ -94,15 +92,13 @@ output\textnote{Attention!} of an Arabic number of the value prefix it with
Please\textnote{Attention!} note, that within used method of counting the
year~2000 is the year~0\,---\,and therefore the first year\,---\,of the
21st~century.%
-\EndIndex{Cmd}{DecadePart}%
-\EndIndex{Cmd}{CenturyPart}%
+\EndIndexGroup
+
\begin{Declaration}
\Macro{DayNumber}\Parameter{year}\Parameter{month}\Parameter{day}\\%
\Macro{ISODayNumber}\Parameter{ISO-date}%
\end{Declaration}%
-\BeginIndex{Cmd}{DayNumber}%
-\BeginIndex{Cmd}{ISODayNumber}%
These\ChangedAt{v3.05a}{\Package{scrdate}} two commands offers the value of
the number of the day of the week\Index{day>of the week} of any date. The
differ only in the kind of date declaration. Command \Macro{DayNumber} needs
@@ -151,8 +147,7 @@ date.
The days of the week are numbered: Sunday\,=\,0, Monday\,=\,1, Tuesday\,=\,2,
Wednesday\,=\,3, Thursday\,=\,4, Friday\,=\,5, and Saturday\,=\,6.%
%
-\EndIndex{Cmd}{DayNumber}%
-\EndIndex{Cmd}{ISODayNumber}%
+\EndIndexGroup
\begin{Declaration}
@@ -160,9 +155,6 @@ Wednesday\,=\,3, Thursday\,=\,4, Friday\,=\,5, and Saturday\,=\,6.%
\Macro{DayName}\Parameter{year}\Parameter{month}\Parameter{day}\\%
\Macro{ISODayName}\Parameter{ISO-date}%
\end{Declaration}%
-\BeginIndex{Cmd}{DayNameByNumber}%
-\BeginIndex{Cmd}{DayName}%
-\BeginIndex{Cmd}{ISODayName}%
Usually\ChangedAt{v3.05a}{\Package{scrdate}} you do not want to know the number
of the day of the week, but the name of the day of the week. Because of this,
the command \Macro{DayNameByNumber} offers the name of the day of the week
@@ -208,21 +200,15 @@ Again a special feature is to make some calculations inside the argument of
\end{quote}
\end{Example}%
%
-\EndIndex{Cmd}{ISODayName}%
-\EndIndex{Cmd}{DayName}%
-\EndIndex{Cmd}{DayNameByNumber}%
+\EndIndexGroup
\begin{Declaration}
- \Macro{ISOToday}\\%
- \Macro{IsoToday}\\
- \Macro{todaysname}\\%
+ \Macro{ISOToday}%
+ \Macro{IsoToday}%
+ \Macro{todaysname}%
\Macro{todaysnumber}%
\end{Declaration}%
-\BeginIndex{Cmd}{todaysname}%
-\BeginIndex{Cmd}{todaysnumber}%
-\BeginIndex{Cmd}{ISOToday}%
-\BeginIndex{Cmd}{IsoToday}%
In the prior examples the current date have been given cumbersomely and
explicitly using the \TeX{} registers \Macro{year}\IndexCmd{year},
\Macro{month}\IndexCmd{month}, and \Macro{day}\IndexCmd{day}. The commands
@@ -234,7 +220,7 @@ numbers less than 10 for the month and day with a 0. In opposite to this
digit only. Command \Macro{todaysname} directly offers the name of the current
day of the week. Command \Macro{todaysnumber} offers the number of that name
instead. More information about usability of this value may be found at
-previous description of \Macro{DayNumber} and \Macro{ISODayNumber}.
+previous description of \DescRef{scrdate.cmd.DayNumber} and \DescRef{scrdate.cmd.ISODayNumber}.
\begin{Example}
I want to show you the name of the weekday in which this document has been
@@ -263,32 +249,28 @@ only for some languages.
\Macro{MakeLowercase}\IndexCmd{MakeLowercase}%
\important{\Macro{MakeLowercase}}, e.\,g.:
% Umbruchkorrektur: listings
-\begin{lstcode}[belowskip=\dp\strutbox]
+\begin{lstcode}
\MakeLowercase{\todaysname}
\end{lstcode}
This converts the whole argument into lower case letters. Of course, this
may be done also using previous described commands
- \Macro{DayNameByNumber}\IndexCmd{DayNameByNumber},
- \Macro{DayName}\IndexCmd{DayName} and
- \Macro{ISODayName}\IndexCmd{ISODayName}.%
+ \DescRef{scrdate.cmd.DayNameByNumber}\IndexCmd{DayNameByNumber},
+ \DescRef{scrdate.cmd.DayName}\IndexCmd{DayName} and
+ \DescRef{scrdate.cmd.ISODayName}\IndexCmd{ISODayName}.%
\end{Explain}%
-\EndIndex{Cmd}{IsoToday}%
-\EndIndex{Cmd}{ISOToday}%
-\EndIndex{Cmd}{todaysnumber}%
-\EndIndex{Cmd}{todaysname}
+\EndIndexGroup
\begin{Declaration}
\Macro{nameday}\Parameter{name}
\end{Declaration}%
-\BeginIndex{Cmd}{nameday}%
Analogous to how the output of \Macro{today} can be modified using
-\Macro{date}\IndexCmd{date}, so the output of \Macro{todaysname} can
-be changed to \PName{name} by using \Macro{nameday}.
+\DescRef{maincls.cmd.date}\IndexCmd{date}, so the output of \DescRef{scrdate.cmd.todaysname}
+can be changed to \PName{name} by using \Macro{nameday}.
\begin{Example}
- You change the current date to a fixed value using \Macro{date}. You
- are not interested in the actual name of the day, but want only to
- show that it is a workday. So you set:
+ You change the current date to a fixed value using
+ \DescRef{maincls.cmd.date}. You are not interested in the actual name of
+ the day, but want only to show that it is a workday. So you set:
\begin{lstlisting}
\nameday{workday}
\end{lstlisting}
@@ -298,21 +280,19 @@ be changed to \PName{name} by using \Macro{nameday}.
\end{quote}
\end{Example}
There's no such command for changing the result of
-\Macro{ISOToday}\IndexCmd{ISOToday} or \Macro{IsoToday}\IndexCmd{IsoToday}.
-\EndIndex{Cmd}{nameday}
+\DescRef{scrdate.cmd.ISOToday}\IndexCmd{ISOToday} or \DescRef{scrdate.cmd.IsoToday}\IndexCmd{IsoToday}.
+\EndIndexGroup
\begin{Declaration}
- \Macro{newdaylanguage}\Parameter{language}\\
- \hphantom{\XMacro{newdaylanguage}}%
- \Parameter{Monday}\Parameter{Tuesday}\Parameter{Wednesday}%
- \Parameter{Thursday}\\
- \hphantom{\XMacro{newdaylanguage}}%
- \Parameter{Friday}\Parameter{Saturday}\Parameter{Sunday}%
+ \Macro{newdaylanguage}\Parameter{language}%
+ \Parameter{Monday}\Parameter{Tuesday}%
+ \Parameter{Wednesday}\Parameter{Thursday}%
+ \Parameter{Friday}\Parameter{Saturday}
+ \Parameter{Sunday}%
\end{Declaration}
-\BeginIndex{Cmd}{newdaylanguage}
Currently the package \Package{scrdate} knows the following languages:
-\begin{itemize}
+\begin{itemize}\setlength{\itemsep}{.5\itemsep}
\item Croatian (\PValue{croatian}),
\item Czech (\PValue{czech}\ChangedAt{v3.13}{\Package{scrdate}}),
\item Danish (\PValue{danish}),
@@ -356,13 +336,14 @@ correct language will be used.
By the way: If you found a suitable definition for a language, that has not
been defined before, please mail it to the \KOMAScript{} author. There is a
good chance, that he will add support for the language to \Package{scrdate}.%
-\EndIndex{Cmd}{newdaylanguage}%
+\EndIndexGroup
%
-\EndIndex{Package}{scrdate}
+\EndIndexGroup
\chapter{Getting the Time with Package \Package{scrtime}}
\labelbase{scrtime}
+\BeginIndexGroup
\BeginIndex{Package}{scrtime}
This package provides an answer to the question of the current time. Since
@@ -371,10 +352,9 @@ the \KOMAScript{} classes and several other \KOMAScript{} packages. See for
example \autoref{sec:typearea.options} for more information.
\begin{Declaration}%
- \Macro{thistime}\OParameter{delimiter}\\
+ \Macro{thistime}\OParameter{delimiter}%
\Macro{thistime*}\OParameter{delimiter}
\end{Declaration}%
-\BeginIndex{Cmd}{thistime}\BeginIndex{Cmd}{thistime*}%
\Macro{thistime} results in the current time\Index{time}. The
delimiter between the values of hour, minutes and seconds can be given
in the optional argument. The default symbol of the delimiter is
@@ -412,46 +392,47 @@ minute field has always two places.
This day is already 12 hours and 25 minutes old.
\end{quote}
\end{Example}
-\EndIndex{Cmd}{thistime}\EndIndex{Cmd}{thistime*}
+\EndIndexGroup
+
\begin{Declaration}%
\Macro{settime}\Parameter{time}
\end{Declaration}%
-\BeginIndex{Cmd}{settime}%
-\Macro{settime} sets the output of \Macro{thistime} and
-\Macro{thistime*} to the value \PName{time}. Now the optional
-parameter of \Macro{thistime} or \Macro{thistime*} is ignored, since
-the result of \Macro{thistime} or \Macro{thistime*} was completely
+\Macro{settime} sets the output of \DescRef{scrtime.cmd.thistime} and
+\DescRef{scrtime.cmd.thistime*} to the value \PName{time}. Now the optional
+parameter of \DescRef{scrtime.cmd.thistime} or \DescRef{scrtime.cmd.thistime*} is ignored, since
+the result of \DescRef{scrtime.cmd.thistime} or \DescRef{scrtime.cmd.thistime*} was completely
determined using \Macro{settime}.%
-\EndIndex{Cmd}{settime}
+\EndIndexGroup
+
\begin{Declaration}
- \KOption{12h}\PName{simple-switch}%
+ \OptionVName{12h}{simple-switch}%
\end{Declaration}%
-\BeginIndex{Option}{12h~=\PName{simple switch}}%
\BeginIndex{Option}{24h}%
With option \Option{12h}\ChangedAt{v3.05a}{\Package{scrtime}} one can select
-whether the result of \Macro{thistime} and \Macro{thistime*} is in 12- or in
+whether the result of \DescRef{scrtime.cmd.thistime} and \DescRef{scrtime.cmd.thistime*} is in 12- or in
24-hour format. The option understands the values for simple-switch listed in
\autoref{tab:truefalseswitch}, \autopageref{tab:truefalseswitch}. The option
without a value is same like \OptionValue{12h}{true} and therefore
12-hour-format will be used. The default is \Option{24h}.
You may use this option either as a global option in the optional argument of
-\Macro{documentclass}, as a package option in the optional argument of
-\Macro{usepackage} or after loading the package using \Macro{KOMAoptions} or
-\Macro{KOMAoption} (see, e.\,g., \autoref{sec:typearea.options},
-\autopageref{desc:typearea.cmd.KOMAoptions}). The option has no effect on the
-results of \Macro{thistime} and \Macro{thistime*} if \Macro{settime} is used.
+\DescRef{typearea.cmd.documentclass}, as a package option in the optional
+argument of \DescRef{typearea.cmd.usepackage} or after loading the package
+using \DescRef{typearea.cmd.KOMAoptions} or \DescRef{typearea.cmd.KOMAoption}
+(see, e.\,g., \autoref{sec:typearea.options},
+\DescPageRef{typearea.cmd.KOMAoptions}). The option has no effect on the
+results of \DescRef{scrtime.cmd.thistime} and \DescRef{scrtime.cmd.thistime*}
+if \DescRef{scrtime.cmd.settime} is used.
Only\textnote{Attention!} for compatibility with former releases of
\Package{scrtime} also option \Option{24h} will switch to 24-hour format if
used in the optional argument of \Macro{documentclass} or
\Macro{usepackage}. Nevertheless, you should not use this option any longer.%
-\EndIndex{Option}{24h}%
-\EndIndex{Option}{12h~=\PName{simple switch}}%
+\EndIndexGroup
%
-\EndIndex{Package}{scrtime}
+\EndIndexGroup
\endinput