Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use discrete headings instead of titled blocks in reference manual #33447

Closed
sbrannen opened this issue Aug 29, 2024 · 0 comments
Closed

Use discrete headings instead of titled blocks in reference manual #33447

sbrannen opened this issue Aug 29, 2024 · 0 comments
Assignees
Labels
type: documentation A documentation task
Milestone

Comments

@sbrannen
Copy link
Member

In various places in the reference manual, whenever we need a "section" that is not physically part of the table of contents, we currently use titled blocks in an attempt to create a pseudo-section with a title and an anchor for cross referencing that section.

For example:

.[[beans-java-combining-xml-centric-declare-as-bean]]Declaring `@Configuration` classes as plain Spring `<bean/>` elements
--
<content here>
--

Unfortunately, the title gets rendered in italics and directly underneath the preceding content as follows:

Screenshot 2024-08-29 at 14 55 15

Whereas, we actually intend for that to be rendered like this:

Screenshot 2024-08-29 at 14 57 17

To achieve the desired type setting, we should instead use Asciidoc's support for discrete headings, which allow the headings to be styled like section titles but without affecting the section hierarchy or table of contents.

@sbrannen sbrannen self-assigned this Aug 29, 2024
@sbrannen sbrannen added the type: documentation A documentation task label Aug 29, 2024
@sbrannen sbrannen added this to the 6.1.13 milestone Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: documentation A documentation task
Projects
None yet
Development

No branches or pull requests

1 participant