Skip to content

Seven code blocks in the guides have callout markers with no matching callout entry #56509

Description

@rolfedh

Describe the bug

#56386 set the rule that a callout list sits directly under its source block with one <n> entry per marker, and #56222, #56425 and #56449 fixed most of the guides. Parsing today's main (a13ff14) with a strict AsciiDoc parser still finds seven blocks in six guides where the markers and the list do not match. Asciidoctor renders them anyway, with a warning or a circled number that points nowhere; a strict parser rejects the whole page.

Guide Block Problem
hibernate-orm.adoc L1907-L1917 <3> on L1911 (the onLoad method) has no entry; the list has <1> and <2>
infinispan-client.adoc L74-L81 <2> on L80 (the Greeting record) has no entry; the list has only <1>
quarkus-data-hibernate-getting-started.adoc L408-L423 <1> (L410) and <2> (L418) have no list at all; the next source block follows directly
security-openid-connect-dev-services.adoc L302-L305 the <2> entry (L308) is separated from the list by the paragraph "Policy jars can also be located in the file system.", so it is not part of the list
security-vertx-oidc-to-quarkus-oidc-migration.adoc L92-L145 <8> on L139 (ProtectedProfileHandler) has no entry; the list stops at <7>
security-vertx-oidc-to-quarkus-oidc-migration.adoc L750-L756 <1> on L752 (@PermissionsAllowed) has no list; prose follows the block
writing-extensions.adoc L1623-L1640 <1> and <2> (L1626-L1627) are followed by a numbered list (1., 2.) instead of a callout list

Not included on purpose: doc-create-tutorial.adoc L177-L205 sets subs="-callouts" because its markers are the example's content; that one is a parser gap on the other side (yupiik/tools-maven-plugin#118).

Expected behavior

Every <n> marker in a block has a <n> entry in the callout list directly under the block, and nothing else stands in for that list.

Actual behavior

See the table: a marker without an entry (four blocks), a block without a list (two), and an entry cut off from its list by a paragraph (one).

How to Reproduce?

Read the lines above, or parse the seven files with Yupiik asciidoc-java 1.2.16 (new Parser().parse(path, lines, context)), which throws Invalid callout references on each of them. Found while generating the Markdown twins of the guides for quarkiverse/quarkus-roq#1105.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions