Vorweg…

Aktualisiert am 18.03.2024

Hier sind vor allem die in der Hilfe verwendeten Begriffe definiert. Einige Begrifflichkeiten werden sinngemäß zu gängigen Bezeichnungen verwendet, konkret auf  OSE  bezogen, können sie eine speziellere Bedeutung haben.

Das Glossar ist im Aufbau. Falls ein Begriff vermisst wird, bitte eine Mitteilung per E-Mail schicken.

A

Absatz

Ein „Absatz“ ist in  OSE  eine Editor-Zeile. Die kann durchaus aus mehreren angezeigten Zeilen bestehen, die statt mit einer Zeilennummer mit einem Umbruchzeichen am linken Rand markiert sind. Maßgeblich ist die Zeilennummer: Dort beginnt eine Zeile bzw. ein Absatz, der mit der nächsten Zeilennummer oder dem Dateiende abgeschlossen ist.

Aktive Umgebung

Mit einem Zusatzprodukt wie z.B. XAMPP kann ein vollwertiger Internet-Server lokal auf dem PC betrieben werden. An diese Umgebung kann das Zielverzeichnis eines Projekts übergeben werden. Das erlaubt die Prüfung der erstellten Website auf dem PC, bevor Änderungen auf den Server geladen werden.

Eine aktive Umgebung ist nur erforderlich, wenn mit Modulen, Layout oder direkt eingebettetem Programmcode (z.B. PHP, Perl, …) die Seiten für die korrekte Darstellung interpretiert werden müssen.

Arbeitsdatei

Bearbeitungen finden grundsätzlich in einer Kopie einer Projektdatei statt. Diese Kopie ist die „Arbeitsdatei“. Sie wird erst durch Speicherung als „Quelltext“ Bestandteil eines Projekts oder überschreibt eine bestehende Quelltext. Die Arbeitsdatei gehört zu den Editor-Dateien.

Arbeitsumgebung

Alle Programmdateien, inklusive der damit bearbeiten Projekte.

Archiv

Eine Datensammlung, die (bei  OSE  ) aus den Datein einer Seite, eines Projekts, des Programms oder der gesamten Arbeitsumgebung bestehen kann.

B

Bilder

Dateien im Format JPEG, PNG, GIF, WEBP, SVG, die für die Ausgabe als Bild in Browsern geeignet sind.

C

CSS

Die Kurzschreibweise von „cascading style sheets“, deutsch „kaskadierende Stilblätter“ , womit es für Unwissende ebenso unverständlich ist.

Gemeint sind Formatbeschreibungen für Seitenelemente auf einer Webseite. Für Überschriften, den Fließtext, Code-Beispiele und anderes können in CSS-Dateien Formatbeschreibungen hinterlegt werden, die bei der Anzeige der Seite genutzt werden.

Das „kaskadierend“ weist auf eine besondere Eigenschaft dieser Formatbeschreibungen hin. Eine vorhandene Sammlung von Definitionen eines Stils kann mit einer weiteren Definition ergänzt oder eine vorhandene damit überschrieben werden. Maßgeblich ist die Reihenfolge des Auftretens.

Die „Format-Kaskade“ hat bei ihrer Verwendung den Wert, der sich aus der bis dort vereinbarten Summe aller einzelnen Definitionen ergibt.

Siehe Stilvorlage

D

Domäne

Die Internet-Adresse (URL), unter der ein Webauftritt erreichbar ist.

In den Ordner auf dem Server, der mit dieser Adresse erreicht wird, werden die Dateien des Zielverzeichnisses kopiert.

Download

Das Übertragen von Daten/Dateien des Servers auf den lokalen Rechner.

E

Editor-Dateien

[OSE] verwaltet verschiedene Dateien automatisch. Das ermöglicht es, eine Arbeit genau dort fortzusetzen, an der die letzte Sitzung beendet wurde. Dafür werden Die Arbeitsdatei und die Basiskonfiguration bei jedem Verlassen des Programms gespeichert, also bereits beim Wechsel zu einem anderen Programm. Zu den Editor-Dateien zählen ebenfalls Lieblingsworte, Textbausteine, globale Module und Layouts, die Programmdatei und -bibliotheken.

Export

Mit „Export“ ist bei  OSE  der Prozess in einem Begriff zusammengefasst, der beim Speichern einer HTML-Datei abläuft. Er umfasst die Übersetzung des Markdown in HTML, das Einbetten in ein Layout, das Ersetzen der Variablen und Module sowie Funktionen.

F

FTP

Die Abkürzung für „File Transfer Protocol“ wird allgemein mit „Dateien von und zu Servern kopieren“ gleich gesetzt.

Mittels FTP etwas „hochladen“ oder „uploaden“ beschreibt das Kopieren einer Datei von einem lokalen Rechner auf einen Server, estwas „downloaden“ oder „herunterladen“ das Gegenteil: Abrufen einer Datei von einem Server zur Verwendung auf einem lokalen Rechner.

Funktion(en)

Im Kontext von  OSE  sind das Operationen, die beim Exportvorgang in der bereits erzeugten HTML-Datei Veränderungen vornehmen.

Das ermöglicht die Simulation von Fähigkeiten, für die auf einem Server üblicherweise Programmiersprachen verwendet werden, die beim Aufruf einer Seite dynamisch Seiteninhalt erzeugen.

Damit können Seiten erzeugt werden, die sowohl auf dem Server als auch lokal auf einem Rechner ohne Scripte den gewünschten Inhalt haben.

G

Generierung

Der mehrstufige Prozess, bei dem aus einem Quelltext eine HTML-Seite erzeugt wird. Der Quelltext wird in HTML umgewandelt und in das Layout eingebettet. In dieser Zwischenstufe werden verwendete Variablen ersetzt, bevor die HTML-Seite zum Speichern angeboten wird.

H

HTML-Seite

PHP-/HTML-Seiten, die lokal oder auf dem Server bereitgestellt werden können oder schon verfügbar sind.

I

Impressum

Für Webseiten gibt es eine „Impressumspflicht“. Das ist die Verpflichtung, für eine Webseite eine „Anbieterkennzeichnung“ bereit zu stellen. Maßgeblich sind dafür §312 BGB und §5 Telemendiengesetz.

J

Javascript

Eine Programmiersprache, die im Browser ausgeführt werden kann. Dafür wird Programmcode mit der Webseite ausgeliefert, der entweder automatisch oder duch Interaktion mit der Webseite ausgeführt wird.

K

Kommentar

Ein Textabschnitt in der Quelltext, der von der Verarbeitung ausgenommen ist. In OSE wird ein Kommentar durch ?? am Absatz-/Zeilenanfang markiert.

Konfigurationsdatei

[OSE] kennt zwei verschiedene Konfigurationsdateien: Die Programmkonfiguration und die Projektkonfiguration(en).

L

Layout

Dateien, die beim Export den generierten Code aufnehmen und mit einem strukturellen Rahmen umgeben, der den Webauftritt bildet. Eine Seite kann nur ein Layout haben, ein Webauftritt dagegen (theoretisch) beliebig viele.

Lieblingsworte

Eine Liste mit Worten, die im Edior farbig hervorgehoben werden können. Damit lassen sich Wortwiederholungen vermeiden oder Fundstellen eines Wortes in der Arbeitsdatei markieren.

M

Markdown

Eine Textform, die durch besondere Auszeichnungen, dem „markdown“, im Rahmen eines formatlosen Textes informationen über Formatwünsche des Schreibenden enthält.

Modul

„Code-Schnipsel“ mit einer speziellen Markdown-Notierung, die im Bereich der Arbeitsdatei bei der Verarbeitung in die HTML-Seite eingebunden werden.

N

Notation

Hier in der Hilfe wird eine „Hinweisnotation“ verwendet:

Eine Zusammenfassung.

Eine Notiz, meist etwas „off topic“.

Eine Anmerkung, die z.B. eine alternative Methode beschreibt oder Hintergrund-Information enthält.

Eine „Information“ enthält Hintergrundwissen oder Hinweise, die über den Rahmen dessen hinaus gehen, das an der jeweiligen Stelle beschrieben wird.

Weiterführende Information zu einem Thema, auch als Symbol für „Glossar-Links“ verwendet.

Ein „Tipp“ oder Hinweis. Das kann sowohl etwas vermeintlich Offensichtliches, als auch etwas „Spezielles“ sein.

Ein hilfreicher, nützlicher oder erforderlicher „Baustein“ zur Erzielung eines Ergebnisses.

Ein Vorgang, der ggf. mehrfach wiederholt werden muss oder kein zwingend offensichtlicher Bestandteil von etwas ist.

Ein Prozess, Ablauf, …

Relevantes Wissen für die Verwendung. Das kann eine Voraussetzung sein oder ein Hinweis, wie sie etwas alternativ erreichen lässt.

Expliziter Hinweis auf eine korrekte Anwendung.

Hinweis auf eine mögliche falsche Verwendung eines Befehls, Funktion, …

Hinweis auf ein mögliches Problem oder womöglich auftretenden Fehler.

Ein Hinweis auf potenzielle Fehlerquellen oder Gefahren.

Ein Hinweis, der unbedingt beachtet werden sollte.

O

Online-Verbindung

Der Rechner muss mit dem Internet verbunden sein, damit Programm-Funktionen verwendet werden können.

Bei  OSE  ist die „Online-Hilfe“ zwar nur mit so einer Verbindung erreichbar, die Verwendung des Programms ist davon unabhängig. Es können problemlso Webseiten erstellt werden, die jedoch erst mit einer Online-Verbindung auf die jeweilige Domäne hochgeladen werden können.

P

Parameter

siehe YAML-Header.

Programmkonfiguration

In dieser Datei sind die für alle Projekte geltenden und Grundfunktionen von [OSE] bestimmende Einstellungen enthalten. Der Dateiname entspricht dem Programmnamen, jedoch mit der Dateiendung „.ini“.

Projekt

Alle Daten, die für die Erstellung und Bearbeitung eines Webauftritts erforderlich sind, inklusive der Quelltexten, Seiten, Modulen und der Konfigurationsdatei.

Projektkonfiguration

In dieser Datei werden Vorgaben für ein Projekt gespeichert, auf die alle Seiten des Projekts bei der Verarbeitung zugreifen.

Der Dateiname entspricht dem Projektnamen, ergänzt mit der Endung „.ini“.

Q

Quelltext, Quelldatei

Markdown-Dateien, aus denen HTML-Seiten entstehen. In  OSE  werden daraus beim Export Zieldateien.

Quellverzeichnis

Das Verzeichnis, in dem die Markdown-Dateien des Projekts als „Quelle“ für die Zieldateien liegen. Typischerweise bildet es mit den Markdown-Texten die Seitenstruktur des Zielverzeichnisses ab.

Querverweis

Dieser Begriff ist im Kontext einer Webseite ein Synonym für „Hyperlink“. Der kann innerhalb der Domäne oder der aktuellen Seite oder auf die Seite einer anderen Domäne führen.

R

Ressourcen

Weitere Daten/Dateien, die für den Webauftritt benötigt werden. Das sind sowohl Bilder, Stilvorlagen, Layouts und weitere Dokumente, als auch Informationen für die Einrichtung des Uploads der Daten auf den Server, genau genommen sogar der Server selbst.

S

Seite

  1. HTML-Seite.

Server

Im Kontext von  OSE  ist das entweder ein „entfernter“ Rechner, der Dateien für die Anzeige im Internet bereit hält, oder eine lokale Lösung, die das Verhalten eines „Internet-Servers“ simuliert.

Für die lokale Simulation kann das Zielverzeichnis einer aktiven Umgebung zugewiesen werden.

Stilvorlage

Eine Datei mit Formatdefinitionen für die Webseite. Sie kann für alle Seiten eines Webauftritts gelten, gleichermaßen können mehrere in einer einzigen Seite verwendet werden.

Siehe CSS

T

Textbausteine

Wiederkehrende Textelemente können als „Kürzel“ hinterlegt und verwendet werden. Die Textbausteine sind Bestandteil der Editor-Dateien und können in allen Projekten verwendet werden.

U

Upload

Das Übertragen der lokalen Seiten in den dafür vorgesehenen Bereich der Domäne.

V

Variablen

  1. Yaml-Header.

Verarbeitung

Die Übergabe der Arbeitsdatei an den Exportvorgang, bei dem Variablen, Parameter, Module und Layout zu einer HTML-Seite verbunden werden.

W

Webauftritt

Die Menge aller einzelnen Seiten, die (typischerweise) im Internet als Bestandteil Domäne zur Verfügung gestellt werden.

Die Entwicklung von Webauftritten ist das Ziel von [OSE].

X

XML

Die „extensible markup language“ ist eine Auszeichnungsform für hierarchisch strukturierte Daten in einer Textdatei. Die Auszeichnung erfolgt ähnlich wie mit HTML, es können jedoch für den jeweiligen Anwendungsfall beliebige Strukturelemente benannt werden. Ob bzw. wie diese Interpretiert werden, hängt vom einlesenden Programm ab.

Y

YAML-Header

Der YAML-Header ist ein Abschnitt am Anfang einer Quelltext, in dem Parameter und Variablen definiert sind, die bei der Verarbeitung der Arbeitsdatei ausgewertet werden.

Z

Zieldatei

Im „ OSE -Jargon“ ist damit das Ergebnis eines Exports gemeint, also die übersetzte Quelldatei, die in einem Layout eingebetet im Zielverzeichnis abgelegt wurde.

Zielverzeichnis

In diesem lokalen Ordner legt  OSE  alle Zieldateien ab. Dieses Verzeichnis entspricht typischerweise dem Inhalt der Webseite auf dem Server.

Zugangsbeschränkung

Für geschlossene Benutzergruppen gibt es die Möglichkeit, Bereiche einer Webseite durch eine Zugangsbeschränkung nur für diese Gruppe zugänglich zu machen. Sehr zuverlässig wird das mit einer .htaccess-Datei erreicht.

Querverweis

Im Abschnitt „Skripte“ gibt es ein Sortiment Skripte, die eine einfache Zugangsverwaltung für eine Webseite ermöglichen.