← Alle Notizen

Leitfaden: Beiträge für sbayer.de

Veröffentlicht

Redaktion

Auch auf: English, español

Diese Seite richtet sich an alle, die Beiträge für sbayer.de schreiben.

Die Webseite wird aus einfachen Textdateien im Format Markdown erzeugt. Je näher ein Manuskript an diesem Format ist, desto schneller und fehlerfreier ist es online. Word-Dateien oder Google Docs gehen auch, aber dann gilt umso mehr: nur die hier beschriebenen Gestaltungsmittel verwenden. Alles andere geht bei der Übernahme verloren.

Am einfachsten ist es, die Vorlage herunterzuladen und auszufüllen. Sie lässt sich mit jedem Texteditor öffnen.

Was zu einem Beitrag gehört

  1. Der Text als eine Datei, am besten Markdown (.md), sonst Word oder ein Link auf ein Google Doc.
  2. Die Kopfangaben (siehe unten), entweder oben in der Datei oder in der Begleit-E-Mail.
  3. Bilder und Downloads als einzelne Dateien, nicht nur in ein Word-Dokument eingefügt.

Kopfangaben

Jeder Beitrag braucht ein paar Angaben, die nicht im Fließtext stehen. In der Vorlage stehen sie zwischen zwei Linien aus drei Bindestrichen:

---
title: "Nextcloud-Ordner mit rclone synchron halten"
date: 2026-11-15
summary: "Wie man mit rclone bisync einen Ordner zwischen Laptop und Nextcloud abgleicht und welche Stolperfallen es dabei gibt."
tags: [NextCloud, Linux]
---
Angabe Bedeutung
title Überschrift des Beitrags. Höchstens etwa 70 Zeichen, ohne Punkt am Ende.
date Gewünschtes Veröffentlichungsdatum im Format JJJJ-MM-TT.
summary Ein bis zwei Sätze, höchstens etwa 200 Zeichen. Erscheint in der Übersicht, im RSS-Feed und in Suchmaschinen. Sollte für sich allein verständlich sein und nicht mit „In diesem Beitrag …“ beginnen.
tags Zwei bis vier Schlagwörter. Möglichst die Schlagwörter verwenden, die es im Notizbuch schon gibt.

Die Adresse der Seite (z. B. sbayer.de/de/nextcloud-rclone-bisync/) legen wir fest. Wer einen Wunsch hat, kann ihn als permalink: nextcloud-rclone-bisync angeben: nur Kleinbuchstaben, Ziffern und Bindestriche, keine Umlaute.

Aufbau des Textes

Kein Titel im Text. Die Überschrift kommt aus den Kopfangaben. Der Text beginnt direkt mit dem ersten Absatz.

Einstieg ohne Überschrift. Ein bis drei Absätze, die sagen, worum es geht und für wen der Beitrag gedacht ist. Wer nur diesen Teil liest, soll wissen, ob sich das Weiterlesen lohnt.

Zwischenüberschriften in zwei Ebenen:

## Abschnitt

### Unterabschnitt

Tiefer als drei Rauten bitte nicht gliedern. Zwischenüberschriften sind kurz und sagen etwas über den Inhalt („Schlüssel erzeugen“ statt „Schritt 2“). Bei Anleitungen in mehreren Teilen heißt der Titel „… – Teil 1: …“ usw.

Kurze Absätze. Drei bis sechs Sätze. Zwischen zwei Absätzen steht eine Leerzeile; ein einfacher Zeilenumbruch wird ignoriert.

Schluss. Ein Fazit, eine Zusammenfassung oder weiterführende Links sind willkommen, aber kein Muss.

Formatierung

Diese Mittel stehen zur Verfügung und werden genau so übernommen:

Was So schreiben
fett **wichtig**
kursiv *Begriff*
Link [Linktext](https://beispiel.de), immer mit vollständiger Adresse
Aufzählung Zeilen mit - am Anfang
nummerierte Liste Zeilen mit 1. , 2. …
Zitat Absatz mit > am Anfang
Code im Text `sudo apt update` (einfache Backticks)
Tabelle wie die Tabellen auf dieser Seite, nur einfache Inhalte

Code und Befehle über mehrere Zeilen stehen in einem Block aus drei Backticks, dahinter die Sprache (bash, python, yaml, json …):

```bash
rclone bisync ~/Dokumente nextcloud:Dokumente --resync
```

Befehle bitte so angeben, dass man sie kopieren und ausführen kann: ohne vorangestelltes $ und ohne Ausgaben im selben Block. Ausgaben kommen in einen eigenen Block ohne Sprachangabe.

Nicht übernommen werden: Schriftarten, Schriftgrößen und Farben, Unterstreichungen, zentrierter Text, mehrspaltige Layouts, Textfelder, Fußnoten und automatische Inhaltsverzeichnisse. Hervorhebungen gehen nur über fett und kursiv. Statt einer Fußnote einen Satz in Klammern oder einen Link verwenden.

Bilder

  • Bilder als einzelne Dateien mitliefern (JPG für Fotos, PNG für Screenshots), mindestens 1200 Pixel breit, gern größer. Wir verkleinern selbst.
  • Dateinamen ohne Leerzeichen und Umlaute, z. B. rclone-konflikt.png.
  • Im Text steht an der richtigen Stelle ein Verweis mit einer kurzen Bildbeschreibung:
![Konfliktmeldung von rclone im Terminal](rclone-konflikt.png)
  • Die Beschreibung in eckigen Klammern ist Pflicht. Sie wird vorgelesen, wenn jemand das Bild nicht sieht, und sagt, was darauf zu sehen ist.
  • Eine Bildunterschrift steht als eigener, kursiver Absatz direkt darunter.
  • Nur Bilder verwenden, an denen wir die Rechte haben. Bei fremden Bildern bitte Quelle und Lizenz angeben. Bilder werden nie von fremden Servern eingebunden, sondern auf sbayer.de abgelegt.
  • Screenshots vorher auf persönliche Daten prüfen (Namen, E-Mail-Adressen, Kennwörter, IP-Adressen).

Videos und eingebettete Inhalte

Ein YouTube-Link allein in einem eigenen Absatz wird automatisch zu einer Vorschaukarte mit Bild. Der Player lädt erst, wenn man darauf klickt. Vorher wird keine Verbindung zu YouTube aufgebaut.

Wie das in der Praxis aussieht, zeigt dieses Video:

https://www.youtube.com/watch?v=VIDEO-ID

Andere Einbettungen (Social-Media-Beiträge, Karten, Formulare, Podcast-Player) übernehmen wir nicht, weil sie beim Aufruf der Seite Daten an Dritte senden. Stattdessen einfach normal verlinken.

Downloads

Skripte, Konfigurationsdateien oder PDFs, die zum Beitrag gehören, als Datei mitliefern und im Text verlinken:

Das vollständige Skript gibt es [hier zum Download](backup-nextcloud.sh).

Der Text und die Datei müssen zusammenpassen. Wenn im Text ein Befehl oder Ausschnitt steht, sollte er genauso in der Datei vorkommen.

Sprachen

Die Webseite erscheint auf Deutsch, Englisch und Spanisch. Es genügt, einen Beitrag in einer Sprache zu liefern; die übrigen Fassungen erstellen wir. Wer selbst übersetzt, behält die Gliederung bei: dieselben Abschnitte, Bilder und Codeblöcke in derselben Reihenfolge. Codeblöcke werden nicht übersetzt, Kommentare darin schon.

Überarbeitungen

Bei Änderungen an einem veröffentlichten Beitrag bitte die vollständige neue Fassung schicken und in ein, zwei Sätzen sagen, was sich geändert hat. Der Beitrag bekommt dann den Hinweis „aktualisiert am …“.

Checkliste vor der Abgabe

  • Titel, Datum, Kurzbeschreibung und Schlagwörter angegeben
  • kein Titel im Text, Einstieg ohne Überschrift
  • Zwischenüberschriften nur mit ## und ###
  • Links mit vollständiger Adresse
  • Code in Blöcken mit Sprachangabe, Befehle ohne $
  • alle Bilder als Dateien, mit Beschreibung, Rechte geklärt, keine persönlichen Daten
  • Downloads beigelegt und im Text verlinkt
  • Text, Bilder und Downloads zusammen an Stefan geschickt, gern als ZIP