texlive[75000] Master/texmf-dist: codedescribe (22apr25)
commits+karl at tug.org
commits+karl at tug.org
Tue Apr 22 22:30:01 CEST 2025
Revision: 75000
https://tug.org/svn/texlive?view=revision&revision=75000
Author: karl
Date: 2025-04-22 22:30:01 +0200 (Tue, 22 Apr 2025)
Log Message:
-----------
codedescribe (22apr25)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/codedescribe/README.md
trunk/Master/texmf-dist/doc/latex/codedescribe/codedescribe.pdf
trunk/Master/texmf-dist/doc/latex/codedescribe/codedescribe.tex
trunk/Master/texmf-dist/tex/latex/codedescribe/codedescribe.sty
trunk/Master/texmf-dist/tex/latex/codedescribe/codelisting.sty
Modified: trunk/Master/texmf-dist/doc/latex/codedescribe/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/codedescribe/README.md 2025-04-22 20:29:52 UTC (rev 74999)
+++ trunk/Master/texmf-dist/doc/latex/codedescribe/README.md 2025-04-22 20:30:01 UTC (rev 75000)
@@ -86,14 +86,17 @@
## Changelog
-* Version 1.6 (this)
- - fixing issue #3 (long standing (hidden) bug. \tsresult now fully respects optional keys.
+* Version 1.7 (this)
+ - fixing [#4](https://github.com/alceu-frigeri/codedescribe/issues/4) (hopefully) for good and working on [#5](https://github.com/alceu-frigeri/codedescribe/issues/5). Added an environment <tsremark*> (see documentation).
+* Version 1.6
+ - fixing issue [#3](https://github.com/alceu-frigeri/codedescribe/issues/3) (long standing (hidden) bug. \tsresult now fully respects optional keys.
+
* Version 1.5b
- - fixing issue #2 (reverting `codesyntax` bug introduced by v1.5).
+ - fixing issue [#2](https://github.com/alceu-frigeri/codedescribe/issues/2) (reverting `codesyntax` bug introduced by v1.5).
* Version 1.5
- - fixing issue #1 (misalignment when missing a `codesyntax` inner environment).
+ - fixing issue [#1](https://github.com/alceu-frigeri/codedescribe/issues/1) (misalignment when missing a `codesyntax` inner environment).
* Version 1.4
- The 'new', 'update' and 'info' keys can, now, be used multiple times when declaring a codedescribe environment. (see documentation).
Modified: trunk/Master/texmf-dist/doc/latex/codedescribe/codedescribe.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/codedescribe/codedescribe.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/codedescribe/codedescribe.tex 2025-04-22 20:29:52 UTC (rev 74999)
+++ trunk/Master/texmf-dist/doc/latex/codedescribe/codedescribe.tex 2025-04-22 20:30:01 UTC (rev 75000)
@@ -1,5 +1,10 @@
+%%%==============================================================================
+% WinEdt pragmas
+% !Mode:: "TeX:EN"
+% Default Compile engines:
% !TEX program = pdflatex
-% !TEX ext = --interaction=nonstopmode --enable-etex --enable-write18
+% !PDFTeXify ext = --enable-etex --restrict-write18
+% !PDFLaTeX ext = --enable-etex --restrict-write18
% !BIB program = none
%%%==============================================================================
%% Copyright 2023-present by Alceu Frigeri
@@ -15,7 +20,7 @@
%%
%% The Current Maintainer of this work is Alceu Frigeri
%%
-%% This is version {1.6} {2025/03/08}
+%% This is version {1.7} {2025/04/21}
%%
%% The list of files that compose this work can be found in the README.md file at
%% https://ctan.org/pkg/codedescribe
@@ -27,6 +32,7 @@
\usepackage{codedescribe}
\usepackage{enumitem}
+\RequirePackage[hidelinks ,hypertexnames=false]{hyperref}
\begin{document}
%%% TO BE DETERMINED !! \parindent
@@ -217,7 +223,7 @@
It has a single package option:
\begin{describelist}{option}
-\describe{nolisting}{it will suppress the \tsobj[pkg]{codelisting} package load. In case it's not necessary or one wants to use a differen package for \LaTeX\ code listing.}
+\describe{nolisting}{it will suppress the \tsobj[pkg]{codelisting} package load. In case it isn't needed or another listing package will be used.}
\end{describelist}
\subsection{Object Type keys}\label{obj-type-def}
@@ -281,7 +287,7 @@
\subsubsection{Customization}\label{format-custom}
-One can add user defined groups/objects or change the pre-defined ones with the following commands:
+To create user defined groups/objects or change the pre-defined ones:
\begin{codedescribe}[code,new=2023/05/16]{\defgroupfmt}
@@ -321,7 +327,7 @@
\ldots
\tsmacro{\end{codedescribe}}{}
\end{codesyntax}
-This is the main environment to describe \tsobj[env]{Macros, Functions, Variable, Environments, etc.} \tsobj[meta]{csv-list} is typeset in the margin. The optional \tsobj[oarg]{obj-type} (see \ref{obj-type-def} and \ref{obj-types}) defines the object-type format.
+This is the main environment to describe \tsobj[env]{Macros, Functions, Variables, Environments, etc.} \tsobj[meta]{csv-list} is typeset in the margin. The optional \tsobj[oarg]{obj-type} (see \ref{obj-type-def} and \ref{obj-types}) defines the object-type format.
\end{codedescribe}
\begin{tsremark}[Note~1:]
One can change the rule color with the key \tsobj[keys]{rulecolor}, for instance \tsmacro{\begin{codedescribe}[rulecolor=white]}{} will remove the rules.
@@ -341,14 +347,10 @@
\end{codesyntax}
The \tsobj[env]{codesyntax} environment sets the fontsize and activates \tsmacro{\obeylines,\obeyspaces}{}, so one can list macros/cmds/keys use, one per line.
\end{codedescribe}
-\begin{tsremark}
+
+\begin{tsremark*}
\tsobj[env]{codesyntax} environment shall appear only once, inside of a \tsobj[env]{codedescribe} environment. Take note, as well, this is not a verbatim environment!
-%\begin{describelist*}{code}
-%\describe{something}{ a text}
-%\describe{some}{ some text}
-%\end{describelist*}
-%
-\end{tsremark}
+\end{tsremark*}
For example, the code for \tsobj[env]{codedescribe} (entry above) is:
@@ -398,7 +400,7 @@
This is the main typesetting command (most of the others are based on this). It can be used to typeset a single 'object' or a list thereof. In the case of a list, each term will be separated by commas. The last two by \tsobj[key]{sep} (defaults to: and).
\end{codedescribe}
\begin{tsremark}
-One can change the last 'separator' with the key \tsobj[keys]{sep}, for instance \tsverb[code]{\tsobj[env,sep=or] {}} (in case one wants to produce an 'or' list of environments). Additionally, one can use the key \tsobj[keys]{comma} to change the last separator to a single comma, like \tsverb[code]{\tsobj[env,comma] {}}.
+The last 'separator' can be changed with the key \tsobj[keys]{sep}, for instance \tsverb[code]{\tsobj[env,sep=or] {}} (it will produce an 'or' list of environments). Additionally, the key \tsobj[keys]{comma} will change the last separator to a single comma, as in \tsverb[code]{\tsobj[env,comma] {}}.
\end{tsremark}
\begin{codedescribe}[code]{\typesetargs,\tsargs}
@@ -446,12 +448,12 @@
Typesets a small note at the margin.
\end{codedescribe}
-\begin{codedescribe}[env]{tsremark}
+\begin{codedescribe}[env,update=2025-04-21]{tsremark,tsremark*}
\begin{codesyntax}
\tsmacro{\begin{tsremark}}[NB]{}
\tsmacro{\end{tsremark}}{}
\end{codesyntax}
- The environment body will be typeset as a text note. \tsobj[oarg]{NB} (defaults to Note:) is the note begin (in boldface). For instance:
+ The environment body will be typeset as a text note. \tsobj[oarg]{NB} (defaults to Note:) is the note begin (in boldface). The non-star version doesn't finishes a paragraph (\TeX\ stays in horizontal mode), whilst the (new) star version does and introduces a vertical space at the end. For instance:
\begin{codestore}[demo.remark]
Sample text. Sample test.
\begin{tsremark}[N.B.]
@@ -461,10 +463,10 @@
\tsdemo{demo.remark}
\end{codedescribe}
-\subsection{Auxiliary Command / Environment}
-In case the used Document Class redefines the \tsobj[code]{\maketitle} command and/or \tsobj[env]{abstract} environment, alternatives are provided (based on the article class).
+\subsection{Auxiliary Commands and Environment}
+In case the Document Class being used redefines the \tsobj[code]{\maketitle} command and/or \tsobj[env]{abstract} environment, alternatives are provided (based on the article class).
-\begin{codedescribe}[code]{typesettitle,tstitle}
+\begin{codedescribe}[code]{\typesettitle,\tstitle}
\begin{codesyntax}
\tsmacro{\typesettitle}{title-keys}
\tsmacro{\tstitle}{title-keys}
@@ -474,7 +476,7 @@
\begin{describelist}{key}
\describe{title}{The used title.}
-\describe{author}{Author's name. It's possible to use \tsobj[code]{\footnote} command in it.}
+\describe{author}{Author's name. It's possible to use the \tsobj[code]{\footnote} command in it.}
\describe{date}{Title's date.}
\end{describelist}
@@ -487,7 +489,7 @@
This is the \tsobj[env]{abstract} environment from the \tsobj[pkg]{article} class.
\end{codedescribe}
-\begin{codedescribe}[code,new=2023/05/16]{typesetdate,tsdate}
+\begin{codedescribe}[code,new=2023/05/16]{\typesetdate,\tsdate}
\begin{codesyntax}
\tsmacro{\typesetdate}{}
\tsmacro{\tsdate}{}
Modified: trunk/Master/texmf-dist/tex/latex/codedescribe/codedescribe.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/codedescribe/codedescribe.sty 2025-04-22 20:29:52 UTC (rev 74999)
+++ trunk/Master/texmf-dist/tex/latex/codedescribe/codedescribe.sty 2025-04-22 20:30:01 UTC (rev 75000)
@@ -12,7 +12,7 @@
%%
%% The Current Maintainer of this work is Alceu Frigeri
%%
-%% This is version {1.6} {2025/03/08}
+%% This is version {1.7} {2025/04/21}
%%
%% The list of files that compose this work can be found in the README.md file at
%% https://ctan.org/pkg/codedescribe
@@ -22,8 +22,8 @@
\ProvidesExplPackage
{codedescribe}
- {2025/03/08}
- {1.6}
+ {2025/04/21}
+ {1.7}
{LaTeX Code Description/Documentation}
%%%%%%%
@@ -36,8 +36,8 @@
{
name .code:n = {codedescribe} ,
prefix .code:n = {codedesc} ,
- date .code:n = {2025/03/08} ,
- version .code:n = {1.6} ,
+ date .code:n = {2025/04/21} ,
+ version .code:n = {1.7} ,
description .code:n = {\LaTeX~Code~Description/Documentation}
}
\cs_if_exist:NF \PkgInfo
@@ -772,7 +772,7 @@
\__codedesc_hline:nnnn {\color{white}}{0.5ex}{2}{-1.5ex}
\__codedesc_metacolor_tl:
\begin{minipage}[t]{\l__codedesc_syntax_wd_dim}
- \obeylines\obeyspaces\setlength\parindent{-2em}
+ \obeylines\obeyspaces\setlength\parindent{-2em}
\end{minipage}\\[-2.5ex]
\\
\__codedesc_hline:nnnn {\color{white}}{0ex}{2}{1ex}
@@ -792,8 +792,7 @@
\par\noindent
\coffin_typeset:Nnnnn \l__codedesc_syntax_coffin {l}{t} {0pt}{\__codedesc_paradvance_dim}
}
- \\[0.5\baselineskip]
- %\\[\__codedesc_paradvance_dim]%[-0.5\baselineskip]
+ \skip_vertical:n{0.375\baselineskip}
}
@@ -823,10 +822,10 @@
\NewDocumentEnvironment{describelist}{O{20mm}m}
{
- %\vspace*{-1.5ex}
\mode_if_horizontal:TF
- {\\[-0.5\baselineskip]}
- {}
+ {\skip_vertical:n{-0.25\baselineskip}}
+ {\skip_vertical:n{0.125\baselineskip}}
+
\__codedesc_set_textcolwidth:
\coffin_clear:N \__codedesc_describe_coffin
\dim_set:Nn \__codedesc_describelabel_wd_dim {#1}
@@ -836,15 +835,14 @@
\tl_set:Nn \__codedesc_listkind_tl {#2}
}
{
-% \par\noindent\coffin_typeset:Nnnnn \__codedesc_describe_coffin {l}{t}{0pt}{10pt}
}
\NewDocumentEnvironment{describelist*}{O{20mm}m}
{
- %\vspace*{-1.5ex}
\mode_if_horizontal:TF
- {\\[-0.5\baselineskip]}%{\vspace*{-1ex}}
- {}
+ {\skip_vertical:n{-0.25\baselineskip}}
+ {\skip_vertical:n{0.125\baselineskip}}
+
\__codedesc_set_textcolwidth:
\coffin_clear:N \__codedesc_describe_coffin
\dim_set:Nn \__codedesc_describelabel_wd_dim {#1}
@@ -854,9 +852,9 @@
\tl_set:Nn \__codedesc_listkind_tl {#2}
}
{
-% \par\noindent\coffin_typeset:Nnnnn \__codedesc_describe_coffin {l}{t}{0pt}{10pt}
}
+\cs_generate_variant:Nn \skip_set:Nn {Ne}
\NewDocumentCommand \describe {mm}
{
\hcoffin_set:Nn \l_tmpb_coffin
@@ -890,25 +888,21 @@
\begin{minipage}[t]{ \__codedesc_describelist_wd_dim }
#2
\end{minipage}
- }
+ }
\__codedesc_join_tl:
\l_tmpb_coffin {l}{t}
\l_tmpa_coffin {r}{t}
- {-\marginparsep}{0pt}
+ {-\marginparsep}{-.12\baselineskip}
+
\mode_if_horizontal:TF
- {
- \\[-\baselineskip]
- }
- { }
-
+ {\skip_vertical:n{0.1667\baselineskip}}
+ {\skip_vertical:n{0.3667\baselineskip}}
\noindent
\coffin_typeset:Nnnnn
\l_tmpb_coffin {l}{t} {0pt}{0pt}
- \\
-
}
+
-
\NewDocumentCommand \typesetmeta {m} {\__codedesc_meta:n {#1}}
@@ -961,31 +955,35 @@
\cs_new_eq:NN \tsmarginnote \typesetmarginnote
+
\NewDocumentEnvironment {tsremark} {O{Note:}}
{
-% %%% WAS
-% \mode_if_horizontal:TF
-% {\par\vspace*{0.25\baselineskip}}%\vspace*{-1.5ex}}
-% {\vspace*{0.75\baselineskip}}
\mode_if_horizontal:TF
- {\skip_vertical:n{-0.125\baselineskip}}
- {\skip_vertical:n{0.25\baselineskip}}
+ {\skip_vertical:n{0.1667\baselineskip}}
+ {\skip_vertical:n{0.4167\baselineskip}}
+
\__codedesc_set_textcolwidth:
\group_begin:
\noindent\hspace{0.2\l__codedesc_textcolwidth_dim}
- \begin{minipage}{0.8\l__codedesc_textcolwidth_dim}
+ \begin{minipage}[b]{0.8\l__codedesc_textcolwidth_dim}
\setlength\parindent{0pt}\small
- \textsl{\textbf{#1}} %\dim_to_decimal:n {\linewidth}
+ \textsl{\textbf{#1}} %\l_tmpa_tl %\dim_to_decimal:n {\linewidth}
}
{
\end{minipage}
\group_end:
-% %%% WAS
-% \\[0.25\baselineskip]
- \skip_vertical:n{0.25\baselineskip}
}
+\NewDocumentEnvironment {tsremark*} {O{Note:}}
+ {
+ \begin{tsremark}[#1]
+ }
+ {
+ \end{tsremark}
+ \skip_vertical:n{0.4167\baselineskip}
+ }
+
%%%% ARGH !!!!
\keys_define:nn { codedesc / title }
Modified: trunk/Master/texmf-dist/tex/latex/codedescribe/codelisting.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/codedescribe/codelisting.sty 2025-04-22 20:29:52 UTC (rev 74999)
+++ trunk/Master/texmf-dist/tex/latex/codedescribe/codelisting.sty 2025-04-22 20:30:01 UTC (rev 75000)
@@ -12,7 +12,7 @@
%%
%% The Current Maintainer of this work is Alceu Frigeri
%%
-%% This is version {1.6} {2025/03/08}
+%% This is version {1.7} {2025/04/21}
%%
%% The list of files that compose this work can be found in the README.md file at
%% https://ctan.org/pkg/codedescribe
@@ -22,8 +22,8 @@
\ProvidesExplPackage
{codelisting}
- {2025/03/08}
- {1.6}
+ {2025/04/21}
+ {1.7}
{LaTeX Code Listing}
%%%%%%%
@@ -36,8 +36,8 @@
{
name .code:n = {codelisting} ,
prefix .code:n = {codelist} ,
- date .code:n = {2025/03/08} ,
- version .code:n = {1.6} ,
+ date .code:n = {2025/04/21} ,
+ version .code:n = {1.7} ,
description .code:n = {\LaTeX~Code~Listing}
}
\cs_if_exist:NF \PkgInfo
More information about the tex-live-commits
mailing list.