☰

显示 UNIX 路径（包括变量组件）的好方法？

tag-icon • tag-icon packages environments paths
显示 UNIX 路径（包括变量组件）的好方法？

我正在为我编写的一些数据分析代码编写文档，我需要说明结果数据的存储位置。数据被写入一个具有特定名称 ( reducedData) 的目录，该目录本身包含在“根目录”中，我的代码会在该目录中查找各种其他内容。根目录的路径是一个可配置变量，因此在我的文档中，我引用的路径应由<rootDir>用户解释为其在配置中设置的任何路径。

在我的文档中我想要有如下格式：

...等等等等。数据存储到：

<rootDir>\减少数据\ <fileName>.hdf

...等等等等等等。

我需要帮助的是选择一种好的方法来实现这一点。我可以使用显式换行符和 强制它按照我想要的方式显示\verb||，但我相信有更好的、更 LaTeX 风格的方法来做到这一点。特别是，除了将路径在其自己的缩进行中分开设置之外，我还想更改字体以使其突出，并且可能对尖括号中的标记进行另一种字体更改，以暗示用户不应将它们视为文字字符串。是否存在可以以标准方式格式化此类内容的包或环境？

答案1

与 egreg 的答案类似，但在占位符文本中额外强调：

\documentclass{article}

\let\path=\texttt
\newcommand{\V}[1]{$\langle$\textit{#1}$\rangle$}

\begin{document}

\path{\V{rootdir}/reduced-data/\V{filename}.hdf}

\end{document}

在此处输入图片描述

命令\meta​doc包可能也会引起人们的兴趣。

答案2

表示“元变量”的常见方式是将它们括在尖括号中，因此它可能看起来像

$\langle$rootDir$\rangle$\texttt{\symbol{`\\}reducedData\symbol{`\\}}%
  $\langle$fileName$\rangle$\texttt{.hdf}

当然埋在序言中定义的宏中。

当然，这些不是 Unix 路径，而是 Windows 路径。

相关内容