Doxygen wizard - Expert - LaTex RTF

写在前面

Doxygen GUI为Doxygen界面操作工具。本篇为windows版Doxygen1.8.15 配置界面翻译， 翻译不当之处请谅解。
本篇包含Doxygen wizard - Expert：LaTex + RTF部分。

LaTex

• GENERATE_LATEX

If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.

The default value is: YES.

生成LaTeX输出

• LATEX_OUTPUT

The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

The default directory is: latex.

This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_OUTPUT标记用于指定放置 LaTeX文档的位置。如果输入了相对路径，输出目录的值将放在它前面。

• LATEX_CMD_NAME

The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be invoked.
Note that when not enabling USE_PDFLATEX the default is latex when enabling USE_PDFLATEX the default is pdflatex and when in the later case latex is chosen this is overwritten by pdflatex. For specific output languages the default can have been set differently, this depends on the implementation of the output language.

This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_CMD_NAME标记可用于指定要调用的LaTeX命令名。
请注意，如果不启用USE_PDFLATEX，默认值为laTex；启用USE_PDFLATEX时，默认值为pdflatex；如果在以后的情况下选择了laTex，则会被pdflatex覆盖。对于特定的输出语言，可以不同地设置默认值，这取决于输出语言的实现。

• MAKEINDEX_CMD_NAME

The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate index for LaTeX.
Note: This tag is used in the Makefile / make.bat.
See also: LATEX_MAKEINDEX_CMD for the part in the generated output file (.tex).

The default file is: makeindex.

This tag requires that the tag GENERATE_LATEX is set to YES.

MAKEINDEX_CMD_NAME标记可用于指定要为LaTeX生成索引的命令名。
注意：此标记用于makefile/make.bat。

• LATEX_MAKEINDEX_CMD

The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to generate index for LaTeX.
Note: This tag is used in the generated output file (.tex).
See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat.

The default value is: \makeindex.

This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_MAKEINDEX_CMD标记可用于指定要为LaTeX生成索引的命令名。
注意：此标记用于生成的输出文件（.tex）。
另请参见：MAKEINDEX_CMD_NAME，了解makefile/make.bat中的部件。
默认值为：\makeindex。

• COMPACT_LATEX

If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX documents. This may be useful for small projects and may help to save some trees in general.

The default value is: NO.

This tag requires that the tag GENERATE_LATEX is set to YES.

如果该标记为yes, doxygen生成更紧凑的LaTeX文档。这可用于小型项目，并可帮助在一般情况下拯救一些树。

• PAPER_TYPE

The PAPER_TYPE tag can be used to set the paper type that is used by the printer.

Possible values are: a4 (210 x 297 mm), letter (8.5 x 11 inches), legal (8.5 x 14 inches) and executive (7.25 x 10.5 inches).

The default value is: a4.

This tag requires that the tag GENERATE_LATEX is set to YES.

PAPER_TYPE标记可用于设置打印机使用的纸张类型。
可能的值为：A4（210 x 297毫米）、Letter（8.5 x 11英寸）、Legal（8.5 x 14英寸）和Executive（7.25 x 10.5英寸）。

• EXTRA_PACKAGES

The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names that should be included in the LaTeX output. The package can be specified just by its name or with the correct syntax as to be used with the LaTeX \usepackage command. To get the times font for instance you can specify :
EXTRA_PACKAGES=times or EXTRA_PACKAGES={times}
To use the option intlimits with the amsmath package you can specify:
EXTRA_PACKAGES=[intlimits]{amsmath}
If left blank no extra packages will be included.

This tag requires that the tag GENERATE_LATEX is set to YES.

EXTRA_PACKAGES标记可用于指定一个或多个应包含在 LaTeX输出中的 LaTeX包名称。包可以通过其名称或正确的语法指定，以便与laxte\usepackage命令一起使用。例如，要获取时间字体，可以指定：
EXTRA_PACKAGES=times 或 EXTRA_PACKAGES={times}
要将选项IntLimits与AMSMath包一起使用，可以指定：
EXTRA_PACKAGES=[intlimits]{amsmath}
如果留空，则不包括额外的包。

• LATEX_HEADER

The LATEX_HEADER tag can be used to specify a personal LaTeX header for the generated LaTeX document. The header should contain everything until the first chapter. If it is left blank doxygen will generate a standard header. See section “Doxygen usage” for information on how to let doxygen write the default header to a separate file.
Note: Only use a user-defined header if you know what you are doing! The following commands have a special meaning inside the header: title, datetime, date, doxygenversion, projectname, projectnumber, projectbrief, projectlogo. Doxygen will replace $title with the empty string, for the replacement values of the other commands the user is referred to HTML_HEADER .

This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_HEADER 标记可用于为生成的 LaTeX文档指定个人 LaTeX头。在第一章之前，标题应该包含所有内容。如果保留为空，则doxygen将生成标准头段。有关如何让doxygen将默认头文件写入单独文件的信息，请参阅“doxygen用法”一节。
注意：只有在您知道自己在做什么的情况下才使用用户定义的头文件！以下命令在头中具有特殊含义：title, datetime, date, doxygenversion, projectname, projectnumber, projectbrief, 。doxygen将用空字符串替换$title，对于其他命令的替换值，用户被引用为HTML_HEADER。

• LATEX_FOOTER

The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the generated LaTeX document. The footer should contain everything after the last chapter. If it is left blank doxygen will generate a standard footer. See LATEX_HEADER for more information on how to generate a default footer and what special commands can be used inside the footer.
Note: Only use a user-defined footer if you know what you are doing!

This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_FOOTER标记可用于为生成的LaTeX文档指定个人LaTeX页脚。页脚应包含最后一章之后的所有内容。如果它留空，那么doxygen将生成一个标准的页脚。有关如何生成默认页脚以及可以在页脚内使用哪些特殊命令的详细信息，请参见LATEX_HEADER。
注意：只有在知道自己在做什么的情况下才使用用户定义的页脚！

• LATEX_EXTRA_STYLESHEET

The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined LaTeX style sheets that are included after the standard style sheets created by doxygen. Using this option one can overrule certain style aspects. Doxygen will copy the style sheet files to the output directory.
Note: The order of the extra style sheet files is of importance (e.g. the last style sheet in the list overrules the setting of the previous ones in the list).

This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_EXTRA_STYLESHEET标记可用于指定附加的用户定义的LaTex样式表，这些样式表包含在Doxygen创建的标准样式表之后。使用此选项可以否决某些样式方面。doxygen将样式表文件复制到输出目录。
注意：额外样式表文件的顺序很重要（例如，列表中的最后一个样式表会否决列表中前一个样式表的设置）。

• LATEX_EXTRA_FILES

The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or other source files which should be copied to the LATEX_OUTPUT output directory. Note that the files will be copied as-is; there are no commands or markers available.

This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_EXTRA_FILES标记可用于指定一个或多个额外的图像或其他源文件，这些文件应复制到LaTex_输出目录。请注意，文件将按原样复制；没有可用的命令或标记。

• PDF_HYPERLINKS

If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated is prepared for conversion to PDF (using ps2pdf or pdflatex). The PDF file will contain links (just like the HTML output) instead of page references. This makes the output suitable for online browsing using a PDF viewer.

The default value is: YES.

This tag requires that the tag GENERATE_LATEX is set to YES.

如果PDF_HYPERLINKS标记设置为yes，则生成的LaTeX将准备转换为pdf（使用ps2pdf或pdf latex）。PDF文件将包含链接（就像HTML输出一样），而不是页面引用。这使得输出适合使用PDF查看器进行在线浏览。

• USE_PDFLATEX

If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate the PDF file directly from the LaTeX files. Set this option to YES, to get a higher quality PDF documentation.

The default value is: YES.

This tag requires that the tag GENERATE_LATEX is set to YES.

如果USE_PDFLATEX标记设置为yes，则doxygen将使用pdflatex直接从LaTeX文件生成PDF文件。将此选项设置为“是”，以获得更高质量的PDF文档。

• LATEX_BATCHMODE

If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \batchmode command to the generated LaTeX files. This will instruct LaTeX to keep running if errors occur, instead of asking the user for help. This option is also used when generating formulas in HTML.

The default value is: NO.

This tag requires that the tag GENERATE_LATEX is set to YES.

如果将LATEX_BATCHMODE标记设置为yes，则doxygen将向生成的LaTex文件添加\batchMode命令。这将指示LaTex在出现错误时继续运行，而不是向用户寻求帮助。在HTML中生成公式时也使用此选项。

• LATEX_HIDE_INDICES

If the LATEX_HIDE_INDICES tag is set to YES then doxygen will not include the index chapters (such as File Index, Compound Index, etc.) in the output.

The default value is: NO.

This tag requires that the tag GENERATE_LATEX is set to YES.

如果LATEX_HIDE_INDICES标记设置为“是”，那么doxygen将不会在输出中包含索引章节（如文件索引、复合索引等）。

• LATEX_SOURCE_CODE

If the LATEX_SOURCE_CODE tag is set to YES then doxygen will include source code with syntax highlighting in the LaTeX output.
Note that which sources are shown also depends on other settings such as SOURCE_BROWSER .

The default value is: NO.

This tag requires that the tag GENERATE_LATEX is set to YES.

如果将 LATEX_SOURCE_CODE标记设置为yes，那么doxygen将在laTex输出中包含语法突出显示的源代码。
请注意，显示哪些源还取决于其他设置，如源和浏览器。

• LATEX_BIB_STYLE

The LATEX_BIB_STYLE tag can be used to specify the style to use for the bibliography, e.g. plainnat, or ieeetr. See https://en.wikipedia.org/wiki/BibTeX and \cite for more info.

The default value is: plain.

This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_BIB_STYLE 标记可用于指定书目使用的样式，例如plannat或ieeeter。更多信息请参见https://en.wikipedia.org/wiki/bibtex和\cite。

• LATEX_TIMESTAMP

If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated page will contain the date and time when the page was generated. Setting this to NO can help when comparing the output of multiple runs.

The default value is: NO.

This tag requires that the tag GENERATE_LATEX is set to YES.

如果将LATEX_TIMESTAMP标记设置为“是”，则每个生成的页面的页脚将包含生成页面的日期和时间。将此设置为否有助于比较多个运行的输出。

• LATEX_EMOJI_DIRECTORY

The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) path from which the emoji images will be read. If a relative path is entered, it will be relative to the LATEX_OUTPUT directory. If left blank the LATEX_OUTPUT directory will be used.

This tag requires that the tag GENERATE_LATEX is set to YES.

LATEX_EMOJI_DIRECTORY标记用于指定从中读取emoji图像的（相对或绝对）路径。如果输入了相对路径，则它将相对于LATEX_OUTPUT目录。如果留空，将使用LATEX_OUTPUT目录。

RTF

• GENERATE_RTF

If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The RTF output is optimized for Word 97 and may not look too pretty with other RTF readers/editors.

The default value is: NO.

如果GENERATE_RTF标记设置为yes，则doxygen将生成RTF输出。RTF输出针对Word 97进行了优化，在其他RTF读卡器/编辑器中可能看起来不太漂亮。

• RTF_OUTPUT

The RTF_OUTPUT tag is used to specify where the RTF docs will be put. If a relative path is entered the value of OUTPUT_DIRECTORY will be put in front of it.

The default directory is: rtf.

This tag requires that the tag GENERATE_RTF is set to YES.

RTF_OUTPUT标记用于指定将在何处放置RTF文档。如果输入了相对路径，输出目录的值将放在它前面。

• COMPACT_RTF

If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF documents. This may be useful for small projects and may help to save some trees in general.

The default value is: NO.

This tag requires that the tag GENERATE_RTF is set to YES.

如果COMPACT_RTF标记设置为yes，则doxygen会生成更紧凑的RTF文档。这可能对小型项目很有用，并且可能有助于节省一些树。

• RTF_HYPERLINKS

If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated will contain hyperlink fields. The RTF file will contain links (just like the HTML output) instead of page references. This makes the output suitable for online browsing using Word or some other Word compatible readers that support those fields.
Note: WordPad (write) and others do not support links.

The default value is: NO.

This tag requires that the tag GENERATE_RTF is set to YES.

如果将RTF_HYPERLINKS标记设置为yes，则生成的rtf将包含超链接字段。RTF文件将包含链接（就像HTML输出一样），而不是页面引用。这使得输出适合使用Word或其他支持这些字段的Word兼容读卡器进行在线浏览。
注意：WordPad（写）和其他不支持链接。

• RTF_STYLESHEET_FILE

Load stylesheet definitions from file. Syntax is similar to doxygen’s configuration file, i.e. a series of assignments. You only have to provide replacements, missing definitions are set to their default value.
See also section “Doxygen usage” for information on how to generate the default style sheet that doxygen normally uses.

This tag requires that the tag GENERATE_RTF is set to YES.

从文件加载样式表定义。语法类似于Doxygen的配置文件，即一系列分配。您只需要提供替换，缺少的定义被设置为它们的默认值。
有关如何生成Doxygen通常使用的默认样式表的信息，请参见“Doxygen用法”一节。

• RTF_EXTENSIONS_FILE

Set optional variables used in the generation of an RTF document. Syntax is similar to doxygen’s configuration file. A template extensions file can be generated using doxygen -e rtf extensionFile.

This tag requires that the tag GENERATE_RTF is set to YES.

设置生成RTF文档时使用的可选变量。语法类似于Doxygen的配置文件。可以使用doxygen-e rtf扩展文件生成模板扩展文件。

• RTF_SOURCE_CODE

If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code with syntax highlighting in the RTF output.
Note that which sources are shown also depends on other settings such as SOURCE_BROWSER .

The default value is: NO.

This tag requires that the tag GENERATE_RTF is set to YES.

如果将 RTF_SOURCE_CODE标记设置为yes，那么doxygen将在rtf输出中包含语法突出显示的源代码。
请注意，显示的源还取决于其他设置，如源浏览器。