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

Update README.md

parent 6894702f
......@@ -10,30 +10,31 @@ If you want to annotate text which *cannot be edited after*, there are several a
- co-ment (http://www.co-ment.com) – co-ment is a web service for annotating, discussing and writing texts online
- CATMA (http://catma.de) – for undogmatic textual markup and analysis
## Annotation
## Text Annotation
Text annotations must be distinguished from
[semantic annotations](https://www.semantic-mediawiki.org/wiki/Help:Introduction_to_Semantic_MediaWiki).
Semantic Annotations put an certain information into a context, for example, a number can represent a height, population, age etc.
Semantic Media Wiki enables you to add this kind of information to a text and offers you the possibility to list all pages
Text Annotations must be distinguished from
[Semantic Annotations](https://www.semantic-mediawiki.org/wiki/Help:Introduction_to_Semantic_MediaWiki).
Semantic Annotations put an singular (atomic) information into a context, for example, a number which an either represent a height, population, age etc.
Semantic Media Wiki enables you to add this kind of information to a piece of your text and offers you the possibility to list all pages
of cities in Europe with a population greater than one Million, for example. It also allows you to directly extract the relevant information
(Name of the City, Country, Population, coordinates) from the Wiki Pages that are found.
YATA does something similar. It annotates certain sections of a text and puts them in a context. But annotations can overlap or be nested
(this is not possible with Semantic Annotations). You can add an arbitary comment as well as categorize your annotation. When you query your
annotations, your result does not only are take to the right page but also to the exact position of the annotation.
YATA does something similar. It annotates certain sections of a text and puts them in a context. On the other hand,
Text Annotations can overlap and/or be nested, something which is not possible with Semantic Annotations.
You can add an arbitary comment as well as categorize your annotation (multiple categorizations are possible).
Categories can be organised in a hierarchical structure. When you query your annotations, your result does
not only are take to the right page but also to the exact position of the annotation.
### Annotation Syntax
Annotations always have a start and an end.
Annotations always have a start and an end. They look like this:
```
{{#annot:}} # opening tag, which marks the start of an annotation
{{#annotend:}} # closing tag, which marks the end of an annotation
```
Annotations usually contain comments and may be categorised (see below):
Annotations usually contain comments and may be categorised (Categories: see below):
````
{{#annot: comment}} # basic annotation with just a comment
{{#annot: comment | category}} # categorized annotation (see annotaion categories below)
......
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