texlive[75953] Master: algxpar (1aug25)
commits+karl at tug.org
commits+karl at tug.org
Sat Aug 2 21:51:54 CEST 2025
Revision: 75953
https://tug.org/svn/texlive?view=revision&revision=75953
Author: karl
Date: 2025-08-02 21:51:53 +0200 (Sat, 02 Aug 2025)
Log Message:
-----------
algxpar (1aug25)
Modified Paths:
--------------
trunk/Master/texmf-dist/doc/latex/algxpar/README.md
trunk/Master/texmf-dist/doc/latex/algxpar/algxpar-doc.pdf
trunk/Master/texmf-dist/doc/latex/algxpar/algxpar-doc.tex
trunk/Master/texmf-dist/tex/latex/algxpar/algxpar.sty
trunk/Master/tlpkg/tlpsrc/algxpar.tlpsrc
Added Paths:
-----------
trunk/Master/texmf-dist/doc/latex/algxpar/DEPENDS.txt
Removed Paths:
-------------
trunk/Master/texmf-dist/tex/latex/algxpar/algxpar-versionchanges.sty
Added: trunk/Master/texmf-dist/doc/latex/algxpar/DEPENDS.txt
===================================================================
--- trunk/Master/texmf-dist/doc/latex/algxpar/DEPENDS.txt (rev 0)
+++ trunk/Master/texmf-dist/doc/latex/algxpar/DEPENDS.txt 2025-08-02 19:51:53 UTC (rev 75953)
@@ -0,0 +1,10 @@
+hard algorithmicx
+hard algpseudocode
+hard amssymb
+hard etoolbox
+hard pgfmath
+hard pgfopts
+hard ragged2e
+hard tikz
+hard varwidth
+hard xcolor
Property changes on: trunk/Master/texmf-dist/doc/latex/algxpar/DEPENDS.txt
___________________________________________________________________
Added: svn:eol-style
## -0,0 +1 ##
+native
\ No newline at end of property
Modified: trunk/Master/texmf-dist/doc/latex/algxpar/README.md
===================================================================
--- trunk/Master/texmf-dist/doc/latex/algxpar/README.md 2025-08-02 19:50:35 UTC (rev 75952)
+++ trunk/Master/texmf-dist/doc/latex/algxpar/README.md 2025-08-02 19:51:53 UTC (rev 75953)
@@ -2,19 +2,20 @@
This package extends the algorithmicx package (algpseudocode) to support multiline text.
## How to use
-Copy `algxpar.sty` and `*.kw.tex` to somewhere in your TeX path.
+Copy `algxpar.sty` and `algxpar-*.kw.tex` to somewhere in your TeX path.
-From CTAN: https://ctan.org/pkg/algxpar (check version!)
+From CTAN: https://ctan.org/pkg/algxpar
+Github: http://github.com/jandermoreira/algxpar
## Licence
-Copyright (C) 2019-2024 by Jander Moreira (moreira.jander at gmail.com)
+Copyright (C) 2019-2025 by Jander Moreira (moreira.jander at gmail.com)
This work may be distributed and/or modified under the
-conditions of the LaTeX Project Public License, either version 1.3
+conditions of the LaTeX Project Public License, either version 1.3c
of this license or (at your option) any later version.
The latest version of this license is in
http://www.latex-project.org/lppl.txt
-and version 1.3 or later is part of all distributions of LaTeX
+and version 1.3c or later is part of all distributions of LaTeX
version 2005/12/01 or later.
This work has the LPPL maintenance status `maintained'.
@@ -27,4 +28,3 @@
Manual (requires `pygmentize`):
* algxpar-doc.tex
-* algxpar-versionchanges.sty
Modified: trunk/Master/texmf-dist/doc/latex/algxpar/algxpar-doc.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/latex/algxpar/algxpar-doc.tex
===================================================================
--- trunk/Master/texmf-dist/doc/latex/algxpar/algxpar-doc.tex 2025-08-02 19:50:35 UTC (rev 75952)
+++ trunk/Master/texmf-dist/doc/latex/algxpar/algxpar-doc.tex 2025-08-02 19:51:53 UTC (rev 75953)
@@ -4,74 +4,17 @@
\documentclass[a4paper, 11pt]{article}
\usepackage[T1]{fontenc}
-\usepackage{amsfonts}
-\usepackage{amsmath}
-\usepackage{textcomp}
-\usepackage[all]{nowidow}
+\usepackage[presets]{packdoc}
-% \usepackage{array}
-\usepackage{enumitem}
-\setlist{nosep}
-
\usepackage[
brazilian,
language = english,
]{algxpar}
+\usepackage{needspace}
-%% Layout
-% geometry
-\usepackage{geometry}
-\geometry{top = 2.5cm, bottom = 2cm, right = 2.5cm, left = 4cm}
-
-% hyperref
-\usepackage{hyperref}
-\hypersetup{
- colorlinks,
- urlcolor = blue!20!black,
- linkcolor = blue!10!black,
- citecolor = black!80,
-}
-
-% cleveref
-\usepackage{cleveref}
-
-% makeidx
-\usepackage{makeidx}
-\makeindex
-
-% minted
-\usepackage[outputdir = ./out]{minted}
-% \usemintedstyle{borland}
-\newminted{latex}{autogobble, breaklines, bgcolor = blue!5, fontsize = \footnotesize}
-\newmintinline{latex}{}
-
-% tcolorbox
-\usepackage{tcolorbox}
-\usepackage{color}
-\usepackage{comment}
-\tcbuselibrary{skins, listings, minted, breakable}
-\tcbset{
- colback = blue!3,
- sharp corners,
- box align = top,
- boxrule = 0pt,
- fontupper = \footnotesize,
- fontlower = \footnotesize,
- minted options={
- fontsize = \footnotesize,
- breaklines,
- autogobble,
- },
- listing engine = minted,
-}
-
-% Versions
-\usepackage{algxpar-versionchanges}
-
-
\begin{filecontents}[overwrite, nosearch, noheader]{algxpar-lzw.tex}
\begin{algorithmic}[1]
\Description LZW Compression using a table with all known sequences of bytes.
@@ -78,171 +21,38 @@
\Input A flow of bytes
\Output A flow of bits with the compressed representation of the input bytes
\Statex
- \Statep{Initialize a table with all bytes}[each position of the table has a single byte]
- \Statep{Initilize \Id{sequence} with the first byte in the input flow}
- \While{there are bytes in the input}[wait until all bytes are processed]
- \Statep{Get a single byte from input and store it in \Id{byte}}
- \If{the concatention of \Id{sequence} and \Id{byte} is in the table}
- \Statep{Set \Id{sequence} to $\Id{sequence} + \Id{byte}$}[concatenate without producing any output]
+ \Statep{Initialize a table with all byte values}[each table position holds a single byte]
+ \Statep{Initialize \Id{sequence} with the first byte from the input stream}
+ \While{there are bytes in the input}[wait until all bytes have been processed]
+ \Statep{Retrieve a single byte from the input and store it in \Id{byte}}
+ \If{the concatenation of \Id{sequence} and \Id{byte} exists in the table}
+ \Statep{Set \Id{sequence} to $\Id{sequence} + \Id{byte}$}[concatenate without generating any output]
\Else
- \Statep{Output the code for \Id{sequence}}[i.e., the binary representation of its position in the table]
- \Statep{Add the concatention of \Id{sequence} and \Id{byte} to the table}[the table learns a longer sequence]
- \Statep{Set \Id{sequence} to \Id{byte}}[starts a new sequence with the remaining byte]
+ \Statep{Output the code for \Id{sequence}}[i.e., the binary representation of its index in the table]
+ \Statep{Add the concatenation of \Id{sequence} and \Id{byte} to the table}[the table learns a new, longer sequence]
+ \Statep{Set \Id{sequence} to \Id{byte}}[begin a new sequence with the remaining byte]
\EndIf
\EndWhile
- \Statep{Output the code for \Id{sequence}}[the remaining sequence of bits]
+ \Statep{Output the code for \Id{sequence}}[the remaining bit sequence]
\end{algorithmic}
\end{filecontents}
-%% Text support
-
-% macro arguments formats
-\colorlet{argumentcolor}{orange!50!black}
-\NewDocumentCommand{\Argument}{ m }{%
- \textcolor{argumentcolor}{$\langle$\normalfont\small\textsl{#1}$\rangle$}%
-}
-\NewDocumentCommand{\MArg}{ m }{\mbox{\texttt{\{}\Argument{#1}\texttt{\}}}}
-\NewDocumentCommand{\OArg}{ m }{\mbox{\texttt{[}\Argument{#1}\texttt{]}}}
-\NewDocumentCommand{\LArg}{ m }{\mbox{\texttt{<}\Argument{#1}\texttt{>}}}
-\NewDocumentCommand{\PackageName}{ m }{\mbox{\textsf{#1}}}
-\NewDocumentCommand{\Deprecated}{}{\textcolor{red!80!black}{(deprecated)}}
-\NewDocumentCommand{\FromPackage}{ m }{%
- \tikz\node[draw, rounded corners = 1.5pt, inner sep = 1.5pt,
- font = \sffamily\tiny] {#1};%
-}
-\NewDocumentCommand{\Empty}{}{%
- \mbox{\normalfont\textcolor{black!60}{\textsl{--empty--}}}
-}
-\NewDocumentCommand{\Option}{ m }{%
- \mbox{\textcolor{green!40!black}{\texttt{#1}}}%
-}
-\NewDocumentCommand{\OptionInd}{ m }{%
- \index{#1@\texttt{#1}}%
- \Option{#1}%
-}
-\NewDocumentCommand{\OptionRef}{ m }{%
- \hyperref[option:#1]{\Option{#1}}%
-}
-\NewDocumentCommand{\Macro}{ m }{%
- \expandafter\latexinline\expandafter{\csname#1\endcsname}%
-}
-\NewDocumentCommand{\MacroRef}{ m }{%
- \hyperref[macro:#1]{\Macro{#1}}%
-}
-\NewDocumentCommand{\MacroDef}{ m }{%
- \index{#1@\texttt{\textbackslash #1}}%
- \refstepcounter{MacroCounter}%
- \label{macro:#1}%
- \Macro{#1}%
-}
-\NewDocumentCommand{\MacroRefInd}{ m }{%
- \index{#1@\texttt{\textbackslash #1}}%
- \MacroRef{#1}%
-}
-
-\tcbset{
- description/.style = {
- coltitle = black,
- fontupper = \normalsize,
- colbacktitle = white,
- titlerule = 0.001pt,
- enhanced jigsaw,
- breakable,
- width = \dimexpr \linewidth - 2em \relax,
- flush right,
- top = 0.5ex,
- bottom = 0pt,
- left = 0pt,
- right = 0pt,
- opacitybacktitle = 0,
- opacityframe = 0,
- opacityback = 0,
- }
-}
-
-\NewDocumentEnvironment{macro}{ m O{} o }{%
- %! formatter = off
- \index{#1@\texttt{\textbackslash#1}}%
- \refstepcounter{MacroCounter}%
- \label{macro:#1}%
- %! parser = off
- \IfValueTF{#3}{%
- \begin{macro*}{#1}{#2}
- }{%
- \begin{macro*}{#1}{#2}[#3]%
- }
- %! parser = on
- }{%
- %! parser = off
- \end{macro*}
- %! parser = on
- %! formatter = on
-}
-\newcounter{MacroCounter}
-\NewDocumentEnvironment{macro*}{ m m o }{
- \medskip\par%
- \begin{tcolorbox}[
- title = {\hspace{-2em}\Macro{#1}#2\IfValueT{#3}{\latexinline!{#3} !}},
- description,
- ]
- }{
- \end{tcolorbox}%
- \medskip%
-}
-
-\newlength{\docassignment}
-\NewDocumentEnvironment{option}{ m m o }{%
- \label{option:#1}%
- \settowidth{\docassignment}{#2}%
- \begin{tcolorbox}
- [
- title = {%
- \hspace{-2em}\OptionInd{#1}%
- \ifdim
- \docassignment>0pt\Option{ = #2}
- \fi%
- \IfValueT{#3}{\hfill\textit{Default:} \Option{#3}}
- },
- description,
- ]
- }{
- \end{tcolorbox}%
- \medskip%
-}
-\NewDocumentEnvironment{option*}{ m }{%
- \begin{tcolorbox}[title = {\hspace{-2em}#1}, description]
- }{
- \end{tcolorbox}%
- \medskip%
-}
-\NewDocumentEnvironment{optionnoind}{ m m }{%
- \begin{tcolorbox}[
- title = {\hspace{-2em}\Option{#1 = #2}},
- description,
- ]
- }{
- \end{tcolorbox}%
- \medskip%
-}
-
-
%% Repetitive text
\NewDocumentCommand{\MacroOptionsText}{}{%
- Any \Argument{options} specified uniquely affect this macro.%
+ Any \Argument{options} specified apply only to this macro.%
}
\NewDocumentCommand{\BlockOptionsText}{}{%
- Any of the \Argument{options} specified in this macro will affect this command and all items in the inner block, propagating up to and including the closing macro.%
+ Any \Argument{options} specified in this macro will impact this command and all items within the inner block, propagating up to and including the closing macro.%
}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\title{%
- The \PackageName{algxpar} package\thanks{This document corresponds to \PackageName{algxpar}~v\AlgVersion, dated \AlgDate.
- This text was last compiled \today.}%
+ The \PackageName{algxpar} package\\\normalsize\AlgVersion
}
\author{Jander Moreira -- \texttt{moreira.jander at gmail.com}}
-\date{October 23, 2024}
+\date{\AlgDate}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
@@ -249,65 +59,62 @@
\begin{document}
\maketitle
-\sloppy
\begin{abstract}
The \PackageName{algxpar} package is an extension of the \PackageName{algorithmicx}\footnote{\url{https://ctan.org/pkg/algorithmicx}.}/\PackageName{algpseudocode} package to handle multi-line text with proper indentation and provide a number of other improvements.
\end{abstract}
-
\tableofcontents
-\VCRegisterVersion{0.9}{2019-11-12}
-\VCRegisterVersion{0.91}{2020-08-01}
-\VCRegisterVersion{0.99}{2023-06-28}
-\VCRegisterVersion{0.99.1}{2024/05/05}
-\VCRegisterVersion{0.99.2}{2024/10/23}
+\PDNewVersion{0.9}{2019-11-12}
+\PDAddChange{0.9}{
+ description = Initial version.,
+ no box,
+ no page,
+}%
+\PDNewVersion{0.91}{2020-08-01}
+\PDNewVersion{0.99}{2023-06-28}
+\PDAddChange{0.99}{
+ description = The code was reviewd and almost entirely rewritten.,
+ no box,
+ no page,
+}.
+\PDNewVersion{0.99.1}{2024/05/05}
+\PDNewVersion{0.99.2}{2024/10/23}
+\PDAddChange{0.99.2}{
+ description = Part of the code was rewritten using \PackageName{etoolbox}.,
+ no box,
+ no page,
+}
+\PDNewVersion{0.99.2a}{2025/07/31}
+\PDAddChange{0.99.2a}{
+ description = {Fixed length computation in non-commented lines to consider the token length.},
+ no box,
+ no page,
+}
+
\begin{figure}
- \tcbinputlisting{listing file = algxpar-lzw.tex, listing only}
+ \tcbinputlisting{example, listing file = algxpar-lzw.tex, listing only}
\vspace{3em}
- \tcbinputlisting{listing file = algxpar-lzw.tex, text only}
+ \tcbinputlisting{example, listing file = algxpar-lzw.tex, text only}
\end{figure}
+\PDPrintChanges
-% \vspace{2em}
-% \changes{v0.9}{2019/10/24}{First version}
-% \changes{v0.91}{2020/04/30}{Macro now can be used as super-/subscripts in math formulas, while still preventing hyphenaton in text mode.}
-% \changes{v0.91}{2020/06/14}{New macro for assignments, using $\gets$}
-% \changes{v0.91}{2020/06/14}{New macro for assignments (verbose)}
+\section{Introduction}
+I teach algorithms and programming, and for writing my algorithms, I've adopted the \PackageName{algorithmicx} package (\PackageName{algpseudocode}). It allows me to create pseudocode that's both clear and easy to read, requiring minimal effort to ensure it looks visually appealing.
-\VCPrintChanges
+Teaching algorithms involves a different approach to pseudocode compared to its typical use in scientific papers, where solutions are often presented in a more formal, concise manner. Students typically work with abstract algorithms before learning a specific programming language, so the focus is more on the logic of the solution than on the variables themselves. Additionally, teaching strategies that emphasize refinement and iteration call for a less programmatic and more descriptive style of code. For instance, instead of writing something like ``${s \gets s + c}$,'' we might say, ``\emph{accumulate current expenses in the total sum of costs},'' as the latter provides a clearer explanation of the logic without requiring students to understand the specifics of variable manipulation.
+However, this more verbose approach often results in longer sentences that can span multiple lines. Given that pseudocode places a premium on visual clarity—particularly in control structures and indentation—it became necessary to create a package that accommodates multi-line statements while maintaining readability.
-\section{Introduction}
-I teach algorithms and programming and have adopted the \PackageName{algorithmicx} package (\PackageName{algpseudocode}) for writing my algorithms as it provides clear and easy to read pseudocodes with minimal effort to get a visually pleasing code.
+The \PackageName{algorithmicx} and \PackageName{algpseudocode} packages do not natively support multi-line statements. Therefore, this package extends several macros to manage multi-line code properly, adding new commands and features to improve its functionality.
-The process of teaching algorithms requires a slightly different use of pseudocode than that normally presented in scientific articles, in which the solutions are presented in a more formal and synthetic way. Students work on more abstract algorithms often preceding the actual knowledge of a programming language, and thus the logic of the solution is more relevant than the variables themselves. Likewise, the use of the development strategy by successive refinements also requires a less programmatic and more verbose code. Thus, when discussing the reasoning for solving a problem, it is common to use sentences such as ``\emph{accumulate current expenses in the total sum of costs}'', because ``${s \gets s + c}$'' is, in this case, too synthetic and necessarily involves knowing how variables work in programs.
-The consequence of more verbose pseudocode leads, however, to longer sentences that often span two or more lines. As pseudocodes, by nature, value visual organization, with regard to control structures and indentations, it became necessary to develop a package that supports the use of commands and comments that could be easily displayed when more than one line was needed.
+\needspace{3cm}
-The \PackageName{algorithmx} and \PackageName{algpseudocode} packages do not natively support multi-line statements. This package therefore extends several macros to handle multiple lines correctly. Some new commands and a number of features have also been added.
-This package was first released as V0.9%
-\VCChange[disable]{
- type = released,
- version = 0.9,
- description = Initial version,
-}%
-and almost totally rewritten in v0.99%
-\VCChange[disable]{
- type = new,
- version = 0.99,
- description = The code was reviewd and almost entirely rewritten,
-}.
-\VCChange[disable]{
- type = new,
- version = 0.99.2,
- description = Part of the code was rewritten using \PackageName{etoolbox}.,
-}.
-
-
\section{Package usage and options}\label{sec:package-usage-and-options}
This package depends on the following packages:
@@ -330,54 +137,55 @@
\medskip
To use the package, simply request its use in the preamble of the document.
-\begin{macro*}{usepackage}{\OArg{package options list}}[algxpar]
- Currently, the list of package options includes the following.
+\begin{Macro*}{usepackage}{\OArg{package options list}\PArg{algxpar}}{}
+\end{Macro*}
- \begin{option*}{\Argument{language name}}
- By default, algorithm keywords are developed in English. The English language keyword set is always loaded. When available, other sets of keywords in other languages can be used simply by specifying the language names. The last language in the list is automatically set as the document's default language.
+Currently, the list of package options includes the following.
- Currently supported languages:
- \begin{itemize}
- \item \OptionInd{english} (default language, always loaded)
- \item \OptionInd{brazilian} Brazilian Portuguese
- \end{itemize}
- \end{option*}
+\begin{Option*}{\Argument{language name}}{}{}
+ Algorithm keywords are typically created in English by default, with the English keyword set always being loaded. When available, one can use keyword sets in other languages by specifying the desired language.
- \begin{latexcode}
- % Loads Brazilian keyword set and sets it as default
- \usepackage[brazilian]{algxpar}
- \end{latexcode}
+ Currently supported languages:
+ \begin{itemize}
+ \item \OptionInd{english} (default language, always loaded)
+ \item \OptionInd{brazilian} Brazilian Portuguese
+ \end{itemize}
+\end{Option*}
- \begin{optionnoind}{language}{\Argument{language name}}
- This option chooses the set of keywords corresponding to \Argument{language name} as the default for the document. This option is available as a general option (see \OptionRef{language}).
+\begin{PDListing}
+ % Loads Brazilian keyword set and sets it as default
+ \usepackage[brazilian]{algxpar}
+\end{PDListing}
- This option is useful when other languages are loaded.
- \end{optionnoind}
+\begin{Optiondef}{language}{\Argument{language name}}{}
+ This option selects the keyword set corresponding to \Argument{language name} as the document's default. It is available as a general option (see \OptionRef{language}).
- \begin{latexcode}
- % Loads Brazilian keyword set but keeps English as default
- \usepackage[brazilian, language = english]{algxpar}
- \end{latexcode}
+ This option is useful when other languages are loaded.
+\end{Optiondef}
- \begin{option*}{\Option{noend}}
- The \OptionInd{noend} suppresses the line that indicates the end of a block, keeping the indentation.
+\begin{PDListing}
+ % Loads Brazilian keyword set but keeps English as default
+ \usepackage[brazilian, language = english]{algxpar}
+\end{PDListing}
- See more information in \OptionRef{end} and \OptionRef{noend} options.
- \end{option*}
+\begin{Optiondef}{noend}{\PDInline{true} | \PDInline{false}}{Default: \PDInline{true}; initially: \PDInline{true}}
+ The \Option{noend} option suppresses the line marking the end of a block, while preserving the indentation.
- \begin{latexcode}
- % Suppresses all end-lines that close a block
- \usepackage[noend]{algxpar}
- \end{latexcode}
-\end{macro*}
+ See more information in \OptionRef{end} and \OptionRef{noend} options.
+\end{Optiondef}
+\begin{PDListing}
+ % Suppresses all end-lines that close a block
+ \usepackage[noend]{algxpar}
+\end{PDListing}
+
\section{Writting pseudocode}
-Algorithms, following the functionality of the \PackageName{algorithmicx} package, are written within the \latexinline{algorithmic} environment. The possibility of using a number to determine how the lines will be numbered is maintained as in the original version.
+Algorithms, following the structure of the \PackageName{algorithmicx} package, are written within the \PDInline{algorithmic} environment. The option to use a number to determine line numbering is preserved from the original version.
-An algorithm is composed of instructions and control structures such as conditionals and loops. And also, some documentation and comments.
+An algorithm consists of instructions, control structures like conditionals and loops, as well as documentation and comments.
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\Description Calculation of the factorial of a natural number
\Input $n \in \mathbb{N}$
@@ -390,20 +198,21 @@
\EndFor
\Statep{\Write \Id{factorial}}
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
\subsection{A preamble on comments}\label{sec:a-preamble-on-comments}
-This is the Euclid's algorithm as provided in the \PackageName{algorithmicx} package documentation\footnote{A label was suppressed here.}.
+This is Euclid's algorithm as shown in the \PackageName{algorithmicx} package documentation\footnote{A label has been suppressed here.}.
\begingroup
%! formatter = off
\AlgSet{comment font = {}}
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}[1]
\Procedure{Euclid}{$a,b$}
\Comment{The g.c.d. of a and b}
\State $r\gets a\bmod b$
- \While{$r\not=0$}\Comment{We have the answer if r is 0}
+ \While{$r\not=0$}
+ \Comment{We have the answer if r is 0}
\State $a\gets b$
\State $b\gets r$
\State $r\gets a\bmod b$
@@ -411,7 +220,7 @@
\State \textbf{return} $b$\Comment{The gcd is b}
\EndProcedure
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
\endgroup
@@ -422,7 +231,7 @@
%! formatter = off
\begingroup
\AlgSet{comment font = {}}
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}[1]
\Procedure[The g.c.d. of a and b]{Euclid}{$a,b$} % <-- Comment
\State $r\gets a\bmod b$
@@ -434,12 +243,12 @@
\Statep[The gcd is b]{\Keyword{return} $b$} % <-- Comment
\EndProcedure
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
\endgroup
%! formatter = on
Using the comment before the text always bothered me somewhat, as it seemed more natural to put it after.
-\VCChange{
+\PDAddChange{
type = new,
version = 0.99,
description = Optional comments may be specified after the command
@@ -446,7 +255,7 @@
}%
Thus, as of v0.99, the comment can be placed after the text (as the second parameter of the macro), certainly making writing algorithms more user-friendly. To maintain backward compatibility, the use of comments before text is still supported, although it is discouraged.
-\VCChange{
+\PDAddChange{
type = new,
version = 0.99,
description = Lines that closes blocks can have comments
@@ -456,7 +265,7 @@
%! formatter = off
\begingroup
\AlgSet{comment font = {}}
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}[1]
\Procedure{Euclid}{$a,b$}[The g.c.d. of a and b] % <-- Comment
\State $r\gets a\bmod b$
@@ -468,7 +277,7 @@
\Statep{\Keyword{return} $b$}[The gcd is b] % <-- Comment
\EndProcedure
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
\endgroup
%! formatter = on
@@ -479,23 +288,24 @@
See more about comments in \cref{sec:comments}.
\subsection{A preamble on options}\label{sec:a-preamble-on-options}
-\VCChange{
- type = new,
- version = 0.99,
- description = {The ``look and feel'' of the pseudocode can be set in the \Macro{begin}\latexinline{{algorithmic}}}
-}[Preamble options]%
+\PDAddChange{0.99}{
+ description = {The ``look and feel'' of the pseudocode can be set in the \Macro{begin}\PDInline{{algorithmic}}},
+ no box,
+}%
As of version 0.99, a list of options can be added to each command, changing some algorithm presentation settings. These settings are optional and must be entered using angle brackets at the end of the command.
%! formatter = off
-\begin{tcblisting}{}
- \begin{algorithmic}<keyword font = \scshape\bfseries, comment width = nice>
+\begin{PDExample}
+ \begin{algorithmic}
+ <keyword font = \scshape\bfseries, comment width = nice>
\If{$a > b$}[check conditions]
- \While{$a > 0$}<keyword color = blue!70>
+ \While{$a > 0$}
+ <keyword color = blue!70>
\Statep{\Call{Process}{$a$}}[process current data]
\EndWhile
\EndIf
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
There is a lot of additional information about options and how they can be used. See discussion and full list in \cref{sec:customization-and-fine-tunning}.
@@ -506,13 +316,13 @@
For automatic handling of comments and multi-line text, the \Macro{Statep} macro is available, which should be used instead of \Macro{State}.
-\begin{macro}{Statep}[\OArg{comment*}\MArg{text}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Statep}{\OArg{comment*}\MArg{text}\OArg{comment}\AArg{options}}{}
The \Macro{Statep} macro corresponds to an statement that can extrapolate a single line. The continuation of each line is indented from the baseline and this indentation is based on the value indicated in the \OptionRef{statement indent} option.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
-As an example, observe lines~\ref{alg:lzw:output} and \ref{alg:lzw:add-to-table} of the LZW compression algorithm on \cpageref{alg:lzw:add-to-table}.
+% As an example, observe lines~\ref{alg:lzw:output} and \ref{alg:lzw:add-to-table} of the LZW compression algorithm on \cpageref{alg:lzw:add-to-table}.
\subsection{Flow Control Blocks}\label{sec:flow-control-blocks}
Flow control is essentially based on conditionals and loop.
@@ -520,7 +330,7 @@
\subsubsection{The \Keyword{if} block}
This block is the standard \textit{if} block.
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\State \Read $v$
\If{$v < 0$}[is it negative?]
@@ -527,95 +337,95 @@
\Statep{$v \gets -v$}[make it positive]
\EndIf
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
-\begin{macro}{If}[\OArg{comment*}\MArg{text}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{If}{\OArg{comment*}\MArg{text}\OArg{comment}\AArg{options}}{}
\Macro{If} shows \Argument{text} (the condition) and must be closed with an \MacroRef{EndIf}, creating a block of nested commands.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{EndIf}[\OArg{comment}\LArg{options}]
+\begin{Macrodef}{EndIf}{\OArg{comment}\AArg{options}}{}
\Macro{EndIf} closes its respective \MacroRef{If}.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{Else}[\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Else}{\OArg{comment}\AArg{options}}{}
This macro defines the \Keyword{else} part of the \MacroRef{If} statement.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{Elsif}[\OArg{comment*}\MArg{text}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Elsif}{\OArg{comment*}\MArg{text}\OArg{comment}\AArg{options}}{}
\Macro{ElsIf} defines the \MacroRef{If} chaining. The argument \Argument{text} is the new condition.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
\subsubsection{The \Keyword{switch} block}
%! formatter = off
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
- \Statep{Get \Id{option}}
- \Switch{\Id{option}}
- \Case{1}[inserts new record]
- \Statep{\Call{Insert}{\Id{record}}}
- \EndCase
- \Case{2}[deletes a record]
- \Statep{\Call{Delete}{\Id{key}}}
- \EndCase
- \Otherwise
- \Statep{Print ``invalid option''}
- \EndOtherwise
+ \Statep{Get \Id{Optiondef}}
+ \Switch{\Id{Optiondef}}
+ \Case{1}[inserts new record]
+ \Statep{\Call{Insert}{\Id{record}}}
+ \EndCase
+ \Case{2}[deletes a record]
+ \Statep{\Call{Delete}{\Id{key}}}
+ \EndCase
+ \Otherwise
+ \Statep{Print ``invalid option''}
+ \EndOtherwise
\EndSwitch
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
-\begin{macro}{Switch}[\OArg{comment*}\MArg{expression}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Switch}{\OArg{comment*}\MArg{expression}\OArg{comment}\AArg{options}}{}
The \Macro{Switch} is closed by a matching \MacroRef{EndSwitch}.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{EndSwitch}[\OArg{comment}\LArg{options}]
+\begin{Macrodef}{EndSwitch}{\OArg{comment}\AArg{options}}{}
This macro closes a \MacroRef{Switch} block.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{Case}[\OArg{comment*}\MArg{constant-list}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Case}{\OArg{comment*}\MArg{constant-list}\OArg{comment}\AArg{options}}{}
When the result of the \Keyword{switch} expression matches one of the constants in \Argument{constants-list}, then the \Keyword{case} is executed. Usually the \Argument{constant-list} is a single constant, a comma-separated list of constants or some kind of range specification.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{EndCase}[\OArg{comment}\LArg{options}]
+\begin{Macrodef}{EndCase}{\OArg{comment}\AArg{options}}{}
This macro closes a corresponding \MacroRef{Case} statement.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{Otherwise}[\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Otherwise}{\OArg{comment}\AArg{options}}{}
A \Keyword{switch} structure can optionally use an \Keyword{otherwise} clause, which is executed when no previous \Keyword{case}s had a hit.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{EndOtherwise}[\OArg{comment}\LArg{options}]
+\begin{Macrodef}{EndOtherwise}{\OArg{comment}\AArg{options}}{}
This macro closes a corresponding \MacroRef{Otherwise} statement.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
\subsubsection{The \Keyword{for} block}
The \Keyword{for} loop uses \Macro{For} and is also flavored with two variants: \Keyword{foreach} (\Macro{ForEach}) and \Keyword{forall} (\Macro{ForAll}).
%! parser = off
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\For{$i \gets 0$ \To $n$}
\Statep{Do something with $i$}
@@ -627,34 +437,34 @@
\Statep{Do something with \Id{item}}
\EndFor
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! parser = on
-\begin{macro}{For}[\OArg{comment*}\MArg{text}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{For}{\OArg{comment*}\MArg{text}\OArg{comment}\AArg{options}}{}
The \Argument{text} is used to establish the loop scope.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{EndFor}[\OArg{comment}\LArg{option}]
+\begin{Macrodef}{EndFor}{\OArg{comment}\AArg{Optiondef}}{}
This macro closes a corresponding \MacroRef{For}, \MacroRef{ForEach} or \MacroRef{ForAll}.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{ForEach}[\OArg{comment*}\MArg{text}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{ForEach}{\OArg{comment*}\MArg{text}\OArg{comment}\AArg{options}}{}
Same as \MacroRef{For}.
-\end{macro}
+\end{Macrodef}
-\begin{macro}{ForAll}[\OArg{comment*}\MArg{text}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{ForAll}{\OArg{comment*}\MArg{text}\OArg{comment}\AArg{options}}{}
Same as \MacroRef{For}.
-\end{macro}
+\end{Macrodef}
\subsubsection{The \Keyword{while} block}
\Macro{While} is the loop with testing condition at the top.
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\While{$n > 0$}
\Statep{Do something}
@@ -661,24 +471,24 @@
\Statep{$n \gets n - 1$}
\EndWhile
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
-\begin{macro}{While}[\OArg{comment*}\MArg{text}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{While}{\OArg{comment*}\MArg{text}\OArg{comment}\AArg{options}}{}
In \Argument{text} is the boolean expression that, when \False, will end the loop.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{EndWhile}[\OArg{comment}\LArg{options}]
+\begin{Macrodef}{EndWhile}{\OArg{comment}\AArg{options}}{}
This macro closes a matching \MacroRef{While} block.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
\subsubsection{The \Keyword{repeat}-\Keyword{until} block}
The loop with testing condition at the bottom is the \Macro{Repeat}/\Macro{Until} block.
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\Repeat
\Statep{Do something}
@@ -685,24 +495,24 @@
\Statep{$n \gets n - 1$}
\Until{$n \leq 0$}
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
-\begin{macro}{Repeat}[\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Repeat}{\OArg{comment}\AArg{options}}{}
This macro starts the \Keyword{repeat} loop, which is closed with \MacroRef{Until}.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{Until}[\OArg{comment*}\MArg{text}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Until}{\OArg{comment*}\MArg{text}\OArg{comment}\AArg{options}}{}
In \Argument{text} is the boolean expression that, when \MacroRef{True}, will end the loop.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
\subsubsection{The \Keyword{loop} block}
A generic loop is build with \Macro{Loop}.
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\Loop
\Statep{Do something}
@@ -717,82 +527,81 @@
\Statep{Keep working}
\EndLoop
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
-\begin{macro}{Loop}[\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Loop}{\OArg{comment}\AArg{options}}{}
The generic loop starts with \Macro{Loop} and ends with \MacroRef{EndLoop}. Usually the infinite loop is interrupted by and internal \MacroDef{Break} or restarted with \MacroDef{Continue}.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{EndLoop}[\OArg{comment}\LArg{options}]
+\begin{Macrodef}{EndLoop}{\OArg{comment}\AArg{options}}{}
\Macro{EndLoop} closes a matching \MacroRef{Loop} block.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
\subsection{Constants and Identifiers}\label{sec:constants-and-identifiers}
A few macros for well known constants were defined: \MacroDef{True} (\True), \MacroDef{False} (\False), and \MacroDef{Nil} (\Nil).
-The macro \Macro{Id} was created to handle ``program-like'' named identifiers, such as \Id{sum}, \Id{word\_counter} and so on.
+The macro \Macro{Id} was created to handle ``program-like'' named identifiers, such as \Id{sum}, \Id{word_counter} and so on.
-\begin{macro}{Id}[\MArg{identifier}]
- \VCChange{
- type = updated,
- version = 0.91,
+\begin{Macrodef}{Id}{\MArg{identifier}}{}
+ \PDAddChange{0.91}{
+ update,
description = {\Macro{Id} has been recoded to work in both text and math modes, preventing hyphenation},
- }[\Macro{Id}]
- Identifiers are emphasised: \latexinline!\Id{value}! is \Id{value}. Its designed to work in both text and math modes: \latexinline!$\Id{offer}_k$! is $\Id{offer}_k$.
-\end{macro}
+ no box,
+ }%
+ \PDAddChange{0.99.2a}{
+ update,
+ description = {\MacroRef{Id} updated to natively handle the underscore character without escaping.},
+ }%
+ Identifiers are emphasised: \PDInline!\Id{my_value}! is \Id{my_value}. Its designed to work in both text and math modes: \PDInline!$\Id{offer}_k$! is $\Id{offer}_k$.
+\end{Macrodef}
\subsection{Assignments and I/O}\label{sec:assignments-and-i/o}
To support teaching-like, basic pseudocode writing, the macros \MacroDef{Read} and \MacroDef{Write} are provided.
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\Statep{\Read $v_1, v_2$}
\Statep{$\Id{mean} \gets \dfrac{v_1 + v_2}{2}$}[calculate]
\Statep{\Write \Id{mean}}
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
The \Macro{Set} macro, although obsolete, can be used for assignments.
-\begin{macro}{Set}[\MArg{lvalue}\MArg{expression} \Deprecated]
- \VCChange{
- type = new,
- version = 0.91,
- %! parser = off
- description = {\Macro{Set} can be used for assignments (deprecated in v0.99)},
- %! parser = on
- }[\Macro{Set}]%
- This macro expands to \MacroRef{Id}\latexinline!{#1} \gets #2!.
-
- this macro will no longer be supported. It will be kept as is for backward compatibility however.
- \VCChange{
- type = deprecated,
- version = 0.99,
+\begin{Macrodef}{Set}{\MArg{lvalue}\MArg{expression}}{}
+ \PDAddChange{0.91}{
+ description = \Macro{Set} can be used for assignments.,
+ no box,
+ }%
+ \PDAddChange{0.99}{
+ deprecation,
description = {\Macro{Set} is deprecated and will no longer be supported},
- }[\Macro{Set}]%
- As the handling of text and math modes should be done and its usage brings no evident advantage,
+ }%
+ This macro expands to \MacroRef{Id}\PDInline!{#1} \gets #2!.
- \VCChange{
- type = removed,
- version = 0.99,
- description = {\Macro{Setl} has been removed from the package},
- }[\Macro{Setl}]%
- The macro \MacroRefInd{Setl} has been removed.
-\end{macro}
+ It will no longer be supported but will be retained as-is for backward compatibility. Since proper handling of text and math modes is needed and its usage offers no clear benefit, there is no justification to keep it.
+\end{Macrodef}
+\PDAddChange{0.99}{
+ removal,
+ title = \Macro{Setl},
+ description = {\Macro{Setl} has been removed from the package},
+}%
+The macro \MacroRefInd{Setl} has been removed.
+
\subsection{Procedures and Functions}\label{sec:procedures-and-functions}
Modularization uses \Macro{Procedure} or \Macro{Function}.
%! formatter = off
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\Procedure{SaveNode}{\Id{node}}[saves a B\textsuperscript{+}-tree node to disk]
- \If{\Id{node}.\Id{is\_modified}}
+ \If{\Id{node}.\Id{is_modified}}
\If{$\Id{node}.\Id{address} = -1$}
\Statep{Set file writting position after file's last byte}[creates a new node on disk]
\Else
@@ -799,13 +608,13 @@
\Statep{Set file writting position to \Id{node}.\Id{address}}[updates the node]
\EndIf
\Statep{Write \Id{node} to disk}
- \Statep{$\Id{node}.\Id{is\_modified} \gets \False$}
+ \Statep{$\Id{node}.\Id{is_modified} \gets \False$}
\EndIf
\EndProcedure
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\Function{Factorial}{$n$}[$n \geq 0$]
\If{$n \in \{0, 1\}$}
@@ -815,73 +624,74 @@
\EndIf
\EndFunction
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
-\begin{macro}{Procedure}[\MArg{name}\MArg{argument list}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Procedure}{\MArg{name}\MArg{argument list}\OArg{comment}\AArg{options}}{}
This macro creates a \Keyword{procedure} block that must be ended with \MacroRef{EndProcedure}.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{EndProcedure}[\OArg{comment}\LArg{optons}]
+\begin{Macrodef}{EndProcedure}{\OArg{comment}\AArg{optons}}{}
This macro closes the \MacroRef{Procedure} block.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{Function}[\MArg{name}\MArg{argument list}\OArg{comment}\LArg{options}]
+\begin{Macrodef}{Function}{\MArg{name}\MArg{argument list}\OArg{comment}\AArg{options}}{}
This macro creates a \Keyword{function} block that must be ended with \MacroRef{EndFunction}. A \MacroDef{Return} is defined.
\BlockOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{macro}{EndFunction}[\OArg{comment}\LArg{optons}]
+\begin{Macrodef}{EndFunction}{\OArg{comment}\AArg{optons}}{}
This macro closes the \MacroRef{Function} block.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
For calling a procedure or function, \Macro{Call} should be used.
-\begin{macro}{Call}[\MArg{name}\MArg{arguments}\LArg{options}]
+\begin{Macrodef}{Call}{\MArg{name}\MArg{arguments}\AArg{options}}{}
\label{call}
\Macro{Call} is used to state a function or procedure call. The module's \Argument{name} and \Argument{arguments} are mandatory.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
\subsection{Comments}\label{sec:comments}
-The \Macro{Comment} macro defined by \PackageName{algorithmicx} has the same original behavior and has been redefined to handle styling options.
+The \Macro{Comment} macro, as defined by the \PackageName{algorithmicx} package, retains its original behavior and has been redefined to support styling options.
-\begin{macro}{Comment}[\MArg{text}\LArg{options}]
- The redesigned version of \Macro{Comment} can be used with \MacroRef{State}, \MacroRef{Statex} and \MacroRef{Statep}. When used with \MacroRef{Statep}, it must be enclosed inside the text braces, but multi-line statements should work differently than expected.
+\begin{Macrodef}{Comment}{\MArg{text}\AArg{options}}{}
+ The updated \Macro{Comment} can be used with \Macro{State}, \Macro{Statex}, and \MacroRef{Statep}. When used with \MacroRef{Statep}, it should be enclosed within the text braces, though multi-line statements may function differently than expected.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
%! formatter = off
-\begin{tcblisting}{sidebyside = false}
+\begin{PDExample}
\begin{minipage}{7.5cm}
- \begin{algorithmic}<comment color = blue>% for viewing purposes only
- \State Store the value zero in variable $x$\Comment{first assignment}
- \Statep{Store the value zero in variable $x$\Comment{first assignment}}
- \Statep{Store the value zero in variable $x$}[first assignment]% best choice
+ \begin{algorithmic}
+ <comment color = blue>% for viewing purposes only
+ \State Assign the value zero to the variable $x$\Comment{first assignment}
+ \Statep{Assign the value zero to the variable $x$\Comment{first assignment}}
+ \Statep{Assign the value zero to the variable $x$}[first assignment]% best choice
\end{algorithmic}
\end{minipage}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
-\begin{macro}{Commentl}[\MArg{text}\LArg{options}]
- While \MacroRef{Comment} pushes text to the end of the line, the macro \Macro{Commentl} is ``local''. In other words, it just puts a comment in place.
+\begin{Macrodef}{Commentl}{\MArg{text}\AArg{options}}{}
+ While \MacroRef{Comment} pushes text to the end of the line, the \Macro{Commentl} macro is ``local'' -- it simply places a comment without altering the line structure.
Local comments follows regular text and no line changes are checked.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\If{$a > 0$~~\Commentl{special case}\\
or\\
@@ -889,80 +699,75 @@
\Statep{Process data~~\Commentl{may take a while}}
\EndIf
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
-\begin{macro}{CommentIn}[\MArg{text}\LArg{options}]
- \Macro{CommentIn} is an alternative to \textit{line comments} which usually extends to the end of the line. This macro defines a comment with a begin and an end. A comment starts with \CommentSymbol\ and ends with \CommentSymbolRight.
+\begin{Macrodef}{CommentIn}{\MArg{text}\AArg{options}}{}
+ \Macro{CommentIn} is an alternative to \textit{line comments}, which typically extend to the end of the line. This macro defines a comment with both a beginning and an end. A comment starts with \CommentSymbol\ and ends with \CommentSymbolRight.
\MacroOptionsText
-\end{macro}
+\end{Macrodef}
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\If{$a > 0$ \CommentIn{special case} or $a < b$ \CommentIn{general case}}
\Statep{Process data~~\Commentl{may take a while}}
\EndIf
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
\subsection{Documentation}\label{sec:documentation}
A series of macros are defined to provide the header documentation for a pseudocode.
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\Description Calculation of the factorial of a natural number through successive multiplications
\Require $n \in \mathbb{N}$
\Ensure $f = n!$
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
-\begin{macro}{Description}
-[~\Argument{description text}]
+\begin{Macrodef}{Description}{~\Argument{description text}}{}
The \Macro{Description} is intended to hold the general description of the pseudocode.
-\end{macro}
+\end{Macrodef}
-\begin{macro}{Require}
-[~\Argument{pre-conditions}]
+\begin{Macrodef}{Require}{~\Argument{pre-conditions}}{}
The required initial state that the code relies on. These are \textit{pre-conditions}.
-\end{macro}
+\end{Macrodef}
-\begin{macro}{Ensure}
-[~\Argument{post-conditions}]
+\begin{Macrodef}{Ensure}{~\Argument{post-conditions}}{}
The final state produced by the code. These are \textit{post-conditions}.
-\end{macro}
+\end{Macrodef}
-\begin{tcblisting}{}
+\begin{PDExample}
\begin{algorithmic}
\Description Calculation of the factorial of a natural number through successive multiplications
\Input $n$ (integer)
\Output $n!$ (integer)
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
-\begin{macro}{Input}
-[~\Argument{inputs}]
+\begin{Macrodef}{Input}{~\Argument{inputs}}{}
This works as an alternative to \MacroRef{Require}, presenting \Keyword{input}.
-\end{macro}
-\begin{macro}{Output}
-[~\Argument{outputs}]
+\end{Macrodef}
+\begin{Macrodef}{Output}{~\Argument{outputs}}{}
This works as an alternative to \MacroRef{Ensure}, presenting \Keyword{output}.
-\end{macro}
+\end{Macrodef}
\section{Customization and Fine Tunning}\label{sec:customization-and-fine-tunning}
-As of version 0.99 of \PackageName{algxpar}, a series of options have been introduced to customize the presentation of algorithms. Colors and fonts that only apply to keywords, for example, can be specified, providing an easier and more convenient way to customize each algorithm.
+Starting from version 0.99 of \PackageName{algxpar}, a set of options has been introduced to customize the presentation of algorithms. For instance, colors and fonts specific to keywords can now be specified, offering a more convenient way to tailor each algorithm.
-The \MacroRef{AlgSet} macro serves this purpose.
+The \MacroRef{AlgSet} macro fulfills this purpose.
-\begin{macro}{AlgSet}[\MArg{options list}]
+\begin{Macrodef}{AlgSet}{\MArg{options list}}{}
This macro sets algorithmic settings as specified in the \Argument{options list}, which is key/value comma-separated list.
- All settings will be applied to the entire document, starting from the point of the macro call. The scope of a definition made with \MacroRef{AlgSet} can be restricted to a part of the document simply by including it in a \TeX\ group.
-\end{macro}
+ All settings will be applied to the entire document from the point where the macro is called. To limit the scope of a definition made with \MacroRef{AlgSet} to a specific part of the document, simply enclose it in a \TeX\ group.
+\end{Macrodef}
\begingroup
-\begin{tcblisting}{}
+\begin{PDExample}
\AlgSet{algorithmic indent = 1.5cm}
\begin{algorithmic}
\Statep{\Read $k$}
@@ -971,14 +776,15 @@
\EndIf
\Statep{\Write $k$}
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
\endgroup% ends the scope
If the settings are only applied to a single algorithm and not a group of algorithms in a text section, the easiest way is to include the options in the \texttt{algorithmicx} environment.
%! formatter = off
-\begin{tcblisting}{}
- \begin{algorithmic}<keyword font = \sffamily\bfseries\itshape>
+\begin{PDExample}
+ \begin{algorithmic}
+ <keyword font = \sffamily\bfseries\itshape>
\Statep{\Read $k$}
\If{$k < 0$}
\Statep{$k \gets -k$}
@@ -985,13 +791,13 @@
\EndIf
\Statep{\Write $k$}
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
Named styles can also be defined using the \PackageName{pgfkeys} syntax.
%! formatter = off
-\begin{tcblisting}{}
+\begin{PDExample}
\AlgSet{
fancy/.style = {
text color = green!40!black,
@@ -1000,7 +806,8 @@
comment symbol = \texttt{//},
}
}
- \begin{algorithmic}<fancy>
+ \begin{algorithmic}
+ <fancy>
\Statep{\Commentl{Process $k$}}
\Statep{\Read $k$}
\If{$k < 0$}
@@ -1008,13 +815,13 @@
\EndIf
\Statep{\Write $k$}
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
Sometimes some settings need to be applied exclusively to one command, for example to highlight a segment of the algorithm.
%! formatter = off
-\begin{tcblisting}{}
+\begin{PDExample}
\AlgSet{
highlight/.style = {
text color = red!60!black,
@@ -1024,38 +831,37 @@
\begin{algorithmic}
\Statep{\Commentl{Process $k$}}
\Statep{\Read $k$}
- \If{$k < 0$}<highlight>
+ \If{$k < 0$}
+ <highlight>
\Statep{$k \gets -k$}[back to positive]
\EndIf
\Statep{\Write $k$}
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
\subsection{Options}\label{sec:options}
-\VCChange{
- type = new,
- version = 0.99,
- description = {Added support to style the main components of the pseudocode, such as keywords, comments and text and widths}
-}[Options]%
+\PDAddChange{0.99}{
+ description = {Added support to style the main components of the pseudocode, such as keywords, comments and text and widths.},
+ no box,
+}%
This section presents the options that can be specified for the algorithms, either using \MacroRef{AlgSet} or the \Argument{options} parameter of the various macros.
-\begin{option}{indent lines}{\Option{true} | \Option{false}}[true]
- \VCChange{
- type = new,
- version = 0.99.1,
+\begin{Optiondef}{indent lines}{\PDInline{true} | \PDInline{false}}{Default: \PDInline{true}; initially: \PDInline{false}}
+ \PDAddChange{0.99.1}{
description = Added experimental support to show vertical indentantion lines,
- }[\Option{indent lines}]%
- With \Option{indent lines} vertical indentation lines are displayed in the pseudocode. This feature only works correctly if the start and end of the block are on the same page and at least two compilation steps are required for the lines to be positioned correctly.
+ }%
+ The \Option{indent lines} option displays vertical indentation lines in the pseudocode. This feature works properly only if the start and end of the block are on the same page. Additionally, at least two compilation steps are needed for the lines to be correctly positioned.
To change the style for the lines, use \OptionRef{line style}
\textit{This feature is still experimental and incomplete.}
-\end{option}
+\end{Optiondef}
%! formatter = off
-\begin{tcblisting}{}
- \begin{algorithmic}<indent lines>
+\begin{PDExample}
+ \begin{algorithmic}
+ <indent lines>
\For{$i \gets 0$ \To $N - 1$}
\For{$j \gets$ \To $N - 1$}
\If{$m_{ij} < 0$}
@@ -1065,7 +871,8 @@
\EndFor
\end{algorithmic}
- \begin{algorithmic}<indent lines, noend>
+ \begin{algorithmic}
+ <indent lines, noend>
\For{$i \gets 0$ \To $N - 1$}
\For{$j \gets$ \To $N - 1$}
\If{$m_{ij} < 0$}
@@ -1074,23 +881,22 @@
\EndFor
\EndFor
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
-\begin{option}{line style}{\Argument{style}}
- \VCChange{
- suppress,
- version = 0.99.1,
- description = SUPRESSED???,
- }[\Option{line style}]%
+\begin{Optiondef}{line style}{\Argument{style}}{}
+ \PDAddChange{0.99.1}{
+ description = {\Option{line style} option added to style indent lines.},
+ }%
Almost anything Ti\emph{k}Z can apply to a line can be used to set the indentation lines.
To show indentation lines in algorithms, \OptionRef{indent lines} must be set to true.
-\end{option}
+\end{Optiondef}
%! formatter = off
-\begin{tcblisting}{}
- \begin{algorithmic}<indent lines, line style = {orange, dotted, -latex, ultra thick}>
+\begin{PDExample}
+ \begin{algorithmic}
+ <indent lines, line style = {orange, dotted, -latex, ultra thick}>
\For{$i \gets 0$ \To $N - 1$}
\For{$j \gets$ \To $N - 1$}
\If{$m_{ij} < 0$}
@@ -1099,53 +905,55 @@
\EndFor
\EndFor
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
-\begin{option}{language}{\Argument{language}}
- This key is used to choose the keyword language set for the current scope. The language keyword set should already have been loaded through the package options (see \cref{sec:package-usage-and-options}).
-\end{option}
+\begin{Optiondef}{language}{\Argument{language}}{}
+ This key is used to select the keyword language set for the current scope. The language keyword set should have already been loaded via the package options (see \cref{sec:package-usage-and-options}).
+\end{Optiondef}
-\begin{option}{noend}{}
- Structured algorithms use blocks for its structures, marking their begin and end. In pseudocode it is common to use a line to finish a block.
- Using the option \Option{end}, this line is suppressed.
+\begin{Optiondef}{noend}{}
+ Structured algorithms use blocks to define their structures, marking both the beginning and the end. In pseudocode, it is common to use a line to indicate the end of a block. The \Option{end} option suppresses this line.
- The result is similar to a program written in Python.
-\end{option}
+ The result resembles a program written in Python.
+\end{Optiondef}
-\begin{option}{end}{}
+\begin{Optiondef}{end}{}
This option reverses the behaviour of \OptionRef{noend}, and the closing line of a block presented.
-\end{option}
+\end{Optiondef}
%! formatter = off
-\begin{tcblisting}{}
- \begin{algorithmic}<noend>
+\begin{PDExample}
+ \begin{algorithmic}
+ <noend>
\For{$i \gets 0$ \To $N - 1$}
\For{$j \gets$ \To $N - 1$}
- \If{$m_{ij} < 0$}<end>
+ \If{$m_{ij} < 0$}
+ <end>
\Statep{$m_{ij} \gets 0$}
\EndIf
\EndFor
\EndFor
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
-\begin{option}{keywords}{\Argument{list of keywords assignments}}
- This option allows to change a keyword (or define a new one). See \cref{sec:languages-and-translations} for more information on keywords and translations.
-\end{option}
+\begin{Optiondef}{keywords}{\Argument{list of keywords assignments}}{}
+ This option allows you to modify an existing keyword or define a new one. For more information on keywords and translations, see \cref{sec:languages-and-translations}.
+\end{Optiondef}
%! formatter = off
-\begin{tcblisting}{}
- \begin{algorithmic}<
- keywords = {
- terminate = Terminate, % new keyword
- then = \{, % redefined
- endif = \}, % redefined
- while = whilst, % redefined
- }
+\begin{PDExample}
+ \begin{algorithmic}
+ <
+ keywords = {
+ terminate = Terminate, % new keyword
+ then = \{, % redefined
+ endif = \}, % redefined
+ while = whilst, % redefined
+ }
>
\While{\True}
\If{$t < 0$}
@@ -1153,24 +961,24 @@
\EndIf
\EndWhile
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
%! formatter = on
-\begin{option}{algorithmic indent}{\Argument{width}}
+\begin{Optiondef}{algorithmic indent}{\Argument{width}}{Initially: \PDInline{1.5em}}
The algorithmic indent is the amount of horizontal space used for indentation inner commands.
This option actually sets the \PackageName{algorithmicx}'s \Macro{algorithmicindent}.
-\end{option}
+\end{Optiondef}
-\begin{option}{comment symbol}{\Argument{symbol}}
- The default symbol that preceeds the text in comments is \Macro{triangleright} (\CommentSymbol), as used by \PackageName{algorithmicx}, and can be changed with this key.
+\begin{Optiondef}{comment symbol}{\Argument{symbol}}{Initially: \PDInline{$\triangleright$}}
+ The default symbol that preceeds the text in comments is \CommentSymbol, as used by \PackageName{algorithmicx}, and can be changed with this key.
The current comment symbol is available with \MacroDef{CommentSymbol}. Do not change this symbol by redefining \Macro{CommentSymbol}, as font, shape and color settings will no longer be respected. Always use \Option{comment symbol}.
-\end{option}
+\end{Optiondef}
-\begin{option}{comment symbol right}{\Argument{symbol}}
- This is the symbol that closes a \MacroRef{CommentIn}. This symbol is set to \CommentSymbolRight\ and can be retrieved with the \MacroDef{CommentSymbolRight} macro. Do not attempt to change the symbol by redefining \Macro{CommentSymbolRight}, as font, shape and color settings will no longer be respected. Always use \Option{comment symbol right}.
-\end{option}
+\begin{Optiondef}{comment symbol right}{\Argument{symbol}}{Initially: \PDInline{$\triangleleft$}}
+ This symbol closes a \MacroRef{CommentIn}. It is set to \CommentSymbolRight\ and can be accessed using the \MacroDef{CommentSymbolRight} macro. Avoid changing the symbol by redefining \Macro{CommentSymbolRight}, as this would cause font, shape, and color settings to be ignored. Always use the \Option{comment symbol right} option.
+\end{Optiondef}
\subsubsection{Fonts, shapes and sizes}
The options ins this section allows setting font family, shape, weight and size for several parts of an algorithm.
@@ -1177,63 +985,64 @@
Notice that color are handled separately (see \cref{sec:colors}) and using \Macro{color} with font options will tend to break the document.
-\begin{option}{text font}{\Argument{font, shape and size}}
+\begin{Optiondef}{text font}{\Argument{font, shape and size}}{Initially: empty}
This setting corresponds to the font family, its shape and size and applies to the \Argument{text} field in each of the commands.
-\end{option}
-
-\begin{option}{comment font}{\Argument{font, shape and size}}
+\end{Optiondef}
+%
+\begin{Optiondef}{comment font}{\Argument{font, shape and size}}{Initially: \PDInline{\slshape}}
This setting corresponds to the font family, its shape and size and applies to all comments.
-\end{option}
+\end{Optiondef}
-\begin{option}{keyword font}{\Argument{font, shape and size}}
+\begin{Optiondef}{keyword font}{\Argument{font, shape and size}}{Initially: \PDInline{\bfseries}}
This setting sets the font family, shape, and size, and applies to all keywords, such as \Keyword{function} or \Keyword{end}.
-\end{option}
+\end{Optiondef}
-\begin{option}{constant font}{\Argument{font, shape and size}}
+\begin{Optiondef}{constant font}{\Argument{font, shape and size}}{Initially: \PDInline{\scshape}}
This setting sets the font family, shape, and size, and applies to all constants, such as \Nil, \True\ and \False.
This setting also applies when \MacroRef{Constant} is used.
-\end{option}
+\end{Optiondef}
-\begin{option}{module font}{\Argument{font, shape and size}}
+\begin{Optiondef}{module font}{\Argument{font, shape and size}}{Initially: \PDInline{\scshape}}
This setting sets the font family, shape, and size, and applies to both procedure and function identifiers, as well as their callings with \MacroRef{Call}.
-\end{option}
+\end{Optiondef}
\subsubsection{Colors}\label{sec:colors}
Colors are defined using the \PackageName{xcolors} package.
-\begin{option}{text color}{\Argument{color}}
+\begin{Optiondef}{text color}{\Argument{color}}{Initially: \PDInline{.}}
This setting corresponds to the color that applies to the \Argument{text} field in each of the commands.
-\end{option}
+\end{Optiondef}
-\begin{option}{comment color}{\Argument{color}}
+\begin{Optiondef}{comment color}{\Argument{color}}{Initially: \PDInline{.!70}}
This setting corresponds to the color that applies to all comments.
-\end{option}
+\end{Optiondef}
-\begin{option}{keyword color}{\Argument{color}}
+\begin{Optiondef}{keyword color}{\Argument{color}}{Initially: \PDInline{.}}
This key is used to set the color for all keywords.
-\end{option}
+\end{Optiondef}
-\begin{option}{constant color}{\Argument{color}}
+\begin{Optiondef}{constant color}{\Argument{color}}{Initially: \PDInline{.}}
This setting corresponds to the color that applies to the defined constant (see \cref{sec:constants-and-identifiers}) and also when macro \MacroRef{Constant} is used.
-\end{option}
+\end{Optiondef}
-\begin{option}{module color}{\Argument{color}}
+\begin{Optiondef}{module color}{\Argument{color}}{Initially: \PDInline{.}}
This color is applied to the identifier used in both \MacroRef{Procedure} and \MacroRef{Function} definitions, as well as module calls with \MacroRef{Call}. Notice that the arguments use \Option{text color}.
-\end{option}
+\end{Optiondef}
\subsubsection{Paragraphs}
Multi-line support are internally handled by \Macro{parbox}es.
-\VCChange{
- type = updated,
- version = 0.99.2,
- description = {Wrong spacing between parboxes were fixed.}
+\PDAddChange{0.99.2}{
+ update,
+ description = {Wrong spacing between parboxes were fixed.},
+ no box,
}
\medskip
%! formatter = off
\begingroup
-\begin{algorithmic}<show boxes>
+\begin{algorithmic}
+ <show boxes>
\Procedure{Euclid}{$a,b$}[The g.c.d. of a and b]
\Statep{$r\gets a\bmod b$}
\While{$r\not=0$}[We have the answer if r is 0]
@@ -1250,31 +1059,31 @@
\medskip
The options in this section should be used to set how these paragraphs will be presented.
-\begin{option}{text style}{\Argument{style}}
+\begin{Optiondef}{text style}{\Argument{style}}{Initially: \PDInline{\RaggedRight}}
This \Argument{style} is applied to the paragraph box that holds the \Argument{text} field in all commands.
-\end{option}
+\end{Optiondef}
-\begin{option}{comment style}{\Argument{style}}
+\begin{Optiondef}{comment style}{\Argument{style}}{Initially: \PDInline{\RaggedRight}}
This \Argument{style} is applied to the paragraph box that holds the \Argument{comment} field in all algorithmic commands. This setting will not be used with \MacroRef{Comment}, \MacroRef{Commentl} or \MacroRef{CommentIn}.
-\end{option}
+\end{Optiondef}
-\begin{option}{comment separator width}{\Argument{width}}
+\begin{Optiondef}{comment separator width}{\Argument{width}}{Initially: \PDInline{1em}}
The minimum space between the text box and the \Macro{CommentSymbol}. This affects the available space in a line for keywords, text and comment.
-\end{option}
+\end{Optiondef}
-\begin{option}{statement indent}{\Argument{width}}
+\begin{Optiondef}{statement indent}{\Argument{width}}{Initially: \PDInline{1em}}
This is the \Macro{hangindent} set inside \MacroRef{Statep} statements.
-\end{option}
+\end{Optiondef}
-\begin{option}{comment width}{\Option{auto}|\Option{nice}|\Argument{width}}
+\begin{Optiondef}{comment width}{\PDInline{auto}|\PDInline{nice}|\Argument{width}}{Initially: \PDInline{auto}}
There are two ways to balance the lengths of \Argument{text} and \Argument{comments} on a line, each providing different visual experiences.
- In automatic mode (\Option{auto}), the balance is chosen considering the widths that the actual text and comment have, trying to reduce the total number of lines, given there is not enough space in a single line for the keywords, text , comment and comment symbol. The consequence is that each line with a comment will have its own balance.
+ In automatic mode (\PDInline{auto}), the balance is chosen considering the widths that the actual text and comment have, trying to reduce the total number of lines, given there is not enough space in a single line for the keywords, text , comment and comment symbol. The consequence is that each line with a comment will have its own balance.
- The second mode, \Option{nice}, sets a fixed width for the entire algorithm, maintaining consistency across all comments. In that case, longer comments will tend to span a larger number of lines. The ``nice value'' is hardcoded and sets the comment width to \latexinline{0.4\linewidth}.
+ The second mode, \PDInline{nice}, sets a fixed width for the entire algorithm, maintaining consistency across all comments. In that case, longer comments will tend to span a larger number of lines. The ``nice value'' is hardcoded and sets the comment width to \PDInline{0.4\linewidth}.
- Also, a fixed comment width can be specified.
-\end{option}
+ Also, a fixed comment \Argument{width} can be specified.
+\end{Optiondef}
% todo: insert the parameter indent when it starts working
\begin{comment}
@@ -1282,17 +1091,17 @@
\end{comment}
\subsection{Languages and translations}\label{sec:languages-and-translations}
-\VCChange{
- type = new,
- version = 0.99,
+\PDAddChange{0.99}{
description = {New mechanism to translation with separate files for each language},
-}[Languages]%
+ no box,
+}%
A simple mechanism is employed to allow keywords to be translated into other languages.
%! formatter = off
\begingroup
-\begin{tcblisting}{}
- \begin{algorithmic}<language = brazilian>
+\begin{PDExample}
+ \begin{algorithmic}
+ <language = brazilian>
\Procedure{Euclid}{$a,b$}
\State $r\gets a\bmod b$
\While{$r\not=0$}
@@ -1303,7 +1112,7 @@
\Statep{\Keyword{return} $b$}
\EndProcedure
\end{algorithmic}
-\end{tcblisting}
+\end{PDExample}
\endgroup
%! formatter = on
@@ -1310,67 +1119,93 @@
Creating a new keyword set uses the \Macro{AlgLanguageSet} macro.
-\begin{macro}{AlgLanguageSet}[\MArg{language name}\MArg{keyword assignments}]
- This macro sets new values for known keywords as well as new ones. Once created, keywords cannot be deleted.
+\begin{Macrodef}{AlgLanguageSet}{\MArg{language name}\MArg{keyword assignments}}{}
+ This macro assigns new values to existing keywords as well as creates new ones. Once defined, keywords cannot be removed.
- In case a default keyword is not reset, the English version will be used.
- To create a new set, copy the file \texttt{algxpar-english.kw.tex} and edit it accordingly.
+ If a default keyword is not redefined, the English version will be used.
- Note that there is a set of keywords for the lines that close each block. These keys are provided to allow for more versatility in changing how these lines are presented. It is highly recommended that references to other keywords use the {Keyworkd} macro so that font, color and language changes can be made without any problems.
- In translations, these \textit{compound keywords} do not necessarily need to appear (see file \texttt{brazilian.kw.tex}, which follows the settings in \texttt{algxpar-english.kw.tex}). However, if defined, there will be different versions for each language.
-\end{macro}
+ To create a new set, copy the file \FileName{algxpar-english.kw.tex} and modify it as needed.
-\begin{figure}
- \tcbinputlisting{listing file = algxpar-english.kw.tex, listing only}
-\end{figure}
-The mechanism behind \MacroRef{AlgLanguageSet} uses the \Macro{SetKeyword} macro, which is called to adjust the value of a single keyword\footnote{Macros like \Macro{algorithmicwhile} from the \PackageName{algorithimicx} package are no longer used.}. To retrieve the value of a given keyword, the \Macro{Keyword} macro must be used. It returns the formatted value according to the options currently in use for keywords.
+ Note that there is a set of keywords for the lines that close each block. These keys are included to offer more flexibility in customizing how these lines are displayed. It is strongly recommended to use the {Keyword} macro for references to other keywords, so that font, color, and language changes can be made without issues.
-\begin{macro}{SetKeyword}[\OArg{language}\MArg{keyword}\MArg{value}]
+
+ In translations, these \textit{compound keywords} are not necessarily required (see the file \FileName{brazilian.kw.tex}, which follows the settings in \FileName{algxpar-english.kw.tex}). However, if they are defined, there will be different versions for each language.
+\end{Macrodef}
+
+% \begin{figure}
+\tcbinputlisting{example, listing file = algxpar-english.kw.tex, listing only}
+% \end{figure}
+
+The mechanism behind \MacroRef{AlgLanguageSet} utilizes the \Macro{SetKeyword} macro, which is called to modify the value of a single keyword\footnote{Macros such as \Macro{algorithmicwhile} from the \PackageName{algorithmicx} package are no longer in use.}. To retrieve the value of a specific keyword, the \Macro{Keyword} macro should be used. It produces the formatted value based on the options currently applied to keywords.
+
+\begin{Macrodef}{SetKeyword}{\OArg{language}\MArg{keyword}\MArg{value}}{}
The macro \MacroRef{SetKeyword} changes a given \Argument{keyword} to \Argument{value} if it exists; otherwise a new keyword is created.
If \Argument{language} is omitted, the language currently in use is changed.
See also the \OptionRef{keywords} option.
-\end{macro}
+\end{Macrodef}
-\begin{macro}{Keyword}[\OArg{language}\MArg{keyword}]
+\begin{Macrodef}{Keyword}{\OArg{language}\MArg{keyword}}{}
This macro expands to the value of a keyword in a \Argument{language} using the font, shape, size, and color determined for the keyword set.
If \Argument{language} is not specified, the current language is used. \Argument{keyword} is any keyword defined for a language, including custom ones.
-\end{macro}
+\end{Macrodef}
-\begin{tcblisting}{}
+\begin{PDExample}
\SetKeyword[german]{if}{wenn} % new
Depending on the language, a keyword can take different forms: \Keyword{if} (English), \Keyword[german]{if} (German) or \Keyword[brazilian]{if} (Brazilian Portuguese).
-\end{tcblisting}
+\end{PDExample}
+\begin{PDExample}
+ \AlgLanguageSet{spanish}{
+ while = mientras,
+ do = hacer,
+ endwhile = fin,
+ if = si,
+ then = entonces,
+ else = en otro caso,
+ endif = fin,
+ }
+ \begin{algorithmic}
+ <language = spanish, indent lines>
+ \If{$a > b$}[check conditions]
+ \While{$a > 0$}
+ \Statep{\Call{Process}{$a$}}[process current data]
+ \EndWhile
+ \Else
+ \Statep{\Call{Signal}{\Id{pid}}}
+ \EndIf
+ \end{algorithmic}
+\end{PDExample}
+
\subsection{Other features}
-\VCChange{
- version = 0.99,
+\PDAddChange{0.99}{
description = Added support to style named constants and function/procedures identifiers,
-}[Features]%
+ no box,
+}%
These macros were added to support the styles defined for named constants and function and procedure identifiers.
-\begin{macro}{Constant}[\OArg{name}]
+\begin{Macrodef}{Constant}{\MArg{name}}{}
This macro presents \Argument{name} using font, shape, size and color defined for constants.
-\end{macro}
+\end{Macrodef}
-\begin{macro}{Module}[\OArg{name}]
+\begin{Macrodef}{Module}{\MArg{name}}{}
This macro presents \Argument{name} using font, shape, size and color defined for procedures and functions.
-\end{macro}
+\end{Macrodef}
\section{``Forgotten'' features}
-\VCChange{
- type = removed,
- version = 0.99,
- description = {Macros \Macro{TextString} and \Macro{VisibleSpace} accidentally removed},
-}
+\PDAddChange{0.99}{
+ removal,
+ description = {Macros \Macro{TextString} and \Macro{VisibleSpace} accidentally removed.},
+ no box,
+}%
Some features were forgotten from v0.91 to v.99, although it was not intentional. The macros \Macro{TextString} and \Macro{VisibleSpace} simply vanished into thin air.
@@ -1387,13 +1222,13 @@
\subsection{LZW revisited}
\begingroup
-\begin{latexcode}
+\begin{PDListing}
\AlgSet{
comment color = purple,
comment width = nice,
comment style = \raggedleft,
}
-\end{latexcode}
+\end{PDListing}
\AlgSet{
comment color = purple,
@@ -1405,7 +1240,7 @@
\subsection{LZW revisited again}
\begingroup
-\begin{latexcode}
+\begin{PDListing}
\AlgSet{
keyword font = \ttfamily,
keyword color = green!40!black,
@@ -1415,7 +1250,7 @@
indent lines,
noend,
}
-\end{latexcode}
+\end{PDListing}
\AlgSet{
keyword font = \ttfamily,
@@ -1426,11 +1261,14 @@
indent lines,
noend,
}
-\input{algxpar-lzw.tex}
+\noindent%
+\begin{minipage}{\linewidth}
+ \input{algxpar-lzw.tex}
+\end{minipage}
\endgroup
-%% Index
+% Index
\printindex
\end{document}
Deleted: trunk/Master/texmf-dist/tex/latex/algxpar/algxpar-versionchanges.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/algxpar/algxpar-versionchanges.sty 2025-08-02 19:50:35 UTC (rev 75952)
+++ trunk/Master/texmf-dist/tex/latex/algxpar/algxpar-versionchanges.sty 2025-08-02 19:51:53 UTC (rev 75953)
@@ -1,404 +0,0 @@
-%! Package = versionchanges
-%! Author = Jander Moreira
-
-\NeedsTeXFormat{LaTeX2e}
-\ProvidesPackage{versionchanges}[2024/05/03 v0.1 This package provides means to track changes to a document]
-\NewDocumentCommand{\VCVersion}{}{0.1}
-\NewDocumentCommand{\VCDate}{}{2024/05/03}
-
-\RequirePackage{pgfkeys}
-\RequirePackage{multicol}
-\RequirePackage{ragged2e}
-\RequirePackage{todonotes}
-
-\setlength{\marginparwidth}{2cm}
-\RequirePackage{marginnote}
-\let\marginpar\marginnote
-
-%% Options
-\pgfkeys{
- /version changes/.cd,
- version prefix/.store in = \vc at VersionPrefix,
- version style/.store in = \vc at VersionStyle,
- change style/.store in = \vc at ChangeStyle,
-}
-
-\NewDocumentCommand{\VCSet}{ > { \TrimSpaces } m }{%
- \pgfkeys{
- /version changes/.cd,
- #1,
- }%
-}
-
-\VCSet{
- version prefix = {v},
- version style = \bfseries\footnotesize,
- change style = \footnotesize\RaggedRight,
-}
-
-% defaults
-
-
-%% Internal commands
-\ExplSyntaxOn
-
-% StepChangeCounter: proceeds to a new change
-\int_zero_new:N \g_vc_change_counter_int
-\NewDocumentCommand{\vc at StepChangeCounter}{}{
- \int_gadd:Nn \g_vc_change_counter_int { 1 }
-}
-\NewDocumentCommand{\vc at CurrentChangeCounter}{}{
- \int_use:N \g_vc_change_counter_int
-}
-
-% SetChangeAttribute: sets the an attribute of the current change record
-% #1: attribute
-% #2: value
-\cs_new:Npn \set_change_attribute:nn #1#2 {
- \tl_clear_new:c { g_vc_change_ \int_use:N \g_vc_change_counter_int _#1_tl }
- \tl_gset:cn { g_vc_change_ \int_use:N \g_vc_change_counter_int _#1_tl } { #2 }
-}
-\NewDocumentCommand{\vc at SetChangeAttribute}{ m m }{
- \set_change_attribute:nn { #1 } { #2 }
-}
-
-% SetChangeAttributeExpanded: sets the an attribute of the current change record
-% #1: attribute
-% #2: value
-\NewDocumentCommand{\vc at SetChangeAttributeExpanded}{ m m }{
- \exp_args:Nnf \set_change_attribute:nn { #1 } { #2 }
-}
-
-% GetChangeInfo: returns the field of a change
-% #1: number of the change
-% #2: field
-% #3: (optional) sets macro instead of returning value
-\NewDocumentCommand{\vc at GetChangeInfo}{ m m o }{
- \IfValueTF{#3}{
- \tl_set:Nx #3 { \tl_use:c { g_vc_change_#1_#2_tl } }
- }{
- \tl_use:c { g_vc_change_#1_#2_tl }
- }
-}
-
-% SetMacroChangeInfo: sets a macro with the field of a change
-% #1: macro
-% #2: number of the change
-% #3: field
-\NewDocumentCommand{\vc at SetMacroChangeInfo}{ m m m }{
- \tl_clear_new:N #1
- \exp_args:NNc \tl_set:NV #1 { g_vc_change_#2_#3_tl }
-}
-
-% RunChangesList: apply a macro to each change of a version
-% #1: version
-% #2: macro with a single mandatory argument
-\NewDocumentCommand{\vc at RunChangesList}{ m m }{
- \seq_map_inline:cn { g_version_#1_seq } { #2 { ##1 } }
-}
-
-
-% RegisterVersion: add a version to the list os versions if it doesn't exist
-% #1: version
-\seq_new:N \g_vc_versions_list_seq
-\cs_new:Npn \register_version:nn #1#2 {
- \seq_if_in:NnTF \g_vc_versions_list_seq { #1 } { } {% else
- \seq_put_right:Nn \g_vc_versions_list_seq { #1 }
- \tl_clear_new:c { g_vc_version_#1_date_tl }
- \tl_gset:cn { g_vc_version_#1_date_tl } { #2 }
- \seq_new:c { g_version_#1_seq }
- }
-}
-\NewDocumentCommand{\VCRegisterVersion}{ m m }{
- \register_version:nn { #1 } { #2 }
-}
-
-% VersionDate: returns the date of a version OR sets a macro
-% with its (expanded) value
-% #1: version
-% #2: (optional) macro to store the value
-\NewDocumentCommand{\vc at VersionDate}{ m o }{
- \IfValueTF{#2}{
- \tl_set:Nx #2 { \tl_use:c { g_vc_version_#1_date_tl } }
- }{
- \tl_use:c { g_vc_version_#1_date_tl }
- }
-}
-
-
-% AddChangeToVersion: add a change reference to the list of the version
-% (a new list will be created if necessary)
-% #1: version
-\cs_new:Npn \add_change_to_version:n #1 {
- % Add a reference (change number) to the list
- % \tl_clear_new:N \l_change_number_tl
- % \exp_args:NNe \tl_set:Nn \l_change_number_tl { \int_use:N \g_vc_change_counter_int }
- \exp_args:Nco \seq_gput_right:Nn { g_version_#1_seq } { \int_use:N \g_vc_change_counter_int }
-}
-\NewDocumentCommand{\vc at AddChangeToVersion}{ }{
- \add_change_to_version:n {
- \tl_use:c { g_vc_change_ \int_use:N \g_vc_change_counter_int _version_tl }
- }
-}
-
-
-% RunVersionList: apply a macro to each version of the list
-% #1: macro with a single mandatory argument
-\NewDocumentCommand{\vc at RunVersionList}{ m }{
- \seq_map_inline:Nn \g_vc_versions_list_seq { #1 { ##1 } }
-}
-
-\ExplSyntaxOff
-
-%%
-
-\newif\ifvc at SuppressInListing\vc at SuppressInListingfalse
-\pgfkeys{
- /version changes/changes/.cd,
- version/.code = {\vc at SetChangeAttribute{version}{#1}},
-% date/.code = {\vc at SetChangeAttribute{date}{#1}},
- description/.code = {\vc at SetChangeAttribute{description}{#1}},
- page/.code = {\vc at SetChangeAttributeExpanded{page}{#1}},
- suppress/.is if = vc at SuppressInListing,
- type/.is choice,
- type/released/.code = {\vc at SetChangeAttribute{type}{Released}},
- type/new/.code = {\vc at SetChangeAttribute{type}{New in}},
- type/updated/.code = {\vc at SetChangeAttribute{type}{Updated in}},
- type/removed/.code = {\vc at SetChangeAttribute{type}{Removed in}},
- type/deprecated/.code = {\vc at SetChangeAttribute{type}{Deprecated in}},
- .unknown/.code = {\pgfkeysalso{type = \pgfkeyscurrentname}},
-}
-
-% #1: (optional) todonotes options
-% #2: text
-\NewDocumentCommand{\vc at MarginNote}{ O{} > { \TrimSpaces } m }{%
- \todo[bordercolor = blue!20, backgroundcolor = blue!10,
- linecolor = blue!20, tickmarkheight = 0.2ex, size = \tiny,
- noline, #1]{%
- #2
- }%
-}
-
-% Change: records a change
-% #1: (optional) todonotes options
-% #2: comma-separated list with change description
-\NewDocumentCommand{\VCChange}{ O{} > { \TrimSpaces } m o }{%
- \vc at StepChangeCounter%
- \pgfkeys{
- /version changes/changes/.cd,
- suppress = false,
- type = new,
- page = \thepage,
- #2,
- }%
- \hspace{0pt}%
- \vc at AddChangeToVersion%
- %! formatter = off
- \ifvc at SuppressInListing% starred VCPrintChange?
- \vc at SetChangeAttribute{star}{*}%
- \else
- \vc at SetChangeAttribute{star}{}%
- \fi%
- %! formatter = on
- \vc at SetChangeAttributeExpanded{label}{\vc at CurrentChangeCounter}%
- \vc at GetChangeInfo{\vc at CurrentChangeCounter}{label}[\vc at InfoResult]%
- \expandafter\label\expandafter{\vc at InfoResult:change}%
- \vc at MarginNote[#1]{%
- \IfValueT{#3}{\textbf{#3}:\\}%
- \vc at GetChangeInfo{\vc at CurrentChangeCounter}{type}
- \vc at VersionPrefix\vc at GetChangeInfo{\vc at CurrentChangeCounter}{version}%
- }%
-}
-
-%%
-
-% Internal commands
-\ExplSyntaxOn
-
-% Reading from file
-\ior_new:N \g_vc_input_io
-
-% LoadFile: reads a previous compiled version changes
-\cs_new:Nn \load_file: {
- \tl_clear_new:N \g_vc_file_contents_tl
- \ior_open:NnTF \g_vc_input_io { \jobname.vcind } {
- \ior_map_inline:Nn \g_vc_input_io {
- \tl_gput_right:Nn \g_vc_file_contents_tl { ##1 }
- }
- }{}
-}
-\NewDocumentCommand{\vc at LoadChanges}{}{
- \load_file:
-}
-\NewDocumentCommand{\vc at FileContentsNotEmpty}{ +m }{
- \tl_if_empty:NTF \g_vc_file_contents_tl {} {
- #1
- }
-}
-
-% File contents
-\NewDocumentCommand{\vc at FileContents}{}{
- \tl_use:N \g_vc_file_contents_tl
-}
-
-% Writing to file
-\iow_new:N \g_vc_output_io
-\tl_new:N \g_vc_output_buffer_tl
-
-% OpenFile: open file for writing
-\NewDocumentCommand{\vc at OpenFile}{ }{
- \iow_open:Nn \g_vc_output_io { \jobname.vcind }
-}
-
-% CloseFile: close file
-\NewDocumentCommand{\vc at CloseFile}{ }{
- \iow_close:N \g_vc_output_io
-}
-
-% WriteBuffer: write to file
-\cs_generate_variant:Nn \iow_now:Nn { NV }
-\NewDocumentCommand{\vc at WriteBuffer}{ }{
- \iow_now:NV \g_vc_output_io \g_vc_output_buffer_tl
- \tl_clear:N \g_vc_output_buffer_tl
-}
-
-\NewDocumentCommand{\vc at AddToBuffer}{ +m }{
- \tl_gput_right:Nn \g_vc_output_buffer_tl { #1 }
-}
-
-\cs_generate_variant:Nn \tl_gput_right:Nn { Nx }
-\NewDocumentCommand{\vc at AddCharToBuffer}{ m }{
- \tl_gput_right:Nx \g_vc_output_buffer_tl { \iow_char:N #1 }
-}
-\ExplSyntaxOff
-
-% WriteVersionChange: write to file a single change
-% #1: change number
-\NewDocumentCommand{\vc at WriteVersionChange}{ m }{%
- \vc at AddToBuffer{ \VCPrintChange}%
- \vc at SetMacroChangeInfo{\vc at InfoResult}{#1}{star}%
- \expandafter\vc at AddToBuffer\expandafter{\vc at InfoResult}%
- % version number
- \vc at AddCharToBuffer{\{}%
- \vc at SetMacroChangeInfo{\vc at InfoResult}{#1}{description}%
- \expandafter\vc at AddToBuffer\expandafter{\vc at InfoResult}%
- \vc at AddCharToBuffer{\}}%
- % date
- \vc at AddCharToBuffer{\{}%
- \vc at SetMacroChangeInfo{\vc at InfoResult}{#1}{page}%
- \expandafter\vc at AddToBuffer\expandafter{\vc at InfoResult}%
- \vc at AddCharToBuffer{\}}%
- % label
- \vc at AddCharToBuffer{\{}%
- \vc at SetMacroChangeInfo{\vc at InfoResult}{#1}{label}%
- \expandafter\vc at AddToBuffer\expandafter{\vc at InfoResult}%
- \vc at AddCharToBuffer{\}}%
- \vc at WriteBuffer
-}
-
-\NewDocumentCommand{\vc at WriteVersion}{ m }{%
-%! parser = off
- \vc at AddToBuffer{\begin{vcversionitem}}%
- %! parser = on
- \vc at AddCharToBuffer{\{}%
- \vc at AddToBuffer{#1}%
- \vc at AddCharToBuffer{\}}%
- \vc at AddCharToBuffer{\{}%
- \vc at VersionDate{#1}[\vc at InfoResult]%
- \expandafter\vc at AddToBuffer\expandafter{\vc at InfoResult}%
- \vc at AddCharToBuffer{\}}%
- \vc at WriteBuffer
- \vc at RunChangesList{#1}{\vc at WriteVersionChange}%
-%! parser = off
- \vc at AddToBuffer{\end{vcversionitem}}%
- %! parser = on
- \vc at WriteBuffer
-}
-
-\NewDocumentCommand{\vc at SaveChanges}{}{%
- \vc at OpenFile%
- \vc at RunVersionList{\vc at WriteVersion}%
- \vc at WriteBuffer
- \vc at CloseFile%
-}
-
-\NewDocumentCommand{\VCPrintChanges}{ O{} }{%
- \vc at FileContentsNotEmpty{
- \VCSet{#1}
- \section*{Change History}
- \begin{multicols}{2}
- \vc at FileContents%
- \end{multicols}
- }
-}
-
-%% Printing the list of changes
-\NewDocumentEnvironment{vcversionitem}{ m m }{%
- \par\noindent%
- {\vc at VersionStyle\vc at VersionPrefix#1 (#2)}
- \vspace*{0.2em}\par%
- \begingroup%
- \setlength{\tabcolsep}{0pt}%
- \vc at ChangeStyle%
- }{%
- \endgroup%
- \vspace{0.5em}%
-}
-
-\newlength{\vc at PageNumberWidth}
-\setlength{\vc at PageNumberWidth}{1cm}
-\NewDocumentCommand{\VCPrintChange}{ s m m m }{%
- \IfBooleanF{#1}{%
- \hspace{0.25cm}%
- \parbox[b]{\dimexpr \linewidth - \vc at PageNumberWidth - 0.25cm}{%
- \setlength{\hangindent}{0.7cm}#2\dotfill%
- }\hspace{-0.05cm}\dotfill~\hspace{0.05cm}\hyperref[#4:change]{#3}%
- \par\vspace{0.5em}
- }
-}
-
-%% Version numbering
-\ExplSyntaxOn
-
-\tl_new:N \g_vc_prefix_text_tl
-\tl_new:N \g_vc_number_tl % todo: turn to int?
-\tl_new:N \g_vc_suffix_text_tl
-\regex_new:N \g_versioning_regex
-\regex_set:Nn \g_versioning_regex { [^\.]+ }
-\regex_new:N \g_subversioning_regex
-\regex_set:Nn \g_subversioning_regex { ([^\d]*)(\d+)(.*) }
-
-\cs_new:Npn \subversioning_check:n #1 {
- \seq_clear_new:N \l_subparts_seq
- \regex_extract_all:NnNTF \g_subversioning_regex { #1 } \l_subparts_seq {
- \tl_gset:Nx \g_vc_prefix_text_tl { \seq_item:Nn \l_subparts_seq {2} }
- \tl_gset:Nx \g_vc_number_tl { \seq_item:Nn \l_subparts_seq {3} }
- \tl_gset:Nx \g_vc_suffix_text_tl { \seq_item:Nn \l_subparts_seq {4} }
- }{
- \tl_gset:Nx \g_vc_prefix_text_tl { #1 }
- \tl_gclear:N \g_vc_number_tl
- \tl_gclear:N \g_vc_suffix_text_tl
- }
-}
-\cs_new:Npn \versioning_check:n #1 {
- \seq_clear_new:N \l_parts_seq
- \regex_extract_all:NnN \g_versioning_regex { #1 } \l_parts_seq
- \seq_map_inline:Nn \l_parts_seq {
- \subversioning_check:n { ##1 }
- <<(\tl_use:N \g_vc_prefix_text_tl)
- (\tl_use:N \g_vc_number_tl)
- (\tl_use:N \g_vc_suffix_text_tl)>>
- }
-}
-\NewDocumentCommand{\VCVersioningCheck}{ m }{
- \par\noindent[\texttt{#1}:~\versioning_check:n { #1 }]\bigskip\par
-}
-
-\ExplSyntaxOff
-
-% Hooks
-\AtBeginDocument{%
- \reversemarginpar%
- \vc at LoadChanges%
-}
-\AtEndDocument{\vc at SaveChanges}
\ No newline at end of file
Modified: trunk/Master/texmf-dist/tex/latex/algxpar/algxpar.sty
===================================================================
--- trunk/Master/texmf-dist/tex/latex/algxpar/algxpar.sty 2025-08-02 19:50:35 UTC (rev 75952)
+++ trunk/Master/texmf-dist/tex/latex/algxpar/algxpar.sty 2025-08-02 19:51:53 UTC (rev 75953)
@@ -5,11 +5,11 @@
%! suppress = FileNotFound
\NeedsTeXFormat{LaTeX2e}[2005/12/01]
-\ProvidesPackage{algxpar}[2024/10/23 v0.99.2 Algorithms with multi-line/paragraph support and some enhancements]
+\ProvidesPackage{algxpar}[2025/07/31 v0.99.2a Algorithms with multi-line/paragraph support and some enhancements]
%% Documentation
-\NewDocumentCommand{\AlgVersion}{}{0.99.2}
-\NewDocumentCommand{\AlgDate}{}{2024/10/23}
+\NewDocumentCommand{\AlgVersion}{}{0.99.2a}
+\NewDocumentCommand{\AlgDate}{}{2025/07/31}
%% Required packages
@@ -17,15 +17,14 @@
\RequirePackage{algpseudocode}
\RequirePackage{ragged2e}
\RequirePackage{xcolor}
-\RequirePackage{fancyvrb} % to load verbatim preserving tabs
\RequirePackage{pgfopts}
\RequirePackage{amssymb}
\RequirePackage{pgfmath}
\RequirePackage{varwidth}
-% \RequirePackage{ifthen}
\RequirePackage{tikz}
\usetikzlibrary{calc, arrows}
\RequirePackage{etoolbox}
+% \RequirePackage{fancyvrb} % to load verbatim preserving tabs
% \RequirePackage{listings} % to load verbatim with tabs
% \RequirePackage{tcolorbox} % to save verbatim
@@ -106,15 +105,15 @@
\ExplSyntaxOff
%% Settings
-\newif\ifaxp at NoEnd\axp at NoEndfalse % whether line with 'end' is used or not
-\newif\ifaxp at IsStatement\axp at IsStatementfalse % set in \Statep
-\newif\ifaxp at ShowBoxes\axp at ShowBoxesfalse % show parboxes for debugging
-\newif\ifaxp at LineBalanceAuto % true for 'auto'; false for 'fixed'
-\newif\ifaxp at IndentLines\axp at IndentLinesfalse % draw lines in blocks
+\newbool{axp at NoEnd} % whether line with 'end' is used or not
+\newbool{axp at IsStatement} % set in \Statep
+\newbool{axp at ShowBoxes} % show parboxes for debugging
+\newbool{axp at LineBalanceAuto} % true for 'auto'; false for 'fixed'
+\newbool{axp at IndentLines} % draw lines in blocks
\NewDocumentCommand{\axp at DisableEnds}{}{%
- \axp at NoEndtrue%
+ \booltrue{axp at NoEnd}%
\RenewDocumentCommand{\ALG at noend}{}{t}%
\algtext*{EndWhile}%
\algtext*{EndFor}%
@@ -128,7 +127,7 @@
}
\NewDocumentCommand{\axp at EnableEnds}{}{%
- \axp at NoEndfalse%
+ \boolfalse{axp at NoEnd}%
\RenewDocumentCommand{\ALG at noend}{}{f}%
\algrenewtext{EndWhile}{\Keyword{endwhile}}%
\algrenewtext{EndFor}{\Keyword{endfor}}%
@@ -182,12 +181,12 @@
show boxes/.is if = axp at ShowBoxes,
%
comment width/.code = {%
- \axp at LineBalanceAutotrue%
- \ifthenelse{\equal{auto}{#1}}{%
- \axp at LineBalanceAutotrue%
+ \booltrue{axp at LineBalanceAuto}%
+ \ifstrequal{#1}{auto}{%
+ \booltrue{axp at LineBalanceAuto}%
}{%
- \axp at LineBalanceAutofalse%
- \ifthenelse{\equal{nice}{#1}}{%
+ \boolfalse{axp at LineBalanceAuto}%
+ \ifstrequal{#1}{nice}{%
\DeclareDocumentCommand{\axp at CommentFixedWidth}{}{0.4\linewidth}%
}{%
\DeclareDocumentCommand{\axp at CommentFixedWidth}{}{#1}%
@@ -281,7 +280,7 @@
noend = false,
}
\ProcessPgfOptions{/algxpar}
-\ifaxp at NoEnd\axp at DisableEnds\fi% globally disable 'ends'
+\ifbool{axp at NoEnd}{\axp at DisableEnds}{}% globally disable 'ends'
% axp at SetToWidth: \settowidth allowing multi-line text
@@ -322,7 +321,7 @@
\ifdimcomp{\axp at TokenWidth}{>}{0pt}{#3}{}%
}
-\newif\ifaxp at NoCommentPresent
+\newbool{axp at NoCommentPresent}
\newlength{\axp at TextWidth}
\newlength{\axp at CommentWidth}
@@ -346,7 +345,7 @@
($ (axp-block-end-\theaxp at BlockLevelCounter) + (0.3ex, 1em) $);
\end{tikzpicture}%
\addtocounter{axp at BlockLevelCounter}{-1}%
- }%
+ }{}%
}
\NewDocumentCommand{\axp at MarkLineEndCont}{}{%
@@ -359,7 +358,7 @@
($ (axp-block-end-\theaxp at BlockLevelCounter) + (0.3ex, 1em) $);
\end{tikzpicture}%
\addtocounter{axp at BlockLevelCounter}{-1}%
- }%
+ }{}%
}
\NewDocumentCommand{\axp at MarkLineEndFinal}{}{%
@@ -373,7 +372,7 @@
|- ++ (1ex, 0);
\end{tikzpicture}%
\addtocounter{axp at BlockLevelCounter}{-1}%
- }%
+ }{}%
}
% % ***********************************************
@@ -409,10 +408,11 @@
\setlength{\axp at TextWidth}{
\dimexpr \linewidth - \axp at CurrentTokenWidth - (\algorithmicindent)*(\theALG at nested - #1)
}%
- \ifdimcomp{\axp at FullTextWidth}{<}{\axp at TextWidth}{%
+ \setlength{\axp at RemainingWidth}{\dimexpr \axp at FullTextWidth - \axp at TextWidth + \axp at CurrentTokenWidth}%
+ \null% this works like an 'anchor' to the next \item
+ \ifdimcomp{\axp at RemainingWidth}{<}{0pt}{%
\axp at TextWidth\axp at FullTextWidth% makes the parbox fit the actual text width
}{}%
- % }{}
}{%
% Yep, we have a comment in this line
% \msg{got a comment!}%
@@ -461,7 +461,7 @@
}%
\pgfmathparse{\axp at CurrentLineWidth - \axp at CommentWidth - \axp at CommentSymbolWidth}%
\setlength{\axp at TextWidth}{\pgfmathresult pt}%
- % \msg{\the\axp at TextWidth}%
+ % \msg{\the\axp at TextWidth}%
}%
}{%
% 'fixed': limit comment width
@@ -480,49 +480,48 @@
}
\newcounter{cont}
-\newif\ifaxp at CloseBlock
+\newbool{axp at CloseBlock}
% axp at MakeCommand: builds the command (see axp at DefineCommand)
% #1 (star): star = end block; no star = begin block
\NewDocumentCommand{\axp at MakeCommand}{ s }{%
-\IfBooleanTF{#1}{%
- \axp at MarkLineEndShort%
-}{%
- \ifaxp at CloseBlock%
- \axp at MarkLineEndCont%
- \axp at CloseBlockfalse%
- \fi%
- \axp at MarkLineBegin%
-}%
-\axp at DoCommand{% ajustment for opening/closing blocks
- \IfBooleanTF{#1}{0}{1}%
-}{% command or module+name
-\axp at MakeSingleToken{}{\axp at CommandKeyword}{\ifaxp at IsModule(\else\ \fi}%
-}{% text or module arguments
-\axp at CommandText\ifaxp at IsModule)\fi%
-}{% command complement
-\axp at MakeSingleToken{ }{\axp at CommandComplementKeyword}{}%
-}{% comment
-\axp at CommentText%
-}{% options
-\axp at CommandOptions%
-}%
+ \IfBooleanTF{#1}{%
+ \axp at MarkLineEndShort%
+ }{%
+ \ifbool{axp at CloseBlock}{%
+ \axp at MarkLineEndCont%
+ \boolfalse{axp at CloseBlock}%
+ }{}%
+ \axp at MarkLineBegin%
+ }%
+ \axp at DoCommand{% ajustment for opening/closing blocks
+ \IfBooleanTF{#1}{0}{1}%
+ }{% command or module+name
+ \axp at MakeSingleToken{}{\axp at CommandKeyword}{\ifbool{axp at IsModule}{(}{~}}%
+ }{% text or module arguments
+ \axp at CommandText\ifbool{axp at IsModule}{)}{}%
+ }{% command complement
+ \axp at MakeSingleToken{ }{\axp at CommandComplementKeyword}{}%
+ }{% comment
+ \axp at CommentText%
+ }{% options
+ \axp at CommandOptions%
+ }%
}
-%! formatter = off
\newsavebox{\axp at SaveBox}
\NewDocumentEnvironment{axp at FBox}{}{%
\begin{lrbox}{\axp at SaveBox}%
-}{%
+ }{%
\end{lrbox}%
- \ifaxp at ShowBoxes%
+ \ifbool{axp at ShowBoxes}{%
\begingroup%
\setlength{\fboxrule}{0.001pt}%
\setlength{\fboxsep}{0pt}%
\color{.!20}\fbox{\color{.}\usebox{\axp at SaveBox}}%
\endgroup%
- \else%
+ }{%
\usebox{\axp at SaveBox}%
- \fi%
+ }%
}
@@ -535,24 +534,24 @@
% #6: options
\newlength{\axp at CurrentTokenWidth}
\NewDocumentCommand{\axp at DoCommand}{ m m m m m m }{%
-\AlgSet{#6}%
-% Dimensions
-\axp at SetToWidth{\axp at CurrentTokenWidth}{#2}%
-\axp at CalculateDimensions{#1}{{\axp at TextStyle\axp at TextFont#3}#4}{#5}%
-%
-% Making the line: body
-#2%
+ \AlgSet{#6}%
+ % Dimensions
+ \axp at SetToWidth{\axp at CurrentTokenWidth}{#2}%
+ \axp at CalculateDimensions{#1}{{\axp at TextStyle\axp at TextFont#3}#4}{#5}%
+ %
+ % Making the line: body
+ #2%
\begin{axp at FBox}%
\ifbool{axp at IsModule}{\hspace{\axp at ParameterIndent}}{}%
\parbox[t]{\axp at TextWidth}{%
- \ifaxp at IsStatement%
+ \ifbool{axp at IsStatement}{%
\setlength{\hangindent}{\axp at StatementIndent}%
- \fi%
+ }{}%
\axp at TextStyle%
\textcolor{\axp at TextColor}{\axp at TextFont{#3}}#4\strut%
}%
\end{axp at FBox}%
- % Making the line: comment
+% Making the line: comment
\ifbool{axp at NoCommentPresent}{}{%
\hspace{\axp at CommentSeparatorWidth}\hfill\CommentSymbol~%
\begin{axp at FBox}%
@@ -587,7 +586,16 @@
\NewDocumentCommand{\False}{}{\Constant{false}}
\NewDocumentCommand{\Nil}{}{\Constant{nil}}
-\newcommand{\Id}[1]{\ensuremath{\emph{\rmfamily#1}}}
+%$ Id
+\ExplSyntaxOn
+\NewDocumentCommand{\Id}{m}{
+ \begingroup
+ \catcode`\_=12
+ \mbox{\emph{\rmfamily\tl_rescan:nn {} {#1}}}
+ \endgroup
+}
+\ExplSyntaxOff
+
% \newcommand{\TextString}[1]{\textrm{\normalfont``{\ttfamily\mbox{#1}}''}}
% \algnewcommand{\VisibleSpace}{\textrm{\color{black!70}\textvisiblespace}}
@@ -600,8 +608,8 @@
% Read, write
\NewDocumentCommand{\Set}{ m m }{%
-\PackageWarning{alxpar}{The macro \string\Set\ is no longer supported.}%
-\Id{#1} \gets #2%
+ \PackageWarning{alxpar}{The macro \string\Set\ is no longer supported.}%
+ \Id{#1} \gets #2%
}
\NewDocumentCommand{\Read}{}{\Keyword{read} }
\NewDocumentCommand{\Write}{}{\Keyword{write} }
@@ -608,18 +616,18 @@
% %% Comments
\algnewcommand{\CommentIn}[1]{%
-\begin{axp at FBox}
-\textcolor{\axp at CommentColor}{\CommentSymbol~\axp at CommentFont#1~\CommentSymbolRight}%
-\end{axp at FBox}%
+ \begin{axp at FBox}
+ \textcolor{\axp at CommentColor}{\CommentSymbol~\axp at CommentFont#1~\CommentSymbolRight}%
+ \end{axp at FBox}%
}
\NewDocumentCommand{\Commentl}{ m D<>{} }{%
-\begingroup%
-\AlgSet{#2}%
-\textcolor{\axp at CommentColor}{\CommentSymbol~\axp at CommentFont#1\strut}%
-\endgroup%
+ \begingroup%
+ \AlgSet{#2}%
+ \textcolor{\axp at CommentColor}{\CommentSymbol~\axp at CommentFont#1\strut}%
+ \endgroup%
}
\RenewDocumentCommand{\Comment}{ m D<>{} }{%
-\hfill\Commentl{#1}<#2>%
+ \hfill\Commentl{#1}<#2>%
}
\newlength{\axp at CurrentIndent}
@@ -627,12 +635,12 @@
\newcounter{axp at BlockCounter}
\newcounter{axp at BlockLevelCounter}
\NewDocumentCommand{\axp at BeginGroup}{}{%
-\begingroup%
+ \begingroup%
}
\NewDocumentCommand{\axp at EndGroup}{}{%
-\global\edef\axp at SaveIndent{\the\ALG at tlm}%
-\endgroup%
-\setlength{\ALG at tlm}{\axp at SaveIndent}%
+ \global\edef\axp at SaveIndent{\the\ALG at tlm}%
+ \endgroup%
+ \setlength{\ALG at tlm}{\axp at SaveIndent}%
}
@@ -642,12 +650,12 @@
% #3: comments
% #4: options
\NewDocumentCommand{\Statep}{ O{} +m O{} D<>{} }{%
-\axp at IsStatementtrue%
-\State\axp at DoCommand{1}{}{#2}{}{#1#3}{#4}%
-\axp at IsStatementfalse%
+ \booltrue{axp at IsStatement}%
+ \State\axp at DoCommand{1}{}{#2}{}{#1#3}{#4}%
+ \boolfalse{axp at IsStatement}%
}
\RenewDocumentCommand{\Statex}{}{%
-\item[]\strut%
+ \item[]\strut%
}
@@ -658,17 +666,17 @@
% #3: comment
% #4: options
\RenewDocumentCommand{\While}{ O{} m O{} D<>{} }{%
-\axp at BeginGroup%
-\axp at DefineCommand{\Keyword{while}}{#2}{\Keyword{do}}{#1#3}{#4}%
-\ALG at makeentity{While}%
+ \axp at BeginGroup%
+ \axp at DefineCommand{\Keyword{while}}{#2}{\Keyword{do}}{#1#3}{#4}%
+ \ALG at makeentity{While}%
}
% #1: comment
% #2: options
\RenewDocumentCommand{\EndWhile}{ O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{endwhile}}{}{}{#1}{#2}%
-\ALG at makeentity{EndWhile}%
-\ifaxp at NoEnd\axp at MarkLineEndFinal\fi%
-\axp at EndGroup%
+ \axp at DefineCommand{\Keyword{endwhile}}{}{}{#1}{#2}%
+ \ALG at makeentity{EndWhile}%
+ \ifbool{axp at NoEnd}{\axp at MarkLineEndFinal}{}%
+ \axp at EndGroup%
}
@@ -677,9 +685,9 @@
% #1: comments
% #2: options
\RenewDocumentCommand{\Repeat}{ O{} D<>{} }{%
-\axp at BeginGroup%
-\axp at DefineCommand{\Keyword{repeat}}{}{}{#1}{#2}%
-\ALG at makeentity{Repeat}%
+ \axp at BeginGroup%
+ \axp at DefineCommand{\Keyword{repeat}}{}{}{#1}{#2}%
+ \ALG at makeentity{Repeat}%
}
% #1: old style comment
% #2: text
@@ -686,10 +694,10 @@
% #3: comment
% #4: options
\RenewDocumentCommand{\Until}{ O{} m O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{until}}{#2}{}{#1#3}{#4}%
-\ALG at makeentity{Until}%
-\ifaxp at NoEnd\axp at MarkLineEndFinal\fi%
-\axp at EndGroup%
+ \axp at DefineCommand{\Keyword{until}}{#2}{}{#1#3}{#4}%
+ \ALG at makeentity{Until}%
+ \ifbool{axp at NoEnd}{\axp at MarkLineEndFinal}{}%
+ \axp at EndGroup%
}
%% Loop
@@ -697,17 +705,17 @@
% #1: comment
% #2: options
\RenewDocumentCommand{\Loop}{ O{} D<>{} }{%
-\axp at BeginGroup%
-\axp at DefineCommand{\Keyword{loop}}{}{}{#1}{#2}%
-\ALG at makeentity{Loop}%
+ \axp at BeginGroup%
+ \axp at DefineCommand{\Keyword{loop}}{}{}{#1}{#2}%
+ \ALG at makeentity{Loop}%
}
% #1: comment
% #2: options
\RenewDocumentCommand{\EndLoop}{ O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{endloop}}{}{}{#1}{#2}%
-\ALG at makeentity{EndLoop}%
-\ifaxp at NoEnd\axp at MarkLineEndFinal\fi%
-\axp at EndGroup%
+ \axp at DefineCommand{\Keyword{endloop}}{}{}{#1}{#2}%
+ \ALG at makeentity{EndLoop}%
+ \ifbool{axp at NoEnd}{\axp at MarkLineEndFinal}{}%
+ \axp at EndGroup%
}
@@ -722,9 +730,9 @@
% #3: comment
% #4: options
\RenewDocumentCommand{\If}{ O{} m O{} D<>{} }{%
-\axp at BeginGroup%
-\axp at DefineCommand{\Keyword{if}}{#2}{\Keyword{then}}{#1#3}{#4}%
-\ALG at makeentity{If}%
+ \axp at BeginGroup%
+ \axp at DefineCommand{\Keyword{if}}{#2}{\Keyword{then}}{#1#3}{#4}%
+ \ALG at makeentity{If}%
}
% #1: old style comment
% #2: text
@@ -731,24 +739,24 @@
% #3: comment
% #4: options
\RenewDocumentCommand{\ElsIf}{ O{} m O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{else}~\Keyword{if}}{#2}{\Keyword{then}}{#1#3}{#4}%
-\axp at CloseBlocktrue%
-\ALG at makeentity{ElsIf}%
+ \axp at DefineCommand{\Keyword{else}~\Keyword{if}}{#2}{\Keyword{then}}{#1#3}{#4}%
+ \booltrue{axp at CloseBlock}%
+ \ALG at makeentity{ElsIf}%
}
% #1: comment
% #2: options
\RenewDocumentCommand{\Else}{ O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{else}}{}{}{#1}{#2}%
-\axp at CloseBlocktrue%
-\ALG at makeentity{Else}%
+ \axp at DefineCommand{\Keyword{else}}{}{}{#1}{#2}%
+ \booltrue{axp at CloseBlock}%
+ \ALG at makeentity{Else}%
}
% #1: comment
% #2: options
\RenewDocumentCommand{\EndIf}{ O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{endif}}{}{}{#1}{#2}%
-\ALG at makeentity{EndIf}%
-\ifaxp at NoEnd\axp at MarkLineEndFinal\fi%
-\axp at EndGroup%
+ \axp at DefineCommand{\Keyword{endif}}{}{}{#1}{#2}%
+ \ALG at makeentity{EndIf}%
+ \ifbool{axp at NoEnd}{\axp at MarkLineEndFinal}{}%
+ \axp at EndGroup%
}
@@ -763,17 +771,17 @@
% #3: comment
% #4: options
\RenewDocumentCommand{\Switch}{ O{} m O{} D<>{} }{%
-\axp at BeginGroup
-\axp at DefineCommand{\Keyword{switch}}{#2}{}{#1#3}{#4}%
-\ALG at makeentity{Switch}%
+ \axp at BeginGroup
+ \axp at DefineCommand{\Keyword{switch}}{#2}{}{#1#3}{#4}%
+ \ALG at makeentity{Switch}%
}
% #1: comment
% #2: options
\RenewDocumentCommand{\EndSwitch}{ O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{endswitch}}{}{}{#1}{#2}%
-\ALG at makeentity{EndSwitch}%
-\ifaxp at NoEnd\axp at MarkLineEndFinal\fi%
-\axp at EndGroup
+ \axp at DefineCommand{\Keyword{endswitch}}{}{}{#1}{#2}%
+ \ALG at makeentity{EndSwitch}%
+ \ifbool{axp at NoEnd}{\axp at MarkLineEndFinal}{}%
+ \axp at EndGroup
}
% #1: old style comment
% #2: text
@@ -780,32 +788,32 @@
% #3: comment
% #4: options
\RenewDocumentCommand{\Case}{ O{} m O{} D<>{} }{%
-\axp at BeginGroup
-\axp at DefineCommand{\Keyword{case}}{#2}{\Keyword{do}}{#1#3}{#4}%
-\ALG at makeentity{Case}%
+ \axp at BeginGroup
+ \axp at DefineCommand{\Keyword{case}}{#2}{\Keyword{do}}{#1#3}{#4}%
+ \ALG at makeentity{Case}%
}
% #1: comment
% #2: options
\RenewDocumentCommand{\EndCase}{ O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{endcase}}{}{}{#1}{#2}%
-\ALG at makeentity{EndCase}%
-\ifaxp at NoEnd\axp at MarkLineEndFinal\fi%
-\axp at EndGroup
+ \axp at DefineCommand{\Keyword{endcase}}{}{}{#1}{#2}%
+ \ALG at makeentity{EndCase}%
+ \ifbool{axp at NoEnd}{\axp at MarkLineEndFinal}{}%
+ \axp at EndGroup
}
% #1: comment
% #2: options
\RenewDocumentCommand{\Otherwise}{ O{} D<>{} }{%
-\axp at BeginGroup
-\axp at DefineCommand{\Keyword{otherwise}}{}{}{#1}{#2}%
-\ALG at makeentity{Otherwise}%
+ \axp at BeginGroup
+ \axp at DefineCommand{\Keyword{otherwise}}{}{}{#1}{#2}%
+ \ALG at makeentity{Otherwise}%
}
% #1: comment
% #2: options
\RenewDocumentCommand{\EndOtherwise}{ O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{endotherwise}}{}{}{#1}{#2}%
-\ALG at makeentity{EndOtherwise}%
-\ifaxp at NoEnd\axp at MarkLineEndFinal\fi%
-\axp at EndGroup
+ \axp at DefineCommand{\Keyword{endotherwise}}{}{}{#1}{#2}%
+ \ALG at makeentity{EndOtherwise}%
+ \ifbool{axp at NoEnd}{\axp at MarkLineEndFinal}{}%
+ \axp at EndGroup
}
@@ -828,9 +836,9 @@
% #3: comment
% #4: options
\RenewDocumentCommand{\For}{ O{} m O{} D<>{} }{%
-\axp at BeginGroup
-\axp at DefineCommand{\Keyword{for}}{#2}{\Keyword{do}}{#1#3}{#4}%
-\ALG at makeentity{For}%
+ \axp at BeginGroup
+ \axp at DefineCommand{\Keyword{for}}{#2}{\Keyword{do}}{#1#3}{#4}%
+ \ALG at makeentity{For}%
}
% #1: old style comment
% #2: text
@@ -837,9 +845,9 @@
% #3: comment
% #4: options
\RenewDocumentCommand{\ForEach}{ O{} m O{} D<>{} }{%
-\axp at BeginGroup
-\axp at DefineCommand{\Keyword{foreach}}{#2}{\Keyword{do}}{#1#3}{#4}%
-\ALG at makeentity{ForEach}%
+ \axp at BeginGroup
+ \axp at DefineCommand{\Keyword{foreach}}{#2}{\Keyword{do}}{#1#3}{#4}%
+ \ALG at makeentity{ForEach}%
}
% #1: old style comment
% #2: text
@@ -846,22 +854,22 @@
% #3: comment
% #4: options
\RenewDocumentCommand{\ForAll}{ O{} m O{} D<>{} }{%
-\axp at BeginGroup
-\axp at DefineCommand{\Keyword{forall}}{#2}{\Keyword{do}}{#1#3}{#4}%
-\ALG at makeentity{For}%
+ \axp at BeginGroup
+ \axp at DefineCommand{\Keyword{forall}}{#2}{\Keyword{do}}{#1#3}{#4}%
+ \ALG at makeentity{For}%
}
% #1: comment
% #2: options
\RenewDocumentCommand{\EndFor}{ O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{endfor}}{}{}{#1}{#2}%
-\ALG at makeentity{EndFor}%
-\ifaxp at NoEnd\axp at MarkLineEndFinal\fi%
-\axp at EndGroup
+ \axp at DefineCommand{\Keyword{endfor}}{}{}{#1}{#2}%
+ \ALG at makeentity{EndFor}%
+ \ifbool{axp at NoEnd}{\axp at MarkLineEndFinal}{}%
+ \axp at EndGroup
}
%% Procedure, function, calls
-\newif\ifaxp at IsModule
+\newbool{axp at IsModule}
\algblockdefx[Procedure]{Procedure}{EndProcedure}{\axp at MakeCommand}{\axp at MakeCommand*}
% #1: old style comment
% #2: name
@@ -869,19 +877,19 @@
% #4: comment
% #5: options
\RenewDocumentCommand{\Procedure}{ O{} m m O{} D<>{} }{%
-\axp at BeginGroup
-\axp at IsModuletrue%
-\axp at DefineCommand{\Keyword{procedure}~\Module{#2}}{#3}{}{#1#4}{#5}%
-\ALG at makeentity{Procedure}%
-\axp at IsModulefalse%
+ \axp at BeginGroup
+ \booltrue{axp at IsModule}%
+ \axp at DefineCommand{\Keyword{procedure}~\Module{#2}}{#3}{}{#1#4}{#5}%
+ \ALG at makeentity{Procedure}%
+ \boolfalse{axp at IsModule}%
}
% #1: comment
% #2: options
\RenewDocumentCommand{\EndProcedure}{ O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{endprocedure}}{}{}{#1}{#2}%
-\axp at MarkLineEndFinal%
-\ALG at makeentity{EndProcedure}%
-\axp at EndGroup
+ \axp at DefineCommand{\Keyword{endprocedure}}{}{}{#1}{#2}%
+ \axp at MarkLineEndFinal%
+ \ALG at makeentity{EndProcedure}%
+ \axp at EndGroup
}
\algblockdefx[Function]{Function}{EndFunction}{\axp at MakeCommand}{\axp at MakeCommand*}
@@ -891,26 +899,26 @@
% #4: comment
% #5: options
\RenewDocumentCommand{\Function}{ O{} m m O{} D<>{} }{%
-\axp at BeginGroup
-\axp at IsModuletrue%
-\axp at DefineCommand{\Keyword{function}~\Module{#2}}{#3}{}{#1#4}{#5}%
-\ALG at makeentity{Function}%
-\axp at IsModulefalse%
+ \axp at BeginGroup
+ \booltrue{axp at IsModule}%
+ \axp at DefineCommand{\Keyword{function}~\Module{#2}}{#3}{}{#1#4}{#5}%
+ \ALG at makeentity{Function}%
+ \boolfalse{axp at IsModule}%
}
% #1: comment
% #2: options
\RenewDocumentCommand{\EndFunction}{ O{} D<>{} }{%
-\axp at DefineCommand{\Keyword{endfunction}}{}{}{#1}{#2}%
-\axp at MarkLineEndFinal%
-\ALG at makeentity{EndFunction}%
-\axp at EndGroup
+ \axp at DefineCommand{\Keyword{endfunction}}{}{}{#1}{#2}%
+ \axp at MarkLineEndFinal%
+ \ALG at makeentity{EndFunction}%
+ \axp at EndGroup
}
\RenewDocumentCommand{\Call}{ m m D<>{} }{%
-\begingroup%
-\AlgSet{#3}%
-\Module{#1}\textcolor{\axp at TextColor}{\axp at TextFont(#2)}%
-\endgroup%
+ \begingroup%
+ \AlgSet{#3}%
+ \Module{#1}\textcolor{\axp at TextColor}{\axp at TextFont(#2)}%
+ \endgroup%
}
@@ -935,13 +943,13 @@
\NewCommandCopy{\axp at AlgorithmicxAlgorithmic}{\algorithmic}
\NewCommandCopy{\axp at AlgorithmicxEndAlgorithmic}{\endalgorithmic}
\RenewDocumentCommand{\algorithmic}{ O{} D<>{} }{%
-\begingroup%
-\AlgSet{#2}%
-\axp at AlgorithmicxAlgorithmic[#1]%
+ \begingroup%
+ \AlgSet{#2}%
+ \axp at AlgorithmicxAlgorithmic[#1]%
}
\RenewDocumentCommand{\endalgorithmic}{}{%
-\axp at AlgorithmicxEndAlgorithmic%
-\endgroup%
+ \axp at AlgorithmicxEndAlgorithmic%
+ \endgroup%
}
\endinput
Modified: trunk/Master/tlpkg/tlpsrc/algxpar.tlpsrc
===================================================================
--- trunk/Master/tlpkg/tlpsrc/algxpar.tlpsrc 2025-08-02 19:50:35 UTC (rev 75952)
+++ trunk/Master/tlpkg/tlpsrc/algxpar.tlpsrc 2025-08-02 19:51:53 UTC (rev 75953)
@@ -0,0 +1,10 @@
+hard algorithmicx
+hard algorithmicx #algpseudocode
+hard amsfonts #amssymb
+hard etoolbox
+hard pgf #pgfmath
+hard pgfopts
+hard ragged2e
+hard pgf #tikz
+hard varwidth
+hard xcolor
More information about the tex-live-commits
mailing list.