diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/denisbdoc')
| -rw-r--r-- | Master/texmf-dist/source/latex/denisbdoc/denisbdoc.dtx | 208 |
1 files changed, 116 insertions, 92 deletions
diff --git a/Master/texmf-dist/source/latex/denisbdoc/denisbdoc.dtx b/Master/texmf-dist/source/latex/denisbdoc/denisbdoc.dtx index 9216617e6bb..36172e6df83 100644 --- a/Master/texmf-dist/source/latex/denisbdoc/denisbdoc.dtx +++ b/Master/texmf-dist/source/latex/denisbdoc/denisbdoc.dtx @@ -31,7 +31,7 @@ This package is currently not documented. \preamble ----------------------------------------------------------------------------- denisbdoc --- A personal dirty package for documenting personal classes, - version 0.9.2 + version 0.9.3 Maintained by Denis Bitouzé E-mail: denis.bitouze@univ-littoral.fr @@ -127,6 +127,7 @@ This work consists of the file denisbdoc.dtx %\changes{v0.9}{2020/05/31}{Nineth CTAN version} %\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} % %\begin{abstract} % ... @@ -197,7 +198,7 @@ This work consists of the file denisbdoc.dtx % % The usual preliminaries. % \begin{macrocode} -\ProvidesExplPackage {denisbdoc} {2021-10-13} {0.9.2} +\ProvidesExplPackage {denisbdoc} {2021-12-01} {0.9.3} {A personal package for documenting packages} % \end{macrocode} % @@ -244,9 +245,9 @@ This work consists of the file denisbdoc.dtx % \begin{macrocode} \sys_if_engine_pdftex:TF { - \RequirePackage{cmap} % Necessary for the angle brackets generated by ×\meta× - % to be copied and pasted as they are, and not replaced - % by "h" and "i" + % \RequirePackage{cmap} % Necessary for the angle brackets generated by ×\meta× + % % to be copied and pasted as they are, and not replaced + % % by "h" and "i" \RequirePackage[T1]{fontenc} \RequirePackage[utf8]{inputenc} % \end{macrocode} @@ -285,7 +286,8 @@ This work consists of the file denisbdoc.dtx \RequirePackage{parskip}% \RequirePackage{marginnote} \RequirePackage{mparhack} - \RequirePackage[inline]{enumitem} + % \RequirePackage[inline]{enumitem} + \RequirePackage{enumitem} \fi% \RequirePackage{afterpage}% \RequirePackage{calc}% @@ -305,7 +307,6 @@ This work consists of the file denisbdoc.dtx }{% \RequirePackage{pdflscape}% } -\RequirePackage{xspace}% \RequirePackage{accsupp} \RequirePackage{newunicodechar} \RequirePackage{hologo}% @@ -1626,6 +1627,14 @@ This work consists of the file denisbdoc.dtx { #2{\sffamily#1} } +\tl_new:N \g_@@_list_word_tl +\IfLanguageName{french}{ + \tl_set:Nn \g_@@_list_word_tl {liste} +}{ + \IfLanguageName{english}{ + \tl_set:Nn \g_@@_list_word_tl {list} + }{}% +}% % The main macro % #1: boolean (true => no hyperlink) % #2: boolean (false => indexation) @@ -1658,9 +1667,9 @@ This work consists of the file denisbdoc.dtx { \tl_if_empty:nTF {#6} { - \index{#5!liste!\textsf{#4}} + \index{#5!\g_@@_list_word_tl!\textsf{#4}} }{ - \index{#5!liste!\textsf{#4}!#6} + \index{#5!\g_@@_list_word_tl!\textsf{#4}!#6} } } } @@ -1693,7 +1702,18 @@ This work consists of the file denisbdoc.dtx class }{}% } +% \end{macrocode} +% % +% % We copy the ×\package×, ×\Package×, ×\class×, ×\Classs×, commands as we used +% % to use ×\pkg×, ×\Pkg×, ×\cls× and ×\Cls× instead in our \file{.dtx}. +% % \begin{macrocode} + % \NewCommandCopy\pkg\package + \NewCommandCopy\Pkg\Package + % \NewCommandCopy\cls\class + \NewCommandCopy\Cls\Class +% % \end{macrocode} % +% \begin{macrocode} \cs_new_protected:Nn \_@@_format:n { \textsc{#1} @@ -1714,7 +1734,7 @@ This work consists of the file denisbdoc.dtx \texttt{#1} % \egroup } -\NewDocumentCommand{\file}{ m } +\ProvideDocumentCommand{\file}{ m } {% \_@@_file:n {#1} } @@ -1755,7 +1775,7 @@ This work consists of the file denisbdoc.dtx % \@ifnextchar.% % { % }{ -% .\xspace +% . % }% % } % } @@ -1989,76 +2009,80 @@ This work consists of the file denisbdoc.dtx % \begin{macrocode} \bool_if:nT {\g_@@_yad_bool} {% % - \zexternaldocument{\c_@@_flatsample_string_tl/these}% - \bool_new:N \g_@@_these_aux_exists% - \msg_new:nnn{denisbdoc}{File~ `\c_@@_these_aux_string_tl'~ needed}{% - File~ `\c_@@_these_aux_string_tl'~ needed~ (otherwise~ this~ document~ will~ - be~ incomplete)!~ Please~ go~ to~ `\c_@@_flatsample_string_tl'~ - directory~ and~ run~ first:\\\\ + \str_if_in:NnT \c_sys_jobname_str { yathesis- } { + \zexternaldocument{\c_@@_flatsample_string_tl/these}% + \bool_new:N \g_@@_these_aux_exists% + \msg_new:nnn{denisbdoc}{File~ `\c_@@_these_aux_string_tl'~ needed}{% + File~ `\c_@@_these_aux_string_tl'~ needed~ (otherwise~ this~ document~ will~ + be~ incomplete)!~ Please~ go~ to~ `\c_@@_flatsample_string_tl'~ + directory~ and~ run~ first:\\\\ - \ \ latexmk~ -g~ -pdf~ -jobname=these~ -pdflatex="pdflatex~ \%O~ \string\ \\ - \ \ '\string\RequirePackage\{etoolbox\}~ \string\ \\ - \ \ \string\AtEndPreamble\{\string\RequirePackage\{yathesis-demo\}\}~ \string\ \\ - \ \ \string\input\{\%S\}'"~ these.tex - \\\\ - Afterwards,~ recompile~ this~ document.% - }% - \file_if_exist:nTF {\c_@@_flatsample_string_tl/\c_@@_these_aux_string_tl} { \bool_gset_true:N - \g_@@_these_aux_exists }{ - % \bool_gset_false:N \g_@@_these_aux_exists - \msg_warning:nn{denisbdoc}{File~ `\c_@@_these_aux_string_tl'~ needed} - \AfterEndPreamble{% - \begin{dbwarning}{Documentation~incomplète~!}{documentation-incomplete} - La~ présente~ documentation~ est~ incomplète~ car~ le~ - \File{\c_@@_these_aux_string_tl}~ est~ absent~ du~ - \Folder{\c_@@_flatsample_string_tl}.~ Pour~ régler~ le~ problème,~ - rendez-vous~ dans~ ce~ dossier~ et~ compilez~ le~ \File{these.tex}~ au~ - moyen~ de~ la~ commande~ suivante\footnote{Sur~ une~ seule~ ligne.}~ : - \par\medskip + \ \ latexmk~ -g~ -pdf~ -jobname=these~ -pdflatex="pdflatex~ \%O~ \string\ \\ + \ \ '\string\RequirePackage\{etoolbox\}~ \string\ \\ + \ \ \string\AtEndPreamble\{\string\RequirePackage\{yathesis-demo\}\}~ \string\ \\ + \ \ \string\input\{\%S\}'"~ these.tex + \\\\ + Afterwards,~ recompile~ this~ document.% + }% + \file_if_exist:nTF {\c_@@_flatsample_string_tl/\c_@@_these_aux_string_tl} {% + \bool_gset_true:N% + \g_@@_these_aux_exists% + }{ + % \bool_gset_false:N \g_@@_these_aux_exists + \msg_warning:nn{denisbdoc}{File~ `\c_@@_these_aux_string_tl'~ needed} + \AfterEndPreamble{% + \begin{dbwarning}{Documentation~incomplète~!}{documentation-incomplete} + La~ présente~ documentation~ est~ incomplète~ car~ le~ + \File{\c_@@_these_aux_string_tl}~ est~ absent~ du~ + \Folder{\c_@@_flatsample_string_tl}.~ Pour~ régler~ le~ problème,~ + rendez-vous~ dans~ ce~ dossier~ et~ compilez~ le~ \File{these.tex}~ au~ + moyen~ de~ la~ commande~ suivante\footnote{Sur~ une~ seule~ ligne.}~ : + \par\medskip - \lstinline[language=bash,upquote=true,commentstyle=,stringstyle=,showstringspaces=false]+latexmk~-g~ -norc~ -r~ ./latexmkrc~-jobname=these-pdflatex="pdflatex~\%O~'\\RequirePackage\{etoolbox\}\\AtEndPreamble\{\\RequirePackage\{yathesis-demo\}\}\\input\{\%S\}'"~these+ - \end{dbwarning} + \lstinline[language=bash,upquote=true,commentstyle=,stringstyle=,showstringspaces=false]+latexmk~-g~ -norc~ -r~ ./latexmkrc~-jobname=these-pdflatex="pdflatex~\%O~'\\RequirePackage\{etoolbox\}\\AtEndPreamble\{\\RequirePackage\{yathesis-demo\}\}\\input\{\%S\}'"~these+ + \end{dbwarning} + } } - } - % - \msg_new:nnn{denisbdoc}{File~ `\c_@@_template_sample_zip_string_tl'~ needed}{% - File~ `canevas-specimen.zip'~ needed~ (otherwise~ this~ document~ will~ be~ - incomplete)!~ Please~ get~ this~ file~ from~ the~ orignal~ yathesis'~ - documentation~ and~ save~ it~ in~ `../exemples/'~ folder.~ Afterwards,~ - recompile~ this~ document.% - }% - \file_if_exist:nTF {../\c_@@_template_sample_zip_string_tl} {}{ - \msg_warning:nn{denisbdoc}{File~ `\c_@@_template_sample_zip_string_tl'~ needed} - \AfterEndPreamble{% - \begin{dbwarning}{Documentation~incomplète~!}{} - La~ version~ électronique~ (\pdf{})~ de~ la~ présente~ documentation~ - est~ incomplète~ :~ normalement,~ les~ canevas~ et~ spécimens~ y~ sont~ - intégrés~ par~ le~ biais~ de~ l'archive~ \gls{zip}~ - \file{\c_@@_template_sample_zip_string_tl}~ (alors~ accessible~ par~ - simple~ clic)~ mais~ ce~ n'est~ pas~ le~ cas~ ici,~ ce~ fichier~ étant~ - absent~ du~ dossier~ parent.~ % \Folder{\c_@@_examples_path_tl}.~ - Pour~ régler~ le~ problème,~ accédez~ à~ ce~ fichier~ attaché~ à~ la~ - version~ électronique~ originale~ de~ la~ documentation~ de~ - \yatcl{}\footnote{Disponible~ à~ l'adresse~ - \url{http://ctan.org/pkg/yathesis},~ si~ besoin~ est.}~ et~ placez-le~ - dans~ le~ \Folder{\c_@@_examples_path_tl}. - \end{dbwarning} + % + \msg_new:nnn{denisbdoc}{File~ `\c_@@_template_sample_zip_string_tl'~ needed}{% + File~ `canevas-specimen.zip'~ needed~ (otherwise~ this~ document~ will~ be~ + incomplete)!~ Please~ get~ this~ file~ from~ the~ orignal~ yathesis'~ + documentation~ and~ save~ it~ in~ `../exemples/'~ folder.~ Afterwards,~ + recompile~ this~ document.% + }% + \file_if_exist:nTF {../\c_@@_template_sample_zip_string_tl} {}{ + \msg_warning:nn{denisbdoc}{File~ `\c_@@_template_sample_zip_string_tl'~ needed} + \AfterEndPreamble{% + \begin{dbwarning}{Documentation~incomplète~!}{} + La~ version~ électronique~ (\pdf{})~ de~ la~ présente~ documentation~ + est~ incomplète~ :~ normalement,~ les~ canevas~ et~ spécimens~ y~ sont~ + intégrés~ par~ le~ biais~ de~ l'archive~ \gls{zip}~ + \file{\c_@@_template_sample_zip_string_tl}~ (alors~ accessible~ par~ + simple~ clic)~ mais~ ce~ n'est~ pas~ le~ cas~ ici,~ ce~ fichier~ étant~ + absent~ du~ dossier~ parent.~ % \Folder{\c_@@_examples_path_tl}.~ + Pour~ régler~ le~ problème,~ accédez~ à~ ce~ fichier~ attaché~ à~ la~ + version~ électronique~ originale~ de~ la~ documentation~ de~ + \yatcl{}\footnote{Disponible~ à~ l'adresse~ + \url{http://ctan.org/pkg/yathesis},~ si~ besoin~ est.}~ et~ placez-le~ + dans~ le~ \Folder{\c_@@_examples_path_tl}. + \end{dbwarning} + } } - } - % - \cs_new_protected:Nn \_@@_screenshot:nn - { - \bool_if:NTF {\g_@@_these_aux_exists} { - \fbox{\includegraphics[bylabel=#2,width=#1\linewidth-2\fboxsep-2\fboxrule]{\c_@@_flatsample_string_tl/these}}% - }{% - \begin{dbwarning}{Copie~d'écran~manquante~!}{} - Il~ devrait~ ici~ y~ avoir~ une~ copie\c_space_tl ~ d'écran.~ Cf.~ - \vref{wa-documentation-incomplete}~ pour~ plus~ de~ détails. - \end{dbwarning} + % + \cs_new_protected:Nn \_@@_screenshot:nn + { + \bool_if:NTF {\g_@@_these_aux_exists} { + \fbox{\includegraphics[bylabel=#2,width=#1\linewidth-2\fboxsep-2\fboxrule]{\c_@@_flatsample_string_tl/these}}% + }{% + \begin{dbwarning}{Copie~d'écran~manquante~!}{} + Il~ devrait~ ici~ y~ avoir~ une~ copie\c_space_tl ~ d'écran.~ Cf.~ + \vref{wa-documentation-incomplete}~ pour~ plus~ de~ détails. + \end{dbwarning} + } + } + \NewDocumentCommand \screenshot { O{.45} m } {% + \_@@_screenshot:nn {#1}{#2} } - } - \NewDocumentCommand \screenshot { O{.45} m } {% - \_@@_screenshot:nn {#1}{#2} } } % \end{macrocode} @@ -2263,15 +2287,15 @@ This work consists of the file denisbdoc.dtx } \NewDocumentCommand \yatpa { } {% - \Package+{\c_@@_yat_class_name_tl}[\itshape][]\xspace + \Package+{\c_@@_yat_class_name_tl}[\itshape][] } \NewDocumentCommand \yatcl { } {% - \texorpdfstring{\class+{\c_@@_yat_class_name_tl}[][][\itshape]\xspace}{yathesis} + \texorpdfstring{\class+{\c_@@_yat_class_name_tl}[][][\itshape]}{yathesis} } \NewDocumentCommand \yatCl { } {% - \texorpdfstring{\Class+{\c_@@_yat_class_name_tl}[][][\itshape]\xspace}{classe yathesis} + \texorpdfstring{\Class+{\c_@@_yat_class_name_tl}[][][\itshape]}{classe yathesis} } % \end{macrocode} % \end{macro} @@ -2335,19 +2359,19 @@ This work consists of the file denisbdoc.dtx % \begin{macro}{\gzt} % \begin{macro}{\gztcl} % \begin{macrocode} -% \NewDocumentCommand \gzt { s } { -% \IfBooleanTF {#1} -% { -% \textit{\c_@@_journal_title_string_tl} -% } -% { -% \textit{\c_@@_journal_short_title_string_tl} -% } -% } -% \NewDocumentCommand \gztcl { } -% {% -% \Class{\textsl{\texttt{\c_@@_gzt_class_name_tl}}} -% } +\ProvideDocumentCommand \gzt { s } { + \IfBooleanTF {#1} + { + \textit{\c_@@_journal_title_string_tl} + } + { + \textit{\c_@@_journal_short_title_string_tl} + } +} +\ProvideDocumentCommand \gztcl { } +{% + \Class{\textsl{\texttt{\c_@@_gzt_class_name_tl}}} +} \NewDocumentCommand \gztauthor { } {% \textsl{\texttt{\c_@@_gztauthor_class_name_tl}} |