napcok/calamares
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[branding] Update documentation

Browse Source 
- mention that translations are included
 - point to external repo for fancy/ example.
This commit is contained in:
Adriaan de Groot 2019-06-16 23:46:32 +02:00
parent a08e764467
commit ef2531b01d
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/branding/README.md
View File

@ -20,7 +20,9 @@ so that it can be run directly from the build directory for testing purposes:
- `default/` is a sample brand for the Generic Linux distribution. It uses - `default/` is a sample brand for the Generic Linux distribution. It uses
the default Calamares icons and a as start-page splash it provides a the default Calamares icons and a as start-page splash it provides a
tag-cloud view of languages. The slideshow is a basic one with a few tag-cloud view of languages. The slideshow is a basic one with a few
slides of text and a single image. No translations are provided. slides of text and a single image. Translations (done by hand, not via
the usual mechanism of Calamares translations) in English, Arabic, Dutch
and French are available.
Since the slideshow can be **any** QML, it is limited only by your designers Since the slideshow can be **any** QML, it is limited only by your designers
imagination and your QML experience. For straightforward presentations, imagination and your QML experience. For straightforward presentations,
@ -37,6 +39,9 @@ Qt translation files are supported (`.ts` sources which get compiled into
`.qm`). Inside the `lang` subdirectory all translation files must be named `.qm`). Inside the `lang` subdirectory all translation files must be named
according to the scheme `calamares-<component name>_<language>.ts`. according to the scheme `calamares-<component name>_<language>.ts`.
The example branding component, called *default*, therefore has translation
files names `calamares-default_nl.ts` (similar for other languages than Dutch).
Text in your `show.qml` (or whatever *slideshow* is set to in the descriptor Text in your `show.qml` (or whatever *slideshow* is set to in the descriptor
file) should be enclosed in this form for translations file) should be enclosed in this form for translations
@ -83,7 +88,8 @@ Generally, you will add a few presentation-level elements first,
then slides. then slides.
- For visible navigation arrows, add elements of class *ForwardButton* and - For visible navigation arrows, add elements of class *ForwardButton* and
*BackwardButton*. Set the *source* property of each to a suitable *BackwardButton*. Set the *source* property of each to a suitable
image. See the `fancy/` example. It is recommended to turn off other image. See the `fancy/` example in the external branding-examples
repository. It is recommended to turn off other
kinds of navigation when visible navigation is used. kinds of navigation when visible navigation is used.
- To indicate where the user is, add an element of class *SlideCounter*. - To indicate where the user is, add an element of class *SlideCounter*.
This indicates in "n / total" form where the user is in the slideshow. This indicates in "n / total" form where the user is in the slideshow.