Commit 3e611eaf authored by David Boddie's avatar David Boddie 💬
Browse files

Merge branch 'expand-general-shell' into 'master'

Expand general shell information

See merge request Librem5/librem5-user-docs-common!35
parents 2acf4c6c 16afcebf
.. include:: defs.txt
.. include:: images.txt
.. _librem_5_contacts:
......
.. include:: defs.txt
.. include:: images.txt
.. _librem_5_initial_setup:
......
.. include:: defs.txt
.. _librem_5_quick_tour:
A Quick Tour
......@@ -17,14 +15,14 @@ Unlocking the Screen
When you power on your phone it will be locked, displaying the lock screen.
.. image:: images/phosh/phosh-locked-sim-locked.png
.. image:: ../images/phosh/phosh-locked-sim-locked.png
:align: center
:scale: 50%
:alt: The lock screen
The first two icons shows the state of the cellular and wireless networks. If these icons are missing then the switches on the side of the phone have been set to disable the modem and WLAN card.
.. image:: images/phosh/phosh-locked-icons-cropped.png
.. image:: ../images/phosh/phosh-locked-icons-cropped.png
:align: center
:alt: The lock screen icons
......@@ -32,7 +30,7 @@ The third icon shows the state of the battery, providing information about its c
To unlock the screen, swipe up from the bottom of the screen to reveal the passcode entry screen.
.. image:: images/phosh/phosh-locked-passcode-entry.png
.. image:: ../images/phosh/phosh-locked-passcode-entry.png
:align: center
:scale: 50%
:alt: The passcode entry screen
......@@ -46,7 +44,7 @@ App Drawer
The app drawer is used to access the built-in and installed applications on the phone. It is automatically opened when you switch on the phone and unlock it, giving you the option to launch an app straight away.
.. image:: images/phosh/phosh-app-drawer.png
.. image:: ../images/phosh/phosh-app-drawer.png
:align: center
:scale: 50%
:alt: The app drawer is open when you unlock the phone
......@@ -55,7 +53,7 @@ The built-in apps are shown in the top row. Installed apps are shown beneath the
To close the app drawer, press the down arrow under the time at the top of the screen. This will reveal the background wallpaper.
.. image:: images/phosh/phosh-background.png
.. image:: ../images/phosh/phosh-background.png
:align: center
:scale: 50%
:alt: The default background
......@@ -64,7 +62,7 @@ To open the app drawer again, press the up arrow at the bottom of the screen.
When one or more applications are running, thumbnail images of them will appear in the top half of the screen, above the icons in the app drawer.
.. image:: images/phosh/phosh-overview.png
.. image:: ../images/phosh/phosh-overview.png
:align: center
:scale: 50%
:alt: Thumbnails of running apps appear above the icons in the app drawer
......@@ -78,7 +76,7 @@ Status Line
At the top of the screen is a status line showing the current time, battery level and network status.
.. image:: images/phosh/phosh-status-line.png
.. image:: ../images/phosh/phosh-status-line.png
:align: center
:scale: 75%
:alt: The status line at the top of the screen
......@@ -94,7 +92,7 @@ Settings Panel
Tap the status bar at the top of the screen to open the settings panel. This provides access to common settings and notifications.
.. image:: images/phosh/phosh-settings-panel.png
.. image:: ../images/phosh/phosh-settings-panel.png
:align: center
:alt: The settings panel
......@@ -111,7 +109,7 @@ A series of icons provide shortcuts for common tasks:
At the top-right corner is the power button. Tap this to access menu items that let you power off the phone and lock the screen.
.. image:: images/phosh/phosh-settings-panel-menu.png
.. image:: ../images/phosh/phosh-settings-panel-menu.png
:align: center
:alt: The settings panel
......@@ -127,7 +125,7 @@ Notification Area
Certain notifications from applications are presented in the area below the settings panel. These are typically notifications that you may need to be
reminded about.
.. image:: images/phosh/phosh-settings-notifications.png
.. image:: ../images/phosh/phosh-settings-notifications.png
:align: center
:scale: 50%
:alt: The notification area of the settings panel
......@@ -135,6 +133,8 @@ reminded about.
The notifications that appear here will usually be displayed briefly at the top
of the screen before they are placed in the area.
See :ref:`librem_5_notifications` for information about how notifications are delivered from applications and the system.
Virtual Keyboard
----------------
......@@ -142,15 +142,15 @@ When you need to input text into an application, the virtual keyboard will open
The keyboard provides different views that you can switch between: one with the alphabet, another with digits, and a third view with symbols.
.. |keyboard-us-alpha| image:: images/keyboard/keyboard-us-alpha.png
.. |keyboard-us-alpha| image:: ../images/keyboard/keyboard-us-alpha.png
:scale: 50%
:alt: The virtual keyboard with US alphabet layout
.. |keyboard-us-numbers| image:: images/keyboard/keyboard-us-numbers.png
.. |keyboard-us-numbers| image:: ../images/keyboard/keyboard-us-numbers.png
:scale: 50%
:alt: The virtual keyboard with US numbers layout
.. |keyboard-us-symbols| image:: images/keyboard/keyboard-us-symbols.png
.. |keyboard-us-symbols| image:: ../images/keyboard/keyboard-us-symbols.png
:scale: 50%
:alt: The virtual keyboard with US symbols layout
......@@ -174,3 +174,6 @@ Next Steps
The next thing you should do is to change the default passcode. This is described in :ref:`librem_5_settings_password`.
After you have done that, you can set up your phone's connection to the mobile network. This is described in the :ref:`librem_5_mobile_networks` section of this guide.
.. include:: ../defs.txt
.. include:: images.txt
......@@ -5,7 +5,7 @@ Kill Switches
The Librem 5 provides three kill switches that can be used to disable hardware features of the phone.
.. image:: images/hardware/librem5-switches.svg
.. image:: ../images/hardware/librem5-switches.svg
:align: center
:width: 480
:alt: The locations of kill switches on the edge of the phone
......
.. _librem_5_notifications:
Notifications
=============
When the phone's system software or applications need to inform you about something, they will send notifications in the form of pop-up messages. You can configure how these will be presented to you, and optionally use sounds and the phone indicator lights to alert you to their presence.
.. contents::
:local:
The sections below should help you manage and customize notifications to meet your needs.
Pop-up Messages
---------------
When an application or system service sends a notification, it will initially appear as a pop-up window at the top of the screen. It will remain there for a few seconds then disappear. If you tap the notification when it appears, you will be taken to the application that sent it.
.. image:: ../images/phosh/phosh-popup-notifications.png
:align: center
:scale: 50%
:alt: A pop-up notification showing that a timer countdown has finished
If you missed the notification then it will be stored until you can respond to it, or until you switch to the application that sent it.
Missed Notifications
--------------------
If you miss a notification it will be displayed below the settings panel when it is opened.
.. image:: ../images/phosh/phosh-missed-notifications.png
:align: center
:scale: 50%
:alt: A missed notification for Clocks displayed below the settings panel
Tap on a missed notification to switch to the application that sent it.
Configuration
-------------
Notifications are configured in the **Settings** application in the :ref:`librem_5_settings_notifications` page.
.. |notifications| image:: ../images/settings/settings-notifications.png
:scale: 50%
:alt: The Notifications page, allowing customization for individual applications
.. |notifications-power| image:: ../images/settings/settings-notifications-power.png
:scale: 50%
:alt: The Power notifications page
.. centered:: |notifications| |notifications-power|
Notifications can be configured to be delivered in a different way for each application. Except for urgent notifications, they can also be disabled for all applications and services.
......@@ -15,7 +15,7 @@ Overview
The status line contains the current time in the center, separating indicators for connectivity on the left from other indicators on the right.
.. image:: images/phosh/phosh-status-line.png
.. image:: ../images/phosh/phosh-status-line.png
:align: center
:scale: 75%
:alt: The status line at the top of the screen
......@@ -44,7 +44,7 @@ Another icon that may appear indicates a disabled connection.
The type of cellular network in use is presented as a simple label alongside the signal strength. Most users will see **2G**, **3G** or **4G**.
.. image:: images/phosh/phosh-status-line-3G.png
.. image:: ../images/phosh/phosh-status-line-3G.png
:align: center
:scale: 75%
:alt: The status line showing a 3G cellular network in use
......@@ -99,4 +99,86 @@ At the right edge of the display, the battery indicator shows the level of charg
Other icons may be shown in the exceptional case where the phone is powered without a battery.
.. include:: defs.txt
.. include:: ../defs.txt
.. Larger icons for inline use in tables
.. Networking
.. |network-txrx| image:: ../images/icons/network-transmit-receive-symbolic.svg
:width: 40
.. |network-offline| image:: ../images/icons/network-offline-symbolic.svg
:width: 40
.. |network-no-route| image:: ../images/icons/network-no-route-symbolic.svg
:width: 40
.. Cellular
.. |cell-dis| image:: ../images/icons/network-cellular-disabled-symbolic.svg
:width: 40
.. |cell-excellent| image:: ../images/icons/network-cellular-signal-excellent-symbolic.svg
:width: 40
.. |cell-good| image:: ../images/icons/network-cellular-signal-good-symbolic.svg
:width: 40
.. |cell-ok| image:: ../images/icons/network-cellular-signal-ok-symbolic.svg
:width: 40
.. |cell-weak| image:: ../images/icons/network-cellular-signal-weak-symbolic.svg
:width: 40
.. |cell-none| image:: ../images/icons/network-cellular-signal-none-symbolic.svg
:width: 40
.. WLAN
.. |wlan-excellent| image:: ../images/icons/network-wireless-signal-excellent-symbolic.svg
:width: 40
.. |wlan-good| image:: ../images/icons/network-wireless-signal-good-symbolic.svg
:width: 40
.. |wlan-ok| image:: ../images/icons/network-wireless-signal-ok-symbolic.svg
:width: 40
.. |wlan-weak| image:: ../images/icons/network-wireless-signal-weak-symbolic.svg
:width: 40
.. |wlan-none| image:: ../images/icons/network-wireless-signal-none-symbolic.svg
:width: 40
.. |wlan-dis| image:: ../images/icons/network-wireless-disabled-symbolic.svg
:width: 40
.. |wlan-offline| image:: ../images/icons/network-wireless-offline-symbolic.svg
:width: 40
.. |wlan-acquire| image:: ../images/icons/network-wireless-acquiring-symbolic.svg
:width: 40
.. |wlan-connect| image:: ../images/icons/network-wireless-connected-symbolic.svg
:width: 40
.. Battery
.. |battery-empty| image:: ../images/icons/battery-empty-symbolic.svg
:width: 40
.. |charging-empty| image:: ../images/icons/battery-empty-charging-symbolic.svg
:width: 40
.. |battery-low| image:: ../images/icons/battery-low-symbolic.svg
:width: 40
.. |charging-low| image:: ../images/icons/battery-low-charging-symbolic.svg
:width: 40
.. |battery-full| image:: ../images/icons/battery-full-symbolic.svg
:width: 40
.. |charging-full| image:: ../images/icons/battery-full-charging-symbolic.svg
:width: 40
.. include:: defs.txt
.. _librem_5_virtual_keyboard:
Virtual Keyboard
......@@ -23,7 +21,7 @@ Layouts
The layout of the virtual keyboard is close to that of conventional physical keyboards, except that it is designed more for text input than as a general input device. As a result, many of the keys found on a physical keyboard, such as *Ctrl*, *Alt* and the cursor keys are not included in the normal layout.
.. image:: images/keyboard/keyboard-us-alpha.png
.. image:: ../images/keyboard/keyboard-us-alpha.png
:align: center
:alt: The virtual keyboard with US alphabet layout
......@@ -40,15 +38,15 @@ Views
The keyboard provides different views that you can switch between: one with the alphabet, another with digits, and a third view with symbols.
.. |keyboard-us-alpha| image:: images/keyboard/keyboard-us-alpha.png
.. |keyboard-us-alpha| image:: ../images/keyboard/keyboard-us-alpha.png
:scale: 50%
:alt: The virtual keyboard with US alphabet layout
.. |keyboard-us-numbers| image:: images/keyboard/keyboard-us-numbers.png
.. |keyboard-us-numbers| image:: ../images/keyboard/keyboard-us-numbers.png
:scale: 50%
:alt: The virtual keyboard with US numbers layout
.. |keyboard-us-symbols| image:: images/keyboard/keyboard-us-symbols.png
.. |keyboard-us-symbols| image:: ../images/keyboard/keyboard-us-symbols.png
:scale: 50%
:alt: The virtual keyboard with US symbols layout
......@@ -67,14 +65,16 @@ Switching Layouts
The keyboard automatically handles switching between layouts for specialized tasks, such as entering phone numbers, but you can also choose between layouts for different languages by pressing the |mode| key.
.. image:: images/keyboard/keyboard-mode-selection.png
.. image:: ../images/keyboard/keyboard-mode-selection.png
:align: center
:alt: Opening the keyboard mode selection menu
This provides access to layouts such as a terminal layout for consoles and terminal emulators, as well as an emoji layout for messaging applications.
.. image:: images/keyboard/keyboard-emoji-layout.png
.. image:: ../images/keyboard/keyboard-emoji-layout.png
:align: center
:alt: The emoji layout for use with messaging applications
The menu also shows which other layouts are available for other languages.
.. include:: images.txt
.. |backspace| image:: ../images/icons/edit-clear-symbolic.svg
:width: 20
.. |close| image:: ../images/icons/window-close-symbolic.svg
:width: 20
.. |enter| image:: ../images/icons/key-enter.svg
:width: 20
.. |keyboard| image:: ../images/icons/input-keyboard-symbolic.svg
:width: 20
.. |mode| image:: ../images/icons/keyboard-mode-symbolic.svg
:width: 20
.. |shift| image:: ../images/icons/key-shift.svg
:width: 20
Using the Phone
===============
We recommend taking :ref:`librem_5_quick_tour` before exploring the phone software in more detail.
.. toctree::
A_Quick_Tour
Status
Notifications
Virtual_Keyboard
Kill_Switches
.. include:: defs.txt
.. include:: images.txt
.. _librem_5_messages:
......
.. include:: defs.txt
.. include:: images.txt
.. _librem_5_settings:
......@@ -80,21 +81,39 @@ Cellular
The **Cellular** page is used to configure your phone's connection to the mobile network. See the :ref:`librem_5_mobile_networks_unlock_sim` section for more information.
.. _librem_5_settings_notifications:
Notifications
-------------
The **Notifications** page is useful when you want to configure how notifications are reported for individual applications and components.
.. |notifications| image:: images/settings/settings-notifications.png
.. image:: images/settings/settings-notifications.png
:scale: 50%
:align: center
:alt: The Notifications page, allowing customization for individual applications
.. |notifications-power| image:: images/settings/settings-notifications-power.png
Notifications can be turned off for all applications and services with the **Do Not Disturb** option.
Press any of the names in the list to open a page showing the preferences for that application or component.
.. image:: images/settings/settings-notifications-power.png
:scale: 50%
:align: center
:alt: The Power notifications page
.. centered:: |notifications| |notifications-power|
The options shown in the image are as follows:
* **Notifications** -- this option allows you to enable or disable delivery of notifications completely for the application.
* **Sound Alerts** will use the system alert sound configured in the **Sound** settings when enabled. Otherwise, no sounds will be used to alert you to new notifications from the application.
* **Notification Popups** are shown at the top of the screen when a notification is delivered.
* **Show Message Content in Popups** -- this option determines whether a summary or a more detailed notification is shown if the application supports it. Only a summary is shown if this is disabled.
* **Lock Screen Notifications** can be shown when the phone is locked and the lock screen is displayed. When enabled, this may result in a message appearing on the lock screen.
* **Show Message Content on Lock Screen** -- this option determines whether a summary or a more detailed message is shown in a lock screen notification if the application supports it.
When you have finished fine-tuning the notification settings, press the back button at the top-left of the screen to return to the main **Notifications** page.
Press any of the names in the list to open a page showing the preferences for that application or component. Press the back button at the top-left of the screen to return to the list.
See the :ref:`librem_5_notifications` chapter of this guide for background information about notifications and how they are used.
.. _librem_5_settings_region_language:
......
.. include:: defs.txt
.. include:: images.txt
.. _librem_5_software:
......
.. include:: defs.txt
.. include:: images.txt
.. _librem_5_wlan:
......
.. include:: defs.txt
.. include:: images.txt
.. _librem_5_web:
......
......@@ -17,132 +17,3 @@
.. |br| raw:: html
<br />
.. Image substitutions
.. |menu| image:: images/icons/open-menu-symbolic.svg
:width: 20
.. |new-tab| image:: images/icons/tab-new-symbolic.svg
:width: 20
.. |close| image:: images/icons/window-close-symbolic.svg
:width: 20
.. |back| image:: images/icons/go-previous-symbolic.svg
:width: 20
.. |bookmarks| image:: images/icons/ephy-bookmarks-symbolic.svg
:width: 20
.. |reader| image:: images/icons/ephy-reader-mode-symbolic.svg
:width: 20
.. |add| image:: images/icons/list-add-symbolic.svg
:width: 20
.. |remove| image:: images/icons/list-remove-symbolic.svg
:width: 20
.. |enter| image:: images/icons/key-enter.svg
:width: 20
.. |shift| image:: images/icons/key-shift.svg
:width: 20
.. |delete| image:: images/icons/edit-delete-symbolic.svg
:width: 20
.. |backspace| image:: images/icons/edit-clear-symbolic.svg
:width: 20
.. |view-more| image:: images/icons/view-more-symbolic.svg
:width: 20
.. |keyboard| image:: images/icons/input-keyboard-symbolic.svg
:width: 20
.. |mode| image:: images/icons/keyboard-mode-symbolic.svg
:width: 20
.. Larger icons for inline use in tables
.. Networking
.. |network-txrx| image:: images/icons/network-transmit-receive-symbolic.svg
:width: 40
.. |network-offline| image:: images/icons/network-offline-symbolic.svg
:width: 40
.. |network-no-route| image:: images/icons/network-no-route-symbolic.svg
:width: 40
.. Cellular
.. |cell-dis| image:: images/icons/network-cellular-disabled-symbolic.svg
:width: 40
.. |cell-excellent| image:: images/icons/network-cellular-signal-excellent-symbolic.svg
:width: 40
.. |cell-good| image:: images/icons/network-cellular-signal-good-symbolic.svg
:width: 40
.. |cell-ok| image:: images/icons/network-cellular-signal-ok-symbolic.svg
:width: 40
.. |cell-weak| image:: images/icons/network-cellular-signal-weak-symbolic.svg
:width: 40
.. |cell-none| image:: images/icons/network-cellular-signal-none-symbolic.svg
:width: 40
.. WLAN
.. |wlan-excellent| image:: images/icons/network-wireless-signal-excellent-symbolic.svg
:width: 40
.. |wlan-good| image:: images/icons/network-wireless-signal-good-symbolic.svg
:width: 40
.. |wlan-ok| image:: images/icons/network-wireless-signal-ok-symbolic.svg
:width: 40
.. |wlan-weak| image:: images/icons/network-wireless-signal-weak-symbolic.svg
:width: 40
.. |wlan-none| image:: images/icons/network-wireless-signal-none-symbolic.svg
:width: 40
.. |wlan-dis| image:: images/icons/network-wireless-disabled-symbolic.svg
:width: 40
.. |wlan-offline| image:: images/icons/network-wireless-offline-symbolic.svg
:width: 40
.. |wlan-acquire| image:: images/icons/network-wireless-acquiring-symbolic.svg
:width: 40
.. |wlan-connect| image:: images/icons/network-wireless-connected-symbolic.svg
:width: 40
.. Battery
.. |battery-empty| image:: images/icons/battery-empty-symbolic.svg
:width: 40
.. |charging-empty| image:: images/icons/battery-empty-charging-symbolic.svg
:width: 40
.. |battery-low| image:: images/icons/battery-low-symbolic.svg
:width: 40
.. |charging-low| image:: images/icons/battery-low-charging-symbolic.svg
:width: 40
.. |battery-full| image:: images/icons/battery-full-symbolic.svg
:width: 40
.. |charging-full| image:: images/icons/battery-full-charging-symbolic.svg
:width: 40
.. Image substitutions
.. |add| image:: images/icons/list-add-symbolic.svg
:width: 20
.. |back| image:: images/icons/go-previous-symbolic.svg
:width: 20
.. |bookmarks| image:: images/icons/ephy-bookmarks-symbolic.svg
:width: 20
.. |close| image:: images/icons/window-close-symbolic.svg
:width: 20
.. |delete| image:: images/icons/edit-delete-symbolic.svg
:width: 20
.. |enter| image:: images/icons/key-enter.svg
:width: 20
.. |keyboard| image:: images/icons/input-keyboard-symbolic.svg
:width: 20
.. |menu| image:: images/icons/open-menu-symbolic.svg
:width: 20
.. |new-tab| image:: images/icons/tab-new-symbolic.svg
:width: 20
.. |reader| image:: images/icons/ephy-reader-mode-symbolic.svg
:width: 20
.. |remove| image:: images/icons/list-remove-symbolic.svg
:width: 20
.. |view-more| image:: images/icons/view-more-symbolic.svg
:width: 20
Supports Markdown
0% or .