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

PDF Documentation Spring-Core 5.1.5: Occurrences of a STRONG tag, where we should see a bold font #22577

Closed
molzb opened this issue Mar 12, 2019 · 4 comments
Assignees
Labels
type: documentation A documentation task
Milestone

Comments

@molzb
Copy link

molzb commented Mar 12, 2019

Documentation Spring-Core 5.1.5 as PDF
https://docs.spring.io/spring/docs/current/spring-framework-reference/pdf/core.pdf

There are code samples with a (written) <strong> tag, where we should see the code section with a bold font.

Examples:
Page 50: <strong>@RequestScope</strong>
Page 62: <strong>@SessionScope</strong>
and 29 more occurrences. Please use Ctrl+F.

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged or decided on label Mar 12, 2019
@jhoeller
Copy link
Contributor

@bclozel Could you have a look at this please? I suppose those tags were in actual effect at some point but got turned to literal text through some general formatting changes...

@sbrannen
Copy link
Member

sbrannen commented Mar 13, 2019

The root cause is the presence of asterisks within code blocks that were carried over from the Docbook days, and the PDF generator simply doesn't support that.

For example, the following:

		<bean class="example.SimpleMovieCatalog" **primary="true"**>
			<!-- inject any dependencies required by this bean -->
		</bean>

Gets converted to:

		<bean class="example.SimpleMovieCatalog" <strong>primary="true"</strong>>
			<!-- inject any dependencies required by this bean -->
		</bean>

So one solution (perhaps the only solution) is to simply remove all bold formatting (i.e., **xyz**) from all source code blocks throughout the Asciidoc files.

@sbrannen sbrannen added type: documentation A documentation task and removed status: waiting-for-triage An issue we've not yet triaged or decided on labels Mar 13, 2019
@sbrannen sbrannen added this to the 5.2 M1 milestone Mar 13, 2019
@sbrannen
Copy link
Member

@bclozel Could you have a look at this please?

@bclozel, I'd be happy to take it over unless you want to. Just let me know...

@sbrannen sbrannen modified the milestones: 5.2 M1, 5.1.6 Mar 13, 2019
@jhoeller
Copy link
Contributor

@sbrannen, volunteering is always appreciated, so it's yours now :-)

I was just asking Brian since he did some recent doc formatting stuff for 5.2.

@jhoeller jhoeller assigned sbrannen and unassigned bclozel Mar 13, 2019
sbrannen added a commit that referenced this issue Mar 13, 2019
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

5 participants