你如何订购Doxygen自定义页面

Question

我在Doxygen中创建了许多自定义页面。我想自定义主菜单中页面的顺序。下面是我当前导航菜单的图片。我想更改顺序，因此概述是第一个，安装第二个，第三个介绍，等等。有没有办法做到这一点？

Answer 1

经过一番调查后，似乎Doxygen目前不支持自定义（或任何）方式的页面排序。

就像@Toby提到的那样，确保Doxygen中所需页面顺序的当前方法是确保以相同的顺序解析页面条件（\ page）。例如，您可以通过手动指定文件来实现所需的顺序，例如：

INPUT = Developers.dox \
        Hive_Training.dox \
        Installation.dox \
        Introduction.dox \
        Models.dox \
        Overview.dox \
        Users.dox \
        Files.dox

这根本不理想，但它确实有效。我发现如果您希望在Doxygen配置文件中维护目录路径，可以创建一个“页面顺序”文件，在任何其他内容之前先解析。例如：

INPUT += PageOrder.dox
INPUT += ../my_module_1/content/
INPUT += ../my_module_2/content/

然后在PageOrder.dox文件中添加所有页面引用：

\page developers Developers
\page hive_training Hive Training
\page installation Installation
\page introduction Introduction
\page models Models
\page overview Overview
\page users Users
\page files Files

这又是不理想的;但是，您的维护过程现在位于单个页面顺序文件中（而不是触摸一（1）个或更多Doxygen配置文件）。

Answer 2

Doxygen按字母顺序处理自定义页面文件名称。

因此，您可以将自定义页面文件命名为：

• _1_file1.dox
• _2_file2.dox
• 等...

因此，它们将在生成的文档中以相同的顺序出现。此解决方案避免修改任何配置文件！

Answer 3

我找到了一种相当麻烦的实现方法。 以前我将所有自定义doxygen文件（图像，页面等）放在一个名为input的目录中。

我将每个网页都放在一个单独的文件中（例如main_page.dox，page1.dox，page2.dox等）

我将自定义页面移动到与输入目录处于同一级别的名为pages的单独目录。

（我还将我的输入目录重命名为图像，并相应地更改了IMAGE_PATH）

然后，在doxygen配置文件中，我按照我想要的顺序将每个页面文件的显式路径添加到INPUT变量 。 E.G：

INPUT= . Documentation\images \ 
      Documentation\pages\main_page.dox \
      Documentation\pages\page2.dox \
      Documentation\pages\page3.dox

这意味着每次添加新页面时，我都必须将其路径添加到INPUT，因此我在顶部说过，这很麻烦。但比在介绍之前出现的妄想更好

这适用于HTML和LaTeX - 尚未使用其他格式进行测试

Answer 4

我知道这个问题相当陈旧，但2017年和我仍然没有找到令人满意的答案...... 由于这是第一次搜索，我认为我仍然应该在这里留下我的解决方法。

我认为最简单，最简单的方法是遍历单个页面的间接，包含所有自定义页面作为子页面。这保留了输入顺序，例如 - ＆GT;

＆＃13;

＆＃13;

@page page_contents Contents
@tableofcontents
@subpage page_intro Intro
@subpage page_install Install
@subpage page_system System

＆＃13;

＆＃13;

＆＃13;

Answer 5

对HTML / CHM输出进行分组的方法是通过不同文件中的嵌套@page和@subpage元素。

因此，我过去所做的就是拥有一个目标网页以及几个结构#chencutre＆＃39;定义部分布局的页面。每个引用都需要在自己的文件中。

作为一个例子：

\mainpage
# Welcome to my main page #
Some text
\subpage IntroductionSection
\subpage DetailsSection
\subpage SamplesSection

然后为每个子项建立一个结构，如（IntroStructure.md）

Introduction {#IntroductionSection}
===============
# An introduciton to the topic #
\subpage GettingStarted
\subpage HowTo
\subpage DeepDive

请注意，每个子页面都需要引用     深潜{#DeepDive} 试。

这就是我处理大量降价文件的方式。 虽然你有一定的文件开销，但对html / chm很有用。