Is there a package for typing examples inside DTX documentation?

Question

This is what I see in pgf documentation, for example:

Is there a package, which would help me render similar two-column samples in my own DTX documentation?

I want to type something like this:

\begin{sample}
This is \LaTeX!
\end{sample}

This should print two columns, with the rendered code on the left and the original TeX on the right (preferably with syntax highlighting).

There are various ways to do this: I use listings for siunitx, for example, but pgf I think is coded directly. If you want to use the pgfmanual style, I'd suggest starting by reading how they do it — Joseph Wright, Oct 09 '22 at 09:44
tcolorbox package has listing and document libraries (e.g. using minted package) with many options. More generally, see doc-supp and syntax highlighting pages on CTAN. — Cicada, Oct 09 '22 at 16:13
Like @Cicada, highly recommend tcolorbox and its associated documentation library for documenting your code and for typesetting examples. I use it for my own packages. — LaTeXereXeTaL, Oct 09 '22 at 18:32

LaTeXereXeTaL · Answer 1 · 2022-10-10T23:54:49.770

Here is an example using tcolorbox and your choice of listings or minted. There are many, many configuration options available and I haven't attempted to address all of them here. See the tcolorbox documentation.

If you use minted you need the line at top invoking --shell-escape and note that this may be a security risk; use it at your own discretion. You can delete that line if you use listings.

Also note that I use TeXShop and its lualatexmk engine.

I show dispExample* since it is what I use in my own package documentation, but tcblisting seems to have more configuration options. It may be the case those same options, or at least a subset thereof, can also be used with dispExample* but I have not explored that.

% !TEX program = lualatexmk
% !TEX parameter = --shell-escape % req. for minted
% !TEX encoding = UTF-8 Unicode
\documentclass{article}
% Choose ONE of the following two lines.
\usepackage[listings,documentation]{tcolorbox}
%\usepackage[minted,documentation]{tcolorbox}
\begin{document}
\begin{dispExample}{sidebyside}
 Hello, \LaTeX{}!
\end{dispExample}
% Use this block if you use minted.
%\begin{tcblisting}{listing engine=minted, sidebyside,
%  minted language=latex}
% Hello, \LaTeX{}!
%\end{tcblisting}
%\begin{tcblisting}{listing engine=minted, sidebyside,
%  minted language=latex, text side listing}
% Hello, \LaTeX{}!
%\end{tcblisting}
%\begin{tcblisting}{listing engine=minted, sidebyside,
%  minted language=latex, listing side text}
% Hello, \LaTeX{}!
%\end{tcblisting}
% Use this block if you use listings.
\begin{tcblisting}{listing engine=listings, listing style=tcblatex, sidebyside}
 Hello, \LaTeX{}!
\end{tcblisting}
\begin{tcblisting}{listing engine=listings, listing style=tcblatex, sidebyside, listing side text}
 Hello, \LaTeX{}!
\end{tcblisting}
\begin{tcblisting}{listing engine=listings, listing style=tcblatex, sidebyside, text side listing}
 Hello, \LaTeX{}!
\end{tcblisting}
\end{document}

score 0 · Accepted Answer · answered Oct 20 '22 at 06:23

0

I made my own package docshots. This code:

\begin{docshot}
\documentclass{article}
\usepackage{xcolor}
\pagestyle{empty}
\begin{document}
   Hello, {\color{orange}\LaTeX}!
\end{document}
\end{docshot}

It renders as such:

answered Oct 20 '22 at 06:23

yegor256

12,021

Is there a package for typing examples inside DTX documentation?

2 Answers2