Skip to content

Conversation

@dreis2211
Copy link
Contributor

Hi,

while working on #18371 I noticed that there are some issues with the handling of | inside tables in the reference docs. Here's a list of issues that I found, but there might be more:

  • The default value of server.tomcat.internal-proxies shows {vbar} in both HTML and PDF reference instead of |
  • The description of server.tomcat.relaxed-path-chars breaks the table formatting completely in the PDF version
  • The description of server.tomcat.relaxed-query-chars breaks the table yet another time ;-)

It seems that neither of the escaping strategies work for both HTML and PDF. Luckily, the docs under https://asciidoctor.org/docs/user-manual/#escaping-the-cell-separator provide a third option.

The cell separator is controlled using the separator attribute on the table block. You’ll want to select a character that will never be used for content. A good candidate is the broken bar, or ¦

Applying this seems to fix the issues mentioned above.

Let me know what you think.
Cheers,
Christoph

@spring-projects-issues spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Sep 27, 2019
@snicoll
Copy link
Member

snicoll commented Sep 27, 2019

breaks the table formatting completely in the PDF version

@dreis2211 just to make sure I understand this one. I've generated a PDF from master (with your latest fix to include the appendices) and I don't see an obvious problem for the two keys you've mentioned. I can see the {vbar} though.

What have I missed?

@dreis2211
Copy link
Contributor Author

Interesting. Now I can't reproduce this either anymore. I should have taken a screenshot. Maybe an error on my side by not (re-)compiling spring-boot-configuration-docs properly beforehand. Sorry for the confusion.

"At least" the {vbar} problem remains. But this gets me thinking if a simple escaping with \| might work after all. Give me a minute to try this.

@dreis2211
Copy link
Contributor Author

@snicoll The simpler escaping with \| seems to work indeed. Could you give it another try whenever you have a spare minute, please?

@dreis2211 dreis2211 changed the title Avoid need to escape pipe character in reference tables Fix escaping of pipe character in reference tables Sep 27, 2019
@dreis2211
Copy link
Contributor Author

dreis2211 commented Sep 27, 2019

Test failure seems related to changes in spring-projects/spring-kafka@e90d9e6

@philwebb philwebb added type: task A general task and removed status: waiting-for-triage An issue we've not yet triaged labels Sep 27, 2019
@philwebb philwebb added this to the 2.2.x milestone Sep 27, 2019
philwebb pushed a commit that referenced this pull request Sep 28, 2019
Replace `{vbar}` with an escaped pipe character. Unfortunately
`{vbar}` does not render correctly with PDF generation.

See gh-18374
@philwebb philwebb closed this in 74f988a Sep 28, 2019
@philwebb philwebb modified the milestones: 2.2.x, 2.2.0.RC1 Sep 28, 2019
philwebb pushed a commit that referenced this pull request Sep 29, 2019
Replace `{vbar}` with an escaped pipe character. Unfortunately
`{vbar}` does not render correctly with PDF generation.

See gh-18374
philwebb added a commit that referenced this pull request Sep 29, 2019
* pr/18374:
  Simplify pipe escaping for reference doc tables
  Avoid need to escape pipe character in reference tables

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

Labels

type: task A general task

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants