Acronym Plurals + kurze Doku für Acronyms in README.md (#52)

* Acronym Plurals + kurze Doku für Acronyms in README.md (to be improved allerdings)

* Acronym Plurals + kurze Doku für Acronyms in README.md (to be improved allerdings)

* Update wbh.tex

accept @kreativmonkey s suggestion to use longplural and keep shortplural optional.

Co-authored-by: sebbo <sebastian@1337lounge.de>
main
aslmx 3 years ago committed by GitHub
parent 6b368dbfe6
commit 02a8e9e455
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -182,8 +182,49 @@ Da zuerst die erste Seite des PDFs ausgefüllt wird, muss der Rest des Formulars
Es wird entweder das Logo oder der Name der Hochschule auf dem Titelblatt ausgegeben, jedoch nicht beides. Sollte beides gesetzt sein, so wird gar nichts ausgegeben.
### Abkürzungen / Acronyms
Beispiel für `acronyms.yaml`
```
acronym:
longest: 3gpp
list:
- id: 3gpp
short: 3GPP
long: 3rd Generation Partnership Project
- id: bss
short: BSS
long: Base Station Subsystem
- id: imsi
short: IMSI
shortplural: IMSIs
long: International Mobile Subscriber Identity
longplural: International Mobile Subscriber Identities
```
Verwendung im Markdown dann mit
```
\acl{3gpp} %% Lang
\acs{3gpp} %% Kurz
\acp{imsi} %% Lang Plural
\acsp{3gpp} %% Kurz Plural
```
Bei den Pluralen ist zu beachten, dass wenn kein Plural definiert ist (siehe `acronyms.yaml` Beispiel), dass einfach ein "s" angehangen wird.
Für mehr Info über Acronyme, siehe [Dokumentation LaTeX acronym Package](https://mirror.clientvps.com/CTAN/macros/latex/contrib/acronym/acronym.pdf)
## ToDo
- [ ] Codeblock mit Linenumbers
- [ ] Installationsanleitung
- [ ] `metadata.yaml`
- [ ] `defaults.yaml`

@ -573,6 +573,9 @@ $if(acronym)$
%\setlength{\itemsep}{-\parsep} % geringerer Zeilenabstand
$for(acronym.list)$
\acro{$it.id$}[$it.short$]{$it.long$}
$if(it.longplural)$
\acro{$it.id$}[$if(it.shortplural)$$it.shortplural$$else$$it.short$$endif$]{$it.longplural$}
$endif$
$endfor$
\end{acronym}
\pagebreak

Loading…
Cancel
Save