Use kebab case

.gitignore

@@ -1 +1,2 @@
-*.pdf
+*.pdf
+.DS_Store

README.md

@@ -24,7 +24,7 @@ While this `README.md` gives you a brief overview of the package's usage, we rec
   title: "Vereinsordnung zu ABCDEF", // title of the law/bylaw/...
   abbrev: "ABCDEFVO", // abbreviation of the law/bylaw/...
   resolution: "3. Beschluss des Vorstands vom 24.01.2024", // resolution number and date
-  inEffect: "24.01.2024", // date when it comes into effect
+  in-effect: "24.01.2024", // date when it comes into effect
   draft: false, // whether this is a draft
   // Template
   logo: image("wuespace.jpg", alt: "WüSpace e. V."), // logo of the organization, shown on the first page
@@ -40,19 +40,24 @@ Sections are auto-detected as long as they follow the pattern `§ 1 ...` or `§
 ```typst
 § 1 Geltungsbereich
 
-(1) Diese Ordnung gilt für alle Mitglieder des Vereins.
+(1) 
+Diese Ordnung gilt für alle Mitglieder des Vereins.
 
-(2) Sie regelt die Mitgliedschaft im Verein.
+(2) 
+Sie regelt die Mitgliedschaft im Verein.
 
 § 2 Mitgliedschaft
 
-(1) Die Mitgliedschaft im Verein ist freiwillig.
+(1) 
+Die Mitgliedschaft im Verein ist freiwillig.
 
-(2) Sie kann jederzeit gekündigt werden.
+(2) 
+Sie kann jederzeit gekündigt werden.
 
 § 2a Ehrenmitgliedschaft
 
-(1) Die Ehrenmitgliedschaft wird durch den Vorstand verliehen.
+(1) 
+Die Ehrenmitgliedschaft wird durch den Vorstand verliehen.
 ```
 
 ### Overarching Sections
@@ -80,7 +85,20 @@ If a paragraph contains multiple sentences, you can number them by adding a `#s~
 ```typst
 § 3 Mitgliedsbeiträge
 
-#s~Die Mitgliedsbeiträge sind monatlich zu entrichten. #s~Sie sind bis zum 5. des Folgemonats zu zahlen.
+#s~Die Mitgliedsbeiträge sind monatlich zu entrichten.
+#s~Sie sind bis zum 5. des Folgemonats zu zahlen.
 ```
 
 This automatically adds corresponding sentence numbers in superscript.
+
+### Referencing other Sections
+
+Referencing works manually by specifying the section number. While automations would be feasible, we have found that in practice, they're not as useful as they might seem for legislative documents.
+
+In some cases, referencing sections using `§ X` could be mis-interpreted as a new section. To avoid this, use the non-breaking space character `~` between the `§` and the number:
+
+```typst
+§ 5 Inkrafttreten
+
+Diese Ordnung tritt am 24.01.2024 in Kraft. §~4 bleibt unberührt.
+```

delegis.typ

@@ -7,9 +7,9 @@
 #let delegis = (
   // Metadata
   title : "Vereinsordnung zur IT-Infrastruktur",
-  abbrev : "ITVO",
+  abbreviation : "ITVO",
   resolution : "3. Beschluss des Vorstands vom 24.01.2024",
-  inEffect : "24.01.2024",
+  in-effect : "24.01.2024",
   draft : false,
   // Template
   logo : none,
@@ -18,13 +18,13 @@
   font : "Atkinson Hyperlegible",
   lang : "de",
   paper: "a5",
-  strDraft : "Entwurf",
-  strIntro : (resolution, inEffect) => [Mit Beschluss (#resolution) tritt zum #inEffect in Kraft:],
+  str-draft : "Entwurf",
+  str-intro : (resolution, in-effect) => [Mit Beschluss (#resolution) tritt zum #in-effect in Kraft:],
   // Content
   body
 ) => [
   /// General Formatting
-  #set document(title: title + " (" + abbrev + ")", keywords: (title, abbrev, resolution, inEffect))
+  #set document(title: title + " (" + abbreviation + ")", keywords: (title, abbreviation, resolution, in-effect))
 
   #let bg = if draft {
     rotate(45deg, text(100pt, fill: luma(85%), font: font, strDraft))
@@ -91,8 +91,8 @@
 
     show par: set block(spacing: .6em)
 
-    if draft { text[#strDraft:] } else { par(text(strIntro(resolution, inEffect))) }
-    par(text(2em, strong[#title~(#abbrev)]), leading: 0.6em)
+    if draft { text[#str-draft:] } else { par(text(str-intro(resolution, in-effect))) }
+    par(text(2em, strong[#title~(#abbreviation)]), leading: 0.6em)
     v(3cm)
   })
 

template/main.typ

@@ -5,7 +5,7 @@
   title: "Vereinsordnung zu ABCDEF",
   abbrev: "ABCDEFVO",
   resolution: "3. Beschluss des Vorstands vom 24.01.2024",
-  inEffect: "24.01.2024",
+  in-effect: "24.01.2024",
   draft: false,
   // Template
   logo: image("wuespace.jpg", alt: "WüSpace e. V."),
@@ -37,9 +37,11 @@ Fußnoten dienen als redaktionelle Anmerkungen oder Interpretationshilfen und si
 
 § 1 Grundlegendes
 
-(1) #lorem(20)
+(1)
+#lorem(20)
 
-(2) #s~#lorem(10)
+(2)
+#s~#lorem(10)
 #s~#lorem(10)
 
 § 2 Bestimmungen
@@ -50,7 +52,9 @@ Fußnoten dienen als redaktionelle Anmerkungen oder Interpretationshilfen und si
 
 § 2a Ergänzende Bestimmungen
 
-(1) #lorem(5)
+(1)
+#lorem(5)
 
-(2) #s~#lorem(3) 
+(2)
+#s~#lorem(3) 
 #s~#lorem(8)

typst.toml

@@ -3,6 +3,7 @@ name = "delegis"
 version = "0.1.0"
 entrypoint = "delegis.typ"
 authors = ["WüSpace e. V. <https://github.com/wuespace>"]
+repository = "https://github.com/wuespace/delegis"
 license = "MIT"
 description = "A package and template for drafting legislative content in a German-style structuring, such as for bylaws, etc."
 categories = ["office"]
@@ -11,4 +12,4 @@ disciplines = ["law"]
 [template]
 path = "template"
 entrypoint = "main.typ"
-thumbnail = "thumbnail.png"
+thumbnail = "thumbnail.png"