path: root/Master/texmf-dist/source/latex/datetime2-latin/datetime2-latin.dtx

%\iffalse
%<*package>
%% \CharacterTable
%%  {Upper-case    \A\B\C\D\E\F\G\H\I\J\K\L\M\N\O\P\Q\R\S\T\U\V\W\X\Y\Z
%%   Lower-case    \a\b\c\d\e\f\g\h\i\j\k\l\m\n\o\p\q\r\s\t\u\v\w\x\y\z
%%   Digits        \0\1\2\3\4\5\6\7\8\9
%%   Exclamation   \!     Double quote  \"     Hash (number) \#
%%   Dollar        \$     Percent       \%     Ampersand     \&
%%   Acute accent  \'     Left paren    \(     Right paren   \)
%%   Asterisk      \*     Plus          \+     Comma         \,
%%   Minus         \-     Point         \.     Solidus       \/
%%   Colon         \:     Semicolon     \;     Less than     \<
%%   Equals        \=     Greater than  \>     Question mark \?
%%   Commercial at \@     Left bracket  \[     Backslash     \\
%%   Right bracket \]     Circumflex    \^     Underscore    \_
%%   Grave accent  \`     Left brace    \{     Vertical bar  \|
%%   Right brace   \}     Tilde         \~}
%</package>
%\fi
% \iffalse
% Doc-Source file to use with LaTeX2e
% Copyright (C) 2018 Nicola Talbot, all rights reserved.
% (New maintainer add relevant lines here.)
% \fi
% \iffalse
%<*driver>
\documentclass{ltxdoc}

\usepackage{alltt}
\usepackage{graphicx}
\usepackage[utf8]{inputenc}
\usepackage[T1]{fontenc}
\usepackage[colorlinks,
            bookmarks,
            hyperindex=false,
            pdfauthor={Nicola L.C. Talbot},
            pdftitle={datetime2.sty Latin Module}]{hyperref}


\CheckSum{212}

\renewcommand*{\usage}[1]{\hyperpage{#1}}
\renewcommand*{\main}[1]{\hyperpage{#1}}
\IndexPrologue{\section*{\indexname}\markboth{\indexname}{\indexname}}
\setcounter{IndexColumns}{2}

\newcommand*{\sty}[1]{\textsf{#1}}
\newcommand*{\opt}[1]{\texttt{#1}\index{#1=\texttt{#1}|main}}

\RecordChanges
\PageIndex
\CodelineNumbered

\begin{document}
\DocInput{datetime2-latin.dtx}
\end{document}
%</driver>
%\fi
%
%\MakeShortVerb{"}
%
%\title{Latin Module for datetime2 Package}
%\author{Nicola L. C. Talbot (inactive)}
%\date{2018-05-18 (v1.1)}
%\maketitle
%
%This module is currently unmaintained and may be subject to change.
%If you want to volunteer to take over maintanance, contact me at
%\url{http://www.dickimaw-books.com/contact.html}
%
%\begin{abstract}
%This is the Latin language module for the \sty{datetime2}
%package. If you want to use the settings in this module you must
%install it in addition to installing \sty{datetime2}. If you use
%\sty{babel} or \sty{polyglossia}, you will need this module to
%prevent them from redefining \cs{today}. The \sty{datetime2}
% \opt{useregional} setting must be set to "text" or "numeric"
% for the language styles to be set.
% Alternatively, you can set the style in the document using
% \cs{DTMsetstyle}, but this may be changed by \cs{date}\meta{language}
% depending on the value of the \opt{useregional} setting.
%\end{abstract}
%
%I've copied the date style from \texttt{babel-latin}'s \cs{today}.
%This is different from \sty{polyglossia}'s Latin \cs{today} so
%there's a check to see if \sty{polyglossia} has been loaded to make
%the styles match.
%
%I don't know if these settings are correct.
%In particular, I don't know if the "latin" time style is
%correct. Currently this just uses the "default" time style. Please
%be aware that this may change. Whoever takes over maintanance
%of this module may can change it as appropriate.
%
%The new maintainer should add the line:
%\begin{verbatim}
% The Current Maintainer of this work is Name.
%\end{verbatim}
%to the preamble part in \texttt{datetime2-latin.ins} where Name
%is the name of the maintainer(s) and replace
%the `inactive' status to `maintained'.
%
%Currently there is only a regionless style.
%
%\StopEventually{%
%\clearpage
%\phantomsection
%\addcontentsline{toc}{section}{Change History}%
%\PrintChanges
%\addcontentsline{toc}{section}{\indexname}%
%\PrintIndex}
%\section{The Code}
%At the moment there is only the one ".ldf" file.
%
%\subsection{Main Latin Module (\texttt{datetime2-latin.ldf})}
%\changes{1.0}{2015-03-31}{Initial release}
%
%\iffalse
%    \begin{macrocode}
%<*datetime2-latin.ldf>
%    \end{macrocode}
%\fi
%
% Identify Module
%    \begin{macrocode}
\ProvidesDateTimeModule{latin}[2018/05/18 v1.1]
%    \end{macrocode}
%
%\begin{macro}{\DTMlatindatefont}
%\sty{polyglossia} version doesn't implement a font change.
%    \begin{macrocode}
\@ifpackageloaded{polyglossia}
{
  \newcommand*{\DTMlatindayfont}[1]{#1}
}
{
%    \end{macrocode}
%This will need protecting.
%    \begin{macrocode}
  \newcommand*{\DTMlatindayfont}[1]{%
    {\check@mathfonts\fontsize\sf@size\z@\math@fontsfalse\selectfont#1}%
  }
}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMlatinordinal}
%    \begin{macrocode}
\newcommand*{\DTMlatinordinal}[1]{%
  \DTMtexorpdfstring
  {%
    \protect\DTMlatindayfont{\uppercase\expandafter{\romannumeral#1}}%
  }%
  {\romannumeral#1 }%
}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMlatinyear}
%    \begin{macrocode}
\newcommand*{\DTMlatinyear}[1]{%
  \DTMtexorpdfstring
  {%
    \uppercase\expandafter{\romannumeral#1}%
  }%
  {\romannumeral#1 }%
}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMlatinmonthname}
% Latin month names.
%    \begin{macrocode}
\@ifpackageloaded{polyglossia}
{
%    \end{macrocode}
% Match \sty{polyglossia} month names:
%    \begin{macrocode}
  \newcommand*{\DTMlatinmonthname}[1]{%
    \ifcase#1
    \or
    Januarii%
    \or
    Februarii%
    \or
    Martii%
    \or
    Aprilis%
    \or
    Maji%
    \or
    Junii%
    \or
    Julii%
    \or
    Augusti%
    \or
    Septembris%
    \or
    Octobris%
    \or
    Novembris%
    \or
    Decembris%
    \fi
  }
}
{
%    \end{macrocode}
% Match \sty{babel} month names:
%    \begin{macrocode}
  \newcommand*{\DTMlatinmonthname}[1]{%
    \ifcase#1
    \or
    Ianuarii%
    \or
    Februarii%
    \or
    Martii%
    \or
    Aprilis%
    \or
    Maii%
    \or
    Iunii%
    \or
    Iulii%
    \or
    Augusti%
    \or
    Septembris%
    \or
    Octobris%
    \or
    Novembris%
    \or
    Decembris%
    \fi
  }
}
%    \end{macrocode}
%\end{macro}
%
%
% Define the \texttt{latin} style.
% The time style is the same as the "default" style
% provided by \sty{datetime2}. This may need correcting. 
%
% Allow the user a way of configuring the "latin" and
% "latin-numeric" styles. This doesn't use the package wide
% separators such as
% \cs{dtm@datetimesep} in case other date formats are also required.
%\begin{macro}{\DTMlatindaymonthsep}
% The separator between the day and month for the text format.
%    \begin{macrocode}
\newcommand*{\DTMlatindaymonthsep}{\space}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMlatinmonthyearsep}
% The separator between the month and year for the text format.
%    \begin{macrocode}
\newcommand*{\DTMlatinmonthyearsep}{\space}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMlatindatetimesep}
% The separator between the date and time blocks in the full format
% (either text or numeric).
%    \begin{macrocode}
\newcommand*{\DTMlatindatetimesep}{\space}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMlatintimezonesep}
% The separator between the time and zone blocks in the full format
% (either text or numeric).
%    \begin{macrocode}
\newcommand*{\DTMlatintimezonesep}{\space}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMlatindatesep}
% The separator for the numeric date format.
%    \begin{macrocode}
\newcommand*{\DTMlatindatesep}{/}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMlatintimesep}
% The separator for the numeric time format.
%    \begin{macrocode}
\newcommand*{\DTMlatintimesep}{:}
%    \end{macrocode}
%\end{macro}
%
%Provide keys that can be used in \cs{DTMlangsetup} to set these
%separators.
%    \begin{macrocode}
\DTMdefkey{latin}{daymonthsep}{\renewcommand*{\DTMlatindaymonthsep}{#1}}
\DTMdefkey{latin}{monthyearsep}{\renewcommand*{\DTMlatinmonthyearsep}{#1}}
\DTMdefkey{latin}{datetimesep}{\renewcommand*{\DTMlatindatetimesep}{#1}}
\DTMdefkey{latin}{timezonesep}{\renewcommand*{\DTMlatintimezonesep}{#1}}
\DTMdefkey{latin}{datesep}{\renewcommand*{\DTMlatindatesep}{#1}}
\DTMdefkey{latin}{timesep}{\renewcommand*{\DTMlatintimesep}{#1}}
%    \end{macrocode}
%
% TODO: provide a boolean key to switch between full and abbreviated
% formats if appropriate. (I don't know how the date should be
% abbreviated.)
%
% Define a boolean key that determines if the time zone mappings
% should be used.
%    \begin{macrocode}
\DTMdefboolkey{latin}{mapzone}[true]{}
%    \end{macrocode}
% The default is to use mappings.
%    \begin{macrocode}
\DTMsetbool{latin}{mapzone}{true}
%    \end{macrocode}
%
% Define a boolean key that determines if the day of month should be
% displayed.
%    \begin{macrocode}
\DTMdefboolkey{latin}{showdayofmonth}[true]{}
%    \end{macrocode}
% The default is to show the day of month.
%    \begin{macrocode}
\DTMsetbool{latin}{showdayofmonth}{true}
%    \end{macrocode}
%
% Define a boolean key that determines if the year should be
% displayed.
%    \begin{macrocode}
\DTMdefboolkey{latin}{showyear}[true]{}
%    \end{macrocode}
% The default is to show the year.
%    \begin{macrocode}
\DTMsetbool{latin}{showyear}{true}
%    \end{macrocode}
%
% Define the "latin" style. (TODO: implement day of week?)
%    \begin{macrocode}
\DTMnewstyle
 {latin}% label
 {% date style
   \renewcommand*\DTMdisplaydate[4]{%
     \DTMifbool{latin}{showdayofmonth}
     {\DTMlatinordinal{##3}\DTMlatindaymonthsep}%
     {}%
     \DTMlatinmonthname{##2}%
     \DTMifbool{latin}{showyear}%
     {%
       \DTMlatinmonthyearsep
       \DTMlatinyear{##1}%
     }%
     {}%
   }%
   \renewcommand*\DTMDisplaydate{\DTMdisplaydate}%
 }%
 {% time style (use default)
   \DTMsettimestyle{default}%
 }%
 {% zone style
   \DTMresetzones
   \DTMlatinzonemaps
   \renewcommand*{\DTMdisplayzone}[2]{%
     \DTMifbool{latin}{mapzone}%
     {\DTMusezonemapordefault{##1}{##2}}%
     {%
       \ifnum##1<0\else+\fi\DTMtwodigits{##1}%
       \ifDTMshowzoneminutes\DTMlatintimesep\DTMtwodigits{##2}\fi
     }%
   }%
 }%
 {% full style
   \renewcommand*{\DTMdisplay}[9]{%
    \ifDTMshowdate
     \DTMdisplaydate{##1}{##2}{##3}{##4}%
     \DTMlatindatetimesep
    \fi
    \DTMdisplaytime{##5}{##6}{##7}%
    \ifDTMshowzone
     \DTMlatintimezonesep
     \DTMdisplayzone{##8}{##9}%
    \fi
   }%
   \renewcommand*{\DTMDisplay}{\DTMdisplay}%
 }%
%    \end{macrocode}
%
% Define numeric style.
%    \begin{macrocode}
\DTMnewstyle
 {latin-numeric}% label
 {% date style
    \renewcommand*\DTMdisplaydate[4]{%
      \DTMifbool{latin}{showdayofmonth}%
      {%
        \number##3 % space intended
        \DTMlatindatesep
      }%
      {}%
      \number##2 % space intended
      \DTMifbool{latin}{showyear}%
      {%
        \DTMlatindatesep
        \number##1 % space intended
      }%
      {}%
    }%
    \renewcommand*{\DTMDisplaydate}{\DTMdisplaydate}%
 }%
 {% time style
    \renewcommand*\DTMdisplaytime[3]{%
      \number##1
      \DTMlatintimesep\DTMtwodigits{##2}%
      \ifDTMshowseconds\DTMlatintimesep\DTMtwodigits{##3}\fi
    }%
 }%
 {% zone style
   \DTMresetzones
   \DTMlatinzonemaps
   \renewcommand*{\DTMdisplayzone}[2]{%
     \DTMifbool{latin}{mapzone}%
     {\DTMusezonemapordefault{##1}{##2}}%
     {%
       \ifnum##1<0\else+\fi\DTMtwodigits{##1}%
       \ifDTMshowzoneminutes\DTMlatintimesep\DTMtwodigits{##2}\fi
     }%
   }%
 }%
 {% full style
   \renewcommand*{\DTMdisplay}[9]{%
    \ifDTMshowdate
     \DTMdisplaydate{##1}{##2}{##3}{##4}%
     \DTMlatindatetimesep
    \fi
    \DTMdisplaytime{##5}{##6}{##7}%
    \ifDTMshowzone
     \DTMlatintimezonesep
     \DTMdisplayzone{##8}{##9}%
    \fi
   }%
   \renewcommand*{\DTMDisplay}{\DTMdisplay}%
 }
%    \end{macrocode}
%
%\begin{macro}{\DTMlatinzonemaps}
% The time zone mappings are set through this command, which can be
% redefined if extra mappings are required or mappings need to be
% removed. This currently has no mappings.
%    \begin{macrocode}
\newcommand*{\DTMlatinzonemaps}{%
}
%    \end{macrocode}
%\end{macro}

% Switch style according to the \opt{useregional} setting.
%    \begin{macrocode}
\DTMifcaseregional
{}% do nothing
{\DTMsetstyle{latin}}
{\DTMsetstyle{latin-numeric}}
%    \end{macrocode}
%
% Redefine \cs{datelatin} (or \cs{date}\meta{dialect}) to prevent
% \sty{babel} from resetting \cs{today}. (For this to work,
% \sty{babel} must already have been loaded if it's required.)
%\changes{1.1}{2018-05-18}{removed spurious space}
%    \begin{macrocode}
\ifcsundef{date\CurrentTrackedDialect}
{%
  \ifundef\datelatin
  {% do nothing
  }%
  {%
    \def\datelatin{%
      \DTMifcaseregional
      {}% do nothing
      {\DTMsetstyle{latin}}%
      {\DTMsetstyle{latin-numeric}}%
    }%
  }%
}%
{%
  \csdef{date\CurrentTrackedDialect}{%
    \DTMifcaseregional
    {}% do nothing
    {\DTMsetstyle{latin}}%
    {\DTMsetstyle{latin-numeric}}%
  }%
}%
%    \end{macrocode}
%\iffalse
%    \begin{macrocode}
%</datetime2-latin.ldf>
%    \end{macrocode}
%\fi
%\Finale
\endinput