Improve markup in unicharset_extractor.1.asc#4501
Open
mariobl wants to merge 1 commit intotesseract-ocr:mainfrom
Open
Improve markup in unicharset_extractor.1.asc#4501mariobl wants to merge 1 commit intotesseract-ocr:mainfrom
mariobl wants to merge 1 commit intotesseract-ocr:mainfrom
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Hello,
I've tried to improve the markup in unicharset_extractor.1.asc. Some explanations:
The man page man-pages.7 ("Fomatting conventions") describes how we should treat command names, literal options and file names. I've applied that to write command names and options in bold, file names italic.
The current links in the SEE ALSO sections are unformatted, but should be bold. Especially online man page collections (like [1]) need this formatting to generate clickable links to that man pages (by the way, this applies also to external commands found in "description" paragraphs etc.).
Currently I've written the following file header:
:man source: tesseractThis is still incomplete. For an example what it should be, see [2]. With the macro {release-version} we would be able to write an unique version number into the header of the rendered man page. Don't know how to expand the macro; maybe refer to the util-linux code…?
If you agree with the changes, I will continue on review the formatting of the other man pages.
[1] https://man.archlinux.org/man/unicharset_extractor.1#SEE_ALSO
[2] https://github.com/util-linux/util-linux/blob/master/text-utils/col.1.adoc?plain=1#L44