Vedtægter i reStructuredText #6

New issue

Open

opened 2020-12-10 10:25:30 +00:00 by reynir · 2 comments

reynir commented

2020-12-10 10:25:30 +00:00

Owner

Motivation

I vores vedtægter refererer vi på kryds og tværs vha. paragrafnumre. Det fungerer, men det har den ulempe at vedtægtsændringer der tilføjer nye paragraffer ofte kan betyde manuel omnummerering af eksisterende paragraffer, og alle referencer skal manuelt opdateres. Det giver risiko for fejl og en masse 'støj' i diff'en.

Foreslået løsning

Jeg foreslår vi går tilbage til reStructuredText. Formattet giver mulighed for automatisk nummerering af paragraffer, og man kan give paragraffer 'interne' navne der gør det lettere at lave referencer.

For et år siden legede jeg lidt med det i https://git.data.coop/reynir/vedtaegter. Jeg brugte sectnum med prefix option til at få § 1.2 etc. Jeg tror ikke referencer blev renderet med numre. Det kan måske bruges som et udgangspunkt.

## Motivation I vores vedtægter refererer vi på kryds og tværs vha. paragrafnumre. Det fungerer, men det har den ulempe at vedtægtsændringer der tilføjer nye paragraffer ofte kan betyde manuel omnummerering af eksisterende paragraffer, og alle referencer skal manuelt opdateres. Det giver risiko for fejl og en masse 'støj' i diff'en. ## Foreslået løsning Jeg foreslår vi går tilbage til reStructuredText. Formattet giver mulighed for automatisk nummerering af paragraffer, og man kan give paragraffer 'interne' navne der gør det lettere at lave referencer. For et år siden legede jeg lidt med det i https://git.data.coop/reynir/vedtaegter. Jeg brugte `sectnum` med `prefix` option til at få `§ 1.2` etc. Jeg tror ikke referencer blev renderet med numre. Det kan måske bruges som et udgangspunkt.

benjaoming commented

2020-12-10 19:45:22 +00:00

Owner

Jeg ved godt, at det her kommer til at lyde sygt underligt, men jeg synes, at om-nummereringen i præcis vedtægter er en "feature not a bug".

Dvs.: Hvis man laver fejl, er det dumt.. men så er hele forsamlingen skyldig i ikke at læse egne vedtægter og ændringer grundigt nok. Jeg kan godt lide, at man tvinges til at læse hele herligheden.

Det er mere hensigtsmæssigt - tænker jeg - at man fikser al nummerering og henvisning helt eksplicit. Vedtægter kan måske indeholde syntax, som vedrører "markup", men decideret fortolkede reST-koder, synes jeg er juridisk problematiske, da de vedrører en konkret implementering af en reST-fortolker.

Ellers tænker jeg, at man kunne bruge fortolkeren som en pre-generator og lade forsamlingen godkende vedtægtsændringer ift. output fra fortolkeren. Output skal gemmes i git og arkiveres i foreningens arkiv.

Er jeg for pedandisk?

Jeg ved godt, at det her kommer til at lyde sygt underligt, men jeg synes, at om-nummereringen i præcis vedtægter er en "feature not a bug". Dvs.: Hvis man laver fejl, er det dumt.. men så er hele forsamlingen skyldig i ikke at læse egne vedtægter og ændringer grundigt nok. Jeg kan godt lide, at man tvinges til at læse hele herligheden. Det er mere hensigtsmæssigt - tænker jeg - at man fikser al nummerering og henvisning helt eksplicit. Vedtægter kan måske indeholde syntax, som vedrører "markup", men decideret fortolkede reST-koder, synes jeg er juridisk problematiske, da de vedrører en konkret implementering af en reST-fortolker. Ellers tænker jeg, at man kunne bruge fortolkeren som en pre-generator og lade forsamlingen godkende vedtægtsændringer ift. output fra fortolkeren. Output skal gemmes i git og arkiveres i foreningens arkiv. Er jeg for pedandisk?

reynir commented

2020-12-10 20:33:15 +00:00

Author

Owner

Nej, jeg er glad for dit input. Jeg er enig i din pointe med at det er problematisk at være afhængig af en bestemt implementation.

Jeg ved ikke om paragrafnummerering er et krav. Måske i stedet for at referere med numeriske indices kunne man give hver paragraf et navn som man så kan bruge i stedet og helt droppe nummereringen. Til det formål er markdown ikke så velegnet hvis man vil have referencerne renderet som <a>-tags medmindre man benytter sig af extensions.

Ren fantasi, men hvad hvis vi i stedet for følgende:

## § 3. Organisation
Foreningens overordnede ledelse er generalforsamlingen, som består af medlemmer med gyldigt medlemsbevis.
Generalforsamlingen vælger:

- En bestyrelse på 5 personer
- 2 suppleanter for bestyrelsen
- 1 revisor
- Evt. 1 suppleant for revisor

## § 5. Foreningens bestyrelse
Foreningens daglige ledelse forestås af bestyrelsen (Jf. § 3).

Kunne skrive:

## \organisation Organisation
Foreningens overordnede ledelse er generalforsamlingen, som består af medlemmer med gyldigt medlemsbevis.
Generalforsamlingen vælger:

- En bestyrelse på 5 personer
- 2 suppleanter for bestyrelsen
- 1 revisor
- Evt. 1 suppleant for revisor

## \bestyrelse Foreningens bestyrelse
Foreningens daglige ledelse forestås af bestyrelsen (Jf. \organisation).

Helt arbitrært tager jeg udgangspunkt i markdown og bruger \x til at deklarere og referere til en variabel x.

Måske i stedet for at vælge et markup sprog vi oversætter til HTML kunne vi skrive vedtægterne direkte i HTML:

<h2 id="organisation">Organisation</h2>
<p>Foreningens overordnede ledelse er generalforsamlingen, som består af medlemmer med gyldigt medlemsbevis.
Generalforsamlingen vælger:</p>
<ol>
  <li>En bestyrelse på 5 personer</li>
  <li>2 suppleanter for bestyrelsen</li>
  <li>1 revisor</li>
  <li>Evt. 1 suppleant for revisor</li>
</ol>

<h2 id="bestyrelse">Foreningens bestyrelse</h2>
<p>Foreningens daglige ledelse forestås af bestyrelsen (Jf. <a href="#organisation">Organisation</a>).

Evt. med et lint check der checker at tekstindholdet i <a>-tags svarer til den linkede heading.

Nej, jeg er glad for dit input. Jeg er enig i din pointe med at det er problematisk at være afhængig af en bestemt implementation. Jeg ved ikke om paragrafnummerering er et krav. Måske i stedet for at referere med numeriske indices kunne man give hver paragraf et navn som man så kan bruge i stedet og helt droppe nummereringen. Til det formål er markdown ikke så velegnet hvis man vil have referencerne renderet som \<a>-tags medmindre man benytter sig af extensions. Ren fantasi, men hvad hvis vi i stedet for følgende: ``` Markdown ## § 3. Organisation Foreningens overordnede ledelse er generalforsamlingen, som består af medlemmer med gyldigt medlemsbevis. Generalforsamlingen vælger: - En bestyrelse på 5 personer - 2 suppleanter for bestyrelsen - 1 revisor - Evt. 1 suppleant for revisor ## § 5. Foreningens bestyrelse Foreningens daglige ledelse forestås af bestyrelsen (Jf. § 3). ``` Kunne skrive: ``` Markdown ## \organisation Organisation Foreningens overordnede ledelse er generalforsamlingen, som består af medlemmer med gyldigt medlemsbevis. Generalforsamlingen vælger: - En bestyrelse på 5 personer - 2 suppleanter for bestyrelsen - 1 revisor - Evt. 1 suppleant for revisor ## \bestyrelse Foreningens bestyrelse Foreningens daglige ledelse forestås af bestyrelsen (Jf. \organisation). ``` Helt arbitrært tager jeg udgangspunkt i markdown og bruger `\x` til at deklarere og referere til en variabel x. Måske i stedet for at vælge et markup sprog vi oversætter til HTML kunne vi skrive vedtægterne direkte i HTML: ``` html <h2 id="organisation">Organisation</h2> <p>Foreningens overordnede ledelse er generalforsamlingen, som består af medlemmer med gyldigt medlemsbevis. Generalforsamlingen vælger:</p> <ol> <li>En bestyrelse på 5 personer</li> <li>2 suppleanter for bestyrelsen</li> <li>1 revisor</li> <li>Evt. 1 suppleant for revisor</li> </ol> <h2 id="bestyrelse">Foreningens bestyrelse</h2> <p>Foreningens daglige ledelse forestås af bestyrelsen (Jf. <a href="#organisation">Organisation</a>). ``` Evt. med et lint check der checker at tekstindholdet i \<a>-tags svarer til den linkede heading.

👍 1