[teams/eco/feep] measurements/okular/2026-06-24/blue-angel-documentation: added English version of software documentation
Joseph P. De Veaugh-Geiss <[email protected]>
| Newsgroups | gmane.comp.kde.cvs |
|---|---|
| Message-ID | <[email protected]> |
Git commit 9d9d73372ed87f278e05ef76bface0ecfa40d680 by Joseph P. De Veaugh-Geiss. Committed on 18/08/2026 at 18:31. Pushed by joseph into branch 'master'. added English version of software documentation A +198 -0 measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.md A +- -- measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.odt A +- -- measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.pdf https://invent.kde.org/teams/eco/feep/-/commit/9d9d73372ed87f278e05ef76bface0ecfa40d680 diff --git a/measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.md b/measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.md new file mode 100644 index 0000000..cfb34e0 --- /dev/null +++ b/measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.md @@ -0,0 +1,198 @@ +# 3.1.3.7 Software Product Documentation + +## Requirements + +a) Minimum system requirements (see Section 3.1.1.1) +b) Documentation of the measurement system (see Section 3.1.1.2) +c) Measurement results in idle mode (see Section 3.1.1.3) +d) Measurement results during use (see Section 3.1.1.4) +e) Calendar year and backward compatibility data (see Section 3.1.2.1) +f) Documentation of data formats (see Section 3.1.3.1) +g) Interface documentation, software source code (if applicable), and software licenses (see Section 3.1.3.2) +h) Information on software updates (see Section 3.1.3.3) +i) Description of the uninstallation process (see Section 3.1.3.4) +j) Information on modularity and on reducing resource consumption (see Section 3.1.3.5) +k) List of permitted tracking functions and, if applicable, instructions for disabling them (see Section 3.1.3.6) + +### Links + +* Reports, data, standard usage scenario script, and description of the workflow of actions, etc. (Measurement: 24 June 2026): <https://invent.kde.org/teams/eco/feep/-/tree/master/measurements/okular/2026-06-24/> + +* KEcoLab measurement lab software stack: <https://invent.kde.org/sdk/kecolab> + +### Minimum system requirements (see Section 3.1.1.1) + +The lab PC runs Fedora Linux 44 (KDE Plasma Desktop Edition). The minimum system requirements for Fedora can be found here: + + <https://docs.fedoraproject.org/en-US/fedora/latest/release-notes/hardware_overview/> + +* 2GHz dual core processor or faster +* 2GB System Memory +* 15GB unallocated drive space + +Okular itself already runs on hardware with significantly lower system requirements. This is illustrated by the fact that Okular is available on the Haiku operating system, which has the following minimum system requirements: + + <https://www.haiku-os.org/about/faq/#what-are-the-minimum-hardware-requirements-to-run-haiku> + +* Pentium4 with 512 MiB of RAM +* 3 GiB of storage space + +You can find Okular for Haiku here: + + <https://github.com/haikuports/haikuports/tree/master/kde-apps/okular> + +Additional Information: + +* Software requirements: Okular runs on all common operating systems: <https://okular.kde.org/download/>. There are no additional software requirements. +* List of external services required to run the software that are not available on the measurement system: none +* List of required additional hardware (e.g., graphics card, peripherals such as a USB-connected camera): none + +### Documentation of the measurement system (see Section 3.1.1.2) + +* **Specifications of the Measurement Systems Used**: + - **Year**: 2019 + - **Model**: Fujitsu Esprimo P957 Tower + - **Processor**: Intel i5-6500 + - **Processor cores**: 4 + - **Clock speed**: 3.20 GHz + - **RAM**: 16 GB (DDR4) + - **Hard drive**: 256 GB SSD + - **Graphics card**: Intel HD Graphics 530 + - **Network**: Gigabit LAN + - **Operating system**: Fedora Linux 44 (KDE Plasma Desktop Edition) + +* **Type of measurement**: Scenario test + +* **Name and brief description of the measurement method**: The measurement method complies with the Blue Angel Criteria, Version 1, for software products. A "System Under Test" (SUT) is connected to an external power meter. A script designed to emulate a standard usage scenario executes a sequence of actions to replicate typical software usage (opening a PDF, jumping to a page, scrolling forward and backward, adding annotations, inverting colors, zooming in and out, etc.). + +* **List of measurement devices**: Gude Expert Power Control 1202 series + +* **List of automation software**: `ydotool` and `kdotool` + +* **Confirmation of tolerance requirements**: A script that runs the same software was used for all measurements. The scripts, log files, data, and description of the workflow for the most recent measurement are available here: <https://invent.kde.org/teams/eco/feep/-/tree/master/measurements/okular/2026-06-24/>. During the measurements, the first two runs of the script were verified via a remote connection using RDP. + +* **List of measurements performed**: Base load, idle mode, scenario test + +* **Measurement data**: Duration is 219 seconds. The standard usage scenario was run 30 times, while the base load and idle mode were each run 10 times. + +* **Description of preparatory work**: + + - Before each execution of the script, the relevant configuration files are deleted. These include: + + `~/.var/app/org.kde.okular/config/okularrc` + + `~/.var/app/org.kde.okular/config/okularpartrc` + + `~/.var/app/org.kde.okular/cache/*` + + `~/.var/app/org.kde.okular/data/okular/docdata/` + + - The following shortcuts must be configured. This is done automatically by the script based on the shortcuts defined in this configuration file: `~/.var/app/org.kde.okular/data/kxmlgui5/okular/part.rc`. + + Rotate Left: `Alt+l` + + Rotate Right: `Alt+r` + + Invert color: `Alt+i` + + Fit width: `Ctrl+Shift+w` + + Single page mode: `Ctrl+Alt+s` + +### Measurement results in idle mode (see Section 3.1.1.3) + +* **Average processor utilization (%)**: 0.1202% + +* **Average RAM usage (MB)**: 0.0570227128593153 MB + +* **Average permanent storage usage (MB/s)**: 0.5331 MB/s + +* **Average bandwidth used for data transfer (Mbit/s)**: Okular is designed entirely for offline use. The network activity during idle time was due to background activity of the operating system (e.g., checking for available updates). + +* **Average power consumption (W) (calculated if applicable)**: 0.0 W + +* **List of all visited web addresses**: No network access is required. The network data during idle time was due to background activity of the operating system (e.g., checking for available updates). + +### Measurement results during use (see Section 3.1.1.4) + +* **Processor Load (%/s)**: 549.2225 %/s + +* **Memory Load (MB/s)**: 94.4266 MB/s + +* **Permanent storage usage (read and write) (MByte/s\*s)**: 396.0455 MByte/s\*s + +* **Data transferred outside the local network (Mbit/s\*s)**: Okular is fully designed for offline use. The network data during the SUS measurement was attributable either to background activity of the operating system (e.g., checking for available updates) or to the remote connection via RDP for monitoring the first two iterations. + +* **Energy consumption (Wh) (net during scenario test)**: 0.025 Wh + +* **List of all accessed Internet addresses**: No network access is required. The network data recorded during the SUS measurement was attributable to background activity of the operating system (e.g., checking for available updates). + +### Calendar year and backward compatibility data (see Section 3.1.2.1) + +Okular's backward compatibility depends on the system requirements of the operating system on which it runs. For example, the Haiku operating system supports Okular, and Haiku runs on computers that are over 20 years old. Based on this, it can be said that Okular runs on computers that are significantly older than 5 years. + +### Documentation of data formats (see Section 3.1.3.1) + +The supported data formats are documented at <https://okular.kde.org/formats>. + +Here are the specifications for the supported formats: + +* [PDF](https://www.iso.org/standard/51502.html) +* [PostScript](https://www.adobe.com/jp/print/postscript/pdfs/PLRM.pdf) +* [TIFF](https://www.iso.org/standard/34342.html) +* [CHM](http://www.russotto.net/chm/chmformat.html) +* [DjVu](http://www.djvu.org/) +* Various image formats ([JPEG](https://jpeg.org/jpeg/index.html), [PNG](https://www.w3.org/TR/2003/REC-PNG-20031110/), etc.) +* [DVI](https://ctan.org/pkg/dvitype) +* [XPS](https://www.ecma-international.org/publications-and-standards/standards/ecma-388/) +* [ODT](https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=office) +* [Fiction Book](http://gribuser.ru/xml/fictionbook/index.html.en) +* [Comic Book](https://en.wikipedia.org/wiki/Comic_book_archive) +* [Plucker](http://www.fifi.org/doc/plucker/manual/DBFormat.html) +* [EPUB](https://www.w3.org/publishing/epub3/) +* [Mobipocket](https://www.loc.gov/preservation/digital/formats/fdd/fdd000472.shtml) + +The exact details of each format can be viewed in full, since the source code for each implementation is available as open source. + +### Interface documentation, software source code (if applicable), and software licenses (see Section 3.1.3.2) + +Okular is released as Open Source Software under the GPL v2 license. The source code has always been fully transparent, and development takes place publicly. All APIs are documented. The source code can be viewed and modified by any user. + +* [Okular API documentation](https://api.kde.org/okular/html/index.html) +* [Okular source code](https://invent.kde.org/graphics/okular) +* [Okular license](https://invent.kde.org/graphics/okular/-/blob/master/COPYING) + +### Information on software updates (see Section 3.1.3.3) + +As an Open Source Software product, Okular has a 20-year history of continuous incremental updates, which began in 2006. See the [complete list of release announcements](https://okular.kde.org/news/). All updates have been released free of charge and will continue to be made available free of charge in the future. + +Okular is released as part of the collection of KDE applications published by the KDE Project according to a [4-month release schedule](https://community.kde.org/Schedules). Since April 2021, this collection has been called "KDE Gear". In previous years, it was primarily known as "KDE Applications". This release schedule is maintained by the KDE community and supported by KDE e.V. The community has committed to continuing this indefinitely. + +Since the source code is released as Open Source Software, others will always be able to adopt and further develop versions of Okular. Okular is shipped with many Linux distributions, which offer varying levels of support. Some distributions offer multi-year support plans. See also the [packaging status](https://okular.kde.org/download/). + +The Open Source nature of the code, the established, sustainable community, and the organization behind it, which are, by their very nature, less vulnerable to economic challenges than commercial enterprises, as well as the variety of third-party providers that distribute Okular in various forms, guarantee the continuity of Okular as a software product over a long period of time, extending far beyond a 5-year horizon. + +The continuous incremental releases ensure that users reliably receive a fully functional product with the latest security updates. This also includes the changes necessary to adapt to new versions of dependencies that address security-related issues. + +Since the code is released as Open Source Software, users also always have the option to maintain their own branch of Okular, backport the necessary fixes, or add their own. This could also be handled by one of the many distributors that provide versions of Okular for those users who are unable or unwilling to do so themselves. + +### Description of the uninstallation process (see Section 3.1.3.4) + +Okular can be uninstalled without leaving any residual files on the system. The exact procedure depends on how the program was installed. + +When installing from source code, CMake generates a list of files to be deleted, which can be handled with a simple shell script. Users who install from source code can do this without any problems. + +When installing binary packages, follow the package provider's instructions. Linux distributions typically provide a command-line tool that includes an uninstall command. They also usually offer graphical applications for uninstalling packages. + +For example, the uninstallation instructions for the Flatpak package manager, which is referenced on the Okular website under the [Download page](https://okular.kde.org/download/), can be found in the [Flatpak documentation](https://docs.flatpak.org/en/latest/using-flatpak.html#remove-an-application). + +The data processed by Okular is completely separate from the program. It is under the users' full control. If the program is uninstalled, all data created by the user remains unaffected. + +### Information on modularity and on reducing resource consumption (see Section 3.1.3.5) + +Okular is a specialized application designed exclusively as a document viewer. It is typically used as a modular component of a desktop environment, often the KDE Plasma desktop, but also desktop environments on other platforms. It has no additional modules unrelated to its core functionality, such as tracking or cloud integration, etc. + +When installed from source code, it can be configured for the platform on which it is to run, and optional features are only included if the corresponding dependencies, such as a text-to-speech system, are available. Technical details are available in the [build control file](https://invent.kde.org/graphics/okular/-/blob/master/CMakeLists.txt). + +When Okular is installed via packages created by Linux distributions or other package providers, these are typically modular in design, so that, for example, translations of the user interface or the manuals can be installed separately and according to the user’s chosen configuration. Example: [openSUSE](https://en.opensuse.org/Okular#Modules). + +Okular is designed to use resources efficiently. It focuses on the core functionality of document display and does not include any features that would consume resources beyond what is necessary for this core purpose. Information on how certain configuration parameters can affect performance and resource usage is documented in the manual: <https://docs.kde.org/stable5/en/okular/okular/configperformance.html>. + +### List of permitted tracking functions and, if applicable, instructions for disabling them (see Section 3.1.3.6) + +By default, no personal data is collected. Okular fully complies with applicable data protection laws. + +Complete documentation on data handling can be found in the KDE Privacy Policy: <https://kde.org/privacypolicy-apps/>. It also refers to the KDE Telemetry Policy, which describes how telemetry data is collected in a way that fully protects user privacy: <https://community.kde.org/Policies/Telemetry_Policy>. + +Okular does not collect any personally identifiable information and, in particular, does not transmit any data to other systems or third parties. There is neither advertising nor user tracking. Users always have full control over what they do with their data. diff --git a/measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.odt b/measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.odt new file mode 100644 index 0000000..27d9f56 Binary files /dev/null and b/measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.odt differ diff --git a/measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.pdf b/measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.pdf new file mode 100644 index 0000000..a7a42e1 Binary files /dev/null and b/measurements/okular/2026-06-24/blue-angel-documentation/de-uz-215-en-3.1.3.7-Software-Product-Documentation.pdf differ