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 documentation of compbrl and comp6 #1736

Open
bertfrees opened this issue Feb 27, 2025 · 0 comments
Open

Fix documentation of compbrl and comp6 #1736

bertfrees opened this issue Feb 27, 2025 · 0 comments
Labels
documentation Change in the user manual or wiki good first issue Good issue for first-time contributors

Comments

@bertfrees
Copy link
Member

From the current documentation it seems like there are two computer braille modes, one for 6-dot and one for 8-dot, but that is not the case. There is only one computer braille mode.

compbrl characters

If the characters are found within a block of text surrounded by whitespace the entire block is translated according to the default braille representations defined by the Character-Definition Opcodes, if 8-dot computer braille is enabled or according to the dot patterns given in the comp6 opcode (see comp6), if 6-dot computer braille is enabled. For example:

compbrl www translate URLs in computer braille

comp6 character dots

This opcode specifies the translation of characters in 6-dot computer braille. The first operand must be a single character. The second operand may specify as many cells as necessary. The opcode is somewhat of a misnomer, since any dots, not just dots 1 through 6, can be specified. This even includes virtual dots (see virtual dots).

@bertfrees bertfrees added documentation Change in the user manual or wiki good first issue Good issue for first-time contributors labels Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Change in the user manual or wiki good first issue Good issue for first-time contributors
Projects
None yet
Development

No branches or pull requests

1 participant