gaja-group
/
element-web
forked from matrix/element-web
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Merge pull request #10418 from vector-im/travis/features 

Describe our existing features better in documentation
This commit is contained in:
Travis Ralston 2019-07-26 08:26:36 -06:00 committed by GitHub
parent 55e2f18d1e 83da5e6004
commit 11c0e982b2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 24 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
config.sample.json
View File

@ -20,8 +20,10 @@
"defaultCountryCode": "GB", "defaultCountryCode": "GB",
"showLabsSettings": false, "showLabsSettings": false,
"features": { "features": {
"feature_groups": "labs", "feature_pinning": "labs",
"feature_pinning": "labs" "feature_custom_status": "labs",
"feature_custom_tags": "labs",
"feature_state_counters": "labs"
}, },
"default_federate": true, "default_federate": true,
"default_theme": "light", "default_theme": "light",

3
docs/config.md
View File

@ -29,8 +29,7 @@ For a good example, see https://riot.im/develop/config.json.
which should take priority and therefore the application cannot continue. which should take priority and therefore the application cannot continue.
1. `features`: Lookup of optional features that may be `enable`d, `disable`d, or exposed to the user 1. `features`: Lookup of optional features that may be `enable`d, `disable`d, or exposed to the user
in the `labs` section of settings. The available optional experimental features vary from in the `labs` section of settings. The available optional experimental features vary from
release to release. Some of the available features are described in the Labs Feature section release to release. The available features are described in [labs.md](labs.md).
of this README.
1. `showLabsSettings`: Shows the "labs" tab of user settings even when no `features` are enabled 1. `showLabsSettings`: Shows the "labs" tab of user settings even when no `features` are enabled
or present. Useful for getting at settings which may be otherwise hidden. or present. Useful for getting at settings which may be otherwise hidden.
1. `brand`: String to pass to your homeserver when configuring email notifications, to let the 1. `brand`: String to pass to your homeserver when configuring email notifications, to let the

23
docs/labs.md
View File

@ -1,12 +1,29 @@
# Labs features # Labs features
Some notes on the features you can enable by going to `Settings->Labs`. Not exhaustive, chat in Some notes on the features you can enable by going to `Settings->Labs`. Not exhaustive, chat in
[#riot-web:matrix.org] for more information. [#riot-web:matrix.org](https://matrix.to/#/#riot-web:matrix.org) for more information.
**Be warned! Labs features are not finalised, they may be fragile, they may change, they may be **Be warned! Labs features are not finalised, they may be fragile, they may change, they may be
dropped. Ask in the room if you are unclear about any details here.** dropped. Ask in the room if you are unclear about any details here.**
## Render simple counters in room header ## Message pinning (`feature_pinning`)
Allows you to pin messages in the room. To pin a message, use the 3 dots to the right of the message
and select "Pin".
## Custom status (`feature_custom_status`)
An experimental approach for supporting custom status messages across DMs. To set a status, click on
your avatar next to the message composer.
## Custom tags (`feature_custom_tags`)
An experimental approach for dealing with custom tags. Custom tags will appear in the bottom portion
of the community filter panel.
Setting custom tags is not supported by Riot.
## Render simple counters in room header (`feature_state_counters`)
Allows rendering of labelled counters above the message list. Allows rendering of labelled counters above the message list.
@ -28,5 +45,3 @@ Once enabled, send a custom state event to a room to set values:
``` ```
That's it. Now should see your new counter under the header. That's it. Now should see your new counter under the header.
[#riot-web:matrix.org]: https://matrix.to/#/#riot-web:matrix.org