微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

Asciidoc编号部分,但仅文档的一部分

如何解决Asciidoc编号部分,但仅文档的一部分

我正在使用Ascii doc与Spring Restdocs一起制作其余文档。我有一个概述部分,然后是一个包含操作的部分。我希望操作的部分编号,但是我不希望总览和其他部分包含在编号中。另外,我不想在“ operations”标头中添加数字,因为这是唯一被编号的部分,所以这毫无意义。

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

= 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[]

渲染后,该结构本身很好,对“操作”内的部分进行了编号。但是,问题在于数字很奇怪。

screenshot of rendering

“操作”标头似乎被迫编号为1,即使那里没有编号,并且随后的编号似乎都知道该编号已被抑制。

我希望这足够了。我对asciidoc并没有超级的经验,所以我可能会缺少一些东西。

我曾经考虑过使用多级编号列表,但我希望将其呈现为带有锚点的标头,而不仅仅是常规列表。


编辑:我正在通过将标题“ Operations”(操作)和与所包含的部分相同的级别(第2级)放置在此位置上。这样可以避免TOC缩进,但是它比分散的数字要分散注意力。

编辑2:我想将 Operations (操作)设为第二级(==),并将控制器的名称设为第三级({{1 }}。我希望对控制器进行编号。将章节标题编号为1,然后将我实际要列举的内容编号为1.1,这没有多大意义。

解决方法

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

  • 如果您需要优化怪异的编号,请确保将级别降低(从===降低到==等)。

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

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

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。