Skip to content

Improve documentation about launchers #391

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Improve documentation about launchers #391

Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ce79700
Improve documentation about launchers
nephros Jan 31, 2024
3fa725d
Add X-Maemo-Fixed-Args
nephros Jan 31, 2024
ff70a99
Rework translations section, iuse Amber variants
nephros Feb 7, 2024
3732bcb
Add Legacy section
nephros Feb 7, 2024
36af9d0
Improve "hide" section
nephros Feb 7, 2024
6c518c6
fixup! Rework translations section, iuse Amber variants
nephros Feb 7, 2024
d8d9a97
Drop details about L10N, add reference to existing doc.
nephros Feb 7, 2024
2a88086
Add note about sandboxing and boosters
nephros Feb 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
42 changes: 42 additions & 0 deletions Reference/Core_Areas_and_APIs/Apps_and_MW/Lipstick/Launchers/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,30 @@ They are read by [Lipstick](/Reference/Core_Areas_and_APIs/Apps_and_MW/Lipstick/
Desktop Entry Specification allows extending the specification with product specific keys. Sailfish
OS uses that to specify some extensions to support certain functions better.

### Launcher and Booster Type
_X-Nemo-Application-Type_, and _X-Nemo-Single-Instance_ can be used instead
of giving the the `--single-instance`, and `--type` options to invoker in the
_Exec_ key.
Note however that _X-Nemo-Application-Type_ will have no effect for sandboxed
apps, which will always be treated as _generic_.

See the documentation for SailJail, Invoker, and the
[Harbour FAQ](https://harbour.jolla.com/faq#.desktop-Files) for more.

### Hiding app from launcher grid
To hide an desktop entry form the Launcher Grid, use _NoDisplay=true_.
This is mainly useful for registering a MIME Type launchers.

In case of multi-platform apps sharing the same .desktop file, app developers
can use _NotShowIn=X-MeeGo_, to hide the launcher only in Sailfish OS.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Uh, think we could avoid meego references at this point. If needed it should be easy to add sailfish specific NotShownIn option, but then again is there actual need to have this? Unlike on linux desktop where one can change the desktop environment the sailfish apps are executed in more controlled environment. If a .desktop is not wanted to be visible as launcher, why include it in the rpm at all?


### Localization
In addition to the _Name[xx]_ method from the Desktop spec, launcher names can
be localized using an existing Qt translation (.qm) file.

See [I18N Documentation](Reference/I18n/I18n_Conventions/#application-names)
about the keys _X-Amber-Translation-Catalog_ and _X-Amber-Logical-Id-*_.

### Application sandboxing profile
Application developers can control their app's
[sandbox](https://github.com/sailfishos/sailjail-permissions#sailfish-os-application-sandboxing-and-permissions)
Expand Down Expand Up @@ -70,3 +94,21 @@ In Sailfish OS 4.3.0 _ExecDBus_ is not considered when validating the arguments
launched via D-Bus which limits usefulness of that key. To work around that, the launch arguments
used for D-Bus activation must match _Exec_ key in _Desktop Entry_ section. This issue is fixed in
Sailfish OS 4.4.0.

## D-Bus method calls
The keys _X-Maemo-Service_, _X-Maemo-Object-Path_, _X-Maemo-Method_ can be
used to specify a D-Bus method on a certain object path, which is called when
the launcher is activated.

The optional _X-Maemo-Fixed-Args_ tag can pass arguments to the call.

This is similar to, but different from D-Bus activation above. The D-Bus
Service must already be registered (e.g. using the method above, or from the app
after launch), and `path` and `method` must exist for that service.

This is used e.g. by MimeType .desktop files to open an app at a certain page.

## Legacy and Deprecated

- _X-MeeGo-Translation-Catalog_ and _X-MeeGo-Logical-Id_. Used for translations. Replaced by the _X-Amber-_ variants.