获取 TikZ/PGF-Documentation 样式的包

Question

LaTeX 文档的黄金标准是 TikZ/PGF 文档（至少对我来说）。它的格式一致，具有出色的代码突出显示功能，并且（我认为最好的功能之一）您可以单击代码片段中的任何命令并转到带有其解释的相应章节。

我如何才能获得相同的外观和功能？

我查看了文档的源代码，但内容相当混乱。大多数宏似乎都是在 中定义的pgfmanual-en-macros.tex，这是正确的吗？还是它也基于一个特殊的包？

该软件包tcolorbox有附加库documentation，支持对命令、环境、键的解释进行排版和索引，以及同时打印源代码和编译结果。但它似乎没有提供“可点击”代码片段的功能。

Answer 1

以下是如何使用 PGF 手册样式的简单示例。请注意以下要求

1. 你必须使用ltxdoc文档类。
2. 包calc、tikz和hyperref是必需的。
3. 的“可选”参数codeexample并非真正可选。即使为空，也必须有空括号[]。

我建议使用hidelinks选项来hyperref隐藏 PDF 中链接周围的红色方框。一般来说，hyperref应该尽可能晚地加载包（另请参阅哪些包应该在 hyperref 之后加载而不是之前加载？）。

自 PGF 3.1.6 起，该文件pgfmanual-en-macros.tex安装到 TeX 搜索路径中。在此版本之前，您必须转到 PGF 文档目录并将文件复制到您的工作目录中。

\documentclass{ltxdoc}
\usepackage{calc}
\usepackage{tikz}
\input{pgfmanual-en-macros.tex}
\usepackage[hidelinks]{hyperref}
\begin{document}

\begin{command}{\textbf\marg{text}}
  Prints its argument in bold.
\end{command}

% These empty brackets are NOT optional
%                  |
%                  v
\begin{codeexample}[]
\textbf{This is a test}
\end{codeexample}

\end{document}

如果出于某种原因，您想要将带星号的命令与command环境分开记录，请参阅这个解决方法。