path: root/Master/texmf-dist/source/latex/datetime2-breton/datetime2-breton.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) 2015-2019 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 Breton Module}]{hyperref}


\CheckSum{252}

\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-breton.dtx}
\end{document}
%</driver>
%\fi
%
%\MakeShortVerb{"}
%
%\title{Breton Module for datetime2 Package}
%\author{Nicola L. C. Talbot (inactive)}
%\date{2019-11-05 (v1.2)}
%\maketitle
%
%This module is currently unmaintained and may be subject to change.
%If you want to volunteer to take over maintenance, contact me at
%\url{http://www.dickimaw-books.com/contact.html}
%
%\begin{abstract}
%This is the Breton 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-breton}'s \cs{today}.
%
%I don't know if these settings are correct as I can't speak Breton.
%In particular, I don't know if the "breton" time style is
%correct. Currently this just uses the "default" time style. Please
%be aware that this may change. Whoever takes over maintenance
%of this module may 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-breton.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}
%\iffalse
%    \begin{macrocode}
%<*datetime2-breton-utf8.ldf>
%    \end{macrocode}
%\fi
%\subsection{UTF-8}
%This file contains the settings that use UTF-8 characters. This
%file is loaded if XeLaTeX or LuaLaTeX are used. Please make sure
%your text editor is set to UTF-8 if you want to view this code.
%\changes{1.0}{2015-03-29}{Initial release}
% Identify module
%    \begin{macrocode}
\ProvidesDateTimeModule{breton-utf8}[2019/11/05 v1.2]
%    \end{macrocode}
%\begin{macro}{\DTMbretonordinal}
%    \begin{macrocode}
\newcommand*{\DTMbretonordinal}[1]{%
  \number#1
  \ifnum#1=1 
   \DTMbretonfmtordinal{añ}%
  \fi
}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMbretonfmtordinal}
%    \begin{macrocode}
\newcommand*{\DTMbretonfmtordinal}[1]{%
  \DTMtexorpdfstring{\protect\/\protect\textsuperscript{#1}}{#1}%
}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMbretonmonthname}
% Breton month names.
%    \begin{macrocode}
\newcommand*{\DTMbretonmonthname}[1]{%
  \ifcase#1
  \or
  Genver%
  \or
  C'hwevrer%
  \or
  Meurzh%
  \or
  Ebrel%
  \or
  Mae%
  \or
  Mezheven%
  \or
  Gouere%
  \or
  Eost%
  \or
  Gwengolo%
  \or
  Here%
  \or
  Du%
  \or
  Kerzu%
  \fi
}
%    \end{macrocode}
%\end{macro}
%
%If abbreviated dates are supported, short month names should be
%likewise provided.
%
%\iffalse
%    \begin{macrocode}
%</datetime2-breton-utf8.ldf>
%    \end{macrocode}
%\fi
%\iffalse
%    \begin{macrocode}
%<*datetime2-breton-ascii.ldf>
%    \end{macrocode}
%\fi
%\subsection{ASCII}
%This file contains the settings that use \LaTeX\ commands for
%non-ASCII characters. This should be input if neither XeLaTeX nor
%LuaLaTeX are used. Even if the user has loaded \sty{inputenc} with
%"utf8", this file should still be used not the
%\texttt{datetime2-breton-utf8.ldf} file as the non-ASCII
%characters are made active in that situation and would need
%protecting against expansion.
%\changes{1.0}{2015-03-29}{Initial release}
% Identify module
%    \begin{macrocode}
\ProvidesDateTimeModule{breton-ascii}[2019/11/05 v1.2]
%    \end{macrocode}
%
%If abbreviated dates are supported, short month names should be
%likewise provided.
%\begin{macro}{\DTMbretonordinal}
%    \begin{macrocode}
\newcommand*{\DTMbretonordinal}[1]{%
  \number#1
  \ifnum#1=1 
   \DTMbretonfmtordsuffix{a\protect\~{n}}%
  \fi
}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMbretonfmtordsuffix}
%    \begin{macrocode}
\newcommand*{\DTMbretonfmtordsuffix}[1]{%
  \DTMtexorpdfstring{\protect\/\protect\textsuperscript{#1}}{#1}%
}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMbretonmonthname}
% Breton month names.
%    \begin{macrocode}
\newcommand*{\DTMbretonmonthname}[1]{%
  \ifcase#1
  \or
  Genver%
  \or
  C'hwevrer%
  \or
  Meurzh%
  \or
  Ebrel%
  \or
  Mae%
  \or
  Mezheven%
  \or
  Gouere%
  \or
  Eost%
  \or
  Gwengolo%
  \or
  Here%
  \or
  Du%
  \or
  Kerzu%
  \fi
}
%    \end{macrocode}
%\end{macro}
%
%\iffalse
%    \begin{macrocode}
%</datetime2-breton-ascii.ldf>
%    \end{macrocode}
%\fi
%
%\subsection{Main Breton Module (\texttt{datetime2-breton.ldf})}
%\changes{1.0}{2015-03-29}{Initial release}
%
%\iffalse
%    \begin{macrocode}
%<*datetime2-breton.ldf>
%    \end{macrocode}
%\fi
%
% Identify Module
%    \begin{macrocode}
\ProvidesDateTimeModule{breton}[2019/11/05 v1.2]
%    \end{macrocode}
% Need to find out if XeTeX or LuaTeX are being used.
%    \begin{macrocode}
\RequirePackage{ifxetex,ifluatex}
%    \end{macrocode}
% XeTeX and LuaTeX natively support UTF-8, so load
% \texttt{breton-utf8} if either of those engines are used
% otherwise load \texttt{breton-ascii}.
%    \begin{macrocode}
\ifxetex
 \RequireDateTimeModule{breton-utf8}
\else
 \ifluatex
   \RequireDateTimeModule{breton-utf8}
 \else
   \RequireDateTimeModule{breton-ascii}
 \fi
\fi
%    \end{macrocode}
%
% Define the \texttt{breton} style.
% The time style is the same as the "default" style
% provided by \sty{datetime2}. This may need correcting. For
% example, if a 12 hour style similar to the "englishampm" (from the
% "english-base" module) is required. 
%
% Allow the user a way of configuring the "breton" and
% "breton-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}{\DTMbretondaymonthsep}
% The separator between the day and month for the text format.
%    \begin{macrocode}
\newcommand*{\DTMbretondaymonthsep}{\space a\space viz\space}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMbretonmonthyearsep}
% The separator between the month and year for the text format.
%    \begin{macrocode}
\newcommand*{\DTMbretonmonthyearsep}{\space}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMbretondatetimesep}
% The separator between the date and time blocks in the full format
% (either text or numeric).
%    \begin{macrocode}
\newcommand*{\DTMbretondatetimesep}{\space}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMbretontimezonesep}
% The separator between the time and zone blocks in the full format
% (either text or numeric).
%    \begin{macrocode}
\newcommand*{\DTMbretontimezonesep}{\space}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMbretondatesep}
% The separator for the numeric date format.
%    \begin{macrocode}
\newcommand*{\DTMbretondatesep}{/}
%    \end{macrocode}
%\end{macro}
%
%\begin{macro}{\DTMbretontimesep}
% The separator for the numeric time format.
%    \begin{macrocode}
\newcommand*{\DTMbretontimesep}{:}
%    \end{macrocode}
%\end{macro}
%
%Provide keys that can be used in \cs{DTMlangsetup} to set these
%separators.
%    \begin{macrocode}
\DTMdefkey{breton}{daymonthsep}{\renewcommand*{\DTMbretondaymonthsep}{#1}}
\DTMdefkey{breton}{monthyearsep}{\renewcommand*{\DTMbretonmonthyearsep}{#1}}
\DTMdefkey{breton}{datetimesep}{\renewcommand*{\DTMbretondatetimesep}{#1}}
\DTMdefkey{breton}{timezonesep}{\renewcommand*{\DTMbretontimezonesep}{#1}}
\DTMdefkey{breton}{datesep}{\renewcommand*{\DTMbretondatesep}{#1}}
\DTMdefkey{breton}{timesep}{\renewcommand*{\DTMbretontimesep}{#1}}
%    \end{macrocode}
%
% Define a setting to change the ordinal suffix style.
%\changes{1.2}{2019-11-05}{renamed scratch variables to avoid conflict}
%    \begin{macrocode}
\DTMdefchoicekey{breton}{ord}[\@dtm@val\@dtm@nr]{level,raise,omit,sc}{%
 \ifcase\@dtm@nr\relax
   \renewcommand*{\DTMbretonfmtordsuffix}[1]{##1}%
 \or
   \renewcommand*{\DTMbretonfmtordsuffix}[1]{%
    \DTMtexorpdfstring{\protect\textsuperscript{##1}}{##1}}%
 \or
   \renewcommand*{\DTMbretonfmtordsuffix}[1]{}%
 \or
   \renewcommand*{\DTMbretonfmtordsuffix}[1]{%
    \DTMtexorpdfstring{\protect\textsc{##1}}{##1}}%
 \fi
}
%    \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{breton}{mapzone}[true]{}
%    \end{macrocode}
% The default is to use mappings.
%    \begin{macrocode}
\DTMsetbool{breton}{mapzone}{true}
%    \end{macrocode}
%
% Define a boolean key that determines if the day of month should be
% displayed.
%    \begin{macrocode}
\DTMdefboolkey{breton}{showdayofmonth}[true]{}
%    \end{macrocode}
% The default is to show the day of month.
%    \begin{macrocode}
\DTMsetbool{breton}{showdayofmonth}{true}
%    \end{macrocode}
%
% Define a boolean key that determines if the year should be
% displayed.
%    \begin{macrocode}
\DTMdefboolkey{breton}{showyear}[true]{}
%    \end{macrocode}
% The default is to show the year.
%    \begin{macrocode}
\DTMsetbool{breton}{showyear}{true}
%    \end{macrocode}
%
% Define the "breton" style. (TODO: implement day of week?)
%    \begin{macrocode}
\DTMnewstyle
 {breton}% label
 {% date style
   \renewcommand*\DTMdisplaydate[4]{%
     \DTMifbool{breton}{showdayofmonth}
     {\DTMbretonordinal{##3}\DTMbretondaymonthsep}%
     {}%
     \DTMbretonmonthname{##2}%
     \DTMifbool{breton}{showyear}%
     {%
       \DTMbretonmonthyearsep
       \number##1 % space intended
     }%
     {}%
   }%
   \renewcommand*\DTMDisplaydate{\DTMdisplaydate}%
 }%
 {% time style (use default)
   \DTMsettimestyle{default}%
 }%
 {% zone style
   \DTMresetzones
   \DTMbretonzonemaps
   \renewcommand*{\DTMdisplayzone}[2]{%
     \DTMifbool{breton}{mapzone}%
     {\DTMusezonemapordefault{##1}{##2}}%
     {%
       \ifnum##1<0 \else+\fi\DTMtwodigits{##1}%
       \ifDTMshowzoneminutes\DTMbretontimesep\DTMtwodigits{##2}\fi
     }%
   }%
 }%
 {% full style
   \renewcommand*{\DTMdisplay}[9]{%
    \ifDTMshowdate
     \DTMdisplaydate{##1}{##2}{##3}{##4}%
     \DTMbretondatetimesep
    \fi
    \DTMdisplaytime{##5}{##6}{##7}%
    \ifDTMshowzone
     \DTMbretontimezonesep
     \DTMdisplayzone{##8}{##9}%
    \fi
   }%
   \renewcommand*{\DTMDisplay}{\DTMdisplay}%
 }%
%    \end{macrocode}
%
% Define numeric style.
%    \begin{macrocode}
\DTMnewstyle
 {breton-numeric}% label
 {% date style
    \renewcommand*\DTMdisplaydate[4]{%
      \DTMifbool{breton}{showdayofmonth}%
      {%
        \number##3 % space intended
        \DTMbretondatesep
      }%
      {}%
      \number##2 % space intended
      \DTMifbool{breton}{showyear}%
      {%
        \DTMbretondatesep
        \number##1 % space intended
      }%
      {}%
    }%
    \renewcommand*{\DTMDisplaydate}[4]{\DTMdisplaydate{##1}{##2}{##3}{##4}}%
 }%
 {% time style
    \renewcommand*\DTMdisplaytime[3]{%
      \number##1 % space intended
      \DTMbretontimesep\DTMtwodigits{##2}%
      \ifDTMshowseconds\DTMbretontimesep\DTMtwodigits{##3}\fi
    }%
 }%
 {% zone style
   \DTMresetzones
   \DTMbretonzonemaps
   \renewcommand*{\DTMdisplayzone}[2]{%
     \DTMifbool{breton}{mapzone}%
     {\DTMusezonemapordefault{##1}{##2}}%
     {%
       \ifnum##1<0 \else+\fi\DTMtwodigits{##1}%
       \ifDTMshowzoneminutes\DTMbretontimesep\DTMtwodigits{##2}\fi
     }%
   }%
 }%
 {% full style
   \renewcommand*{\DTMdisplay}[9]{%
    \ifDTMshowdate
     \DTMdisplaydate{##1}{##2}{##3}{##4}%
     \DTMbretondatetimesep
    \fi
    \DTMdisplaytime{##5}{##6}{##7}%
    \ifDTMshowzone
     \DTMbretontimezonesep
     \DTMdisplayzone{##8}{##9}%
    \fi
   }%
   \renewcommand*{\DTMDisplay}{\DTMdisplay}%
 }
%    \end{macrocode}
%
%\begin{macro}{\DTMbretonzonemaps}
% The time zone mappings are set through this command, which can be
% redefined if extra mappings are required or mappings need to be
% removed.
%    \begin{macrocode}
\newcommand*{\DTMbretonzonemaps}{%
  \DTMdefzonemap{01}{00}{CET}%
  \DTMdefzonemap{02}{00}{CEST}%
}
%    \end{macrocode}
%\end{macro}

% Switch style according to the \opt{useregional} setting.
%    \begin{macrocode}
\DTMifcaseregional
{}% do nothing
{\DTMsetstyle{breton}}
{\DTMsetstyle{breton-numeric}}
%    \end{macrocode}
%
% Redefine \cs{datebreton} (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-03-19}{removed spurious space}
%    \begin{macrocode}
\ifcsundef{date\CurrentTrackedDialect}
{%
  \ifundef\datebreton
  {% do nothing
  }%
  {%
    \def\datebreton{%
      \DTMifcaseregional
      {}% do nothing
      {\DTMsetstyle{breton}}%
      {\DTMsetstyle{breton-numeric}}%
    }%
  }%
}%
{%
  \csdef{date\CurrentTrackedDialect}{%
    \DTMifcaseregional
    {}% do nothing
    {\DTMsetstyle{breton}}%
    {\DTMsetstyle{breton-numeric}}%
  }%
}%
%    \end{macrocode}
%\iffalse
%    \begin{macrocode}
%</datetime2-breton.ldf>
%    \end{macrocode}
%\fi
%\Finale
\endinput