bunteshaus.de/docs/artikelstruktur.md

87 lines
3.9 KiB
Markdown
Raw Normal View History

2022-04-04 18:04:16 +02:00
# Anleitung fuer Artikel
## Grundlegendes
Jeder Artikel ist ein Ordner der in den Ordnern `content/events` `content/news` oder `content/bunteshaus` liegen kann.
Dadrin muss sich mindestens eine `index.*.md` Datei befinden und ggf. noch Bilder, die den Artikel illustrieren.
Das Sternchen steht dabei fuer `de`, `ku` oder `en`. Dieses steht für die Übersetzung des Artikels.
Ein Beispiel sieht so aus:
```
2022-04-04 18:23:02 +02:00
--content/news/2323.12.29-Konzert
2022-04-04 18:04:16 +02:00
|_ index.de.md
|_ index.en.md
|_ 1.jpg
```
2022-04-04 18:41:32 +02:00
Eine Methode ist, einen Artikel auf Deutsch anzulegen (`index.de.md`), diese Datei zu `index.ku.md` kopieren und dann den [Inhalt](https://schlomp.space/Bunteshaus/bunteshaus.de#inhalt) zu übersetzen.
2022-04-04 18:04:16 +02:00
## Metadaten
```
1 ---
2 title: "Testtitel"
3 date: 2021-10-23T18:15:19+02:00
4 featured: false
2022-04-04 18:23:02 +02:00
5 about: false
6 when: "Jeden Montag, 19Uhr"
7 categories: ["Pressemitteilung"]
8 events: ["Konzert"]
9 tags: ["Interpretin 1", "Interpretin 2", "Interpret 3"]
10 price: "3€"
11 registeremail: "mail@bunteshaus.de"
12 covid: "3G"
13 ---
14 Endlich wieder Konzerte und den Auftakt macht Testtitel!
2022-04-04 18:04:16 +02:00
```
2022-04-04 20:07:52 +02:00
| ZeilenNr. | Bedeutung | notwendig |
2022-04-04 20:06:10 +02:00
|---:|:---|---:|
2022-04-04 20:07:09 +02:00
| Zeile 1| und 13 Kennzeichnen die Metadaten.| yes |
| Zeile 2| ist der Titel, wie er auf der Homepage auftauchen wird.| yes |
| Zeile 3| ist das Datum und die Zeit (und Zeitzone (`+02:00`)), an dem der Artikel erstellt wird.| yes |
| Zeile 4| kann benutzt werden, um den Artikel prominent zu Platzieren. (Pressemitteilungen etc.)| |
| Zeile 5| damit wird ein artikel in die ueberuns kategorie aufgenommen (das projek "café" zb)| |
| Zeile 6| wenn etwas ein Event ist, dann hat es ein Datum. Hier kann man das wie im beispiel angeben.| |
2022-04-04 20:08:20 +02:00
|Zeile 7*| da alles eine news ist, gibt man so die kategorie fuer diese an. Fuer zb Partys oder Konzerte Inhaus empfiehlt sich "Buha"| |
|Zeile 8*| Wenn etwas ein Event ist, kriegt es eine spezielle Kategorie. (Konzert, Party, Regelmäßig, Workshop (siehe Liste auf der homepage))| |
|Zeile 9*| zum taggen von artikeln. zb interpreten von konzerten, thematliche schwerpunkte, vortragende.| |
2022-04-04 20:07:09 +02:00
|Zeile 10| kann benutzt werden um die Kosten des Termin anzugeben. Füllbar mit Text "3€" oder "free"| |
|Zeile 11| heisst irrtuemlich noch so, wird aber geaendert| |
|Zeile 12| falls man noch vor covid warnen muss (work in progress :D)| |
|Zeile 14| Ab Zeile 14 Beginnt der Inhalt| |
2022-04-04 19:43:14 +02:00
2022-04-04 19:58:09 +02:00
\* Kategorien und Tags funktionieren so:
2022-04-04 19:59:36 +02:00
Da man da mehrere Daten angeben kann, muss ein Eintrag in eckige Klammern:
`categories: ["einzelne kategorie"]`
Sollen da mehr Kategorien stehen, gibt man diese so an:
`categories: ["erste kategorie","zweite kategorie","dritte kategorie"]`
2022-04-04 19:37:20 +02:00
2022-04-04 18:04:16 +02:00
## Inhalt
2022-04-04 18:28:32 +02:00
Soll eine Überschrift im Text passieren, schreibe `##` vor den Teile. Eine Unterüberschrift geht mit `###`
2022-04-04 18:32:24 +02:00
`## Kapitelüberschrift`
`### Absatzüberschrift`
2022-04-04 18:40:15 +02:00
2022-04-04 18:32:24 +02:00
Soll etwas **fettschrift** geschrieben werden, schreibe `**` davor und dahinter.
2022-04-04 18:32:57 +02:00
`**worte in fettschrift**`
2022-04-04 18:40:15 +02:00
2022-04-04 18:04:16 +02:00
Soll eine neue Zeile angefangen werden, schreibe zwei Leerzeichen hinter den Satz.
2022-04-04 18:32:57 +02:00
`[...] am ende des satzes. | <- Der Strich symbolisiert das Zeilenende`
2022-04-04 18:40:15 +02:00
2022-04-04 18:32:24 +02:00
Soll ein Absatz gemacht werden, lasse eine Zeile zwischen dem ersten und dem neuen Absatz frei.
2022-04-04 18:04:16 +02:00
Eine Link kann einfach geschrieben werden, allerdings kann man diesen auch gestalten:
`[Bunteshaus](https://bunteshaus.de)` wird [Bunteshaus](https://bunteshaus.de)
2022-04-04 18:39:40 +02:00
Du kannst ein Bild aus dem Ordner des Artikels hinzufuegen:
`{{< picture 1 "Beschreibung" >}}`
Benenne Bilder Alphabetisch.
Fuer einen Artikel brauchst du im Optimalfall min. 1 Bild.
2022-04-04 18:43:45 +02:00
Das erste Bild, welches gefunden wird, illustriert den Artikel in der Übersicht.
Jedes weitere Bild steht zu Verfuegung um damit den Artikel im Text zu illustrieren.
2022-04-04 18:39:40 +02:00
Das Snippet oben wird and der Stelle eingefuegt, an der das Bild erscheinen soll.
2022-04-04 18:45:15 +02:00
Die Nummer dadrin ist fortlaufend ab 1. (Das Snippet oben symbolisiert quasi das zweite Bild im Ordner)
2022-04-04 18:04:16 +02:00