如何使用 pgfmanual 包以 tikz 风格记录包

Question

我喜欢 tikz（和 tizk-cd）文档的格式，其中有可点击的链接，可以转到样式/命令的定义、颜色、带有图像和代码的示例等……正如这里提到的获取 TikZ/PGF-Documentation 样式的包pgfmanual 似乎提供了这样的功能，但尚未记录。

是否可以简要介绍一下如何使用pgfmanual，并提供探索更多高级选项的指针？

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.
  % These empty brackets are NOT optional
  %                |
  %                v
\begin{codeexample}[]
\textbf{This is a test}
\end{codeexample}
  %
\end{command}

\begin{environment}{{center}}
  Center text horizontally on the page.
  %
\begin{codeexample}[vbox]
  \begin{center}
    \textbf{This is a test}
  \end{center}
\end{codeexample}
  %
\end{environment}

\end{document}

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