uk.half-shot.matrix-hookshot.feed: add template variations

This commit is contained in:
Aminda Suomalainen 2023-05-05 10:42:11 +03:00
parent dd0b7da6fe
commit 120117aa58
Signed by: Mikaela
SSH Key Fingerprint: SHA256:CXLULpqNBdUKB6E6fLA1b/4SzG0HvKD19PbIePU175Q

View File

@ -13,6 +13,7 @@ perform two state installations/directories/whatever:
<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE --> <!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
- [feed](#feed) - [feed](#feed)
- [Template variations](#template-variations)
- [installation](#installation) - [installation](#installation)
- [Usage without integration manager](#usage-without-integration-manager) - [Usage without integration manager](#usage-without-integration-manager)
@ -29,16 +30,23 @@ contains:
```json ```json
{ {
"label": "YLE News in English", "label": "YLE News in English",
"template": "$FEEDTITLE: $AUTHOR $LINK \n $SUMMARY", "template": "$FEEDTITLE: $AUTHOR $LINK ($DATE) $SUMMARY",
"url": "https://feeds.yle.fi/uutiset/v1/recent.rss?publisherIds=YLE_NEWS" "url": "https://feeds.yle.fi/uutiset/v1/recent.rss?publisherIds=YLE_NEWS"
} }
``` ```
- `"template"` is optional and defaults to `New post in $FEEDNAME: $LINK` - `"template"` is optional and defaults to `New post in $FEEDNAME: $LINK`
- Note: `$LINK` actually means `[$TITLE](LINK)`. - Note: `$LINK` actually means `[$TITLE](LINK)`. `$URL` is just the link.
[#731](https://github.com/matrix-org/matrix-hookshot/issues/731)
- [Upstream documentation](https://matrix-org.github.io/matrix-hookshot/latest/setup/feeds.html#feed-templates) - [Upstream documentation](https://matrix-org.github.io/matrix-hookshot/latest/setup/feeds.html#feed-templates)
### Template variations
This contains the whole JSON line to easen copy-pasting as my events are missing it entirely.
- default: `"template": "New post in $FEEDNAME: $LINK",`
- Matrix: `"template": "$FEEDTITLE: $AUTHOR $LINK ($DATE) $SUMMARY",`
- IRC: `"template": "$URL $FEEDTITLE: $AUTHOR ($DATE) $SUMMARY",`
## installation ## installation
This probably has or should be left for the integration manager. This probably has or should be left for the integration manager.