【问题标题】:Asciidoc numbered sections, but only part of documentAsciidoc 编号的部分,但只是文档的一部分
【发布时间】:2020-10-08 15:31:51
【问题描述】:

我正在使用 Ascii doc 通过 Spring Restdocs 制作休息文档。我有一个概述部分,然后是一个操作部分。我希望操作有编号的部分,但我不希望概述和其他部分包含在编号中。另外,我不希望“操作”标题有数字,因为这是唯一编号的部分,所以没有什么意义。

所以,我所拥有的是这样的:

= Web service title header

[preface]
== Overview
overview text

=== Overview sub section 1
stuff

=== Overview sub section 2
more stuff

== Operations

:sectnums:

include::oauth2-scopes.adoc[]

include::oauth2-clients.adoc[]

然后controller-1.adoc 看起来像这样:

=== OAuth2 Scopes
==== Get scope
operation::get-scope[]

==== Get all scopes
operation::get-all-scopes[]

渲染时,结构本身很好,“操作”内部的部分已编号。但是,问题是这些数字很奇怪。

似乎“操作”标头被强制编号为 1,即使那里没有数字,并且后续数字似乎知道该数字被抑制了。

我希望这已经足够了。我对 Asciidoc 不是很有经验,所以我可能会遗漏一些东西。

我曾想过使用多级编号列表,但我希望它呈现为带有锚点的标题,而不仅仅是常规列表。


编辑:我正在通过将标题“操作”放在与包含的部分相同的级别(级别 2)来解决它。这使得 TOC 缩进关闭,但它比混乱的数字更不让人分心。

编辑 2: 我希望 Operations 处于二级 (==) 并且控制器的名称处于三级 (===)。我希望对控制器进行编号。将部分标题编号为 1,然后将我真正想要枚举的内容编号为 1.1,这没有多大意义。

【问题讨论】:

    标签: asciidoc asciidoctor spring-restdocs


    【解决方案1】:

    我不确定我是否正确理解了您的问题。

    • 如果您需要优化奇怪的编号,请确保降低级别(从 === 到 == 等)这将解决这个问题。

    • 如果您想在某个时候关闭编号,请在所需位置设置一个“:sectnums!:”。

    但是,如果我完全走错了路,请尝试重新提出您的问题。如果您添加屏幕截图,请确保它适合您的示例;-)

    【讨论】:

    • 我认为碎石镜头非常合适。它显示相同的结构,但标题不同。我想简化我猜的标记。
    猜你喜欢
    • 2012-05-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2023-03-14
    • 2016-03-26
    • 1970-01-01
    相关资源
    最近更新 更多