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

fix: ignore quote in summary reference ids #308

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

rdlopes
Copy link
Contributor

@rdlopes rdlopes commented Apr 1, 2024

Hi all,
I was generating documentation in French language and quotes appear quite often in titles.

Problem is that quotes don't play well with asciidoctor unique ids.

I remember having applied such a fix to feature ids, but never did on summary references.

So, to avoid the problem, I've applied the same rule of thumb:

  • ids don't contain special characters
  • asciidoc links from references or cross links should be labeled

For instance:

  • Feature One failing scenario becomes link <<One-failing-scenario,One failing scenario>>
  • Feature Accéder à l'application becomes link <<Accéder-à-l-application,Accéder à l'application>>

Here's the fix that reflects on this issue.

PS: my IntelliJ keeps complaining that there are empty quotes, resulting in performance loss. So I also removed them from where I changed code.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant