Skip to content

Commit 3f57836

Browse files
committed
content: usage: advanced: DIY config style inheriting and auto-saving
1 parent 1df6169 commit 3f57836

2 files changed

Lines changed: 9 additions & 5 deletions

File tree

51.6 KB
Loading

content/usage/advanced/index.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -155,8 +155,8 @@ user (if one exists - otherwise it uses Cockpit's default profiles).
155155
### Profiles
156156

157157
A "profile" is a collection of [views](#views) that are relevant to a particular use-case or vehicle,
158-
together with any configured [custom widgets](#do-it-yourself-widget), [custom Actions](#custom-actions),
159-
and persistent [data-lake](#data-lake) variables.
158+
together with any configured [custom widgets](#do-it-yourself-diy-widget),
159+
[custom Actions](#custom-actions), and persistent [data-lake](#data-lake) variables.
160160

161161
If one control station computer is used for multiple complex use-cases (which each require multiple
162162
separate Views), then they can be separated into Profiles and the most relevant one can be switched
@@ -689,11 +689,15 @@ modifying basic appearance characteristics:
689689
It is possible to change the decimal resolution of the displayed statistics, and the limit the number
690690
of plotted samples to improve visibility and performance.
691691

692-
#### Do It Yourself Widget
692+
#### Do It Yourself (DIY) Widget
693693

694694
- Completely custom elements, code logic, and styling
695695
{{ easy_image(src="diy-widget-config", width=550, center=true) }}
696696
- Runs code automatically when Cockpit starts/refreshes
697+
- Can save and apply updates automatically (while editing), or be configured to only apply changes manually
698+
- Auto-save should generally be disabled while editing JavaScript functionality, but can be convenient
699+
while modifying a widget's visual interface / styling
700+
- Can inherit styles from the Cockpit interface, or use completely independent styles
697701
- Can listen to, create, and modify [data-lake variables](#data-lake), and register and/or execute Actions
698702
using the Cockpit API (`window.cockpit.*`)
699703
- Can be exported to or imported from a JSON file with `"html"`, `"css"`, and `"js"` string fields
@@ -789,8 +793,8 @@ detailed debugging interface provided.
789793
Cockpit's data lake is an accessible data management and storage system.
790794

791795
It is designed to expose Cockpit's internals to the interface (including [displaying](#very-generic-indicators)
792-
and [plotting](#data-plotting)), and for use in user-defined functions (through [custom widgets](#do-it-yourself-widget)
793-
and [custom Actions](#custom-actions)).
796+
and [plotting](#data-plotting)), and for use in user-defined functions (through
797+
[custom widgets](#do-it-yourself-diy-widget) and [custom Actions](#custom-actions)).
794798

795799
The data lake:
796800
- Includes information about Cockpit, the vehicle, video streams, MAVLink telemetry, and widget and Action internals

0 commit comments

Comments
 (0)