diff --git a/README.md b/README.md index 04da0b2..b86464b 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ -# Annotation guideline -Source code of https://guidelines.surfacesyntacticud.org/ , a guideline for SUD annotation -This repository contains an annotation guideline and the necessary tools for its creation for a new language. The following instructions will guide you on how to work with this repository. +# Annotation guidelines +Source code of https://guidelines.surfacesyntacticud.org/, guidelines for SUD annotation +This repository contains an annotation guidelines and the necessary tools for its creation for a new language. +The following instructions will guide you on how to work with this repository. ## Tools @@ -20,7 +21,7 @@ git submodule update ## Writings in guidelines -You have the option to add information directly in the guideline or utilize the various tools provided in the "tools" folder. More information about these tools can be found within the same folder. +You have the option to add information directly in the guidelines or utilize the various tools provided in the "tools" folder. More information about these tools can be found within the same folder. ## Visualisation diff --git a/content/docs/general_guideline/Features/_index.md b/content/docs/general_guideline/Features/_index.md index 858c0fd..a7d2458 100644 --- a/content/docs/general_guideline/Features/_index.md +++ b/content/docs/general_guideline/Features/_index.md @@ -1,12 +1,7 @@ --- title: "UD Morpho-syntactic Features" weight: 20 -# bookFlatSection: false -# bookToc: true -# bookHidden: false bookCollapseSection: true -# bookComments: false -# bookSearchExclude: false --- # UD Morpho-syntactic Features diff --git a/content/docs/general_guideline/Misc/_index.md b/content/docs/general_guideline/Misc/_index.md index f7fed7d..a7c1528 100644 --- a/content/docs/general_guideline/Misc/_index.md +++ b/content/docs/general_guideline/Misc/_index.md @@ -1,11 +1,11 @@ --- -title: "Additionnal Features (Misc)" -weight: 70 +title: "MISC Features" +weight: 35 bookToc: false bookCollapseSection: true --- -# MISC +# MISC Features This section provides an overview of the different features that can be used for various nodes. These features are not specific to a particular part of speech, but can be applied to any kind of part of speech: diff --git a/content/docs/general_guideline/Features/ExtPos.md b/content/docs/general_guideline/SUD_features/ExtPos.md similarity index 100% rename from content/docs/general_guideline/Features/ExtPos.md rename to content/docs/general_guideline/SUD_features/ExtPos.md diff --git a/content/docs/general_guideline/Features/Shared.md b/content/docs/general_guideline/SUD_features/Shared.md similarity index 100% rename from content/docs/general_guideline/Features/Shared.md rename to content/docs/general_guideline/SUD_features/Shared.md diff --git a/content/docs/general_guideline/Features/Subject.md b/content/docs/general_guideline/SUD_features/Subject.md similarity index 100% rename from content/docs/general_guideline/Features/Subject.md rename to content/docs/general_guideline/SUD_features/Subject.md diff --git a/content/docs/general_guideline/SUD_features/_index.md b/content/docs/general_guideline/SUD_features/_index.md new file mode 100644 index 0000000..22fa682 --- /dev/null +++ b/content/docs/general_guideline/SUD_features/_index.md @@ -0,0 +1,15 @@ +--- +title: "SUD Features" +weight: 25 +bookCollapseSection: true +--- + +# SUD Features + +Some new features were introduced in the SUD framework. +Even if the feature `ExtPos` is also now used by [some UD treebanks](https://tables.grew.fr/?data=ud_feats/FEATS&cols=ExtPos), we consider it here as a *SUD feature*. + +Tree SUD specific features are used: + - [`ExtPos`](ExtPos) for external POS in idioms or tilte + - [`Shared`](Shared) for encoding the fact that dependants are shored or not in coordination constructions + - [`Subject`](Subject) for control verbs \ No newline at end of file diff --git a/content/docs/general_guideline/Syntactic_relations/_index.md b/content/docs/general_guideline/Syntactic_relations/_index.md index cf3c9e7..6c5653f 100644 --- a/content/docs/general_guideline/Syntactic_relations/_index.md +++ b/content/docs/general_guideline/Syntactic_relations/_index.md @@ -1,6 +1,6 @@ --- title: "Syntactic Relations" -weight: 30 +weight: 15 # bookFlatSection: false bookToc: true # bookHidden: false diff --git a/content/docs/general_guideline/Upos/_index.md b/content/docs/general_guideline/Upos/_index.md index 0712bd3..b96aa09 100644 --- a/content/docs/general_guideline/Upos/_index.md +++ b/content/docs/general_guideline/Upos/_index.md @@ -1,11 +1,11 @@ --- -title: "upos" +title: "POS tagging" weight: 10 -bookToc: true +bookToc: false bookCollapseSection: true --- -# upos +# POS tagging **SUD** uses the same pos tagset as **UD**: - [ADJ](./ADJ.md): adjective diff --git a/content/docs/general_guideline/_index.md b/content/docs/general_guideline/_index.md index 7c809cf..77933c5 100644 --- a/content/docs/general_guideline/_index.md +++ b/content/docs/general_guideline/_index.md @@ -1,5 +1,5 @@ --- -title: "General Guideline" +title: "General Guidelines" weight: 1 bookFlatSection: false bookToc: true @@ -9,7 +9,7 @@ bookCollapseSection: true # bookSearchExclude: false --- -# General Guideline +# General Guidelines This section contain the annotation's instructions for the tags and for the universal constructions. diff --git a/content/docs/general_guideline/Morph_based_tag/_index.md b/content/docs/general_guideline/mSUD/_index.md similarity index 75% rename from content/docs/general_guideline/Morph_based_tag/_index.md rename to content/docs/general_guideline/mSUD/_index.md index c356ea6..d4d54ff 100644 --- a/content/docs/general_guideline/Morph_based_tag/_index.md +++ b/content/docs/general_guideline/mSUD/_index.md @@ -1,5 +1,5 @@ --- -title: "Morph-based tag" +title: "mSUD" weight: 80 # bookFlatSection: false bookToc: true @@ -9,4 +9,4 @@ bookCollapseSection: true # bookSearchExclude: false --- -# morph-based tag \ No newline at end of file +# mSUD: annotation at the morph level \ No newline at end of file diff --git a/content/docs/general_guideline/Morph_based_tag/aff.md b/content/docs/general_guideline/mSUD/aff.md similarity index 100% rename from content/docs/general_guideline/Morph_based_tag/aff.md rename to content/docs/general_guideline/mSUD/aff.md diff --git a/content/docs/language/_index.md b/content/docs/language/_index.md index 8fdf4e9..cfcb0bf 100644 --- a/content/docs/language/_index.md +++ b/content/docs/language/_index.md @@ -1,13 +1,11 @@ --- -title: "Language" +title: "Language specific guidelines" weight: 2 bookToc: true bookCollapseSection: true --- -# Specific language guidelines sections - - +# Language specific guidelines Here, you will find some guidelines to annotate language's specific phenomena. \ No newline at end of file diff --git a/content/docs/language/old_beja/_index.md b/content/docs/language/beja/_index.md similarity index 78% rename from content/docs/language/old_beja/_index.md rename to content/docs/language/beja/_index.md index 10d0b7f..4c147a6 100644 --- a/content/docs/language/old_beja/_index.md +++ b/content/docs/language/beja/_index.md @@ -1,37 +1,33 @@ --- -title: "old_Beja" +title: "Beja" weight: 3 bookCollapseSection: true --- # Beja Guidelines -**NB:** This page is under construction. A overview of the SUD annotation of the Beja corpus is available in the paper: [A morph-based and a word-based treebank for Beja](https://aclanthology.org/2021.tlt-1.5.pdf). +**NB:** This page is under construction. + +## Publication +A overview of the SUD annotation of the Beja corpus is available in the paper: [A morph-based and a word-based treebank for Beja](https://aclanthology.org/2021.tlt-1.5.pdf). ## Annotation at the morph level - -The SUD corpus of Beja is firstly annotated at the morph level (`SUD_Beja-NSC`). +The SUD corpus of Beja is firstly annotated at the morph level (`mSUD_Beja-NSC`). In the UD repository, the word-based corpus is released as `UD_Beja-NSC`. - - The two other combinations are also available: - - `SUD_Beja-NSC_WB` the data following SUD guidelines but at the word level - - `UD_Beja-NSC_MB` the data following UD guidelines but at the morph level + - `SUD_Beja-NSC` the data following SUD guidelines but at the word level + - `mUD_Beja-NSC` the data following UD guidelines but at the morph level The table below shows how the conversions are made in order to produce all the corpora described above. | | SUD | | UD | - |:-:|:-----:|:-:|:----:| - | **morph-based** | **`SUD_Beja-NSC`** [![gh](/images/Octocat.png)](https://github.com/surfacesyntacticud/SUD_Beja-NSC) [![gm](/images/square_g.svg)](http://universal.grew.fr/?corpus=SUD_Beja-NSC@latest) | [⇨](https://github.com/surfacesyntacticud/tools/tree/master/converter) | `UD_Beja-NSC_MB` [![gh](/images/Octocat.png)](https://github.com/UniversalDependencies/UD_Beja-NSC/tree/dev/not-to-release) [![gm](/images/square_g.svg)](http://universal.grew.fr/?corpus=UD_Beja-NSC_MB@conv) | - | | [⇩](https://github.com/surfacesyntacticud/tools/tree/master/morph2word) | | | - | **word-based** | `SUD_Beja-NSC_WB` [![gh](/images/Octocat.png)](https://github.com/surfacesyntacticud/SUD_Beja-NSC/tree/master/word_based) [![gm](/images/square_g.svg)](http://universal.grew.fr/?corpus=SUD_Beja-NSC_WB@latest) | [⇨](https://github.com/surfacesyntacticud/tools/tree/master/converter) | **`UD_Beja-NSC`** [![gh](/images/Octocat.png)](https://github.com/UniversalDependencies/UD_Beja-NSC/tree/dev) [![gm](/images/square_g.svg)](http://universal.grew.fr/?corpus=UD_Beja-NSC@conv) | diff --git a/content/docs/language/old_beja/affixe_word_order.md b/content/docs/language/beja/affixe_word_order.md similarity index 100% rename from content/docs/language/old_beja/affixe_word_order.md rename to content/docs/language/beja/affixe_word_order.md diff --git a/content/docs/language/old_beja/coordination_head_final.md b/content/docs/language/beja/coordination_head_final.md similarity index 100% rename from content/docs/language/old_beja/coordination_head_final.md rename to content/docs/language/beja/coordination_head_final.md diff --git a/content/docs/language/old_beja/non_canonical_serial_verb.md b/content/docs/language/beja/non_canonical_serial_verb.md similarity index 100% rename from content/docs/language/old_beja/non_canonical_serial_verb.md rename to content/docs/language/beja/non_canonical_serial_verb.md diff --git a/content/docs/language/old_beja/relative_clauses.md b/content/docs/language/beja/relative_clauses.md similarity index 100% rename from content/docs/language/old_beja/relative_clauses.md rename to content/docs/language/beja/relative_clauses.md diff --git a/static/images/Octocat.png b/static/images/Octocat.png index 91057da..b976db0 100644 Binary files a/static/images/Octocat.png and b/static/images/Octocat.png differ