Commit f7e903a4 authored by David Boddie's avatar David Boddie
Browse files

Make room for Squeekboard in the software reference

parent 616ca2fe
Pipeline #52085 passed with stage
in 1 minute and 18 seconds
......@@ -42,13 +42,15 @@ D-Bus APIs provided by the Phone Shell (:ref:`phosh`):
authentication dialogs (used by e.g. gnupg's pinentry, SIM card pin
entry, etc.)
.. _api_docs_keyboard:
On-Screen Keyboard
------------------
The visibility of the on-screen (virtual) keyboard can be controlled using its
D-Bus API, exposed on the session bus as the ``sm.puri.OSK0`` service, on the
``/sm/puri/OSK0`` object path, with the ``sm.puri.OSK0`` interface, as
described in the `Squeekboard`_ documentation.
described in the `Squeekboard HACKING.md guide <squeekboard_hacking_>`_.
This interface provides the following property:
......@@ -59,6 +61,8 @@ This can be read and changed with the following methods:
* ``GetVisible(out b visible)``
* ``SetVisible(in b visible)``
.. _squeekboard_hacking: https://source.puri.sm/Librem5/squeekboard/blob/master/HACKING.md
Mobile Widgets
--------------
* The `libhandy documentation`_ is a reference manual for the adaptive widgets
......
......@@ -13,5 +13,6 @@ and uses a custom Wayland compositor called Phoc_.
.. toctree::
Phosh/Install
Phosh/Squeekboard
.. include:: /links.txt
.. index:: Installing phosh
Installation
============
Installing Phosh for Development
================================
Phosh runs on the development images by default. If you want to hack on it, you
need to build it from source, obtained from the `Phosh repository`_. You will
......
Squeekboard
===========
Squeekboard is a virtual, on-screen keyboard for environments based on `Wayland`_, built primarily for the Librem 5 phone.
.. contents::
:local:
Developer Documentation
-----------------------
The `Squeekboard documentation`_ can be found on the Purism developer documentation site. This includes a `tutorial`_ for creating new keyboard layouts.
The keyboard also provides a :ref:`D-Bus API <api_docs_keyboard>` that other applications and environments can use to interact with it.
User Documentation
------------------
The `virtual keyboard user guide`_ in the `Librem 5 user guide`_ describes how the keyboard is used within the :ref:`phosh` shell.
.. include:: /links.txt
.. _`tutorial`: https://developer.puri.sm/projects/squeekboard/tutorial.html
.. _`virtual keyboard user guide`: https://docs.puri.sm/Librem_5/Virtual_Keyboard.html
......@@ -119,6 +119,7 @@
.. _`Librem 5 developer documentation repository`: https://source.puri.sm/Librem5/developer.puri.sm
.. _`Librem 5 examples project`: https://source.puri.sm/Librem5/example-apps/
.. _`Librem 5 scratch apt repository`: https://ci.puri.sm/dists/scratch/
.. _`Librem 5 user guide`: https://docs.puri.sm/Librem_5.html
.. _`librem5-devkit-tools`: https://source.puri.sm/Librem5/librem5-devkit-tools
.. _`linux-emcraft repository`: https://source.puri.sm/Librem5/linux-emcraft/
.. _`linux-emcraft issue 2`: https://source.puri.sm/Librem5/linux-emcraft/issues/2
......@@ -160,6 +161,7 @@
.. _`Scalable Vector Graphics`: https://www.w3.org/TR/SVG/
.. _`Sidebar lists`: https://developer.gnome.org/hig/stable/sidebar-lists.html.en
.. _`Squeekboard`: https://source.puri.sm/Librem5/squeekboard
.. _`Squeekboard documentation`: https://developer.puri.sm/projects/squeekboard/
.. _`U-Boot Librem 5 Builds`: https://arm01.puri.sm/job/u-boot_builds/job/uboot_librem5_build/
.. _`Using GtkApplication`: https://developer.gnome.org/GtkApplication/
.. _`Using GSettings`: https://developer.gnome.org/GSettings/
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment