Documentation développeur VN-Designer
13

Exportation et publication

Ce qui se passe lors de l’exportation vers le dossier publish/, comment naissent les pages, le CSS, les fichiers d’exécution et les contributions des extensions, comment fonctionnent l’aperçu et le téléversement FTP, quelles règles de confidentialité s’appliquent et ce que les auteurs peuvent influencer.

Vue d’ensemble#

Trois voies mènent d’un projet à un site web :

VoieBoutonDestinationFinalité
Exporter« Exporter »<Projekt>/publish/site web terminé, prêt à être téléversé
Aperçuœil (aperçu en direct), « Voir dans le navigateur »<Programm-Profil>/preview/<Kennung>/site/consulter et tester, jamais dans publish/
Publier« Publier » › « Téléverser sur le serveur »exporte d’abord, puis téléverse publish/ par FTP, FTPS ou SFTPmettre le site web sur le serveur

Le site web est du pur HTML et CSS, au choix avec des pages PHP. Pour fonctionner, il n’a besoin ni du programme ni d’une base de données du programme.

Le dossier publish/#

Le résultat de l’exportation, abrégé ici pour le projet d’exemple du chapitre Paquets (trois pages, une image, un 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/…

Selon le contenu s’y ajoutent vendor/vn-…/ (scripts d’exécution), assets/vn-…/ (parties serveur), assets/<Erweiterung>/ (contributions des extensions), assets/fonts/, assets/vn-shared/config.php, sitemap.xml, robots.txt, llms.txt, vn-translate/ et vn-blog/. Le dossier du projet contient en outre .publish-pages.json (liste des pages exportées en dernier) ; ce fichier reste en dehors de publish/ et n’est pas téléversé.

L’exportation n’écrase que ce qu’elle produit elle-même. Les autres fichiers de publish/ (par exemple un .htaccess créé par vous) restent en place et sont téléversés avec le reste.

Déroulement de l’exportation#

exportSite() dans index.html appelle buildExportSite() (src/publish.js) et transmet le résultat à fs:savePublishHtml (main.cjs). Étapes :

  1. Choisir les pages. Les pages cochées dans la liste des pages sont exportées (publish différent de false) ; l’aperçu prend en plus la page active. Sans page ou sans bloc, l’exportation s’interrompt avec un message. Le CSS de toutes les pages va malgré tout dans style.css, même si seules certaines pages sont exportées.
  2. Rendre les blocs de chaque page et intégrer toutes les personnalisations (Intégration).
  3. Assembler la page (Structure d’une page).
  4. Regrouper style.css (Structure de style.css).
  5. Écrire les fichiers : pages, style.css, fichiers référencés de assets/, fichiers d’exécution utilisés de vendor/, parties serveur, contributions des extensions, fichiers SEO.
  6. Nettoyer : les pages et fichiers d’une exportation précédente qui n’en font plus partie sont supprimés (Noms de fichier, Assets).

Structure d’une page#

Chaque page suit cet ordre (d’après 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>

Le titre est le titre SEO de la page, sinon le nom du projet (pour les pages autres que « Home » avec un nom de page : Projekt — Seite). lang provient de la page ou du site web (valeur par défaut de ; les valeurs non valides deviennent de). Le bouton de retour en haut est activé par défaut (paramètre du site web). Les scripts des fonctions additionnelles (vidéo, vidéo d’arrière-plan, animation, formulaire, infobulle, sous-menu, traducteur) n’apparaissent que sur les pages dont le HTML en a besoin.

Intégration des textes et des personnalisations#

Chaque bloc est rendu avec ses valeurs actuelles (schemaEntry.render). Ensuite, l’exportation intègre les personnalisations de l’utilisateur dans le HTML exactement dans cet ordre ; les traces de l’éditeur (data-vn-text-id, contenteditable, vn-editable-text, data-vn-image-key, data-vn-drag…) disparaissent à cette occasion :

  1. Intégrations vidéo et attributs vidéo, adresses des visionneuses PDF ; les maquettes de l’éditeur (data-vn-editor-only) sont supprimées.
  2. CMS : marquer les textes et les images comme modifiables (uniquement les blocs avec CMS).
  3. Taille du texte, largeur du texte, position du texte (les curseurs du panneau).
  4. Icônes des entrées de menu.
  5. Animations.
  6. Textes : contenu saisi, niveau de titre choisi, liens, alignement.
  7. Boutons, icônes (Bootstrap Icons et icônes personnalisées), images libres, liens d’image, textes alternatifs, titres, tailles.
  8. Si l’avis sur les cookies est actif : bloquer les intégrations de tiers (Confidentialité).
  9. Optimisation des images (ci-dessous).
  10. Placer les calques d’image libres dans un conteneur avec position: relative ; placer les blocs de popup dans leur fenêtre.

Ensuite, toutes les adresses file:// du projet deviennent assets/…. Le code PHP de <script type="text/x-vn-php"> devient du PHP brut ; si data-position="top" figure sur le script, il est placé au début du fichier.

Structure de style.css#

Toutes les pages chargent le même fichier style.css (cache du navigateur). Le contenu, dans cet ordre :

  1. Le CSS de thème de tous les thèmes actifs du projet, sans portée et sans @layer.
  2. Le CSS de tous les blocs de toutes les pages, pour chaque bloc sa sortie LESS compilée précédée de la classe d’instance. Les blocs communs à toutes les pages n’apparaissent qu’une fois.
  3. Les règles @font-face des polices personnalisées et les réglages de police et de typographie du site web.
  4. Les règles de la Surface libre (vn-fl-wrap), si une page en a besoin.
  5. Les règles fixes du programme : menu fixe pleine largeur avec z-index: 5000, boîtes de dialogue (.modal, .modal-backdrop) au-dessus du menu, assombrissement des entrées de menu et liens colorés au survol, menu mobile déplié (marge en bas, défilement interne à partir de 80 % de la hauteur de la fenêtre), style des liens (soulignement dans le menu et dans le bloc, réglage du programme).
  6. En dernier le CSS personnalisé de l’utilisateur (« CSS personnalisé… »), afin qu’il l’emporte sur tout le reste.

L’éditeur connaît @layer et @scope, pas la page terminée : là, à spécificité égale, c’est l’ordre qui décide. Toutes les adresses file:// du CSS deviennent assets/….

Blocs communs à toutes les pages dans l’exportation#

Les blocs communs à toutes les pages (attribut global, voir Blocs communs à toutes les pages) se trouvent dans une liste distincte et figurent sur chaque page exportée : les blocs dont le groupe contient menu, nav ou header avant le contenu de la page, tous les autres après. Lors du test, le menu se trouvait avant le hero et le pied de page après.

Pages et noms de fichier#

  • Le nom de fichier d’une page respecte ^[a-z0-9_-]+\.(html|php)$ (uniquement minuscules, chiffres, _, -) ; l’extension est choisie par l’utilisateur dans la liste des pages. Un autre nom fait échouer l’exportation avec « Nom de fichier non valide ».
  • PHP dans .html : si une page contient du code PHP (bloc « Code PHP personnalisé », CMS, blog, code personnalisé dans les insertions globales) et s’appelle .html, le programme ne la renomme pas. Il signale seulement : « PHP n’y fonctionne que si votre serveur exécute les .html comme du PHP ». L’utilisateur met le nom de fichier en .php.
  • Les pages qui ne sont pas exportées cette fois (décochées, renommées, supprimées) sont retirées de publish/ par l’exportation, mais seulement si elles proviennent d’elle (liste .publish-pages.json et repère vendor/bootstrap-icons/bootstrap-icons.css dans le fichier).
  • L’édition DEMO ajoute à chaque page une mention de VN-Designer.

Images et assets#

Seuls sont copiés les fichiers auxquels le HTML ou le CSS terminé renvoie : toute chaîne assets/… dans le texte des pages et de style.css (fin à un guillemet, une parenthèse, une espace, &, <, >). Un import de thème qui a placé des centaines d’images de démonstration dans assets/ ne gonfle donc pas publish/. En outre :

  • Les fichiers de plus de 20 Mo (vidéos) ne sont pas recopiés si le fichier existant a la même taille et n’est pas plus ancien.
  • Les références que l’exportation ne trouve pas dans le texte, elle les copie explicitement : assets/vn-shared/ (toujours), assets/vn-formrender/forms/ et les PDF des visionneuses PDF (les polices et images dans le CSS sont trouvées par la recherche normale).
  • Une image exportée auparavant et à laquelle plus rien ne renvoie est supprimée de publish/assets/ (les dossiers vides également). Sur le serveur, le programme ne supprime rien.
  • Les fichiers CSS de thème sous assets/theme/ et les scripts sous assets/theme-js/ ne sont copiés que si les pages y renvoient (le CSS de thème se trouve dans style.css).

Optimisation des images#

L’optimisation n’est active que si l’outil SEO (site.seo) est activé et que « Optimiser les images » est coché. Alors toutes les images à partir de la troisième d’une page reçoivent loading="lazy", toutes reçoivent decoding="async", et les images de projet sans indication de taille reçoivent l’attribut style="aspect-ratio:auto <Breite> / <Höhe>" (le rapport d’aspect naturel, pour que la page ne saute pas au chargement). Volontairement sans width/height, qui pourraient déformer une mise en page. Le programme ne réduit ni ne convertit aucun fichier.

Sortie SEO#

Tout ce qui suit est désactivé tant que l’outil SEO ne règle rien ; les pages existantes restent alors identiques au caractère près. Avec des réglages, le head reçoit : canonical, la méta Robots (max-image-preview …), des balises sociales supplémentaires, hreflang et du JSON-LD (organisation, commerce local, hôtel …). En outre, l’exportation écrit les fichiers sitemap.xml, robots.txt et llms.txt (uniquement ces trois noms, uniquement si activé, 2 Mo au plus chacun). Si l’un d’eux est désactivé, la prochaine exportation supprime le fichier produit auparavant, mais seulement s’il porte « Erzeugt von VN-Designer » dans ses 400 premiers caractères. Les balises Open Graph existent sans l’outil SEO si la page a une image sociale et que le site web a une adresse absolue.

Fichiers d’exécution de vendor/#

Le programme ne copie que ce que les pages exportées chargent réellement. Le déclencheur est une référence dans le HTML des pages :

Destination dans publish/Déclencheur
vendor/bootstrap.min.css, vendor/bootstrap.bundle.min.js, vendor/jquery.min.jsréférence dans le HTML (jQuery uniquement dans le mode Bootstrap « depuis le thème »)
vendor/bootstrap-icons/toujours
vendor/vn-lightbox/, vn-cookie-consent/, vn-whatsapp/fonction activée dans la barre
vendor/vn-tooltip/, vn-submenu/, vn-popup/, vn-sform/, vn-bgvideo/, vn-video/un bloc d’une page en a besoin
vendor/vn-cms/ (avec config.php généré)un bloc avec CMS
assets/vn-formrender/ (avec forms/.htaccess, config.php, recipients.php)classe vn-formrender ou vn-sform-form dans le HTML
assets/vn-search/classe vn-search
assets/vn-pdf-viewer/ avec les PDF utilisésvisionneuse PDF
vn-translate/ (avec vn-translate-config.php et .htaccess)VN Traducteur actif
vn-blog/blocs de blog

recipients.php liste les adresses des destinataires de toutes les valeurs data-recipient des formulaires (et, à partir de la version 1.3.100, des adresses de native-form-handler.php?to=…) ; mailer.php et native-form-handler.php n’envoient qu’à ces adresses (le gestionnaire aussi à sa propre adresse d’expédition, voir Destinataires). Les fichiers du programme sous vendor/ font partie du programme, pas du projet ; les auteurs ne peuvent pas les modifier.

vn-shared et config.php#

Les identifiants ne figurent jamais dans le dossier du projet, mais dans le profil du programme. Ce n’est que lors de l’exportation que naissent les fichiers de configuration PHP dans publish/ : assets/vn-shared/config.php avec les valeurs SMTP et un hmac_secret, lorsqu’un accès SMTP est saisi (dans l’aperçu avec des valeurs de capture de courriels). Variables : $smtp_host, $smtp_port, $smtp_encryption, $smtp_username, $smtp_password, $smtp_from_email, $smtp_from_name, $hmac_secret. Les parties PHP (formulaires, extensions) les lisent avec include depuis assets/vn-shared/config.php. Autres fichiers générés : assets/vn-formrender/config.php (secret hCaptcha), assets/vn-search/admin-config.php, vendor/vn-cms/config.php (hash salé du mot de passe du CMS) et vn-translate/vn-translate-config.php. Toutes les valeurs sont nettoyées et écrites sous forme de chaînes PHP.

Contributions des extensions#

Les contributions (Extensions) ne sont émises que tant que l’extension est chargée. L’exportation écrit files[].text dans publish/assets/<id>/… (uniquement des chemins de cette forme, 600 fichiers au plus au total, 400000 caractères chacun), remplace {{secret:NAME}} et {{secret-php:NAME}} et supprime les fichiers écrits précédemment qui n’en font plus partie (ainsi que les dossiers devenus vides). head et bodyEnd figurent sur chaque page exportée.

.htaccess#

Le programme ne génère des fichiers .htaccess qu’à deux endroits : assets/vn-formrender/forms/ (Options -Indexes) et vn-translate/ (verrouille le fichier de configuration contenant la clé). Tous les autres fichiers de protection sont créés par les parties serveur elles-mêmes (par exemple l’extension VN iCal au premier accès pour data/) ou par l’auteur. Un .htaccess créé par vous dans publish/ (ou dans assets/<Erweiterung>/ comme fichier de la contribution) est conservé lors de l’exportation et téléversé avec le reste ; lors du test, publish/.htaccess est resté en place après une nouvelle exportation. Le serveur d’aperçu ne délivre jamais les fichiers dont le nom commence par un point.

Aperçu et exportation#

L’aperçu appelle la même fonction d’exportation avec preview: true, mais écrit dans <Programm-Profil>/preview/<Hash des Projektpfads>/site/. Ainsi, rien de ce que PHP écrit pendant les tests (bases de données, inscriptions, journaux) ne se retrouve dans le dossier que « Publier » téléverse, et l’aperçu n’écrase jamais publish/. Différences avec l’exportation :

  • La page s’exécute via un serveur local (uniquement 127.0.0.1, port aléatoire, l’en-tête Host doit correspondre exactement, les pages web tierces ne peuvent que lire). Les pages .php s’exécutent lorsqu’un php.exe est connu (réglage, programme complémentaire « VN-Local Server » ou installation depuis le programme) ; sinon une page d’information s’affiche à la place du code.
  • Les courriels des formulaires et des extensions ne partent pas, mais arrivent sous forme de fichiers .eml dans un dossier de capture de courriels.
  • Les listes de suivi des contributions et des assets sont séparées pour l’aperçu.
  • L’aperçu en direct charge http://127.0.0.1:<Anschluss>/<Seite>?v=<Zeit> dans un cadre ; les scripts s’y exécutent comme sur la vraie page, contrairement à la zone de travail.

Publier par FTP#

« Téléverser sur le serveur » exporte d’abord (comme « Exporter »), puis transfère publish/.

ProtocoleRemarque
ftpnon chiffré, port 21
ftpschiffré, port 21 (explicite) ou 990 (implicite)
ftps-laxcomme ftps, sans vérification du certificat
sftpvia SSH, port 22, uniquement nom d’utilisateur et mot de passe
  • Uniquement les fichiers modifiés : le programme calcule une valeur SHA-256 pour chaque fichier de publish/ et la compare à l’état du dernier téléversement vers cette destination (repère par projet, protocole, serveur, port et dossier cible, dans le profil du programme). Une autre destination (serveur de test, puis serveur réel) commence donc toujours par un téléversement complet. Sans cette option, il téléverse tout.
  • FTP/FTPS : fichier par fichier ; si la connexion est interrompue, le programme se reconnecte (jusqu’à cinq tentatives) et reprend là ; chaque fichier terminé est enregistré dans le repère. Les erreurs d’authentification et les refus définitifs du serveur (5xx) sont signalés immédiatement. Les dossiers cibles sont créés.
  • Rien n’est supprimé sur le serveur. Même les fichiers retirés localement y restent ; c’est à l’utilisateur de faire le ménage.
  • Les identifiants sont stockés chiffrés dans le profil du programme (serveurs nommés avec liste de sélection), jamais dans le projet.

Confidentialité#

Le site web terminé ne doit rien charger de tiers, tant que l’auteur ne le veut pas expressément.

  • Bootstrap, Bootstrap Icons, tous les scripts d’exécution et toutes les polices se trouvent dans publish/ même. Le programme télécharge Google Fonts lors de la configuration d’une police et l’enregistre dans le projet ; la page terminée n’interroge jamais Google.
  • Les extensions et blocs personnalisés ne doivent charger dans head, bodyEnd ou leur balisage ni scripts, ni polices, ni styles, ni images provenant de serveurs tiers.
  • L’exportation bloque les intégrations de tiers connues lorsque VN Consentement aux cookies est actif : iframes de Google Maps, YouTube (y compris youtube-nocookie) et, à partir de la version 1.3.100, Vimeo (player.vimeo.com/video/…) et scripts de Google Tag Manager, Google Analytics, Facebook. L’iframe perd src (qui devient data-vn-cc-src), le script devient type="text/plain" ; un bouton en surimpression charge le contenu après consentement. Catégories : cartes « functional », YouTube et Vimeo « marketing », scripts de statistiques « statistics ». Avec l’attribut data-vn-consent-category="functional|statistics|marketing" sur l’iframe ou le script, vous bloquez de la même façon toute autre source.
  • Si VN Consentement aux cookies n’est pas actif et que les pages contiennent de telles intégrations, l’exportation signale un avertissement (« peut enfreindre le RGPD »). Elle exporte malgré tout.
  • L’élément Carte du kit de construction (google.com/maps) et l’élément Vidéo avec une adresse YouTube ou (à partir de la version 1.3.100) Vimeo sont bloqués lorsque l’avis sur les cookies est actif. Les vidéos d’arrière-plan de YouTube et Vimeo (data-bg-video) ne sont créées qu’à l’exécution par vendor/vn-bgvideo ; lorsque l’avis sur les cookies est activé, il ne les charge, à partir de la version 1.3.100, qu’après l’accord pour « Marketing » (d’ici là, l’image de remplacement reste affichée), sans avis sur les cookies immédiatement (Lecture sur la page). Les blocs avec leurs propres intégrations d’autres fournisseurs devraient indiquer eux-mêmes la catégorie.
  • Le code des insertions globales (texte brut) passe lui aussi, lorsque l’avis sur les cookies est actif, par le blocage des services connus. La contribution (head, bodyEnd) d’une extension n’est pas bloquée : les extensions ne chargent donc jamais rien de tiers.

Ce que les auteurs peuvent influencer#

EmplacementEffetDescription
CSS personnalisétout à la fin de style.cssCSS de l’utilisateur valable pour tout le site web
Insertions HTML globales<head>, après <body>, avant </body>, avant le type de documentPour tout le site web ; les réglages de page ont les mêmes quatre champs par page ; texte brut, inséré tel quel (PHP autorisé, la page doit alors s’appeler .php)
Scripts de bloc<script> dans le balisage du blocs’exécutent sur la page terminée ; dans l’éditeur avec des substituts. Les blocs qui insèrent des éléments par script doivent aller dans le balisage avec {{vn-id}} ; repère comme propriété JavaScript
Blocs PHPbloc « Code PHP personnalisé », custom-phpatterrissent comme PHP brut à l’emplacement du bloc, avec data-position="top" au début du fichier
Contribution d’exportation d’une extensionhead, bodyEnd, assets/<id>/…voir Extensions
ID d’ancreid sur l’élément racinepropriété du bloc ; sinon blk-<Kennung>
Réglages de pagetitre, description, image sociale, lang, code personnalisépar page
Outil SEOcanonical, sitemap, robots.txt, JSON-LD, optimisation des imagesvoir Sortie SEO
Attribut de cookiedata-vn-consent-categoryblocage des intégrations personnalisées
Blocs communs à toutes les pagesglobal/once sur l’élément racineposition des blocs dans l’exportation, voir Blocs communs à toutes les pages