Improve section readability

This commit is contained in:
Gerard Vermeulen 2022-10-20 07:07:28 +02:00
parent 17f2dc78c8
commit 595953f9eb
1 changed files with 14 additions and 13 deletions

View File

@ -2339,21 +2339,22 @@ listings below make* [[https://github.com/tecosaur/engrave-faces#readme][Engrave
without a caption" LaTeX environments.
2. Listing [[lst:ensure-engrave-faces-with-latex-face-apply-fix]] makes
=engrave-faces-latex-face-apply= handle symbolic color name strings (in
addition to the hexadecimal strings). Since for instance the faces in
src_emacs-lisp{(find-library "org-faces")} have symbolic color names, this
fix allows to engrave org-mode source blocks during LaTeX export without any
further tweaking.
addition to the hexadecimal strings). Since faces in for instance
src_emacs-lisp{(find-library "org-faces")} and src_emacs-lisp{(find-library
"faces")} have symbolic color names (beware: Emacs themes may replace the
symbolic color names with hexadecimal strings), this fix allows to engrave
org-mode source blocks during LaTeX export without any further tweaking.
3. Listing [[lst:ensure-engrave-faces-with-latex-face-mapper-fix]] makes
=engrave-faces-latex-face-mapper= handle horizontal and vertical whitespace
=engrave-faces-latex-face-mapper= handle horizontal and vertical spacing
in multiple line documentation strings correctly. For instance, *without this
fix* the empty line in the documentation string of
=org-latex-engraved-sourc-block-filter= of listing
[[lst:org-latex-engraved-source-block-filter]] is invisible in the exported =pdf=
file and *very obviously* the mishandling of the spacing destroys the
indentation in Python documentation strings. The idea of the fix is to let
the LaTeX face mapper wrap only groups of "words joined by blank characters"
in LaTeX commands and pass "newlines and other whitespace between those
groups" on without wrapping.
fix* the mishandling of vertical and horizontal spacing destroys the
indentation in Python documentation strings. An Emacs lisp example of the
bug is the disappearance of the empty line in the documentation string of
=org-latex-engraved-source-block-filter= of listing
[[lst:org-latex-engraved-source-block-filter]] in exported =pdf= files. The idea
of the fix is to let the LaTeX face mapper wrap only groups of "words joined
by blank characters" in LaTeX commands and pass "newlines and other
whitespace between those groups" on without wrapping.
4. Listing [[lst:ox-engraved-emacs-lisp-setup]] shows how to use this configuration.
#+caption[Engrave to floating unbreakable or non-floating breakable environments]: