Skip to content

Commit 4fe4b80

Browse files
author
Chris Gårdenberg
committed
docs(Shortcodes): Added info about the new shortcode
ref #506
1 parent b51a1b1 commit 4fe4b80

1 file changed

Lines changed: 32 additions & 4 deletions

File tree

new_website/docs/shortcodes.md

Lines changed: 32 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ id: shortcodes
33
title: Shortcodes
44
sidebar_label: Shortcodes
55
---
6+
67
Here we have a complete reference guide to all shortcodes available in the plugin, with all attributes.
78

89
* * *
@@ -229,8 +230,11 @@ results from the API.
229230

230231
You can set the `mode`-attribute to either `event` or `course`, to make the list show events or course templates.
231232

232-
The `orderby`-attribute gives you the possibility to change what field the list should be ordered by. The available fields can be found at https://api.eduadmin.se/?page=read#operation/GetEvents or https://api.eduadmin.se/?page=read#operation/GetCourseTemplates depending on what `mode`-attribute you are using, either `event` or `course`,
233-
and the `order`-attribute takes the values ASC or DESC.
233+
The `orderby`-attribute gives you the possibility to change what field the list should be ordered by. The available
234+
fields can be found at https://api.eduadmin.se/?page=read#operation/GetEvents
235+
or https://api.eduadmin.se/?page=read#operation/GetCourseTemplates depending on what `mode`-attribute you are using,
236+
either `event` or `course`,
237+
and the `order`-attribute takes the values ASC or DESC.
234238

235239
`showsearch` will force the search bar to be visible.
236240

@@ -327,8 +331,7 @@ And if you want to create a specific page for a programme, you can also use the
327331

328332
### `[eduadmin-programme-list]`
329333

330-
As with the normal list view, this view lists the available programmes you have created in [**
331-
EduAdmin**](https://www.eduadmin.se).
334+
As with the normal list view, this view lists the available programmes you have created in [**EduAdmin**](https://www.eduadmin.se).
332335

333336
| Attribute | Value type | Default value |
334337
|:----------|:----------:|:-------------:|
@@ -337,3 +340,28 @@ EduAdmin**](https://www.eduadmin.se).
337340
And if you want to filter this list, you can apply the `category`-attribute.
338341

339342
* * *
343+
344+
### `[eduadmin-programmeinfo]`
345+
346+
This shortcode is used when you want to create your own custom template [**programme view**](#eduadmin-programme-detail).
347+
348+
:::note
349+
350+
We will add more attributes to this shortcode in the future.
351+
352+
:::
353+
354+
| Attribute | Value type | Default value |
355+
|:--------------------------|:----------:|:-------------:|
356+
| programmeid | integer | _null_ |
357+
| programmename | boolean | null |
358+
| programmepublicname | boolean | null |
359+
| programmeimage | boolean | null |
360+
| programmeimagetext | boolean | null |
361+
| programmedescriptionshort | boolean | null |
362+
| programmedescription | boolean | null |
363+
| programmegoal | boolean | null |
364+
| programmetarget | boolean | null |
365+
| programmeprerequisites | boolean | null |
366+
| courseafter | boolean | null |
367+
| programmequote | boolean | null |

0 commit comments

Comments
 (0)