Archiv für den Monat: Dezember 2016

Aufgepretzelt – von statisch zu generiert – Teil 1

Pretzel

Pretzel

Es beginnt mit einer einzelnen, einfachen Web-Seite. Etwas HTML, etwas CSS, vielleicht auch noch ein bisschen Javascript. Dann kommt eine Zweite hinzu und mit der Dritten hält dann auch das Menü Einzug in die Website. Da dieses Menü in allen statischen Seiten vorhanden ist müssen dann beim Hinzufügen der vierten Seite alle anderen Seiten angepasst werden, damit alle das gleiche Menü haben.

Dann kommt der Gedanke: „Das muss doch einfacher gehen!“

Der Einsatz eines CMS (z.B. WordPress, Typo3, Silverstripe etc.) ist für ein paar wenige Seiten aber doch zu viel des Guten und es müssten dann auch regelmässig (Sicherheits-)Updates eingespielt werden.

Hier kommen die Website-Generatoren wie Jekyll, Hugo oder Pretzel zum Zug. Mit einem Website-Generator werden die Seiten lokal aus verschiedenen Dateien zusammengebaut. Die gesamte Website kann dann in der Form von statischen HTML-Dateien auf den Webserver hochgeladen werden.

Da in diesem Fall die Website schon besteht und vorerst keine Änderungen angebracht werden sollen beschreibe ich hier die Migration von statischen HTML-Seiten zu einer generierten Website. Dazu setze ich Pretzel ein, das Vorgehen kann aber für andere Website-Generatoren übernommen werden.

Voraussetzung:
Die HTML-Seiten sollten alle einen identischen, sauberen Aufbau haben. D.h. die einzelnen Seiten sollten sich nur in den relevanten Bereichen unterscheiden und es sollten z.B. keine fehlenden Menüeinträge auf einzelnen Seiten vorhanden sein.

Benötigte Software:

  • Website-Generator, in diesem Fall Pretzel in der Version V0.4.0.0.
  • Compare-Tool, um Dateien und Ordner zu vergleichen. Ich setze hierzu die Gratisversion von Code Compare ein. Als Alternative könnte z.B. Beyond Compare (ist kostenpflichtig) eingesetzt werden.
  • Die Dateien können zwar auch mit Notepad editiert werden, es empfiehlt sich aber ein komfortablerer Editor wie Notepad++ oder Visual Studio Code einzusetzen.

Ausserdem empfiehlt es sich, für die einzelnen Schritte des Umbaus Sicherungskopien anzulegen. Dies kann durch kopieren oder zippen des Arbeitsordners oder durch den Einsatz einer Versionskontrolle wie Git oder Subversion (SVN) erfolgen. Wenn man zur Versionskontrolle z.B. Github einsetzt hat man zudem noch eine Sicherungskopie ausser Haus.

Grundidee der Migration:
Am Ende der Migration möchten wir wieder dieselben Web-Seiten haben, die wir jetzt schon als statische Seiten haben. Dadurch sind wir sicher, dass der migrierte Webauftritt dem bisherigen Webauftritt entspricht. Sobald dies erfüllt ist können wir dann die gewünschten Änderungen vornehmen.

Dazu gehen wir Schritt für Schritt vor und ändern immer nur einen Aspekt, generieren dann die Website neu und vergleichen das Resultat mit den statischen Seiten. Wenn nun Unterschiede vorhanden sind analysieren wir, warum diese Unterschiede entstehen und passen unsere Änderung an. Sobald keine Unterschiede mehr ausgewiesen werden können wir eine Sicherungskopie anlegen und uns dem nächsten Aspekt widmen. Dies machen wir solange, bis alle nötigen Umbauarbeiten durchgeführt sind.

Ausblick:
Im nächsten Teil erstellen wir die Struktur und lassen die Seiten aus den bestehenden statischen Seiten erzeugen, ohne irgendwelche Elemente schon in Templates auszulagern.