Scribd
Upload
38 views2 pages

The L3docstrip Package Code Extraction and Manipulation

The l3docstrip package extends the DocStrip program for extracting code from .dtx files in LATEX3. It adds a convention for marking internal functions and variables as private to a module by using @@ in place of the module name. When extracting code using l3docstrip and the %<@@=hmodulei syntax, the @@ will be replaced with __ to clearly indicate internal status to the specified module. This allows separation of public and internal functions without namespaces.

Uploaded by

rzrt rt r tzr
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
38 views2 pages

The L3docstrip Package Code Extraction and Manipulation

The l3docstrip package extends the DocStrip program for extracting code from .dtx files in LATEX3. It adds a convention for marking internal functions and variables as private to a module by using @@ in place of the module name. When extracting code using l3docstrip and the %<@@=hmodulei syntax, the @@ will be replaced with __ to clearly indicate internal status to the specified module. This allows separation of public and internal functions without namespaces.

Uploaded by

rzrt rt r tzr
Copyright
© © All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as PDF, TXT or read online on Scribd
You are on page 1/ 2

The l3docstrip package

Code extraction and manipulation∗


The LATEX3 Project†

Released 2012/06/08

1 Extending DocStrip
The l3docstrip module adds LATEX3 extensions to the DocStrip program for extracting code
from .dtx. As such, this documentation should be read along with that for DocStrip.

2 Internal functions and variables


An important consideration for LATEX3 development is separating out public and internal
functions. Functions and variables which are private to one module should not be used
or modified by any other module. As TEX does not have any formal namespacing system,
this requires a convention for indicating which functions in a code-level module are public
and which are private.
Using l3docstrip allows internal functions to be indicated using a “two part” system.
Within the .dtx file, internal functions may be indicated using @@ in place of the module
name, for example
\cs_new_protected:Npn \@@_some_function:nn #1#2
{
% Some code here
}
\tl_new:N \l_@@_internal_tl
To extract the code using l3docstrip, the “guard” concept used by DocStrip is ex-
tended by introduction of the syntax %<@@=hmodule i. The hmodulei name will be used
when the code is extracted to replace the @@, so that

%<*package>
%<@@=foo>
\cs_new_protected:Npn \@@_some_function:nn #1#2
∗ This file describes v3787, last revised 2012/06/08.
† E-mail: [email protected]

1
{
% Some code here
}
\tl_new:N \l_@@_internal_tl
%</package>

will be extracted as
\cs_new_protected:Npn \__foo_some_function:nn #1#2
{
% Some code here
}
\tl_new:N \l__foo_internal_tl
where the __ indicates that the functions and variables are internal to the foo module.

You might also like