Im Bereich “Know-How” gibt es neben zahlreichen Download-Dateien auch einzelne Artikel. Die meisten davon wurden aus dem früheren Wiki von der alten Seite importiert. Daher heißt dieses Layout hier “wiki”. Die Artikel bestehen aus einer einzelnen Datei, können aber auch Bilder eingebettet haben.
Für den Wiki-Artikel ist also nur eine Datei erforderlich. Selbstverständlich bietet sich auch hier das benutzte Markdown-Format zur Darstellung des Inhaltes an.
Und ebenso wie sonst auch ist hier zuerst ein Frontmatter enthalten, mit dem die nötigen Informationen zur Darstellung an Hugo gegeben werden. Es unterscheidet sich ein klein wenig von dem der Download-Dateien, da die Angabe über eine beigeordnete Datei entfällt.
| Frontmatter | Angabe | Erläuterung |
|---|---|---|
| --- | Leitet den Frontmatter-Block ein | |
| layout: "wiki" | Pflicht | Das Layout für einen Wiki-Artikel heißt "wiki". |
| title: "RC5 Codes für IR Contol Set 30344" | Pflicht | Der Titel, der als Überschrift oben erscheint |
| date: 2016-08-24T00:00:00+0200 | Pflicht |
Das Datum des uploads - wird automatisch erzeugt.
Codierung: yyyy-mm-ddThh:mm:ss+hhmm Beim manuellem Erstellen neuer Seiten bitte die Zeitzone (`+0100` MEZ bzw. `+0200` MESZ nicht vergessen)! Es wird empfohlen, vorhandene Archetypes zu nutzen. Hugo kümmert sich dann um das korrekte Datum mitsamt der Zeitzone. Für legacy Dateien die älter als 2 h sind, ist die Angabe der Zeitzone unerheblich und kann entfallen. Für alles aktuelle soll sie rein, sonst wird die Seite von Hugo nicht (zur richtigen Zeit) gebaut. |
| konstrukteure: - "uffi" |
Option | 'Autor' (im Singular!) wär hier von der Wortwahl geschickter, konstrukteure nennen wir es sonst aber auch. Im Falle eines aus der alten Seite importierten Wiki-Artikels sind der Autor und der Nutzer normalerweise identisch. |
| uploadBy: - "uffi" |
Pflicht | Logisch macht es keinen Sinn, hier eine Liste zu führen, denn der upload erfolgt natürlich nur von einem Nutzer. Nun gibt es da aber eine kleine Kosmetik für eine angenehme Formulierung der Angaben auf der Seite. Und diese Kosmetik funktioniert (derzeit) nur mit gleichen Datentypen. Deswegen: Liste mit nur einem Eintrag. |
| license: "unknown" | Option | Die Angabe der Lizenz zur Veröffentlichung. Gab es in der alten ftc nicht, ist neu hier. |
| legacy_id: - /wiki1b8f.html |
Option |
Das ist gedacht für Seiten, die aus der alten ftc übernommen wurden.
Ebenso nützlich, aber auch wenn mal was verschoben wurde. Dann bleiben
die Links darauf alle wirksam.
'https://www.ftcommunity.de' wird rausgeworfen, der Rest kommt so wie
in der url-Zeile vom Browser bis zum ersten Sonderzeichen - meist ein
'?'.
Original hieß das mal https://www.ftcommunity.de/wiki1b8f.html?action=show&topic_id=40 Falls ein imported tag vergeben ist, muss auch eine legacy_id vorhanden sein! |
| imported: - "2019" |
Option |
Wird dieser Eintrag gemacht, ist die Datei aus einer vorherigen
ftc-Version übernommen worden. "2019" steht dann für das Jahr, in
dem der Import gemacht wurde.
Ist die Datei neuer als aus dem Jahr 2018, wird dieser Eintrag nicht gemacht. Die Idee ist, hier bei Bedarf einen Automaten drauf loszulassen, der die Einträge vornimmt / ergänzt (z. B.: - "2019" -> - "2019" - "2033"). Vorläufig wird das Feld nicht ausgewertet, hilft uns aber eines Tages herauszufinden, was schon vorher da war. legacy_id ist dafür ungeeignet, da dort jede ehemalige ID reinkommt - also auch wenn innerhalb der aktuellen ftc-Seite was verschoben wird. Zukunftssicher ist eine Liste besser geeignet als ein einzelner String. |
| --- | Schließt den Frontmatter-Block ab. |
Für das gewählte Beispiel (ex_wiki_RC5_Codes_fr_IR_Contol_Set_30344.md) haben wir dieses Frontmatter:
---
layout: "wiki"
title: "RC5 Codes für IR Contol Set 30344 (für den schwarzen Empfänger)"
date: 2016-08-24T00:00:00
konstrukteure:
- "uffi"
uploadBy:
- "uffi"
license: "unknown"
legacy_id:
- /wiki1b8f.html
imported:
- "2019"
---
<!-- https://www.ftcommunity.de/wiki1b8f.html?action=show&topic_id=40 -->
<!--
Wiki
Thema: RC5 Codes für IR Contol Set 30344 (für den schwarzen Empfänger)
Aktuelle Version
von: uffi
am: 24.08.2016, 19:04:16 Uhr
Historie:
Version 3 von uffi am 24.08.2016, 18:02:57 Uhr
Version 2 von uffi am 24.08.2016, 15:23:26 Uhr
Version 1 von uffi am 24.08.2016, 14:56:29 Uhr
Das hier wäre dann Version 4, die auf .md umgestellt und etwas aufgehübscht
wurde. Uffi wird es mir wohl verzeihen.
-->
Nach dem Frontmatter kommt nun noch ein wenig Antiquarisches.
In der Beschreibung steht zuerst der vollständige Link zur alten ftc als html-Kommentar, um notfalls die volle Info über die Herkunft zur Verfügung zu haben. Der Link selbst erscheint nirgends. Zusätzlich ist noch die Historie angegeben, so wie sie die alte Seite aufgelistet hat. Die wird auch nicht angezeigt (wohl aber dem Kundigen offenbart).
Nach diesem langen HTML-Kommentar kommt dann der eigentliche Inhalt der Seite. Die Beschreibung darf mit allem, was Markdown bietet, formatiert werden. Eventuell steht an der ein oder anderen Stelle ein HTML-Tag dazwischen um dem Markdown etwas nachzuhelfen.
Wie das alles in der Darstellung genau aussieht, bestimmt die zugehörige
“Beschreibung” in der Datei
layouts/knowhow/wiki.html,
die die Angaben für das layout: “wiki” liest und in eine angenehme
Browseransicht umsetzt. Dieses Skript ist hier beschrieben.