TEXT   49

Attributes Tables

Guest on 13th May 2022 01:57:40 AM

  1. ~~~~~~~~~~~~~~~~~
  2. Attributes Tables
  3. ~~~~~~~~~~~~~~~~~
  4.  
  5. .. include:: prologue.rst
  6.  
  7. Description
  8. ===========
  9.  
  10. Files with names of the form ``*.atb`` are attributes tables, and with names of
  11. the form ``*.ati`` are attributes subtables. They are used when BRLTTY is
  12. displaying screen attributes rather than screen content. Each of the eight
  13. braille dots represents one of the eight VGA attribute bits.
  14.  
  15. Attributes tables can usually be found in the ``/etc/brltty/Attributes/``
  16. directory (see |README.Customize| for more details). See
  17. `Attributes Table List`_ for a list of BRLTTY's attributes tables.
  18.  
  19. An attributes table consists of a sequence of directives, one per line, which
  20. define how combinations of VGA attributes are to be represented in braille.
  21. UTF-8 character encoding must be used. Whitespace (blanks, tabs) at the
  22. beginning of a line, as well as before and/or after any operand of any
  23. directive, is ignored. Lines containing only whitespace are ignored. If the
  24. first non-whitespace character of a line is ``#`` then that line is a comment
  25. and is ignored.
  26.  
  27. Directives
  28. ==========
  29.  
  30. The Dot Directive
  31. -----------------
  32.  
  33. .. parsed-literal:: dot *dot* *state* # *comment*
  34.  
  35. Use this directive to specify what a specific dot represents. The default is
  36. that all dots are down and not used to represent anything.
  37.  
  38. *dot*
  39.    The dot being defined. It is a single digit within the range ``1``-``8`` as
  40.    defined by the standard braille dot numbering convention (see
  41.    |README.BrailleDots| for details).
  42.  
  43. *state*
  44.    What the dot being defined represents. It may be:
  45.  
  46.    =attribute
  47.       The dot is raised if the named attribute is on.
  48.  
  49.    ~attribute
  50.       The dot is raised if the named attribute is off.
  51.  
  52. The attributes are:
  53.  
  54. =========  ===  ========
  55. Name       Hex  binary
  56. ---------  ---  --------
  57. fg-blue    01   00000001
  58. fg-green   02   00000010
  59. fg-red     04   00000100
  60. fg-bright  08   00001000
  61. bg-blue    10   00010000
  62. bg-green   20   00100000
  63. bg-red     40   01000000
  64. blink      80   10000000
  65. =========  ===  ========
  66.  
  67. Examples::
  68.  
  69.    dot 1 =fg-red
  70.    dot 2 ~bg-blue
  71.  
  72. .. include:: nesting-directives.rst
  73.  
  74. Attributes Table List
  75. =====================
  76.  
  77. .. csv-table::
  78.    :header-rows: 1
  79.    :file: attributes-table.csv

Raw Paste


Login or Register to edit or fork this paste. It's free.