Document resource source management and browsing in framework 0.7.0

This commit is contained in:
Dymas committed 2026-10-29 14:09:51 +01:00
1 parent 494651e118
commit 5c709e81ef
2 files changed
+8 -1

No files matched your search

+1 -1
View File
@@ -2,7 +2,7 @@
Plugins and themes for [Web Framework](https://gitea.coreplay.eu/Dymas/web-framework).
In **Config → Add resources**, install a resource, restart the app, then enable the plugin or select the theme.
In **Config → Add resources → Plugins** or **Themes**, install a resource, restart the app, then enable the plugin or select the theme. Manage catalogs under **Sources** (framework 0.7.0+).
- Plugins: Notes, Bookmarks, Workspace status, and **Queue**.
- Themes: Default, Ocean, and Mint.
+7
View File
@@ -24,3 +24,10 @@ To update, stop the workspace, back up the resource folder, verify a newer archi
Store newly developed plugins and themes here with all required helpers, templates, and assets in their own subfolder. Increment the resource version, build its complete ZIP, and update `catalog.json` with schema version 1. Commit source, archive, and catalog together. Keep old versioned archives for existing installations. Publish catalogs and archives for unauthenticated read access; never include secrets.
The initial six starter resources can be regenerated with `PYTHONPATH=. python tools/prepare_resources.py /path/to/web-framework-resources` from the framework repository. The exporter refreshes bundled source directories and retains independently developed resources in the catalog. `python tools/build_catalog.py` builds every source resource without replacing bundled source. Only configure trusted repositories: plugin code runs with the application user's privileges after restart.
## Resource browsing in framework 0.7.0+
Config → Add resources provides Sources, Themes, and Plugins subtabs. Sources offers the built-in Web Framework Resources catalog plus additional HTTP(S) catalog URLs, one per line. At least one source is required, with a maximum of 20. Source changes require `plugins.manage` and CSRF, persist in encrypted settings, and apply immediately to browsing, installation, and update checks. The built-in source can be deselected when using another source. Invalid source changes preserve the previous configuration; the source screen does not fetch catalogs.
Themes and Plugins remember independent browser-session searches and show responsive tiles. Installed resources are highlighted green and sorted first, then alphabetically; available resources use a plain Install button. Installation retains the selected subtab and search. The main Config → Themes page also uses green installed tiles and places the active template first. Detailed implementation reference: [framework resource functions](https://gitea.coreplay.eu/Dymas/web-framework/wiki/functions).