Tweak documentation

UUDigitalHumanitieslab · May 30, 2024 · 0091c49 · 0091c49
1 parent 2da5a9a
commit 0091c49
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 13 deletions.
diff --git a/docs/annotaties/saf.md b/docs/annotaties/saf.md
@@ -4,12 +4,12 @@
 Een bestand in het SASTA Output formaat representeert de uitingen en annotaties van één transcript. Het bestand wordt opgeleverd als een Excel spreadsheet (`.xlsx`).
 
 ## Kolommen
-### ID
+### Uiting
 In deze kolom staat het uitingsnummer van de uiting. Let op: dit zijn alleen de uitingen die geselecteerd zijn voor analyse. De `ID` kolom loopt dus altijd van `1` tot `<hoeveelheid gemarkeerde uitingen>`.
 ### Level
 In deze kolom word de naam van de verschillende niveaus getoond, zie [levels](#levels).
 
-### Unaligned
+### Hele uiting
 Deze kolom is bedoeld voor niet-gealigneerde annotaties. Een voorbeeld zijn annotaties die niet bij een specifiek woord of woordgroep horen, maar bij de gehele uiting.
 
 ### Word1, Word2, ...WordN
@@ -18,17 +18,16 @@ De `Word`-kolommen zijn bedoeld voor annotaties behorende bij een specifiek woor
 ### Fases
 In deze kolom wordt automatisch een opsomming gemaakt van alle fases die horen bij de annotaties van de uiting, in Romeinse cijfers.
 
-### Commentaar
-In deze kolom kan commentaar worden opgenomen, behorende bij de gehele zin. Voor commentaar over een specifiek woord word het level `Commentaar` gebruikt.
+### Opmerkingen
+In deze kolom kunnen opmerkingen worden opgenomen, behorende bij de gehele zin. Deze worden niet door SASTA verwerkt. Voor commentaar over een specifiek woord word het level `Opmerkingen` gebruikt.
 
 ## Rijen
-Eén uiting bestaat uit meerdere rijen, elk beginnende met dezelfde [ID](#id). Voor een uiting zijn steeds de `Utt`-rij, `level`-rijen, en de `Commentaar`-rij opgenomen.
+Eén uiting bestaat uit meerdere rijen, elk beginnende met hetzelfde uitingsnummer. Voor een uiting zijn steeds de `Uiting`-rij, `level`-rijen, en de `Opmerkingen`-rij opgenomen.
 
-### Utt
+### Uiting
 Op deze rij staan de woorden van uiting. Als een woord in het invoerbestand bijvoorbeeld voorzien is van een CHAT-annotatie, wordt deze verwerkt en wordt het woord opgeschoond getoond.
 
 ### Levels
 Annotaties kunnen op verschillende niveaus worden gemaakt.
-
-Voor elk niveau is er een aparte rij opgenomen. Voor TARSP-transcripten is er een uitzondering: het `Zc`-niveau komt eenmaal voor per zc-embedding.
+Voor elk niveau is er een aparte rij opgenomen.
 
diff --git a/docs/input-formats/sif.md b/docs/input-formats/sif.md
@@ -67,6 +67,6 @@ Uitingen kunnen geannoteerd worden volgens de [CHAT handleiding][chat-manual].
 
 
 ## Voorbeeldbestanden
-Zie [link](../input-formats/voorbeelden) voor downloadbare voorbeeldbestanden.
+Zie [link](./voorbeelden.md) voor downloadbare voorbeeldbestanden.
 
 [chat-manual]: https://talkbank.org/manuals/CHAT.pdf
diff --git a/docs/input-formats/voorbeelden.md b/docs/input-formats/voorbeelden.md
@@ -1,6 +1,6 @@
 # Voorbeeldbestanden
 
-## [SASTA Input Formaat](/input-formats/sif)
+## [SASTA Input Formaat](../input-formats/sif.md)
 - Microsoft Word (`.docx`): [download](../assets/example-files/sif.docx)
 - Platte tekst (`.txt`): [download](../assets/example-files/sif.txt)
 ## CHAT Input
diff --git a/docs/methodes.md b/docs/methodes.md
@@ -8,5 +8,5 @@ Voor de geselecteerde methode wordt een tabel getoond met per query (taalmaat):
 
 - `code`: de interne code die SASTA hanteert..
 - `level`: Het niveau waarop de query opereert. Per methodecategorie verschillen de beschikbare niveaus.
-- `item`: De code die gegenereert wordt door SASTA, en door de gebruiker ook toegevoegd kan worden in het [SASTA Annotation Format](../annotaties/saf). De codes zijn hoofdletter-ongevoelig, dus `BVBep` en `bvbep` leveren dezelfde scores op.
+- `item`: De code die gegenereert wordt door SASTA, en door de gebruiker ook toegevoegd kan worden in het [SASTA Annotation Format](annotaties/saf.md). De codes zijn hoofdletter-ongevoelig, dus `BVBep` en `bvbep` leveren dezelfde scores op.
 - `actions`: Klik op het vergrootglas om alle beschikbare details van een query te tonen.
diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css
@@ -1,5 +1,5 @@
 :root {
-    --md-primary-fg-color: #002984;
+    --md-primary-fg-color: #3f51b5;
     --md-primary-fg-color--light: #3f51b5;
     --md-primary-fg-color--dark: #002984;
-}
+}
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,5 +1,6 @@
 site_name: SASTA Documentatie
 repo_url: https://github.com/UUDigitalHumanitieslab/sasta
+site_url: https://uudigitalhumanitieslab.github.io/sasta/
 
 theme:
     name: material
@@ -8,6 +9,7 @@ theme:
     favicon: assets/favicon.svg
     palette:
         scheme: custom
+        primary: custom
 nav:
     - Home: 'index.md'
     - Gebruikersaccount: 'accounts.md'