HowTo: Shorten the delay until accented characters appear

By default, the accented characters appear after a tap-and-hold time of 800 ms. This is set in file /usr/share/maliit/plugins/com/jolla/Popper.qml. You may shorten this time. Original code sequence:

    Timer {
        id: popperExpandTimer
        interval: 800
        onTriggered: {
            if (popper.accents.length > 1) {
                keyboard.inputHandler._handleKeyRelease()
                popper.expanded = true
            }
        }
    }

Adapt the 800 to anything what suits you. I reduced it to 100 ms, i.e. almost immediately.

Note: This edit may get lost with a Sailfish OS update (depending on whether Popper.qml is replaced thereby).

HowTo: Add cursor (arrow) keys to your keyboard

You may add cursor keys wherever you want to within your layout. A natural position may be the lowest key line. Cursor keys are function key, i.e. are not shifted and "symboled", you cannot have any additional letter/function on the same place. However, you may reduce the width of keys to add the cursor keys without loosing other keys.

There are several solutions around that change existing files. The following solution reduces these changes to a single file only (if anyone knows how to eliminate this change as well: please amend). For other languages you may want to adapt the layout of the lowest key line to your countries preferences.

There are 2 changes to the original keyboard layout files (e.g. /usr/share/maliit/plugins/com/jolla/layouts/de.qml):

• Some more inclusions at the begin
• A replacement for the call of file ../SpacebarRow.qml

Add inclusions to the original keyboard layout file

At the begin, the Sailfish layout file reads something like

// Copyright (C) 2013 Jolla Ltd.
// Contact: Pekka Vuorela <pekka.vuorela@jollamobile.com>

import QtQuick 2.0
import ".."

Extend this by some more inclusion statements to read:

// Copyright (C) 2013 Jolla Ltd.
// Contact: Pekka Vuorela <pekka.vuorela@jollamobile.com>

import QtQuick 2.0
import com.jolla.keyboard 1.0
import Sailfish.Silica 1.0
import com.meego.maliitquick 1.0
import ".."

In the original keybaord layout file replace the call of file ../SpacebarRow.qml
Towards their end, the original Sailfish keyboard layout files contain the line

SpacebarRow {}

Replace this line with the following code:

KeyboardRow {

    // Symbol Key with shortened length
    FunctionKey {
        id: symbolKey
        property int _charactersWhenPressed
        property bool _quickPicking
        caption: attributes.inSymView ? "ABC" : "?123"
        width: functionKeyWidth-20
        keyType: KeyType.SymbolKey
        onPressedChanged: {
        if (pressed && !keyboard.inSymView && keyboard.lastInitialKey === symbolKey) {
            keyboard.deadKeyAccent = ""
            keyboard.toggleSymbolMode()
            _quickPicking = true
        } else {
            _quickPicking = false
        }
        _charactersWhenPressed = keyboard.characterKeyCounter
        }
        onClicked: {
        if (!_quickPicking || keyboard.characterKeyCounter > _charactersWhenPressed) {
            keyboard.toggleSymbolMode()
        }
        }
        Rectangle {
        color: parent.pressed ? Theme.highlightBackgroundColor : Theme.primaryColor
        opacity: parent.pressed ? 0.6 : 0.17
        radius: geometry.keyRadius
        anchors.fill: parent
        anchors.margins: Theme.paddingMedium
        }
    }

    // ContextAwareCommaKey {}
    CharacterKey {
        caption: MInputMethodQuick.contentType === Maliit.UrlContentType
             ? "/"
             : MInputMethodQuick.contentType === Maliit.EmailContentType
               ? "@"
               : ","
        captionShifted: caption
        symView: ","
        symView2: ","
        width: punctuationKeyWidth-10
        fixedWidth: true
        separator: false
    }

    // Left arrow key
    FunctionKey {
        icon.source: "image://theme/icon-l-left" + (pressed ? ("?" + Theme.highlightColor) : "")
        repeat: true
        key: Qt.Key_Left
        //width: punctuationKeyWidth
        width: 42
    }

    SpacebarKey {
        fixedWidth: true
    }

    // Right arrow key 
    FunctionKey {
        icon.source: "image://theme/icon-l-right" + (pressed ? ("?" + Theme.highlightColor) : "")
        repeat: true
        key: Qt.Key_Right
        width: 42
    }

             // Comma/semicolon key
    CharacterKey {
        caption: "."
        captionShifted: ";"
        width: punctuationKeyWidth-10
        fixedWidth: true
        separator: false
    }

    // Enter key with shortened length
    FunctionKey {
        property bool chineseOverride: keyboard.chineseOverrideForEnter
        icon.source: !chineseOverride ? MInputMethodQuick.actionKeyOverride.icon : ""
        caption: !chineseOverride ? MInputMethodQuick.actionKeyOverride.label : "输入" // = "enter"
        key: Qt.Key_Return
        enabled: !chineseOverride ? MInputMethodQuick.actionKeyOverride.enabled : true
        width: functionKeyWidth-30
        Rectangle {
        color: parent.pressed ? Theme.highlightBackgroundColor : Theme.primaryColor
        opacity: parent.pressed ? 0.6
                    : MInputMethodQuick.actionKeyOverride.highlighted ? 0.4 : 0.17
        radius: geometry.keyRadius
        anchors.fill: parent
        anchors.margins: Theme.paddingMedium
        }
    }
    }

Use the original layout file and make a copy of this (e.g. dex.qml), also create the conf file (e.g. dex.conf) as shown in the main answer) and copy the file to directory `/usr/share/maliit/plugins/com/jolla/layout/`.

Amendments to ../InputHandler.qml
In file `/usr/share/maliit/plugins/com/jolla/InputHandler.qml` (the one existing, original Sailfish file that needs an amendment in the original file) replace the code section:

            MInputMethodQuick.sendKey(Qt.Key_Backspace, 0, "\b", Maliit.KeyClick)
        } else if (pressedKey.key === Qt.Key_Paste) {
            MInputMethodQuick.sendCommit(Silica.Clipboard.text)
        } else  {
            resetShift = false
        }

by

            // Code amended, to provide for arrow/cursor keys left/right/up/down:
        MInputMethodQuick.sendKey(Qt.Key_Backspace, 0, "\b", Maliit.KeyClick)
        } else if (pressedKey.key === Qt.Key_Up) {
            MInputMethodQuick.sendKey(Qt.Key_Up, 0, "", Maliit.KeyClick)
        } else if (pressedKey.key === Qt.Key_Down) {
            MInputMethodQuick.sendKey(Qt.Key_Down, 0, "", Maliit.KeyClick)
        } else if (pressedKey.key === Qt.Key_Left) {
            MInputMethodQuick.sendKey(Qt.Key_Left, 0, "", Maliit.KeyClick)
        } else if (pressedKey.key === Qt.Key_Right) {
            MInputMethodQuick.sendKey(Qt.Key_Right, 0, "", Maliit.KeyClick)
        } else if (pressedKey.key === Qt.Key_Paste) {
            MInputMethodQuick.sendCommit(Silica.Clipboard.text)
        } else  {
            resetShift = false
        }

This code above caters for up/down arrow keys as well, although these are not included in the keyboard layout file as above.
Overwrite the original InputHandler.qml file with the edited file.

Notes

• Test the result.
• It does not work in Android apps.
• The functionality of the cursor keys may get lost with a Sailfish OS update (depending on whether InputHandler.qml is replaced thereby; the keys themselves remain visible, because they are defined in the keyboard layout file).

Sources/copyrights

• Above code partly provided by @CsTom.
• Above code partly copyrighted as:

/*
 * Copyright (C) 2013 Jolla ltd. and/or its subsidiary(-ies). All rights reserved.
 *
 * Contact: Pekka Vuorela <pekka.vuorela@jollamobile.com>
 *
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this list
 * of conditions and the following disclaimer.
 * Redistributions in binary form must reproduce the above copyright notice, this list
 * of conditions and the following disclaimer in the documentation and/or other materials
 * provided with the distribution.
 * Neither the name of Jolla ltd nor the names of its contributors may be
 * used to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
 * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
 * THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

HowTo: Remove unwanted keyboard layouts from the long-tap space selection

If you think, the list of keyboard layouts presented when you tap-and-hold the space key is too long, remove individual entries from the list. The entries are generated from all .conf files in directory /usr/share/maliit/plugins/com/jolla/layouts/, i.e. all files conforming to /usr/share/maliit/plugins/com/jolla/layouts/*.conf. Ex factory, there is the file

/usr/share/maliit/plugins/com/jolla/layouts/layouts.conf

containing the list of all layouts ex factory. In addition there are the .conf files you created yourself (or inherited from any installation you have done).

Procedure to limit the number of keyboard layouts listed:

1. Make sure, you have developer mode activated on your Jolla handset.
   See section 2.1 "Developer mode" of the question above.
2. On your PC, create .conf files for the languages you would like to be listed.
   The necessary entries you can retrieve from file /usr/share/maliit/plugins/com/jolla/layouts/layouts.conf (to get that file onto your PC, see section 2.2 "Getting the layout template" of the question above).
   For more information on the contents of .conf files see section 2.4 "Creating a config file" in the question above.
3. Copy the .conf files into directory /usr/share/maliit/plugins/com/jolla/layouts/ of the Jolla handset.
   See section 2.5 "Copying the layout and config file back onto the Jolla handset" of the question above.
4. Go to layouts directory: cd /usr/share/maliit/plugins/com/jolla/layouts/ and [Enter].
5. Rename file layouts.conf to e.g. layouts.conf.tmp: mv layouts.conf layouts.conf.tmp and [Enter].
   This will exclude all entries in that file from being listed.
6. Reset the keyboard service: killall maliit-server and [Enter].
7. Exit root access: exit and [Enter].

This procedure has been derived from the answers to https://together.jolla.com/question/1204/limit-the-number-of-keyboards-to-be-selected-from-space-bar/. However, because you do not edit the layouts.conf. file but simply rename it, you loose less of your changes during a system update that reinstalls the layouts.conf file.

Procedure when after a system update, all keyboard entries reappear:

1. Carry out steps 1, 3 (up to having root access to the Jolla handset) and 4 of the procedure above.
2. Delete the current file layouts.conf.tmp: rm layouts.conf.tmp, [Enter] and confirm with [y].
3. Rename the new file layouts.conf to e.g. layouts.conf.tmp: mv layouts.conf layouts.conf.tmp and [Enter].
   This will exclude all entries in that file from being listed.
4. Reset the keyboard service: Enter killall maliit-server and [Enter].
5. Exit root access: exit and [Enter].

HowTo: vkb layout file available from internet

When you find a template and config file in the Internet, you can shorten the procedure as given above:

1. Get the URLs of both files.
2. Get a command line prompt and log in as administrator , see sections:
   • 2.1 "Developer mode"
   • 2.5 "Copying the layout and config file back onto the Jolla handset" of above procedure, steps 2 to 5.
3. Download the layout file: Enter curl http://url.to/your/new/layout.qml > /usr/share/maliit/plugins/com/jolla/layouts/layout.qml and [Enter].
   (Replace "http://url.to/your/new/layout.qml" with the correct URL to the layout file and "layout.qml" with the file name).
4. Download the config file: Enter curl http://url.to/your/new/layout.conf > /usr/share/maliit/plugins/com/jolla/layouts/layout.conf and [Enter].
   (Replace "http://url.to/your/new/layout.conf" with the correct URL to the config file and "layout.conf" with the file name).
5. Reset the keyboard service: Enter killall maliit-server and [Enter].
6. Follow section 2.6 "Selecting the new keyboard layout" of above procedure.

NOTE: Disable "Remote access" again before connecting to networks you cannot trust (e.g. public WiFi networks, mobile providers that do not allocate private IP 4 addresses and block inter-user IP communication – assume, they do not, as long as you do not know they do). Otherwise, strangers could try to enter your phone via ssh and try passwords using an automated procedure until they have been successfully entering your phone.

Wiki: Changes from Sailfish OS 1.0.3.8 to 1.0.4.20

Popper.qml

File /usr/share/maliit/plugins/com/jolla/Popper.qml, code of 1.0.4.20:

    Timer {
        id: popperExpandTimer
        interval: 500
        onTriggered: {
            if (popper.accents.length > 1) {
                keyboard.inputHandler._handleKeyRelease()
                popper.expanded = true
            }
        }
    }

This is the code for giving access to accented characters, see HowTo: Shorten the delay until accented characters appear. The delay time has been reduced from 800 to 500 ms.

Comment: It is save to overwrite the Popper.qml of 1.0.4.20 with a file that worked with 1.0.3.8.

InputHandler.qml

File /usr/share/maliit/plugins/com/jolla/InputHandler.qml, code of 1.0.4.20:

        if (pressedKey.repeat) {
            autorepeatTimer.interval = 500
            autorepeatTimer.start()
        }
    }

This code seems to handle long-tap of keys and auto-repetition of the corresponding character (I have not yet seen any auto-repetition). The auto-repeat time has been reduced from 800 to 500 ms.

Comment: It seems to be save to overwrite the InputHandler.qml of 1.0.4.20 with a file that worked with 1.0.3.8.

Keyboard layout files

Files in directory /usr/share/maliit/plugins/com/jolla/layouts/, e.g. de.qml for German keyboard layout, have been added a license allowing amendment and redistribution.

Comment: It generally is not a good idea, to overwrite the original files in this directory, you rather should create new files based on the original ones. Your amended layouts should work. If they require amendments to files in directory /usr/share/maliit/plugins/com/jolla/layouts/, you will have to amend these files again.