cmhughes
commented
6 months ago Thanks for this.
Using the following settings
cube707.yaml
defaultIndent: " "
specialBeginEnd:
#
# store
# ^^A ....
# as verbatim
#
dtxComments:
begin: \^\^A
body: [^\n]*?
end: ''
lookForThis: verbatim
#
# store
# <.*?>
# as verbatim
#
dtxXML:
begin: \<
body: [^>]*?
end: \>
lookForThis: verbatim
#
# polyswitch work
#
modifyLineBreaks:
mandatoryArguments:
foo:
MandArgBodyStartsOnOwnLine: 1 # -1,0,1,2,3,4
RCuBStartsOnOwnLine: 1 # -1,0,1,2,3,4
bar:
MandArgBodyStartsOnOwnLine: 1 # -1,0,1,2,3,4
RCuBStartsOnOwnLine: 1 # -1,0,1,2,3,4
replacements:
#
# BEFORE indentation
#
# change
#
# % \iffalse
#
# into
#
# \iffalse%TOBEREMOVED
-
substitution: |-
s/^%(.*?)$/$1%TOBEREMOVED/mg
when: before
#
# AFTER indentation
#
# change
#
# \iffalse%TOBEREMOVED
#
# back into
#
# % \iffalse
-
substitution: |-
s/^(.*?)%TOBEREMOVED$/% $1/mg
when: after
#
# change
#
# % <>
#
# into
#
# %<>
-
substitution: |-
s/^%\h*\</%</mg
when: after
#
# change, for example
#
# %<*class>
# \NeedsTeXFormat{LaTeX2e}
# \ProvidesClass{HsH-standalone}[2024-01-29 my cool class]
# % \end{macrocode}
#
# into
#
# %<*class>
# \NeedsTeXFormat{LaTeX2e}
# \ProvidesClass{HsH-standalone}[2024-01-29 my cool class]
# % \end{macrocode}
-
substitution: |-
s/^(%.*?\R)((?:[^%].*?$)+?\R)(%)/
my $begin = $1;
my $middle = $2;
my $end = $3;
# remove leading space from first line of $middle
$middle =~ s|^(\h*)||s;
my $leadingSpace = ($1?$1:q());
$middle =~ s|^$leadingSpace||mg;
$begin.$middle.$end;/sgmxe
when: afterand calling
latexindent.pl -r -m -l cube707.yaml myfile.dtxgives the following
% \iffalse
%<*driver> ^^A ---------- documentation driver -----------------------------------------
\ProvidesFile{class.dtx}
\documentclass{ltxdoc}
\begin{document}
\DocInput{\jobname.dtx}
\end{document}
%</driver>
% \fi
% ^^A ---------- document body -----------------------------------------
% \title{A \LaTeX\ class}
% \maketitle
%
% \section{Introduction}
% This is just an example.
%
% \section{Class commands}
% You can use the following options:
%
% \begin{description}
% \item[foo] first command with long paragraph
% \item[bar] second command
% \end{description}
%
% \section{Implementation}
% \begin{macrocode}
%<*class>
\NeedsTeXFormat{LaTeX2e}
\ProvidesClass{HsH-standalone}[2024-01-29 my cool class]
% \end{macrocode}
%
% \subsection{Implement the commands}
%
% \begin{macro}{\foo}
% this is an example macro.
% \begin{macrocode}
\def\foo{
foo
}
% \end{macrocode}
% \end{macro}
%
% \begin{macro}{\bar}
% this is an example macro.
% \begin{macrocode}
\def\bar{
bar
}
% \end{macrocode}
% \end{macro}
%
% \begin{macrocode}
%<*class>
% \end{macrocode}
\endinputI hope it as you would like :)
Cube707
This is a very heavy feature-request, so feel free to tell me it's out of scope š
But if this is of interes to you I would be happy to assist in getting this to work.
When creating LaTeX packages or classes the source-code and documentation is usually written in a single file of format
dtx. This file contains two layers of LaTeX code, the source as expected and the documentation inside comments.I would like to use
latexindentto help me keep a consistent format, but I cant really get it to run properly. I would also argue that this is a common requirement in the LaTeX community and it might make sens to create a solution that can be included in the documentation or build directly into the script, if this is of interest to you.what are
dtxfilesThe filetype mixes package source-code and documentation in a single file. It can be processed using different standard utilities to produce both the class/package file and a pdf documenting it.
Calling the
docstriputility on the file will stip all comments (and therefore the documentation), leaving only the bare source-code.Calling
pdflatexon the file will process it into a pdf with the proceeding%beeing removed, printing the documentation and all source-code being contained insidemacrocodeblocks.original code
Note that lines prefixed with
%are not commented out but are valid LaTeX-code.actual/given output
running
latexindenton the file only formats the not-commented parts (as is expected)desired output
something similar to this:
anything else
%<..>lines, which are guard-statements and should not be formatted.latexindentshould be keept available as much as possibledtxuses^^Aas a comment character, which could be respected