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.

Sign up for GitHub

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/LaTeX: Escape characters in admonition titles #1299

Merged
merged 3 commits into from
Apr 20, 2020
Merged

PDF/LaTeX: Escape characters in admonition titles #1299

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d679162
PDF/LaTeX: Escape characters in admonition titles
mortenpi Apr 19, 2020
76c9219
Add CHANGELOG
mortenpi Apr 19, 2020
42eab2f
Merge branch 'master' into mp/pdf-admonition-escape
mortenpi Apr 19, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@

* ![Enhancement][badge-enhancement] The `curl` timeout when checking remote links is now configurable with the `linkcheck_timeout` keyword. ([#1057][github-1057], [#1295][github-1295])

* ![Bugfix][badge-bugfix] Special characters are now properly escaped in admonition titles in LaTeX/PDF builds and do not cause the PDF build to fail anymore. ([#1299][github-1299])

## Version `v0.24.9`

* ![Bugfix][badge-bugfix] Canonical URLs are now properly prettified (e.g. `/path/` instead of `/path/index.html`) when using `prettyurls=true`. ([#1293][github-1293])
Expand Down Expand Up @@ -557,6 +559,7 @@
[github-1292]: https://github.com/JuliaDocs/Documenter.jl/pull/1292
[github-1293]: https://github.com/JuliaDocs/Documenter.jl/pull/1293
[github-1295]: https://github.com/JuliaDocs/Documenter.jl/pull/1295
[github-1299]: https://github.com/JuliaDocs/Documenter.jl/pull/1299

[documenterlatex]: https://github.com/JuliaDocs/DocumenterLaTeX.jl
[documentermarkdown]: https://github.com/JuliaDocs/DocumenterMarkdown.jl
Expand Down
3 changes: 1 addition & 2 deletions src/Writers/LaTeXWriter.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -506,7 +506,7 @@ end
function latex(io::IO, md::Markdown.Admonition)
wrapblock(io, "quote") do
wrapinline(io, "textbf") do
_print(io, md.title)
latexinline(io, md.title)
end
_println(io, "\n")
latex(io, md.content)
Expand Down Expand Up @@ -681,7 +681,6 @@ const _latexescape_chars = Dict{Char, AbstractString}(
'\\' => "{\\textbackslash}",
'\'' => "{\\textquotesingle}",
'"' => "{\\textquotedbl}",
'_' => "{\\_}",
Copy link
Member Author

Choose a reason for hiding this comment

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

Technically unrelated, but this duplicates the loop below.

)
for ch in "&%\$#_{}"
_latexescape_chars[ch] = "\\$ch"
Expand Down
8 changes: 8 additions & 0 deletions test/examples/src.latex_simple/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,3 +14,11 @@ julia> 127 % Int8
1 ⊻ 2
1 | 2
```

## Escaping: ~, ^, \, ', ", _, &, %, \, $, #, { and }.

~, ^, \, ', ", _, &, %, \, $, #, { and }.

!!! info "~, ^, \, ', ", _, &, %, \, $, #, { and }."

~, ^, \, ', ", _, &, %, \, $, #, { and }.