summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/denisbdoc/denisbdoc.dtx
diff options
context:
space:
mode:
Diffstat (limited to 'macros/latex/contrib/denisbdoc/denisbdoc.dtx')
-rw-r--r--macros/latex/contrib/denisbdoc/denisbdoc.dtx227
1 files changed, 205 insertions, 22 deletions
diff --git a/macros/latex/contrib/denisbdoc/denisbdoc.dtx b/macros/latex/contrib/denisbdoc/denisbdoc.dtx
index 36172e6df8..2a6d7d057b 100644
--- a/macros/latex/contrib/denisbdoc/denisbdoc.dtx
+++ b/macros/latex/contrib/denisbdoc/denisbdoc.dtx
@@ -3,13 +3,13 @@
\iffalse
%</internal>
%<*readme>
-denisbdoc - A personal package for documenting classes and packages, v. 0.9.2
+denisbdoc - A personal package for documenting classes and packages, v. 0.9.4
=============================================================================
**The sole purpose of this (quick 'n dirty) `denisbdoc` package is for
documenting the classes written by their author (Denis Bitouzé).**
-The class is supplied in `.dtx` format. If you want to unpack the `.dtx`
+The package is supplied in `.dtx` format. If you want to unpack the `.dtx`
yourself, running:
tex denisbdoc.dtx
@@ -18,6 +18,131 @@ will extract the package.
This package is currently not documented.
%</readme>
+%<*ctanomat>
+% This is a description file for ctan-o-mat.
+% It manages uploads of a package to
+% CTAN -- the Comprehensive TeX Archive Network.
+%
+% The syntax is roughly oriented towards (La)TeX.
+% Two form of the macros are used. The simple macros take one argument
+% in braces. Here the argument may not contain embedded macros.
+%
+% The second form uses an environment enclosed in \begin{}/\end{}.
+% In the long text fields logo macros can be used.
+%
+% You should enter your values between the begin and the end of the
+% named type.
+% -------------------------------------------------------------------------
+% This field contains the CTAN id of the package.
+% The value is optional.
+% The value is restricted to 32 characters.
+\pkg{denisbdoc}
+% -------------------------------------------------------------------------
+% This field contains the version of the package.
+% The value is optional.
+% The value is restricted to 32 characters.
+\version{0.9.4 2022-06-13}
+% -------------------------------------------------------------------------
+% This field contains the name of the author(s).
+% The value is optional.
+% The value is restricted to 128 characters.
+\author{Denis Bitouzé}
+% -------------------------------------------------------------------------
+% This field contains the email address of the uploader.
+% The value is an email address.
+% The value is restricted to 255 characters.
+\email{denis.bitouze@univ-littoral.fr}
+% -------------------------------------------------------------------------
+% This field contains the name of the uploader.
+% The value is restricted to 255 characters.
+\uploader{Denis Bitouzé}
+% -------------------------------------------------------------------------
+% This field contains the directory on CTAN.
+% The value is optional.
+% The value is restricted to 255 characters.
+\ctanPath{/macros/latex/contrib/denisbdoc}
+% -------------------------------------------------------------------------
+% This field contains the license.
+% The value is optional.
+% The value is restricted to 2048 characters.
+% Multiple values are allowed.
+\license{lppl1.3c}
+% -------------------------------------------------------------------------
+% This field contains the URL of the home page.
+% The value is optional.
+% The value is a URL.
+% The value is restricted to 255 characters.
+% Multiple values are allowed.
+\home{}
+% -------------------------------------------------------------------------
+% This field contains the URL of the bug tracker.
+% The value is optional.
+% The value is a URL.
+% The value is restricted to 255 characters.
+% Multiple values are allowed.
+\bugtracker{}
+% -------------------------------------------------------------------------
+% This field contains the support channel.
+% The value is optional.
+% The value is a URL.
+% The value is restricted to 255 characters.
+% Multiple values are allowed.
+\support{}
+% -------------------------------------------------------------------------
+% This field contains the version management.
+% The value is optional.
+% The value is a URL.
+% The value is restricted to 255 characters.
+% Multiple values are allowed.
+\repository{}
+% -------------------------------------------------------------------------
+% This field contains the developer's channel.
+% The value is optional.
+% The value is a URL.
+% The value is restricted to 255 characters.
+% Multiple values are allowed.
+\development{}
+% -------------------------------------------------------------------------
+% This field contains the update indicator; true for update.
+% The value is optional.
+% The value is restricted to 8 characters.
+\update{true}
+% -------------------------------------------------------------------------
+% This field contains the topics id.
+% The value is optional.
+% The value is restricted to 1024 characters.
+% Multiple values are allowed.
+\topic{}
+% -------------------------------------------------------------------------
+% This field contains the text for the mail announcement.
+% The value is optional.
+% The value is restricted to 8192 characters.
+\begin{announcement}
+\end{announcement}
+% -------------------------------------------------------------------------
+% This field contains the one-liner for the package.
+% The value is optional.
+% The value is restricted to 128 characters.
+\summary{A personal dirty package for documenting packages}
+% -------------------------------------------------------------------------
+% This field contains the descriptive abstract for the package.
+% The value is optional.
+% The value is restricted to 4096 characters.
+\begin{description}
+A personal dirty package for documenting packages.
+\end{description}
+% -------------------------------------------------------------------------
+% This field contains the note to the CTAN upload managers.
+% The value is optional.
+% The value is restricted to 2048 characters.
+\begin{note}
+\end{note}
+% -------------------------------------------------------------------------
+% This field contains the archive file.
+% The value is the file name of the archive to be uploaded.
+% It may have a relative or absolute directory.
+\file{../dtx-forge/denisbdoc.zip}
+%</ctanomat>
%<*internal>
\fi
\def\nameofplainTeX{plain}
@@ -31,7 +156,7 @@ This package is currently not documented.
\preamble
-----------------------------------------------------------------------------
denisbdoc --- A personal dirty package for documenting personal classes,
- version 0.9.3
+ version 0.9.4
Maintained by Denis Bitouzé
E-mail: denis.bitouze@univ-littoral.fr
@@ -69,6 +194,11 @@ This work consists of the file denisbdoc.dtx
%</install>
%<install>\endbatchfile
%<*internal>
+\usedir{.}
+\generate{
+ \nopreamble\nopostamble
+ \file{\jobname.pkg}{\from{\jobname.dtx}{ctanomat}}
+}%
\usedir{source/latex/denisbdoc}
\generate{
\file{\jobname.ins}{\from{\jobname.dtx}{install}}
@@ -128,6 +258,7 @@ This work consists of the file denisbdoc.dtx
%\changes{v0.9.1}{2020/10/14}{Further CTAN version}
%\changes{v0.9.2}{2021-10-13}{Further CTAN version}
%\changes{v0.9.3}{2021-12-01}{Further CTAN version}
+%\changes{v0.9.4}{2022-06-13}{Further CTAN version}
%
%\begin{abstract}
% ...
@@ -198,7 +329,7 @@ This work consists of the file denisbdoc.dtx
%
% The usual preliminaries.
% \begin{macrocode}
-\ProvidesExplPackage {denisbdoc} {2021-12-01} {0.9.3}
+\ProvidesExplPackage {denisbdoc} {2022-06-13} {0.9.4}
{A personal package for documenting packages}
% \end{macrocode}
%
@@ -249,7 +380,6 @@ This work consists of the file denisbdoc.dtx
% % to be copied and pasted as they are, and not replaced
% % by "h" and "i"
\RequirePackage[T1]{fontenc}
- \RequirePackage[utf8]{inputenc}
% \end{macrocode}
%
% In order to get rid of the warning "PDF inclusion: multiple pdfs with page
@@ -1403,14 +1533,14 @@ This work consists of the file denisbdoc.dtx
% \renewcommand{\generalname}{Général}%
%
\if@DBD@beamer@not@loaded@
-\ifcsdef{@chapter}{
- \xapptocmd{\@chapter}{%
+\ifcsdef{@chapter}{%
+ \AddToHook{cmd/@chapter/before}{%
\addtocontents{dbwarninglist}{\protect\addvspace{10\p@}}%
\addtocontents{dbremarklist}{\protect\addvspace{10\p@}}%
\addtocontents{dbexamplelist}{\protect\addvspace{10\p@}}%
\addtocontents{dbfaqlist}{\protect\addvspace{10\p@}}%
\addtocontents{dbtablist}{\protect\addvspace{10\p@}}%
- }{}{}
+ }%
}{}
\fi%
%
@@ -1734,9 +1864,15 @@ This work consists of the file denisbdoc.dtx
\texttt{#1}
% \egroup
}
-\ProvideDocumentCommand{\file}{ m }
+\ProvideDocumentCommand{\file}{ s m }
{%
- \_@@_file:n {#1}
+ \IfBooleanT {#1} {
+ \IfLanguageName{french}{fichier~}{}%
+ }
+ \_@@_file:n {#2}
+ \IfBooleanT {#1} {
+ \IfLanguageName{english}{~file}{}%
+ }
}
\NewDocumentCommand{\File}{ m }
{%
@@ -1784,6 +1920,10 @@ This work consists of the file denisbdoc.dtx
{
\_@@_file:n {#1}%
}
+\NewDocumentCommand{\software}{ m }
+{
+ \_@@_file:n {#1}%
+}
\NewDocumentCommand{\texstudio}{ }
{
\program{TeXstudio}
@@ -2095,14 +2235,30 @@ This work consists of the file denisbdoc.dtx
\newunicodechar{⟩}{$\rangle$}
% \end{macrocode}
%
+% Borrowed from the \package{tcolorbox} package:
% \begin{macrocode}
\cs_new_protected:Nn \_@@_meta:nn
{
+ % \bgroup%
+ % \normalfont
+ % \ttfamily%
+ % \itshape%
+ % \textcolor{#1}{$\langle$#2$\rangle$}%
+ % \egroup%
\bgroup%
- \normalfont
- \ttfamily%
- \itshape%
- \textcolor{#1}{$\langle$#2$\rangle$}%
+ \color{#1}%
+ \ensuremath\langle
+ \ifmmode \expandafter \nfss@text \fi
+ {%
+ \meta@font@select
+ \edef\meta@hyphen@restore
+ {\hyphenchar\the\font\the\hyphenchar\font}%
+ \hyphenchar\font\m@ne
+ \language\l@nohyphenation
+ \ttfamily%
+ #2%
+ \meta@hyphen@restore
+ }\ensuremath\rangle
\egroup%
}
\AtBeginDocument{%
@@ -2186,17 +2342,26 @@ This work consists of the file denisbdoc.dtx
% \end{macrocode}
%
% \begin{macrocode}
-\newtcbtheorem[list~inside=dbwarninglist,number~within=\g_@@_number_within_tl,crefname={avertissement}{avertissements}]{dbwarning}{Avertissement}{%
+\IfLanguageName{french}{\tl_const:Nn \c_@@_warning_title_tl {avertissement}}{
+ \IfLanguageName{english}{\tl_const:Nn \c_@@_warning_title_tl {warning}}{}%
+}%
+\newtcbtheorem[list~inside=dbwarninglist,number~within=\g_@@_number_within_tl,crefname={\c_@@_warning_title_tl}{\c_@@_warning_title_tl s}]{dbwarning}{\text_titlecase:n\c_@@_warning_title_tl}{%
colback=red!5!white,
colframe=red!75!black,
dbtcb
}{wa}
-\newtcbtheorem[list~inside=dbexamplelist,number~within=\g_@@_number_within_tl,crefname={exemple}{exemples}]{dbexample}{Exemple}{%
+\IfLanguageName{french}{\tl_const:Nn \c_@@_example_title_tl {exemple}}{
+ \IfLanguageName{english}{\tl_const:Nn \c_@@_example_title_tl {example}}{}%
+}%
+\newtcbtheorem[list~inside=dbexamplelist,number~within=\g_@@_number_within_tl,crefname={\c_@@_example_title_tl}{\c_@@_example_title_tl s}]{dbexample}{\text_titlecase:n\c_@@_example_title_tl}{%
colback=lime!5!white,
colframe=lime!75!black,
dbtcb,
}{ex}
-\newtcbtheorem[list~inside=dbremarklist,number~within=\g_@@_number_within_tl,crefname={remarque}{remarques}]{dbremark}{Remarque}{%
+\IfLanguageName{french}{\tl_const:Nn \c_@@_remark_title_tl {remarque}}{
+ \IfLanguageName{english}{\tl_const:Nn \c_@@_remark_title_tl {remark}}{}%
+}%
+\newtcbtheorem[list~inside=dbremarklist,number~within=\g_@@_number_within_tl,crefname={\c_@@_remark_title_tl}{\c_@@_remark_title_tl s}]{dbremark}{\text_titlecase:n\c_@@_remark_title_tl}{%
colback=cyan!5!white,
colframe=cyan!75!black,
dbtcb
@@ -2207,7 +2372,13 @@ This work consists of the file denisbdoc.dtx
% fontupper=\itshape,
dbtcb
}{faq}
-\newtcbtheorem[list~inside=dbtabularlist,number~within=\g_@@_number_within_tl,crefname={tableau}{tableaux}]{dbtab}{Tableau}{%
+\IfLanguageName{french}{\tl_const:Nn \c_@@_table_title_tl {tableau}}{
+ \IfLanguageName{english}{\tl_const:Nn \c_@@_table_title_tl {table}}{}%
+}%
+\IfLanguageName{french}{\tl_const:Nn \c_@@_tables_title_tl {tableaux}}{
+ \IfLanguageName{english}{\tl_const:Nn \c_@@_tables_title_tl {tables}}{}%
+}%
+\newtcbtheorem[list~inside=dbtabularlist,number~within=\g_@@_number_within_tl,crefname={\c_@@_table_title_tl}{\c_@@_tables_title_tl}]{dbtab}{\text_titlecase:n\c_@@_table_title_tl}{%
colback=purple!5!white,
colframe=purple!75!black,
fontupper=\itshape,
@@ -2590,10 +2761,22 @@ This work consists of the file denisbdoc.dtx
% listing~options={rangebeginprefix=\\,rangeendsuffix=\}}
}%
}%
-\renewcommand*{\tcbdocnew}[1]{\scriptsize\sffamily\textcolor{green!50!black}{\bfseries
-Nouv.~:}~#1}
-\renewcommand*{\tcbdocupdated}[1]{\scriptsize\sffamily\textcolor{blue!75!black}{\bfseries
-\textsc{m.-à-j.}~:}~#1}
+\tl_const:Nn \c_@@_updated_style_tl {\scriptsize\sffamily\color{green!50!black}\bfseries}
+\tl_const:Nn \c_@@_new_style_tl {\scriptsize\sffamily\color{blue!75!black}\bfseries}
+\IfLanguageName{french}{
+ \tcbset{doclang/updated={\c_@@_updated_style_tl M.~ à~ j.}\normalcolor\normalfont}
+}{
+ \tcbset{doclang/updated=\c_@@_updated_style_tl Updated\normalcolor\normalfont}
+}%
+\IfLanguageName{french}{
+ \tcbset{doclang/new=\c_@@_new_style_tl Nouv.\normalcolor\normalfont}
+}{
+ \tcbset{doclang/new=\c_@@_new_style_tl New\normalcolor\normalfont}
+}%
+% \IfLanguageName{french}{}{
+% \renewcommand*{\tcbdocupdated}[1]{\scriptsize\sffamily\textcolor{blue!75!black}{\bfseries%
+% \textsc{m.-à-j.}~:}~#1}
+% }%
%
\lstset{style=dbtex}
\sys_if_engine_pdftex:TF