[notesqml] Add some more module documentation

This commit is contained in:
Adriaan de Groot 2020-02-11 12:29:18 +01:00
parent 4f60a6340e
commit c3c845e9d7

View File

@ -1,3 +1,15 @@
# The *notesqml* module can be used to display a QML file
# as an installer step. This is most useful for release-notes
# and similar somewhat-static content, but if you want to you
# can put SameGame in there as well.
#
# While the module compiles a QML file into a QRC for inclusion
# into the shared library, normal use will configure it with
# an external file, either from Calamares AppData directory or
# from the branding directory.
#
# ---
#
# QML modules can search for the QML inside the Qt resources # QML modules can search for the QML inside the Qt resources
# (QRC) which are compiled into the module, or in the branding # (QRC) which are compiled into the module, or in the branding
# setup for Calamares, (or both of them, with branding taking # setup for Calamares, (or both of them, with branding taking
@ -9,7 +21,7 @@
# QML file for it. # QML file for it.
# #
# To support instanced QML modules, searches in the branding # To support instanced QML modules, searches in the branding
# directory look for the full module@instanceid name as well. # directory look for the full notesqml@instanceid name as well.
--- ---
# Search mode. Valid values are "both", "qrc" and "branding" # Search mode. Valid values are "both", "qrc" and "branding"
search: both search: both
@ -20,6 +32,9 @@ search: both
# normally be "notesqml"). # normally be "notesqml").
#filename: notesqml #filename: notesqml
# This is the name of the module in the progress-tree / sidebar
# in Calamares. To support multiple instances of the QML module,
# the name is configurable and translatable here.
qmlLabel: qmlLabel:
notes: "Release Notes" notes: "Release Notes"
notes[nl]: "Opmerkingen" notes[nl]: "Opmerkingen"