VN-Designer Entwickler-Dokumentation
13

Exportieren und Veröffentlichen

Was beim Export in den Ordner publish/ geschieht, wie Seiten, CSS, Laufzeit-Dateien und Beiträge von Erweiterungen entstehen, wie Vorschau und FTP-Upload arbeiten, welche Datenschutz-Regeln gelten und was Autoren beeinflussen können.

Überblick#

Drei Wege führen von einem Projekt zu einer Website:

WegKnopfZielZweck
Exportieren„Exportieren“<Projekt>/publish/fertige, hochladbare Website
VorschauAuge (Live-Vorschau), „Im Browser ansehen“<Programm-Profil>/preview/<Kennung>/site/Ansehen und Testen, nie in publish/
Veröffentlichen„Veröffentlichen“ › „Auf den Server hochladen“exportiert zuerst, lädt dann publish/ per FTP, FTPS oder SFTP hochWebsite auf den Server bringen

Die Website ist reines HTML und CSS, wahlweise mit PHP-Seiten. Sie braucht zum Betrieb weder das Programm noch eine Datenbank des Programms.

Der Ordner publish/#

Das Ergebnis des Exports, hier gekürzt für das Beispiel-Projekt aus dem Kapitel Pakete (drei Seiten, ein Bild, ein SVG):

text
publish/
  index.html  impressum.html  kontakt.html
  style.css
  assets/images/foto.jpg  assets/images/logo.svg
  vendor/bootstrap.min.css
  vendor/bootstrap.bundle.min.js
  vendor/bootstrap-icons/…

Dazu kommen je nach Inhalt vendor/vn-…/ (Laufzeit-Skripte), assets/vn-…/ (Server-Teile), assets/<Erweiterung>/ (Beiträge von Erweiterungen), assets/fonts/, assets/vn-shared/config.php, sitemap.xml, robots.txt, llms.txt, vn-translate/ und vn-blog/. Im Projektordner liegt außerdem .publish-pages.json (Liste der zuletzt exportierten Seiten); sie bleibt außerhalb von publish/ und wird nicht hochgeladen.

Der Export überschreibt nur, was er selbst erzeugt. Andere Dateien in publish/ (etwa eine selbst angelegte .htaccess) bleiben liegen und gehen beim Hochladen mit.

Ablauf des Exports#

exportSite() in index.html ruft buildExportSite() (src/publish.js) auf und gibt das Ergebnis an fs:savePublishHtml (main.cjs). Schritte:

  1. Seiten wählen. Exportiert werden die Seiten mit Häkchen in der Seitenliste (publish nicht false); die Vorschau nimmt zusätzlich die aktive Seite. Ohne Seite oder ohne Block bricht der Export mit einer Meldung ab. Das CSS aller Seiten kommt trotzdem in style.css, auch wenn nur einzelne Seiten exportiert werden.
  2. Blöcke je Seite rendern und alle Anpassungen einbacken (Einbacken).
  3. Seite zusammensetzen (Aufbau einer Seite).
  4. style.css bündeln (Aufbau von style.css).
  5. Dateien schreiben: Seiten, style.css, referenzierte Dateien aus assets/, benutzte Laufzeit-Dateien aus vendor/, Server-Teile, Beiträge von Erweiterungen, SEO-Dateien.
  6. Aufräumen: Seiten und Dateien eines früheren Exports, die jetzt nicht mehr dazugehören, werden entfernt (Dateinamen, Assets).

Aufbau einer Seite#

Jede Seite hat diese Reihenfolge (aus buildExportHtml):

text
[Code „vor dem Dokumenttyp“ (Global + Seite) und PHP-Code mit data-position="top"]
<!doctype html>
<html lang="…">
<head>
  meta charset, meta viewport, title
  meta description, Open-Graph-/Twitter-Tags (nur mit Social-Bild und Website-Adresse)
  SEO-Tags (Canonical, Robots, JSON-LD …; nur wenn eingeschaltet)
  Favicon
  vendor/bootstrap.min.css (außer im Bootstrap-Modus „aus dem Theme“), vendor/bootstrap-icons/bootstrap-icons.css
  Stile der Zusatzfunktionen (Lightbox, Cookie-Hinweis, WhatsApp, Popup, CMS, Tooltip, Animationen)
  style.css
  Beitrag „head“ der Erweiterungen
  Code „vor </head>“ (Global, dann Seite)
</head>
<body>
  Code „nach <body>“
  seitenweite Blöcke oben (Menü …), Blöcke der Seite, seitenweite Blöcke unten (Fußzeile …)
  Nach-oben-Knopf und Anker-Versatz
  Skripte: vendor/bootstrap.bundle.min.js (oder die Skripte des Themes)
  Skripte der Zusatzfunktionen (nur wenn benutzt)
  Beitrag „bodyEnd“ der Erweiterungen
  Code „vor </body>“ (Global, dann Seite)
</body>
</html>

Der Titel ist der SEO-Titel der Seite, sonst der Projektname (für Seiten außer „Home“ mit Seitennamen: Projekt — Seite). lang kommt von der Seite oder der Website (Vorgabe de; ungültige Werte werden zu de). Der Nach-oben-Knopf ist standardmäßig an (Website-Einstellung). Die Skripte der Zusatzfunktionen (Video, Hintergrundvideo, Animation, Formular, Tooltip, Untermenü, Übersetzer) stehen nur auf Seiten, deren HTML sie braucht.

Texte und Anpassungen einbacken#

Jeder Block wird mit seinen aktuellen Werten gerendert (schemaEntry.render). Danach arbeitet der Export die Anpassungen des Nutzers in genau dieser Reihenfolge in das HTML ein; Editor-Spuren (data-vn-text-id, contenteditable, vn-editable-text, data-vn-image-key, data-vn-drag…) verschwinden dabei:

  1. Video-Einbettungen und Video-Attribute, PDF-Betrachter-Adressen; Editor-Attrappen (data-vn-editor-only) werden entfernt.
  2. CMS: Texte und Bilder als änderbar kennzeichnen (nur Blöcke mit CMS).
  3. Textgröße, Textbreite, Textposition (die Regler im Panel).
  4. Menüpunkt-Symbole.
  5. Animationen.
  6. Texte: eingegebener Inhalt, gewählte Überschrift-Ebene, Links, Ausrichtung.
  7. Buttons, Symbole (Bootstrap Icons und eigene Symbole), freie Bilder, Bild-Links, Alt-Texte, Titel, Größen.
  8. Bei aktivem Cookie-Hinweis: Drittanbieter-Einbettungen sperren (Datenschutz).
  9. Bild-Optimierung (unten).
  10. Freie Bild-Ebenen in einen Behälter mit position: relative legen; Popup-Blöcke in ihr Fenster setzen.

Danach werden alle file://-Adressen des Projekts zu assets/…. PHP-Code aus <script type="text/x-vn-php"> wird zu rohem PHP; steht data-position="top" am Skript, kommt er an den Dateianfang.

Aufbau von style.css#

Alle Seiten laden dieselbe Datei style.css (Browser-Cache). Der Inhalt in dieser Reihenfolge:

  1. Das Theme-CSS aller im Projekt aktiven Themes, ungescopt und ohne @layer.
  2. Das CSS aller Blöcke aller Seiten, je Block seine kompilierte LESS-Ausgabe mit der Instanzklasse davor. Seitenweite Blöcke stehen nur einmal.
  3. Die @font-face-Regeln der eigenen Schriften und die Schrift- und Typografie-Einstellungen der Website.
  4. Die Regeln der Freien Fläche (vn-fl-wrap), wenn eine Seite sie braucht.
  5. Feste Regeln des Programms: festes Menü auf voller Breite mit z-index: 5000, Dialoge (.modal, .modal-backdrop) über dem Menü, Abdunkeln der Menüpunkte und farbiger Links beim Überfahren, aufgeklapptes Handy-Menü (Abstand unten, in sich scrollbar ab 80 % Fensterhöhe), Linkstil (Unterstreichung in Menü und Block, Einstellung des Programms).
  6. Zuletzt das Eigene CSS des Nutzers („Eigenes CSS…“), damit es alles überstimmt.

Der Editor kennt @layer und @scope, die fertige Seite nicht: dort entscheidet bei gleicher Spezifität die Reihenfolge. Alle file://-Adressen im CSS werden zu assets/….

Seitenweite Blöcke im Export#

Seitenweite Blöcke (Attribut global, siehe Seitenweite Blöcke) liegen in einer eigenen Liste und stehen auf jeder exportierten Seite: Blöcke, deren Gruppe menu, nav oder header enthält, vor dem Seiteninhalt, alle anderen danach. Im Test stand das Menü vor dem Hero und die Fußzeile danach.

Seiten und Dateinamen#

  • Der Dateiname einer Seite lautet ^[a-z0-9_-]+\.(html|php)$ (nur Kleinbuchstaben, Ziffern, _, -); die Endung wählt der Nutzer in der Seitenliste. Ein anderer Name lässt den Export mit „Ungültiger Dateiname“ scheitern.
  • PHP in .html: Enthält eine Seite PHP-Code (Block „Eigener PHP-Code“, CMS, Blog, eigener Code in den Globalen Einfügungen) und heißt .html, benennt das Programm sie nicht um. Es meldet nur: „PHP läuft dort nur, wenn dein Server .html als PHP ausführt“. Der Nutzer stellt den Dateinamen auf .php.
  • Seiten, die diesmal nicht exportiert werden (abgehakt, umbenannt, gelöscht), entfernt der Export wieder aus publish/, aber nur, wenn sie von ihm stammen (Liste .publish-pages.json und die Kennung vendor/bootstrap-icons/bootstrap-icons.css in der Datei).
  • Die DEMO-Edition fügt jeder Seite einen Hinweis auf VN-Designer hinzu.

Bilder und assets#

Kopiert werden nur Dateien, auf die das fertige HTML oder CSS verweist: jede Zeichenfolge assets/… im Text der Seiten und von style.css (Ende bei Anführungszeichen, Klammer, Leerzeichen, &, <, >). Ein Theme-Import, der Hunderte Demo-Bilder in assets/ gelegt hat, bläht publish/ deshalb nicht auf. Außerdem:

  • Dateien über 20 MB (Videos) werden nicht erneut kopiert, wenn die vorhandene Datei gleich groß und nicht älter ist.
  • Verweise, die der Export nicht im Text findet, kopiert er ausdrücklich: assets/vn-shared/ (immer), assets/vn-formrender/forms/ und die PDFs der PDF-Betrachter (Schriften und Bilder im CSS findet die normale Suche).
  • Ein früher exportiertes Bild, auf das nichts mehr verweist, wird aus publish/assets/ gelöscht (leere Ordner ebenfalls). Auf dem Server löscht das Programm nichts.
  • Die Theme-CSS-Dateien unter assets/theme/ und die Skripte unter assets/theme-js/ werden nur kopiert, wenn die Seiten darauf verweisen (das Theme-CSS steckt in style.css).

Bild-Optimierung#

Die Optimierung ist nur aktiv, wenn das SEO-Werkzeug (site.seo) eingeschaltet ist und „Bilder optimieren“ gilt. Dann erhalten alle Bilder ab dem dritten einer Seite loading="lazy", alle decoding="async", und Projektbilder ohne Größenangabe das Attribut style="aspect-ratio:auto <Breite> / <Höhe>" (das natürliche Seitenverhältnis, damit die Seite beim Laden nicht springt). Bewusst ohne width/height, die ein Layout verzerren könnten. Das Programm verkleinert oder konvertiert keine Dateien.

SEO-Ausgabe#

Alles hier ist aus, solange das SEO-Werkzeug nichts einstellt; bestehende Seiten bleiben dann Zeichen für Zeichen unverändert. Mit Einstellungen entstehen im head: canonical, Robots-Meta (max-image-preview …), zusätzliche Social-Tags, hreflang und JSON-LD (Organisation, lokales Geschäft, Hotel …). Außerdem schreibt der Export die Dateien sitemap.xml, robots.txt und llms.txt (nur diese drei Namen, nur wenn eingeschaltet, je höchstens 2 MB). Ist eine davon ausgeschaltet, löscht der nächste Export die zuvor erzeugte Datei, aber nur wenn sie in den ersten 400 Zeichen „Erzeugt von VN-Designer“ trägt. Die Open-Graph-Tags gibt es ohne SEO-Werkzeug, wenn die Seite ein Social-Bild und die Website eine absolute Adresse hat.

Laufzeit-Dateien aus vendor/#

Das Programm kopiert nur, was die exportierten Seiten wirklich laden. Auslöser ist ein Verweis im HTML der Seiten:

Ziel in publish/Auslöser
vendor/bootstrap.min.css, vendor/bootstrap.bundle.min.js, vendor/jquery.min.jsVerweis im HTML (jQuery nur im Bootstrap-Modus „aus dem Theme“)
vendor/bootstrap-icons/immer
vendor/vn-lightbox/, vn-cookie-consent/, vn-whatsapp/Funktion in der Leiste eingeschaltet
vendor/vn-tooltip/, vn-submenu/, vn-popup/, vn-sform/, vn-bgvideo/, vn-video/ein Block auf einer Seite braucht es
vendor/vn-cms/ (mit erzeugter config.php)ein Block mit CMS
assets/vn-formrender/ (mit forms/.htaccess, config.php, recipients.php)Klasse vn-formrender oder vn-sform-form im HTML
assets/vn-search/Klasse vn-search
assets/vn-pdf-viewer/ samt den benutzten PDFsPDF-Betrachter
vn-translate/ (mit vn-translate-config.php und .htaccess)VN Übersetzer aktiv
vn-blog/Blog-Bausteine

recipients.php listet die Empfängeradressen aller data-recipient-Werte der Formulare (und ab Version 1.3.100 der Adressen aus native-form-handler.php?to=…); mailer.php und native-form-handler.php senden nur an diese Adressen (der Handler zusätzlich an die eigene Absenderadresse, siehe Empfänger). Die Dateien im Programm unter vendor/ sind Teil des Programms, nicht des Projekts; Autoren können sie nicht ändern.

vn-shared und config.php#

Zugangsdaten stehen nie im Projektordner, sondern im Programm-Profil. Erst beim Export entstehen die PHP-Konfigurationsdateien in publish/: assets/vn-shared/config.php mit den SMTP-Werten und einem hmac_secret, wenn ein SMTP-Zugang eingetragen ist (in der Vorschau mit Mail-Fänger-Werten). Variablen: $smtp_host, $smtp_port, $smtp_encryption, $smtp_username, $smtp_password, $smtp_from_email, $smtp_from_name, $hmac_secret. PHP-Teile (Formulare, Erweiterungen) lesen sie mit include aus assets/vn-shared/config.php. Weitere erzeugte Dateien: assets/vn-formrender/config.php (hCaptcha-Geheimnis), assets/vn-search/admin-config.php, vendor/vn-cms/config.php (gesalzener Hash des CMS-Passworts) und vn-translate/vn-translate-config.php. Alle Werte werden dabei gereinigt und als PHP-Strings geschrieben.

Beiträge von Erweiterungen#

Beiträge (Erweiterungen) werden nur ausgegeben, solange die Erweiterung geladen ist. Der Export schreibt files[].text nach publish/assets/<id>/… (nur Pfade dieser Form, höchstens 600 Dateien insgesamt, je 400000 Zeichen), ersetzt {{secret:NAME}} und {{secret-php:NAME}} und entfernt früher geschriebene Dateien, die nicht mehr dazugehören (samt leer gewordener Ordner). head und bodyEnd stehen auf jeder exportierten Seite.

.htaccess#

Das Programm erzeugt .htaccess-Dateien nur an zwei Stellen: assets/vn-formrender/forms/ (Options -Indexes) und vn-translate/ (sperrt die Konfigurationsdatei mit dem Schlüssel). Alle übrigen Schutzdateien legen die Server-Teile selbst an (etwa die Erweiterung VN iCal beim ersten Zugriff für data/) oder der Autor. Eine selbst angelegte .htaccess in publish/ (oder in assets/<Erweiterung>/ als Datei des Beitrags) bleibt beim Export erhalten und wird mit hochgeladen; im Test blieb publish/.htaccess nach einem erneuten Export stehen. Der Vorschau-Server liefert Dateien, die mit einem Punkt beginnen, nie aus.

Vorschau und Export#

Die Vorschau ruft dieselbe Export-Funktion mit preview: true auf, schreibt aber nach <Programm-Profil>/preview/<Hash des Projektpfads>/site/. Dadurch landet nichts, was PHP beim Testen schreibt (Datenbanken, Anmeldungen, Protokolle), im Ordner, den „Veröffentlichen“ hochlädt, und die Vorschau überschreibt publish/ nie. Unterschiede zum Export:

  • Die Seite läuft über einen lokalen Server (nur 127.0.0.1, zufälliger Anschluss, Host-Kopf muss genau stimmen, fremde Webseiten dürfen nur lesen). .php-Seiten laufen, wenn eine php.exe bekannt ist (Einstellung, Zusatzprogramm „VN-Local Server“ oder Installation aus dem Programm); sonst zeigt eine Hinweisseite statt Code.
  • Mails von Formularen und Erweiterungen gehen nicht hinaus, sondern als .eml-Dateien in einen Mail-Fänger-Ordner.
  • Merklisten für Beiträge und Assets sind für die Vorschau getrennt.
  • Die Live-Vorschau lädt http://127.0.0.1:<Anschluss>/<Seite>?v=<Zeit> in einem Rahmen; Skripte laufen dort wie auf der echten Seite, anders als in der Arbeitsfläche.

Veröffentlichen per FTP#

„Auf den Server hochladen“ exportiert erst (wie „Exportieren“) und überträgt dann publish/.

ProtokollHinweis
ftpunverschlüsselt, Port 21
ftpsverschlüsselt, Port 21 (explizit) oder 990 (implizit)
ftps-laxwie ftps, ohne Prüfung des Zertifikats
sftpüber SSH, Port 22, nur Benutzername und Passwort
  • Nur geänderte Dateien: Das Programm bildet von jeder Datei in publish/ einen SHA-256-Wert und vergleicht ihn mit dem Stand des letzten Uploads zu diesem Ziel (Merker nach Projekt, Protokoll, Server, Port und Zielordner, im Programm-Profil). Ein anderes Ziel (Testserver, dann Live-Server) beginnt deshalb immer mit einem vollständigen Upload. Ohne den Schalter lädt es alles hoch.
  • FTP/FTPS: Datei für Datei; bricht die Verbindung ab, verbindet sich das Programm neu (bis zu fünf Versuche) und macht dort weiter; jede fertige Datei wird im Merker gespeichert. Anmeldefehler und endgültige Absagen des Servers (5xx) werden sofort gemeldet. Zielordner werden angelegt.
  • Nichts wird auf dem Server gelöscht. Auch Dateien, die lokal entfernt wurden, bleiben dort liegen; das räumt der Nutzer selbst auf.
  • Zugangsdaten stehen verschlüsselt im Programm-Profil (benannte Server mit Auswahlliste), nie im Projekt.

Datenschutz#

Die fertige Website soll nichts von Dritten laden, solange der Autor es nicht ausdrücklich so will.

  • Bootstrap, Bootstrap Icons, alle Laufzeit-Skripte und alle Schriften liegen in publish/ selbst. Google Fonts lädt das Programm beim Einrichten einer Schrift herunter und speichert sie im Projekt; die fertige Seite fragt nie bei Google an.
  • Eigene Erweiterungen und Bausteine dürfen in head, bodyEnd oder ihrem Markup keine Skripte, Schriften, Stile oder Bilder von Fremdservern laden.
  • Bekannte Drittanbieter-Einbettungen sperrt der Export, wenn VN Cookie-Consent aktiv ist: iframes von Google Maps, YouTube (auch youtube-nocookie) und, ab Version 1.3.100, Vimeo (player.vimeo.com/video/…) und Skripte von Google Tag Manager, Google Analytics, Facebook. Das iframe verliert src (wird data-vn-cc-src), das Skript wird type="text/plain"; ein Überlagerungs-Knopf lädt den Inhalt nach Zustimmung. Kategorien: Karten „functional“, YouTube und Vimeo „marketing“, Statistik-Skripte „statistics“. Mit dem Attribut data-vn-consent-category="functional|statistics|marketing" am iframe oder script sperren Sie jede weitere Quelle ebenfalls.
  • Ist VN Cookie-Consent nicht aktiv und die Seiten enthalten solche Einbettungen, meldet der Export eine Warnung („kann gegen die DSGVO verstoßen“). Er exportiert trotzdem.
  • Das Karte-Element des Baukastens (google.com/maps) und das Video-Element mit einer YouTube- oder (ab Version 1.3.100) Vimeo-Adresse werden bei aktivem Cookie-Hinweis gesperrt. Hintergrundvideos von YouTube und Vimeo (data-bg-video) erzeugt vendor/vn-bgvideo erst zur Laufzeit; bei eingeschaltetem Cookie-Hinweis lädt es sie ab Version 1.3.100 erst nach Zustimmung zu „Marketing“ (bis dahin bleibt das Ersatzbild stehen), ohne Cookie-Hinweis sofort (Wiedergabe auf der Seite). Bausteine mit eigenen Einbettungen anderer Anbieter sollten die Kategorie selbst angeben.
  • Der Code der Globalen Einfügungen (Rohtext) läuft bei aktivem Cookie-Hinweis ebenfalls durch die Sperre für bekannte Dienste. Der Beitrag (head, bodyEnd) einer Erweiterung wird nicht gesperrt: Erweiterungen laden deshalb nie Fremdes.

Was Autoren beeinflussen können#

StelleWirkungBeschreibung
Eigenes CSSganz zuletzt in style.cssWebsite-weites CSS des Nutzers
Globale HTML-Einfügungen<head>, nach <body>, vor </body>, vor dem DokumenttypWebsite-weit; Seiten-Einstellungen haben dieselben vier Felder pro Seite; Rohtext, wird unverändert eingefügt (PHP erlaubt, die Seite muss dann .php heißen)
Block-Skripte<script> im Markup des Bausteinslaufen auf der fertigen Seite; im Editor mit Stellvertretern. Blöcke, die per Skript Elemente einfügen, gehören ins Markup mit {{vn-id}}; Merker als JavaScript-Eigenschaft
PHP-BlöckeBlock „Eigener PHP-Code“, custom-phplanden als rohes PHP an der Stelle des Blocks, mit data-position="top" am Dateianfang
Export-Beitrag einer Erweiterunghead, bodyEnd, assets/<id>/…siehe Erweiterungen
Anker-IDid am WurzelelementEigenschaft des Blocks; sonst blk-<Kennung>
Seiten-EinstellungenTitel, Beschreibung, Social-Bild, lang, eigener Codeje Seite
SEO-WerkzeugCanonical, Sitemap, robots.txt, JSON-LD, Bild-Optimierungsiehe SEO-Ausgabe
Cookie-Attributdata-vn-consent-categorySperrung eigener Einbettungen
Seitenweite Blöckeglobal/once am WurzelelementPosition der Blöcke im Export, siehe Seitenweite Blöcke