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

Update README.md

parent df84099e
......@@ -21,20 +21,23 @@ MediaWiki has the concept of **ParserFunctions** and offers the possibility to i
```
We use this facility to define our own ParserFunctions to offer annotations:
- `{{#annot:}}`: opening tag, which marks the beginning of an annotation
- `{{#annotend:}}`: closing tag, which marks the end of an annotation
```
{{#annot:}} # opening tag, which marks the start of an annotation
{{#annotend:}} # closing tag, which marks the end of an annotation
```
Annotations come in different flavors:
- `{{#annot: comment}}` basic annotation with just a comment
- `{{#annot: comment | category}}` categorized annotation (see annotaion categories below)
- `{{#annot: comment | cat_parent/cat_child}}` annotation with a specific category identified by a `cat_parent/cat_child` pair
- `{{#annot: comment | category1, category2}}` annotation with more than one category
- `{{#annot: comment | category | some_id}}` an id is used to identify the proper end of the annotation when nesting. Annotation end must contain the same id: `{{#annotend: some_id}}`
- `{{#annot: | category}}` just specifiying the category a text belongs to, with no comment
- `{{#annot: comment | | some_id}}` nested annotation with an id to identify its ending, without any category
- `{{#annotend: id}}` End-of-Annotation-Tag. The id must be present if the opening tag has one.
- `{{annotend}}` or `{{#annotend}}` (without the colon) are allowed too.
Annotations usually contain comments and may be categorised (see below):
````
{{#annot: comment}} # basic annotation with just a comment
{{#annot: comment | category}} # categorized annotation (see annotaion categories below)
{{#annot: comment | cat_parent/cat_child}} # annotation with a specific category identified by a `cat_parent/cat_child` pair
{{#annot: comment | category1, category2}} # annotation with more than one category
{{#annot: comment | category | some_id}} # an id is used to identify the proper end of the annotation when nesting. Annotation end must contain the same id: `{{#annotend: some_id}}`
{{#annot: | category}} # just specifiying the category a text belongs to, with no comment
{{#annot: comment | | some_id}} # nested annotation with an id to identify its ending, without any category
{{#annotend: id}} # End-of-Annotation-Tag. The id must be present if the opening tag has one.
{{annotend}} {{#annotend}} # some syntax sugar in case you forget the colon or the hash symbol
```
### 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,
......
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