From dcfe1327cd1ba3e84fc6dc22a29fc6aa35dae52d Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Sl=C3=A1vek=20Banko?= Date: Wed, 20 Oct 2021 16:28:07 +0200 Subject: [PATCH] Change README to markdown format. Add translation status overview. MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Slávek Banko --- README => README.md | 58 +++++++++++++++++++++++++++++++++------------ 1 file changed, 43 insertions(+), 15 deletions(-) rename README => README.md (70%) diff --git a/README b/README.md similarity index 70% rename from README rename to README.md index 530f491..7b065a6 100644 --- a/README +++ b/README.md @@ -1,7 +1,6 @@ KKBSwitch - a keyboard layout indicator for TDE. - KKBSwitch displays an icon in the system tray that indicates which layout is currently active and enables you to switch layouts by clicking the icon or by selecting from the menu. @@ -16,6 +15,8 @@ group. Features include: +----------------- + - displays an icon in the system tray indicating the active keyboard group. - Configurable icons for the keyboard layouts (chosen from country flag @@ -31,26 +32,27 @@ NB: You still have to configure XKeyboard with the usual xorg options (XkbModel, XkbLayout, XkbVariant and XkbOptions). -Using KKBSwicth. +Using KKBSwitch +----------------- The most basic usage is simply to let it sit in the system tray and show you which keyboard group is currently active. You can also click the -KKBSwicth system tray icon to switch keyboard layouts. +KKBSwitch system tray icon to switch keyboard layouts. When right-clicked, the system tray icon displays a menu with the following entries: - one or more entries corresponding to the configured keyboard groups -(XKeyboard can have up to 4 groups configured). The currently active -group will be checked. - -Selecting a menu entry corresponding to a group will make that group -active. + (XKeyboard can have up to 4 groups configured). The currently active + group will be checked. + Selecting a menu entry corresponding to a group will make that group + active. - "Configure Keyboard Switch..." entry lets you configure KKBSwitch - "About Keyboard Switch" displays a standard "About" dialog - "Quit" quits KKBSwitch. -Configuring KKBSwicth. +Configuring KKBSwitch +----------------------- In the KKBSwitch configuration dialog you can do the following: - set the icons corresponding to the available keyboard groups. Note @@ -79,17 +81,43 @@ with an asterisk in the KKBSwitch tray icon's menu. DCOP Bindings +--------------- As of version 0.2, KKBSwitch can be manipulated programmatically with DCOP. It exports an interface named KBSwitchIntf. The interfaces offers the following methods: - int getNumKbdGroups() returns the number of configured keyboard -groups (layouts) + groups (layouts) - ASYNC selectNextGroup() does the same thing as clicking on the -KKBSwitch's tray icon, i.e. makes the next keyboard group active. -If in "toggle mode", toggles between the two recently used ones, just -like clicking on the tray icon does. + KKBSwitch's tray icon, i.e. makes the next keyboard group active. + If in "toggle mode", toggles between the two recently used ones, just + like clicking on the tray icon does. - ASYNC selectGroup(int groupno) makes the group whose number is -groupno active (like selecting a group from the tray icon popup menu) + groupno active (like selecting a group from the tray icon popup menu) - TQStringList getGroupNames() returns the list of the keyboard group -names as configured in XKeyboard. + names as configured in XKeyboard. + +. + +Contributing +-------------- + +If you wish to contribute to kkbswitch, you might do so: + +- TDE Gitea Workspace (TGW) collaboration tool. + https://mirror.git.trinitydesktop.org/gitea + +- TDE Weblate Translation Workspace (TWTW) collaboration tool. + https://mirror.git.trinitydesktop.org/weblate + + +Translations status +--------------------- + +### messages +[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kkbswitch/multi-auto.svg +"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kkbswitch/) + +### desktop files +[![Translations status](https://mirror.git.trinitydesktop.org/weblate/widgets/applications/-/kkbswitch-kkbswitchdesktop/multi-auto.svg +"Engage in translating")](https://mirror.git.trinitydesktop.org/weblate/projects/applications/kkbswitch-kkbswitchdesktop/)