calamares: branding and modules configuration updates

calamares/etc/calamares/branding/openmamba/branding.desc

@@ -1,6 +1,66 @@
+# Product branding information. This influences some global
+# user-visible aspects of Calamares, such as the product
+# name, window behavior, and the slideshow during installation.
+#
+# Additional styling can be done using the stylesheet.qss
+# file, also in the branding directory.
 ---
 componentName:  openmamba
 
+# This selects between different welcome texts. When false, uses
+# the traditional "Welcome to the %1 installer.", and when true,
+# uses "Welcome to the Calamares installer for %1." This allows
+# to distinguish this installer from other installers for the
+# same distribution.
+welcomeStyleCalamares:   false
+
+# Should the welcome image (productWelcome, below) be scaled
+# up beyond its natural size? If false, the image does not grow
+# with the window but remains the same size throughout (this
+# may have surprising effects on HiDPI monitors).
+welcomeExpandingLogo:   true
+
+# Size and expansion policy for Calamares.
+#  - "normal" or unset, expand as needed, use *windowSize*
+#  - "fullscreen", start as large as possible, ignore *windowSize*
+#  - "noexpand", don't expand automatically, use *windowSize*
+windowExpanding:    normal
+
+# Size of Calamares window, expressed as w,h. Both w and h
+# may be either pixels (suffix px) or font-units (suffix em).
+#   e.g.    "800px,600px"
+#           "60em,480px"
+# This setting is ignored if "fullscreen" is selected for
+# *windowExpanding*, above. If not set, use constants defined
+# in CalamaresUtilsGui, 800x520.
+windowSize: 800px,520px
+
+# These are strings shown to the user in the user interface.
+# There is no provision for translating them -- since they
+# are names, the string is included as-is.
+#
+# The four Url strings are the Urls used by the buttons in
+# the welcome screen, and are not shown to the user. Clicking
+# on the "Support" button, for instance, opens the link supportUrl.
+# If a Url is empty, the corresponding button is not shown.
+#
+# bootloaderEntryName is how this installation / distro is named
+# in the boot loader (e.g. in the GRUB menu).
+#
+# These strings support substitution from /etc/os-release
+# if KDE Frameworks 5.58 are available at build-time. When
+# enabled, @{var-name} is replaced by the equivalent value
+# from os-release. All the supported var-names are in all-caps,
+# and are listed on the FreeDesktop.org site,
+#       https://www.freedesktop.org/software/systemd/man/os-release.html
+# Note that ANSI_COLOR and CPE_NAME don't make sense here, and
+# are not supported (the rest are). Remember to quote the string
+# if it contains substitutions, or you'll get YAML exceptions.
+#
+# The *Url* entries are used on the welcome page, and they
+# are visible as buttons there if the corresponding *show* keys
+# are set to "true" (they can also be overridden).
+
 strings:
     productName:         openmamba GNU/Linux
     shortProductName:    openmamba
@@ -9,18 +69,58 @@ strings:
     versionedName:       openmamba GNU/Linux milestone4 4.0 for x86_64
     shortVersionedName:  openmamba 4.0
     bootloaderEntryName: openmamba
-    productUrl:          http://openmamba.org/
+    productUrl:          https://openmamba.org/
-    supportUrl:          http://forum.openmamba.org/
+    supportUrl:          https://forum.openmamba.org/
-    knownIssuesUrl:      http://bugs.openmamba.org/
+    knownIssuesUrl:      https://bugs.openmamba.org/
-    releaseNotesUrl:     http://openmamba.org/news/
+    releaseNotesUrl:     https://openmamba.org/news/
 
+# These images are loaded from the branding module directory.
+#
+# productIcon is used as the window icon, and will (usually) be used
+#       by the window manager to represent the application. This image
+#       should be square, and may be displayed by the window manager
+#       as small as 16x16 (but possibly larger).
+# productLogo is used as the logo at the top of the left-hand column
+#       which shows the steps to be taken. The image should be square,
+#       and is displayed at 80x80 pixels (also on HiDPI).
+# productWelcome is shown on the welcome page of the application in
+#       the middle of the window, below the welcome text. It can be
+#       any size and proportion, and will be scaled to fit inside
+#       the window. Use `welcomeExpandingLogo` to make it non-scaled.
+#       Recommended size is 320x150.
+#
+# These filenames can also use substitutions from os-release (see above).
 images:
     productLogo:         "openmamba.png"
     productIcon:         "openmamba.png"
     productWelcome:      "welcome.png"
 
+# The slideshow is displayed during execution steps (e.g. when the
+# installer is actually writing to disk and doing other slow things).
 slideshow:               "show.qml"
+# There are two available APIs for the slideshow:
+#  - 1 (the default) loads the entire slideshow when the installation-
+#      slideshow page is shown and starts the QML then. The QML
+#      is never stopped (after installation is done, times etc.
+#      continue to fire).
+#  - 2 loads the slideshow on startup and calls onActivate() and
+#      onLeave() in the root object. After the installation is done,
+#      the show is stopped (first by calling onLeave(), then destroying
+#      the QML components).
+slideshowAPI: 2
 
+
+# Colors for text and background components.
+#
+#  - sidebarBackground is the background of the sidebar
+#  - sidebarText is the (foreground) text color
+#  - sidebarTextHighlight sets the background of the selected (current) step.
+#    Optional, and defaults to the application palette.
+#  - sidebarSelect is the text color of the selected step.
+#
+# These colors can **also** be set through the stylesheet, if the
+# branding component also ships a stylesheet.qss. Then they are
+# the corresponding CSS attributes of #sidebarApp.
 style:
    sidebarBackground:    "#666666"
    sidebarText:          "#FFFFFF"

calamares/etc/calamares/branding/openmamba/show.qml

@@ -48,16 +48,16 @@ Presentation
         Text {
             anchors.horizontalCenter: background1.horizontalCenter
             anchors.top: parent.top
-            text: "<h2>Thanks for choosing openmamba!</h2><br/><br/>"
+            text: "<h2>" + qsTr("Thanks for choosing openmamba!") + "</h2><br/><br/>"
             wrapMode: Text.WordWrap
             horizontalAlignment: Text.Center
         }
         Text {
             anchors.horizontalCenter: background1.horizontalCenter
             anchors.top: background1.bottom
-            text: "<br/><b>openmamba with KDE</b><br/><br/>"+
+            text: "<br/><b>" + qsTr("openmamba with KDE Plasma") + "</b><br/><br/>" +
-                  "The most evolved and complete desktop system of openmamba, KDE based.<br/>"+
+                  qsTr("The most evolved and complete desktop system of openmamba, KDE based.") + "<br/>"+
-                  "For every user who wants a modern, multimedia and productive desktop.<br/>"
+                  qsTr("For every user who wants a modern, multimedia and productive desktop.") + "<br/>"
             wrapMode: Text.WordWrap
             horizontalAlignment: Text.Center
         }
@@ -81,49 +81,16 @@ Presentation
         Text {
             anchors.horizontalCenter: background2.horizontalCenter
             anchors.top: parent.top
-            text: "<h2>Thanks for choosing openmamba!</h2><br/><br/>"
+            text: "<h2>" + qsTr("Thanks for choosing openmamba!") + "</h2><br/><br/>"
             wrapMode: Text.WordWrap
             horizontalAlignment: Text.Center
         }
         Text {
             anchors.horizontalCenter: background2.horizontalCenter
             anchors.top: background2.bottom
-            text: "<br/><b>openmamba with LXDE</b><br/><br/>"+
+            text: "<br/><b>" + qsTr("openmamba with LXDE") + "</b><br/><br/>" +
-                  "openmamba system with a simple and light desktop.<br/>"+
+                  qsTr("openmamba system with a simple and light desktop.") + "<br/>" +
-                  "For server installation or desktop on obsolete PC, embedded systems, tablet, single-board PC.<br/>"
+                  qsTr("For server installation or desktop on obsolete PC, embedded systems, tablet, single-board PC.") + "<br/>"
-            wrapMode: Text.WordWrap
-            horizontalAlignment: Text.Center
-        }
-    }
-
-    Slide {
-        Image {
-            id: background03
-            source: "background.jpg"
-            width: 1920; height: 1200
-            fillMode: Image.PreserveAspectFit
-            anchors.centerIn: parent
-        }
-        Image {
-            id: background3
-            source: "desktop-gnome-300x225.jpg"
-            width: 300; height: 225
-            fillMode: Image.PreserveAspectFit
-            anchors.centerIn: parent
-        }
-        Text {
-            anchors.horizontalCenter: background3.horizontalCenter
-            anchors.top: parent.top
-            text: "<h2>Thanks for choosing openmamba!</h2><br/><br/>"
-            wrapMode: Text.WordWrap
-            horizontalAlignment: Text.Center
-        }
-        Text {
-            anchors.horizontalCenter: background3.horizontalCenter
-            anchors.top: background3.bottom
-            text: "<br/><b>openmamba with GNOME</b><br/><br/>"+
-                  "openmamba system with GNOME desktop.<br/>"+
-                  "For users who prefer a different desktop place without relinquishing openmamba system.</br>"
             wrapMode: Text.WordWrap
             horizontalAlignment: Text.Center
         }

calamares/etc/calamares/branding/openmamba/stylesheet.qss

@@ -0,0 +1,41 @@
+/*
+
+A branding component can ship a stylesheet (like this one)
+which is applied to parts of the Calamares user-interface.
+In principle, all parts can be styled through CSS.
+Missing parts should be filed as issues.
+
+The IDs are based on the object names in the C++ code.
+
+Documentation for styling Qt Widgets through a stylesheet
+can be found at
+    https://doc.qt.io/qt-5/stylesheet-examples.html
+In Calamares, styling widget classes is supported (e.g.
+using `QComboBox` as a selector). You can also use specific
+object names (ids), which you can find through debugging tools.
+
+*/
+
+/* Main application window.
+
+#mainApp { }
+#logoApp { }
+#sidebarApp { }
+#sidebarMenuApp { }
+*/
+
+/* Partitioning module.
+
+#bootInfoIcon { }
+#bootInfoLable { }
+#deviceInfoIcon { }
+#defineInfoLabel { }
+#scrollAreaWidgetContents { }
+#partitionBarView { }
+*/
+
+/* Licensing module.
+
+#licenseItem {  }
+#licenseItemFullText {  }
+*/

calamares/etc/calamares/modules/finished.conf

@@ -1,19 +1,42 @@
 # Configuration for the "finished" page, which is usually shown only at
 # the end of the installation (successful or not).
 ---
+# DEPRECATED
+#
 # The finished page can hold a "restart system now" checkbox.
 # If this is false, no checkbox is shown and the system is not restarted
 # when Calamares exits.
-restartNowEnabled: true
+# restartNowEnabled: true
 
+# DEPRECATED
+#
 # Initial state of the checkbox "restart now". Only relevant when the
 # checkbox is shown by restartNowEnabled.
-restartNowChecked: false
+# restartNowChecked: false
+
+# Behavior of the "restart system now" button.
+#
+# There are four usable values:
+#   - never
+#       Does not show the button and does not restart.
+#       This matches the old behavior with restartNowEnabled=false.
+#   - user-unchecked
+#       Shows the button, defaults to unchecked, restarts if it is checked.
+#       This matches the old behavior with restartNowEnabled=true and restartNowChecked=false.
+#   - user-checked
+#       Shows the button, defaults to checked, restarts if it is checked.
+#       This matches the old behavior with restartNowEnabled=true and restartNowChecked=true.
+#   - always
+#       Shows the button, checked, but the user cannot change it.
+#       This is new behavior.
+#
+# The three combinations of legacy values are still supported.
+restartNowMode: user-checked
 
 # If the checkbox is shown, and the checkbox is checked, then when
 # Calamares exits from the finished-page it will run this command.
 # If not set, falls back to "shutdown -r now".
-restartNowCommand: "/bin/systemctl -i reboot"
+restartNowCommand: "systemctl -i reboot"
 
 # When the last page is (successfully) reached, send a DBus notification
 # to the desktop that the installation is done. This works only if the

calamares/etc/calamares/modules/machineid.conf

@@ -1,8 +1,24 @@
+# Machine-ID and other random data on the target system.
+#
+# This module can create a number of "random" things on the target:
+#  - a systemd machine-id file (hence the name of the Calamares module)
+#    with a random UUID.
+#  - a dbus machine-id file (or, optionally, link to the one from systemd)
+#  - an entropy file
+#
 ---
 # Whether to create /etc/machine-id for systemd.
 systemd: true
+
 # Whether to create /var/lib/dbus/machine-id for D-Bus.
 dbus: true
 # Whether /var/lib/dbus/machine-id should be a symlink to /etc/machine-id
 # (ignored if dbus is false, or if there is no /etc/machine-id to point to).
+dbus-symlink: true
+# this is a deprecated form of *dbus-symlink*
 symlink: true
+
+# Whether to create an entropy file
+entropy: false
+# Whether to copy entropy from the host
+entropy-copy: false