To receive notifications about scheduled maintenance, please subscribe to the mailing-list gitlab-operations@sympa.ethz.ch. You can subscribe to the mailing-list at https://sympa.ethz.ch

Commit 3f263413 authored by vermeul's avatar vermeul
Browse files

Update README.md

parent 8a31eef4
......@@ -58,16 +58,21 @@ Note: **the combination of parent_category/child_category must be unique**
### list categories
Put this on any WikiPage and it will list all existing categories:
Put this on any WikiPage and it will list existing categories:
```
{{#annotcat: list}}
{{#annotcat: list | top_category_name}}
{{#annotcat: list | parent_name/category_name}}
{{#annotcat: list}} # lists all categories (might be a long list!)
{{#annotcat: list | top_category_name}} # list a certain top category and all categories «below»
{{#annotcat: list | parent_name/category_name}} # start list with node parent_category/category
```
The first one will list all existing categories, which can result in a long table. The second one will list a certain top category and all categories underneath.
The third one is identical to the second one, but starts with a given category «node».
### list existing categories
```
{{#annotcat: list }}
{{#annotcat: list | top_cat }} #
{{#annotcat: list | parent_cat/child_cat }}
```
### add a new category
......@@ -109,15 +114,6 @@ results as before when searching for annotations. Therefore: be careful!
### list existing categories
```
{{#annotcat: list }} # lists all categories
{{#annotcat: list | top_cat }} # start with top_cat (which must have no parent)
{{#annotcat: list | parent_cat/child_cat }} # start list with node parent_cat/child_cat
```
## Nested or overlapping annotations: Examples
The vertical bars are used to supply a number of different arguments. Because annotations can be even nested or overlapping,
we need to add an identifier to be sure the start and endings are connected together correctly. For example:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment