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

Update README.md

parent 6c2e9d90
......@@ -5,17 +5,17 @@
## Annotation Syntax
MediaWiki has the concept of ParserFunctions and offers the possibility to implement your own:
MediaWiki has the concept of **ParserFunctions** and offers the possibility to implement your own:
```
{{#myOwnParserFunction:}}
```
We want to use this facility to define our own ParserFunctions which offer annotations. We generally need to define two tags:
- opening tag, which marks the beginning of an annotation: `{{#annot:}}`
- closing tag, which marks the end of an annotation: `{{#annotend:}}`
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
Annotations should come in different flavors:
Annotations come in different flavors:
- `{{#annot: comment}}` basic annotation with just a comment
- `{{#annot: comment | category}}` categorized annotation
- `{{#annot: comment | category1, category2 | id}}` annotation with more than one category, with an id to identify the proper end of it when nesting `{{#annotend: id}}`
......@@ -23,6 +23,10 @@ Annotations should come in different flavors:
- `{{#annotend: id}}` End-of-Annotation-Tag. The id must be present if the opening tag has one.
- for convenence, `{{annotend}}` or `{{#annotend}}` (without the colon) are allowed too.
## Annotation Categories
## 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