Skip to content

Commit d72f048

Browse files
committed
Add correct newspopup plugin README
1 parent a48ae09 commit d72f048

File tree

1 file changed

+16
-10
lines changed

1 file changed

+16
-10
lines changed

src/plugins/newspopup/README.md

Lines changed: 16 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,25 @@
1-
Config Editor Plugin
2-
====================
3-
4-
This plugin adds editors for the input configs `tenantConfig.json` and `config.json` to the Admin GUI.
5-
6-
Uses Ace v1.4.14 code editor from https://ace.c9.io
1+
NewsPopup Plugin
2+
================
73

4+
This plugin adds an editor for editing the contents of the `NewsPopup` displayed in QWC2.
85

96
Usage
107
=====
118

12-
Enable this plugin by setting the following options in the `config` block of the `adminGui` section of the `tenantConfig.json`:
9+
Make sure the `NewsPopup` plugin is enabled in your QWC2 `config.json`. Then, enable this plugin by setting the following options in the `config` block of the `adminGui` section of the `tenantConfig.json`:
10+
11+
```json
12+
"plugins": ["newspopup"],
13+
"news_file": "<path_to_news.html>",
14+
"viewer_config_file": "<path_to_config.json>"
15+
```
1316

17+
For example
1418
```json
15-
"plugins": ["config_editor"],
16-
"input_config_path": "<path to the input configs>"
19+
"news_file": "/qwc2/assets/news.html",
20+
"viewer_config_file": "/qwc2/config.json"
1721
```
1822

19-
The Admin GUI requires write access to the `input_config_path`.
23+
The plugin requires write access to the files specified by `news_file` and `viewer_config_file` (i.e. the files need to be mounted read-write into the container).
24+
25+
The plugin will display an editor to modify the contents of `news_file` and update the `NewsPopup` plugin configuration in `viewer_config_file`.

0 commit comments

Comments
 (0)