Skip to content

Commit

Permalink
#702 Rewrite titles of layouts to `[languages] [base] [qualifiers] [v…
Browse files Browse the repository at this point in the history
…ersion]` (#1007)

* #702 Rewrite titles of layouts to `[languages] [base] [qualifiers] [version]`

`[languages]` are languages or "alphabets", for example:
- canadian aboriginal syllabic
- english
- english deutsch
- esperanto english deutsch
- japanese hiragana
- japanese kana
- japanese katakana
- ...

`[base]` is the name of the original layout:
- messagease
- qbased
- qwertease
- qwertyfour
- thumb-key
- type-split

`[qualifiers]` are additional features/modifiers of the layout, in alphabetical order:
- +æ
- +åæø
- compose
- double symbols
- emoji
- left-handed
- phonetic
- programming
- samsung
- symbols
- symbols-numbers
- two-hands
- wide (may be the same as "two-hands"?)
- writer

`[version]` is a `v` followed by a number:
- v1
- v2
- v3

* #702 Also rename constants to match layout titles

* #702 Add layout naming guideline to README

---------

Co-authored-by: Dessalines <[email protected]>
  • Loading branch information
mpsijm and dessalines authored Aug 7, 2024
1 parent b8e513e commit 629bb38
Show file tree
Hide file tree
Showing 65 changed files with 196 additions and 195 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,7 @@ I'd be happy to accept additions to add more languages, and layouts. To start:
- Read the letter position guidelines above. This means you'll likely need a letter frequency chart for text written in your language.
- The general rule is: popular vowels on the right, bottom to top, consonants on the left.
- Copy [this file](https://github.com/dessalines/thumb-key/blob/main/app/src/main/java/com/dessalines/thumbkey/keyboards/ENThumbKey.kt), or another sample keyboard from the same folder.
- The title of the new layout should be lowercase and follow the following format: `[languages] [base] [qualifiers]? [version]?` (see also [#702](https://github.com/dessalines/thumb-key/issues/702)).
- Change the characters to whatever you'd like.
- This file contains both a _shifted_, and _non-shifted_ keyboard, so make sure you take care of both.
- You can also add or subtract columns if you want, but the layout must remain a grid. I **highly recommend** sticking with the 3x3 layout.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ import com.dessalines.thumbkey.utils.SwipeDirection
import com.dessalines.thumbkey.utils.autoCapitalizeI
import com.dessalines.thumbkey.utils.autoCapitalizeIApostrophe

val KB_BG_PHONETIC_MESSAGEASE_SYMBOLS_MAIN =
val KB_BG_MESSAGEASE_PHONETIC_SYMBOLS_MAIN =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -478,7 +478,7 @@ val KB_BG_PHONETIC_MESSAGEASE_SYMBOLS_MAIN =
),
)

val KB_BG_PHONETIC_MESSAGEASE_SYMBOLS_SHIFTED =
val KB_BG_MESSAGEASE_PHONETIC_SYMBOLS_SHIFTED =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -940,13 +940,13 @@ val KB_BG_PHONETIC_MESSAGEASE_SYMBOLS_SHIFTED =
),
)

val KB_BG_PHONETIC_MESSAGEASE_SYMBOLS: KeyboardDefinition =
val KB_BG_MESSAGEASE_PHONETIC_SYMBOLS: KeyboardDefinition =
KeyboardDefinition(
title = "bulgarian symbols phonetic messagease",
title = "bulgarian messagease phonetic symbols",
modes =
KeyboardDefinitionModes(
main = KB_BG_PHONETIC_MESSAGEASE_SYMBOLS_MAIN,
shifted = KB_BG_PHONETIC_MESSAGEASE_SYMBOLS_SHIFTED,
main = KB_BG_MESSAGEASE_PHONETIC_SYMBOLS_MAIN,
shifted = KB_BG_MESSAGEASE_PHONETIC_SYMBOLS_SHIFTED,
numeric = KB_EN_MESSAGEASE_NUMERIC,
),
settings =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import com.dessalines.thumbkey.utils.KeyboardDefinition
import com.dessalines.thumbkey.utils.KeyboardDefinitionModes
import com.dessalines.thumbkey.utils.SwipeDirection

val KB_CZ_PROG_MAIN =
val KB_CZ_MESSAGEASE_PROGRAMMING_MAIN =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -525,7 +525,7 @@ val KB_CZ_PROG_MAIN =
),
)

val KB_CZ_PROG_SHIFTED =
val KB_CZ_MESSAGEASE_PROGRAMMING_SHIFTED =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -1031,13 +1031,13 @@ val KB_CZ_PROG_SHIFTED =
),
)

val KB_CZ_PROG: KeyboardDefinition =
val KB_CZ_MESSAGEASE_PROGRAMMING: KeyboardDefinition =
KeyboardDefinition(
title = "čeština programming messagease",
title = "čeština messagease programming",
modes =
KeyboardDefinitionModes(
main = KB_CZ_PROG_MAIN,
shifted = KB_CZ_PROG_SHIFTED,
main = KB_CZ_MESSAGEASE_PROGRAMMING_MAIN,
shifted = KB_CZ_MESSAGEASE_PROGRAMMING_SHIFTED,
numeric = KB_EN_MESSAGEASE_NUMERIC,
),
)
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ val SPACEBAR_KEY_ITEM =
val SPACEBAR_SKINNY_KEY_ITEM = SPACEBAR_KEY_ITEM.copy(widthMultiplier = 1)
val SPACEBAR_DOUBLE_KEY_ITEM = SPACEBAR_KEY_ITEM.copy(widthMultiplier = 2)

val SPACEBAR_PROGRAMMER_KEY_ITEM =
val SPACEBAR_PROGRAMMING_KEY_ITEM =
KeyItemC(
center =
KeyC(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ import com.dessalines.thumbkey.utils.KeyboardDefinition
import com.dessalines.thumbkey.utils.KeyboardDefinitionModes
import com.dessalines.thumbkey.utils.SwipeDirection

val KB_DE_EN_AE_THUMBKEY_MAIN =
val KB_EN_DE_THUMBKEY_AE_MAIN =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -498,7 +498,7 @@ val KB_DE_EN_AE_THUMBKEY_MAIN =
),
)

val KB_DE_EN_AE_THUMBKEY_SHIFTED =
val KB_EN_DE_THUMBKEY_AE_SHIFTED =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -981,13 +981,13 @@ val KB_DE_EN_AE_THUMBKEY_SHIFTED =
),
)

val KB_DE_EN_AE_THUMBKEY =
val KB_EN_DE_THUMBKEY_AE =
KeyboardDefinition(
title = "deutsch english thumb-key",
title = "english deutsch thumb-key",
modes =
KeyboardDefinitionModes(
main = KB_DE_EN_AE_THUMBKEY_MAIN,
shifted = KB_DE_EN_AE_THUMBKEY_SHIFTED,
main = KB_EN_DE_THUMBKEY_AE_MAIN,
shifted = KB_EN_DE_THUMBKEY_AE_SHIFTED,
numeric = NUMERIC_KEYBOARD,
),
)
Original file line number Diff line number Diff line change
Expand Up @@ -952,11 +952,11 @@ val KB_DE_NORDIC_MESSAGEASE_SHIFTED =

val KB_DE_NORDIC_MESSAGEASE: KeyboardDefinition =
KeyboardDefinition(
title = "deutsch + åæø messagease",
title = "deutsch messagease +åæø",
modes =
KeyboardDefinitionModes(
main = KB_DE_NORDIC_MESSAGEASE_MAIN,
shifted = KB_DE_NORDIC_MESSAGEASE_SHIFTED,
numeric = KB_DE_NORDIC_MESSAGEASE_NUMERIC,
numeric = KB_NORDIC_MESSAGEASE_NUMERIC,
),
)
Original file line number Diff line number Diff line change
Expand Up @@ -1006,7 +1006,7 @@ val KB_DE_THUMBKEY_SYMBOLS_SHIFTED =

val KB_DE_THUMBKEY_SYMBOLS: KeyboardDefinition =
KeyboardDefinition(
title = "deutsch symbols thumbkey",
title = "deutsch thumb-key symbols",
modes =
KeyboardDefinitionModes(
main = KB_DE_THUMBKEY_SYMBOLS_MAIN,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -928,7 +928,7 @@ val KB_EN_DA_THUMBKEY_SYMBOLS_SHIFTED =

val KB_EN_DA_THUMBKEY_SYMBOLS: KeyboardDefinition =
KeyboardDefinition(
title = "english dansk symbols thumb-key",
title = "english dansk thumb-key symbols",
modes =
KeyboardDefinitionModes(
main = KB_EN_DA_THUMBKEY_SYMBOLS_MAIN,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ import com.dessalines.thumbkey.utils.SwipeDirection
import com.dessalines.thumbkey.utils.autoCapitalizeI
import com.dessalines.thumbkey.utils.autoCapitalizeIApostrophe

val KB_ENEO_MESSAGEASE_SYMBOLS_MAIN =
val KB_EN_EO_MESSAGEASE_SYMBOLS_MAIN =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -557,7 +557,7 @@ val KB_ENEO_MESSAGEASE_SYMBOLS_MAIN =
),
)

val KB_ENEO_MESSAGEASE_SYMBOLS_SHIFTED =
val KB_EN_EO_MESSAGEASE_SYMBOLS_SHIFTED =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -1091,13 +1091,13 @@ val KB_ENEO_MESSAGEASE_SYMBOLS_SHIFTED =
),
)

val KB_ENEO_MESSAGEASE_SYMBOLS: KeyboardDefinition =
val KB_EN_EO_MESSAGEASE_SYMBOLS: KeyboardDefinition =
KeyboardDefinition(
title = "english esperanto symbols messagease",
title = "english esperanto messagease symbols",
modes =
KeyboardDefinitionModes(
main = KB_ENEO_MESSAGEASE_SYMBOLS_MAIN,
shifted = KB_ENEO_MESSAGEASE_SYMBOLS_SHIFTED,
main = KB_EN_EO_MESSAGEASE_SYMBOLS_MAIN,
shifted = KB_EN_EO_MESSAGEASE_SYMBOLS_SHIFTED,
numeric = KB_EN_MESSAGEASE_NUMERIC,
),
settings =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1183,7 +1183,7 @@ val KB_EN_FR_NUMERIC =

val KB_EN_FR_MESSAGEASE_SYMBOLS: KeyboardDefinition =
KeyboardDefinition(
title = "english français symbols messagease",
title = "english français messagease symbols",
modes =
KeyboardDefinitionModes(
main = KB_EN_FR_MAIN,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -940,7 +940,7 @@ val KB_EN_MESSAGEASE_COMPOSED_SHIFTED =

val KB_EN_MESSAGEASE_COMPOSE: KeyboardDefinition =
KeyboardDefinition(
title = "english composed messagease",
title = "english messagease compose",
modes =
KeyboardDefinitionModes(
main = KB_EN_MESSAGEASE_COMPOSED_MAIN,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import com.dessalines.thumbkey.utils.lastColKeysToFirst

val KB_EN_MESSAGEASE_LEFT: KeyboardDefinition =
KeyboardDefinition(
title = "english left-handed messagease",
title = "english messagease left-handed",
modes =
KeyboardDefinitionModes(
main = lastColKeysToFirst(KB_EN_MESSAGEASE_MAIN),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ import com.dessalines.thumbkey.utils.autoCapitalizeI
import com.dessalines.thumbkey.utils.autoCapitalizeIApostrophe
import com.dessalines.thumbkey.utils.lastColKeysToFirst

val KB_EN_MESSAGEASE_SYMBOLS_LEFT: KeyboardDefinition =
val KB_EN_MESSAGEASE_LEFT_SYMBOLS: KeyboardDefinition =
KeyboardDefinition(
title = "english symbols left-handed messagease",
title = "english messagease left-handed symbols",
modes =
KeyboardDefinitionModes(
main = lastColKeysToFirst(KB_EN_MESSAGEASE_SYMBOLS_MAIN),
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -904,7 +904,7 @@ val KB_EN_MESSAGEASE_SYMBOLS_SHIFTED =

val KB_EN_MESSAGEASE_SYMBOLS: KeyboardDefinition =
KeyboardDefinition(
title = "english symbols messagease",
title = "english messagease symbols",
modes =
KeyboardDefinitionModes(
main = KB_EN_MESSAGEASE_SYMBOLS_MAIN,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ import com.dessalines.thumbkey.utils.KeyboardDefinitionSettings
import com.dessalines.thumbkey.utils.autoCapitalizeI
import com.dessalines.thumbkey.utils.autoCapitalizeIApostrophe

val KB_EN_MESSAGEASE_TWO_HANDS_SYMBOLS_MAIN =
val KB_EN_MESSAGEASE_SYMBOLS_TWO_HANDS_MAIN =
KeyboardC(
listOf(
KB_EN_MESSAGEASE_SYMBOLS_MAIN.arr[0] +
Expand All @@ -21,7 +21,7 @@ val KB_EN_MESSAGEASE_TWO_HANDS_SYMBOLS_MAIN =
),
)

val KB_EN_MESSAGEASE_TWO_HANDS_SYMBOLS_SHIFTED =
val KB_EN_MESSAGEASE_SYMBOLS_TWO_HANDS_SHIFTED =
KeyboardC(
listOf(
KB_EN_MESSAGEASE_SYMBOLS_SHIFTED.arr[0] +
Expand Down Expand Up @@ -50,13 +50,13 @@ val NUMERIC_KEYBOARD_MESSAGEASE_TWO_HANDS =
),
)

val KB_EN_MESSAGEASE_TWO_HANDS_SYMBOLS: KeyboardDefinition =
val KB_EN_MESSAGEASE_SYMBOLS_TWO_HANDS: KeyboardDefinition =
KeyboardDefinition(
title = "english messagease two-hands symbols",
title = "english messagease symbols two-hands",
modes =
KeyboardDefinitionModes(
main = KB_EN_MESSAGEASE_TWO_HANDS_SYMBOLS_MAIN,
shifted = KB_EN_MESSAGEASE_TWO_HANDS_SYMBOLS_SHIFTED,
main = KB_EN_MESSAGEASE_SYMBOLS_TWO_HANDS_MAIN,
shifted = KB_EN_MESSAGEASE_SYMBOLS_TWO_HANDS_SHIFTED,
numeric = NUMERIC_KEYBOARD_MESSAGEASE_TWO_HANDS,
),
settings =
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import com.dessalines.thumbkey.utils.SwipeNWay
import com.dessalines.thumbkey.utils.autoCapitalizeI
import com.dessalines.thumbkey.utils.autoCapitalizeIApostrophe

val KB_EN_TWO_HANDS_MESSAGEASE_MAIN =
val KB_EN_MESSAGEASE_TWO_HANDS_MAIN =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -514,7 +514,7 @@ val KB_EN_TWO_HANDS_MESSAGEASE_MAIN =
),
)

val KB_EN_TWO_HANDS_MESSAGEASE_SHIFTED =
val KB_EN_MESSAGEASE_TWO_HANDS_SHIFTED =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -1014,14 +1014,14 @@ val KB_EN_TWO_HANDS_MESSAGEASE_SHIFTED =
),
)

val KB_EN_TWO_HANDS_MESSAGEASE: KeyboardDefinition =
val KB_EN_MESSAGEASE_TWO_HANDS: KeyboardDefinition =
KeyboardDefinition(
title = "english messagease two-hands",
modes =
KeyboardDefinitionModes(
main = KB_EN_TWO_HANDS_MESSAGEASE_MAIN,
shifted = KB_EN_TWO_HANDS_MESSAGEASE_SHIFTED,
numeric = KB_EN_TWO_HANDS_MESSAGEASE_NUMERIC,
main = KB_EN_MESSAGEASE_TWO_HANDS_MAIN,
shifted = KB_EN_MESSAGEASE_TWO_HANDS_SHIFTED,
numeric = KB_EN_MESSAGEASE_TWO_HANDS_NUMERIC,
),
settings =
KeyboardDefinitionSettings(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -927,7 +927,7 @@ val KB_EN_NO_MESSAGEASE_SYMBOLS_SHIFTED =

val KB_EN_NO_MESSAGEASE_SYMBOLS: KeyboardDefinition =
KeyboardDefinition(
title = "english norsk symbols messagease",
title = "english norsk messagease symbols",
modes =
KeyboardDefinitionModes(
main = KB_EN_NO_MESSAGEASE_SYMBOLS_MAIN,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ import com.dessalines.thumbkey.utils.SwipeNWay
import com.dessalines.thumbkey.utils.autoCapitalizeI
import com.dessalines.thumbkey.utils.autoCapitalizeIApostrophe

val KB_EN_TWO_HANDS_QWERTEASE_MAIN =
val KB_EN_QWERTEASE_TWO_HANDS_MAIN =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -552,7 +552,7 @@ val KB_EN_TWO_HANDS_QWERTEASE_MAIN =
),
)

val KB_EN_TWO_HANDS_QWERTEASE_SHIFTED =
val KB_EN_QWERTEASE_TWO_HANDS_SHIFTED =
KeyboardC(
listOf(
listOf(
Expand Down Expand Up @@ -1090,14 +1090,14 @@ val KB_EN_TWO_HANDS_QWERTEASE_SHIFTED =
),
)

val KB_EN_TWO_HANDS_QWERTEASE: KeyboardDefinition =
val KB_EN_QWERTEASE_TWO_HANDS: KeyboardDefinition =
KeyboardDefinition(
title = "english qwertease two-hands",
modes =
KeyboardDefinitionModes(
main = KB_EN_TWO_HANDS_QWERTEASE_MAIN,
shifted = KB_EN_TWO_HANDS_QWERTEASE_SHIFTED,
numeric = KB_EN_TWO_HANDS_MESSAGEASE_NUMERIC,
main = KB_EN_QWERTEASE_TWO_HANDS_MAIN,
shifted = KB_EN_QWERTEASE_TWO_HANDS_SHIFTED,
numeric = KB_EN_MESSAGEASE_TWO_HANDS_NUMERIC,
),
settings =
KeyboardDefinitionSettings(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -727,7 +727,7 @@ val KB_EN_QWERTYFOUR_COMPOSE_SHIFTED =

val KB_EN_QWERTYFOUR_COMPOSE: KeyboardDefinition =
KeyboardDefinition(
title = "english composed qwertyfour",
title = "english qwertyfour compose",
modes =
KeyboardDefinitionModes(
main = KB_EN_QWERTYFOUR_COMPOSE_MAIN,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -651,7 +651,7 @@ val KB_EN_THUMBKEY_COMPOSE_SHIFTED =

val KB_EN_THUMBKEY_COMPOSE: KeyboardDefinition =
KeyboardDefinition(
title = "english composed thumb-key",
title = "english thumb-key compose",
modes =
KeyboardDefinitionModes(
main = KB_EN_THUMBKEY_COMPOSE_MAIN,
Expand Down
Loading

0 comments on commit 629bb38

Please sign in to comment.