Skip to content

Increase number of TOC levels in generated PDF documentation #29781

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

Closed
wants to merge 1 commit into from

Conversation

vikeychen
Copy link
Contributor

This was introduced by 4b22a4a.

This is single pdf file now.
image

This is splitted file before.
image

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Jan 7, 2023
@rstoyanchev rstoyanchev requested a review from bclozel January 24, 2023 12:11
@rstoyanchev rstoyanchev added the type: task A general task label Jan 24, 2023
@sbrannen sbrannen self-assigned this Jan 24, 2023
@sbrannen sbrannen added type: documentation A documentation task and removed type: task A general task labels Jan 24, 2023
@sbrannen sbrannen marked this pull request as draft January 24, 2023 14:22
@sbrannen sbrannen removed the status: waiting-for-triage An issue we've not yet triaged or decided on label Jan 24, 2023
@sbrannen sbrannen changed the title Fix inner toc missing in generated pdf documentation Increase number of TOC levels in generated PDF documentation Jan 24, 2023
@sbrannen sbrannen removed the request for review from bclozel January 24, 2023 14:23
Copy link
Member

@sbrannen sbrannen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for submitting the PR.

As I explained in my comments, to achieve the goal of increasing the number of TOC levels in the PDF we would prefer to modify the spring-framework.adocbook directly.

In light of that, I have updated the title of this PR and will make the necessary changes.

@@ -1,4 +1,4 @@
:toc: left
:toclevels: 4
:toclevels: 5
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We explicitly selected 4 TOC levels and do not wish to change that to 5.

@@ -1,6 +1,7 @@
:noheader:
:toc:
include::attributes.adoc[]
include::page-layout.adoc[]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

page-layout.adoc is specific to the HTML5 backend and as such should not be applied for the generated PDF.

For the PDF, we explicitly apply document configuration local to the spring-framework.adocbook file -- as can be seen by the existing :noheader: and :toc: entries.

@sbrannen sbrannen added this to the 6.0.5 milestone Jan 24, 2023
@sbrannen sbrannen closed this in da088e5 Jan 24, 2023
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

Successfully merging this pull request may close these issues.

None yet

4 participants