==============
Keyboard spoke
==============

.. _layout-name-mapping:

Keyboard layout name mapping
============================
The keyboard layout names used by Anabot to manipulate with layouts listed in the
Keyboard spoke may not always be easy to figure out as they are taken from X11
configuration.

To find a low-level keyboard layout name, have a look under ``! layout`` and ``! variant``
sections of ``/usr/share/X11/xkb/rules/base.lst`` file in the installer environment.
For instance, a record under ``! layout`` section consisting of ``cz    Czech``
appears as ``Czech`` in the layout list and is mapped to ``cz`` value of
``name`` attribute of an element handling keyboard layout.

In a similar way, a record ``dvorak    fr: French (Dvorak)`` under ``! variant``
section is listed as ``French (Dvorak)`` in the layout list in Anaconda,
and is mapped to ``fr (dvorak)`` value of the ``name`` attribute.

/installation/hub/keyboard/add_layout
=====================================
Handles *add* (*+*) button and resulting dialog.

Attributes:

* ``name`` - name of the layout, e. g. ``cz`` or ``de (deadgraveacute)`` (see
  section about layout name :ref:`mapping <layout-name-mapping>`)
* ``dialog`` - action to handle the dialog - ``accept`` (default) or ``reject``

/installation/hub/keyboard/layout
=================================
Selects a layout from layouts list.

Attributes:

* ``name`` - name of the layout, e. g. ``de (nodeadkeys)``. A *glob* expression may be used.
  Also see section about layout name :ref:`mapping <layout-name-mapping>`.

/installation/hub/keyboard/layout/move_down
===========================================
Moves the selected layout one position down in the list using the *down* button.

/installation/hub/keyboard/layout/move_up
=========================================
Moves the selected layout one position up in the list using the *up* button.

/installation/hub/keyboard/layout/options
=========================================
Handles *Options* button and the resulting *Layout Switching Options* dialog.

Attributes:

* ``dialog`` - action to handle the dialog - ``accept`` (default) or ``reject``

/installation/hub/keyboard/layout/options/shortcut
==================================================
Handles (de)activation of a layout switching shortcut in *Layout Switching Options* dialog.

Attributes:

* ``name`` - shortcut name (as in the list)
* ``action`` - ``enable`` or ``disable``

/installation/hub/keyboard/layout/position
==========================================
Handles layout position in the list. **Not implemented at this point.**

/installation/hub/keyboard/layout/remove
========================================
Removes the selected layout from the list using *remove* (*-*) button.

/installation/hub/keyboard/layout/show
======================================
Displays keyboard layout in graphical form using the appropriate button.
**There is no check to test whether the displayed layout is correct at this point.**

/installation/hub/keyboard/layout/test
======================================
Handles keyboard layout test in the *Test the layout configuration below:* field.
**Not implemented at this point.**

/installation/hub/keyboard/move_down
====================================
Equivalent to `/installation/hub/keyboard/layout/move_down`_

/installation/hub/keyboard/move_up
==================================
Equivalent to `/installation/hub/keyboard/layout/move_up`_

/installation/hub/keyboard/options
==================================
Equivalent to `/installation/hub/keyboard/layout/options`_

/installation/hub/keyboard/options/shortcut
===========================================
Equivalent to `/installation/hub/keyboard/layout/options/shortcut`_

/installation/hub/keyboard/remove
=================================
Equivalent to `/installation/hub/keyboard/layout/remove`_

/installation/hub/keyboard/replace_layouts
==========================================
A shortcut to remove all existing layouts and add a new one.

Attributes:

* ``name`` - name of the replacement layout, e. g. ``cz`` or ``de (deadgraveacute)``
  (see section about layout name :ref:`mapping <layout-name-mapping>`)

/installation/hub/keyboard/show
===============================
Equivalent to `/installation/hub/keyboard/layout/show`_

/installation/hub/keyboard/test
===============================
Equivalent to `/installation/hub/keyboard/layout/test`_