大型文档中可持续引用的推荐样式指南

大型文档中可持续引用的推荐样式指南

我开始撰写越来越多的报告,报告的篇幅也越来越大,通常约 60-100 页,包含多个部分、附录等。然而,我发现我当前用于标记图形、部分等的系统/风格并不理想,并且扩展性也不太好。我很快就要写我的博士论文了,我想确保我决定使用的风格能够很好地适应,并且我不会后悔或者试图在以后改变它。

目前我的引用风格大致如下:

\documentclass{article}
\begin{document}
\section{Introduction}
\label{sec:introduction}
\subsection{Referencing}
\label{subsec:referencing}
\subsubsection{Too many nested references}
\label{subsubsec:too_many_nested_references}
Some equations, figures, tables, pseudo code, code implementations, referenced by:
%\label{eqt:equation_scaling}
%\label{fig:growth_in_labels}
%\label{tab:results_of_scaling}
%\label{algo:producing_labels}
%\label{code:python:producing_labels}
\appendix
\section{Alternatives}
\label{app:sec:alternatives}
Here we list some alternatives to appending \verb|app:| to everything.
\end{document}

通过这种方法,我经常发现我想要一种比最小的更详细的标签语法\label{environment:brief_description},但从类似的东西中获益匪浅\label{topic/section:environment:brief_description}。但是,我担心如果我在编辑过程中尝试移动内容或重新构建文档,我会尝试在标签中包含部分信息。(我经常会将证明或讨论从一个部分移动到另一个部分)。

如果有人有处理此类问题的经验,或者推荐了解决此类问题的指南,我们将不胜感激。

答案1

由于撰写论文时几乎不可避免地需要进行结构重组,因此我强烈反对在标签中包含章节名称或其他内容。小节最终会变成章节,章节会变成章节或小节,等等。您可以将第 3 章和第 5 章中的小节合并到第 2 章中,或者将第 4.2 节拆分为两个新章节,一个在这里,一个在第 6 章中。我想你会明白的。

如果您标记了图形、表格和代码,问题就不会那么严重。只需确保对每种类型使用不同的前缀。也不要使用\label{fig:Fig3a}或类似的东西。尽量给它们起一个独特而有说服力的名字,比如\label{fig:elephant_in_the_room},尽可能避免缩写。也许您在这里可以做的唯一例外是子图,因为通常您不会得到超过子图的数量(一)至(八),而且您可能不会混淆不同主角的子人物。如果您要这样做,请给他们起一个有说服力的名字。

还给予方程式有说服力的名称,例如\label{eq:Probability_to_observe_pink_elephant_when_drinking_too_much}。请记住,许多编辑器都有自动完成功能,可让您快速引用它们,而无需查找是否需要使用\ref{eq:intermediate_result12b}\ref{eq:intermediate_result11c_v3}(最后两个示例旨在表明,在引入另一个中间步骤或扩展某些方程式等时,这些标签变得毫无意义)。真正尝试找到有说服力的名称。上面的例子可以更简洁,例如\label{eq:pink_elephant_probability},但一定要包含足够的信息,以便能够明确地识别方程式。如果您无法为标签、等式等想出一个明确而明确的名称,那么可能根本不需要引用。

不是在图表、方程式、表格等标签中包含诸如章节或节之类的内容。如果您想使用子结构,则最好使用不会被拆分的逻辑单元,而不是节或章节标题。也许像\label{eq:derivation_pink_elephant_probability:Bayesian_inference}。如果您的主管不同意您认为它应该出现在正文中的观点,这允许您稍后将此派生转移到其他位置,例如转移到附录中。

如果您完成了推导,请将结果上移一个逻辑步骤,即“粉红色大象概率的推导”中的最后一个方程不应再包含derivation_pink_elephant_probability其中的部分,而可能更像\label{eq:pink_elephant_probability}。如果您稍后将此方程的推导移至附录但将结果保留在正文中,则更容易在附录中重命名此方程标签,例如\label{eq:derivation_pi…ity:end_result}如果您想交叉引用它,而您可以在正文中保留所有交叉引用,\ref{eq:pink_elephant_probability}而不是重命名它们。

答案2

好吧,使用分层标签:

  • 在如此长的工作中,对最顶层的部分进行一致的标记,可能类似于:chap:introchap:prelim等等。

  • 将其他所有内容一致地标记为<type>:<chapter>-<label>,例如eq:prelim-RST或(在 的证明中thm:bla-foo)或其他任何内容。始终eq:bla-foo-Cauchy使用前缀。<type>

    我的<type>前缀是:chap,,,,,,,(可能是其他浮点数),,,,, (可能是sect其他类似定理的环境)subsecteqfigtabthmlemmadef

  • 以一致的方式标记参考文献,如doe-soe-1950或(以防有许多作者ABCD-1970或 )abel-etal-1970

对我来说,这个方法确实很有效。顶部的分区应该将工作分成相当长的部分,这样你就可以很容易地识别标签。

相关内容