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 8a31eef4 authored by vermeul's avatar vermeul
Browse files

Update README.md

parent fc5e55a0
......@@ -56,6 +56,19 @@ So if we want to annotate a written subtraction example, we simply write:
```
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:
```
{{#annotcat: list}}
{{#annotcat: list | top_category_name}}
{{#annotcat: list | parent_name/category_name}}
```
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».
### add a new category
To add a new category into the categories table, we simply add one of the following anywhere in a Wiki Page:
......@@ -66,6 +79,20 @@ To add a new category into the categories table, we simply add one of the follow
Only the name argument is mandatory, everything else is optional. If you don't specify a parent category, a new top category will be created.
### update an existing category
To update a category, add something like this to any Wiki Page:
```
# update everything
{{#annotcat: up | kat_parent/kat_child | name='new category name', description='new description', parent='grandparent_category/parent_category' }}
# make a category becoming a top category
{{#annotcat: up | kat_parent/kat_child | parent=}}
# remove description
{{#annotcat: up | kat_parent/kat_child | description=}}
```
If you do not want to update certain fields, just omit them. If you want to remove the parent or deleting the description, just leave the value empty.
### delete an existing category
......@@ -81,14 +108,6 @@ If this category was a parent- or child-category, then this connection will brea
results as before when searching for annotations. Therefore: be careful!
### update an existing category
To update a category, add this to any Wiki Page:
```
{{#annotcat: up | kat_parent/kat_child | name='new category name', description='new description', parent='grandparent_category/parent_category' }}
```
If you do not want to update certain fields, just omit them.
### list existing categories
......
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