Try to improve overall manual page typesetting #2728
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 11 commits
July 16, 2024 14:11
Make occurences of "mu", small commands such as "mu init", and command-line arguments bold.
Try to stick to the man-pages(7) standard.
Make the emphasis more consistent, and do it using underscores in Org documents, since verbatim is rendered as underlined anyway.
Use underlining only, do not use <>, as it is the most often done.
|
Thank you, nice work! I'm merging this, thanks about the note re: zero-width-space, I'll keep that in mind! |
|
Nice, thank you ! Apart from synopses, the only zero-width space is in the |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I tried to make the typesetting of the numerous manual pages more consistent and
more compliant to the standards described in man-pages(7). There are quite a lot
of changes I think, hence I tried to scatter them in different commits to make
it easier to figure out what is going on and to allow picking only certain
changes, in case some of them are not wanted.
There is one major thing to notice. In order to get the proper output for
manual pages references, and synopses, I used zero width spaces which I
learned about here.
This is admittedly a little hacky, there might be a better way to get the same
outputs. It renders fine in standard manual pages, but if you plan to export the
Org sources to other formats, I do not know what it may look like.