From c3c845e9d7e334ca60cbdc3c64e819f31e22ca46 Mon Sep 17 00:00:00 2001 From: Adriaan de Groot Date: Tue, 11 Feb 2020 12:29:18 +0100 Subject: [PATCH] [notesqml] Add some more module documentation --- src/modules/notesqml/notesqml.conf | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/src/modules/notesqml/notesqml.conf b/src/modules/notesqml/notesqml.conf index 1dcc25cff..1afd9e682 100644 --- a/src/modules/notesqml/notesqml.conf +++ b/src/modules/notesqml/notesqml.conf @@ -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 # (QRC) which are compiled into the module, or in the branding # setup for Calamares, (or both of them, with branding taking @@ -9,7 +21,7 @@ # QML file for it. # # 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: both @@ -20,6 +32,9 @@ search: both # normally be "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: notes: "Release Notes" notes[nl]: "Opmerkingen"