Home

How to contribute to the SUD guidelines

The SUD guidelines (available at https://surfacesyntacticud.github.io/guidelines/u/) are automatically built from the files of the guidelines repository. If you want to contribute to it, please mail your GitHub login to [email protected] to be added to the members of the project.

This page describes how to modify pages using the online GitHub interface, suitable for small updates. For more complex contribution, see how to install a local instance.

Modify an existing page

Once you are logged and you have the writing rights, you can edit a page directly form the GitHub interface.

1. Go to the page you want to modify (for example the main French page or here for more links). You can also use the button Edit the page from the SUD website to be redirected to the GitHub interface.

2. Click on the pen icon "Edit this file". You can then edit the text directly in the page. When you are done, you can click on the button Commit changes at the end of the page.

The syntax used for the page encoding is Markdown. You can find a quick overview of the syntax in the Markdown-Cheatsheet or more links here.

During the edition, you can switch between the two panes Edit file and Preview. Note that you will not be able to preview dependency graphs in this mode.

A few minutes after your commit the modified page will be available on the website.

Add or modify a dependency graph example

To produce the dependency graph picture, the reactive-dep-tree tool is used. For instance, the picture of the SUD main page is produced with the code:

{{< conll >}}
# text = I'm happy about SUD.
1	I	I	PRON	PRP	Case=Nom|Number=Sing|Person=1|PronType=Prs	2	subj	_	SpaceAfter=No
2	'm	be	AUX	VBP	Mood=Ind|Tense=Pres|VerbForm=Fin	0	root	_	_
3	happy	happy	ADJ	JJ	Degree=Pos	2	comp:pred	_	_
4	about	about	ADP	IN	_	3	mod	_	_
5	SUD	SUD	PROPN	DT	Number=Sing	4	comp:obj	_	SpaceAfter=No
6	.	.	PUNCT	.	_	2	punct	_	_
{{< /conll >}}

⚠️⚠️ The columns must be separated with a tabulation symbol (TAB) and not by spaces. Unfortunately, several browsers silently convert the TAB entered from the keyboard into spaces. To avoid this problem, you can use copy/paste from existing data with real tabulations (for instance, to add a token, you can copy/paste a existing line and then edit the columns)

Note that you can also copy/paste the CoNLL code of an example found on Grew-match (button CoNLL above the sentence) or from ArboratorGrew through Get CoNLL-U of this tree in a menu above the graph picture.

Direct links to existing guidelines pages

• Universal guidelines
  • Main page
  • General principles
  • SUD Relations: comp, comp_aux, comp_cleft, comp_obj, comp_obl, comp_pred, mod, subj, udep
  • For other pages, navigate into folders starting from here
• Language specific pages:
  • Beja
  • French
  • Naija
  • Zaar