(logging-log4j2) branch 2.x updated: Improve plugin reference ToC

[vy]

This is an automated email from the ASF dual-hosted git repository.

vy pushed a commit to branch 2.x
in repository https://gitbox.apache.org/repos/asf/logging-log4j2.git


The following commit(s) were added to refs/heads/2.x by this push:
     new c36ee1811f Improve plugin reference ToC
c36ee1811f is described below

commit c36ee1811fd5961d2ec7677726b59fb799c96fda
Author: Volkan Yazıcı <vol...@yazi.ci>
AuthorDate: Tue May 7 13:31:27 2024 +0200

    Improve plugin reference ToC
---
 src/docgen/index.adoc.ftl | 6 +++++-
 src/docgen/type.adoc.ftl  | 2 +-
 2 files changed, 6 insertions(+), 2 deletions(-)

diff --git a/src/docgen/index.adoc.ftl b/src/docgen/index.adoc.ftl
index 40633161b8..32a756054c 100644
--- a/src/docgen/index.adoc.ftl
+++ b/src/docgen/index.adoc.ftl
@@ -15,6 +15,10 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express 
or implied.
 See the License for the specific language governing permissions and
 limitations under the License.
 -->
+
+// ToC does not look nice with a deep sectioning, override it:
+:page-toclevels: 3
+
 <#-- @ftlvariable name="lookup" 
type="org.apache.logging.log4j.docgen.generator.TypeLookup" -->
 
 = Plugin reference
@@ -52,7 +56,7 @@ Below is a list of all types reachable by plugins grouped by 
the Maven coordinat
         <#assign lastArtifactId = sourcedType.artifactId/>
 
 [#${sourcedType.groupId?replace('.', 
'-')}_${sourcedType.artifactId?replace('.', '-')}]
-=== `${sourcedType.groupId}:${sourcedType.artifactId}`
+=== `${sourcedType.artifactId}`
     </#if>
 
 
include::_plugin-reference/${sourcedType.groupId}-${sourcedType.artifactId}-${sourcedType.type.className}.adoc[leveloffset=+3]
diff --git a/src/docgen/type.adoc.ftl b/src/docgen/type.adoc.ftl
index 48f8dc2478..ec7c90bc0a 100644
--- a/src/docgen/type.adoc.ftl
+++ b/src/docgen/type.adoc.ftl
@@ -21,7 +21,7 @@
 <#-- @ftlvariable name="lookup" 
type="org.apache.logging.log4j.docgen.generator.TypeLookup" -->
 
 [#${sourcedType.groupId?replace('.', 
'-')}_${sourcedType.artifactId?replace('.', '-')}_${type.className?replace('.', 
'-')}]
-= ${type.name!('`' + type.className + '`')}
+= ${type.name!('`' + type.className?keep_after_last('.') + '`')}
 
 Class:: `${type.className}`
 Provider:: `${sourcedType.groupId}:${sourcedType.artifactId}`