wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

apply changes from code review

Browse source
This commit is contained in:
Hubert Chathi 2022-11-01 11:39:15 -04:00
parent 60d9518a63
commit d0d7bdb807
3 changed files with 18 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

19
layouts/shortcodes/event.html
View file

@ -2,10 +2,23 @@
This template is used to render an event.
It expects to be passed an `event` parameter, which is the name of a schema file under
"data/event-schemas/schema". The file extension is omitted. For example:
It takes the following parameters:
{{% event event="m.accepted_terms" %}}
* `event` (required): the name of a schema file under "data/event-schemas/schema".
The file extension is omitted. For example:
{{% event event="m.accepted_terms" %}}
* `desired_example_name` (optional): the name of the example file to use under
"data/event-schemas/examples", without the file extension. If omitted
defaults to the example file with the same name as the `event` parameter, and
(if the name does not contain a "$"), all examples that begin with the name
given by the `event` parameter followed by a "$". For example, if the
`event` parameter is "m.foo", then by default it will include the "m.foo"
example along with any examples starting with "m.foo$".
* `title` (optional): the title to use for the event. Defaults to the name
given in the `event` parameter.
This template replaces the old {{*_event}} template.