HTML5-Tutorium: JavaScript: Hello World 01: Unterschied zwischen den Versionen
Kowa (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Kowa (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
||
| (11 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 1: | Zeile 1: | ||
{{HTML5-Tutorium:JavaScript:HelloWorld:Menü}} | |||
'''Musterlösung''': [https://glossar.hs-augsburg.de/beispiel/tutorium/2021/hello_world/WK_HelloWorld01/index.html <code>index.html</code>] | |||
([{{Git-Server}}/kowa/WK_HelloWorld01.git Git-Repository]) | |||
==Ein neues Projekt erstellen== | ==Ein neues Projekt erstellen== | ||
* Visual Studio Code (VSC) starten | * Visual Studio Code (VSC) starten | ||
* <code> | * <code>File</code> → <code>Open Folder</code> | ||
* Erstellen Sie unter einem sinnvollen Pfad auf Ihrem Rechner einen neuen Ordner ({{zB}} <code>.../webprog/hello_world/HelloWorld01</code> und öffnen Sie diesen Ordner. | * Erstellen Sie unter einem sinnvollen Pfad auf Ihrem Rechner einen neuen Ordner ({{zB}} <code>.../webprog/hello_world/HelloWorld01</code> und öffnen Sie diesen Ordner. | ||
| Zeile 30: | Zeile 34: | ||
</source> | </source> | ||
Speichern Sie die Datei (<code>STRG/CTRL/CMD s</code>). Im Reiter <code> | Speichern Sie die Datei (<code>STRG/CTRL/CMD-s</code>). Im Reiter <code>OPEN EDITORS</code> wird angezeigt, ob es nicht gespeicherte Dateien gibt. Dort befindet sich auch ein Icon, um alle nicht gespeicherten Dateien auf die Festplatte zu schreiben. Man vergisst leider häufig, eine Datei zu speichern, bevor man sie in einem Browser öffnet und wundert sich dann, warum man keine Änderungen sieht. (In dieser Hinsicht ist WebStorm besser. Hier werden Dateien automatisch gespeichert, wenn sie für eine Browser-Darstellung benötigt werden.) | ||
Die erste Zeile legt den Typ der Datei fest. Diese Information benötigen die Browser, damit | Die erste Zeile legt den Typ der Datei fest. Diese Information benötigen die Browser, damit | ||
| Zeile 166: | Zeile 170: | ||
Der Life Server von VSC fügt der HTML-Datei eine JavaScript-Code hinzu, der dafür sorgt, dass die Seite im Browser jedes Mal neu geladen wird, sobald sich der Inhalt in VSC ändert. | Der Life Server von VSC fügt der HTML-Datei eine JavaScript-Code hinzu, der dafür sorgt, dass die Seite im Browser jedes Mal neu geladen wird, sobald sich der Inhalt in VSC ändert. | ||
Diesen Code können Sie sehen, wenn Sie im Browser den HTML-Code untersuchen (Firefox uns Safari: Rechtsklick → <code>Element untersuchen</code>, Chrome: Rechtsklick → <code> | Diesen Code können Sie sehen, wenn Sie im Browser den HTML-Code untersuchen (Firefox uns Safari: Rechtsklick → <code>Element untersuchen</code>, Chrome: Rechtsklick → <code>Untersuchen</code>). Wenn Sie im Inspektor das <code>html</code>- | ||
und dann das <code>body</code>-Element öffnen, sehen Sie den zusätzlich JavaScript-Code den der VSC-Server ans Ende vom Body eingefügt hat. | und dann das <code>body</code>-Element öffnen, sehen Sie den zusätzlich JavaScript-Code den der VSC-Server ans Ende vom Body eingefügt hat. | ||
| Zeile 228: | Zeile 232: | ||
VSC nimmt Ihnen diese Arbeit ab. Klicken Sie im linken Menü auf das Icon mit den drei Kreisen, die durch zwei Linien verbunden sind. | VSC nimmt Ihnen diese Arbeit ab. Klicken Sie im linken Menü auf das Icon mit den drei Kreisen, die durch zwei Linien verbunden sind. | ||
Damit öffnet sich der Git-Dateibrowser (<code>Source Control</code>). Eventuell müssen Sie das Reload-Icon hinter <code>SOURCE CONTROL</code> | |||
anklicken, um die zuletzt geänderten DAateien zu sehen. | |||
Schreiben Sie in das Feld <code>Message</code> den Text <code>Initial Commit</code> (wenn Sie sich an die Konvention halten möchten, alle Kommentare in Englisch zu schreiben). Klicken Sie dann auf das Haken-Icon hinter dem Text <code>SOURCE CONTROL</code>. Daraufhin erscheint eine Alert-Box, dass keine „staged changes“ vorhanden seien. Man wird gefragt, ob mal alle Änderungen „stagen“ und dann direkt committen wolle. Auf gut Deutsch wird man gefragt, ob man alle Dateien, die in der Dateiliste mit einen <code>U</code> markiert sind, ins Git-Repository einfügen wolle. Da Sie das wollen, klicken Sie auf <code>Ja</code>. (Irgendwann werden Sie auf <code>Immer</code> klicken, sobald Sie die ständigen Nachfragen nerven.) | |||
<!-- | <!-- | ||
| Zeile 246: | Zeile 253: | ||
Wenn Sie auf den Dateinamen klicken, sehen Sie, was sich geändert hat. | Wenn Sie auf den Dateinamen klicken, sehen Sie, was sich geändert hat. | ||
Sichern Sie auch diese Version der Datei mittels eines Commits. Vergessen Sie nicht, eine neue <code>Commit Message</code> einzugeben. | |||
Sichern Sie auch diese Version der Datei mittels eines Commits | |||
Selektieren Sie im linken Bereich das Git-Icon und öffnen Sie den Reiter <code>Commit</code>. | |||
Dort sehen Sie eine Liste mit allen Commits. Wenn Sie einen Commitbereich öffnen, sehen Sie, welche Dateien dabei verändert wurden. Die Veränderungen können Sie betrachten, wenn Sie auf die einzelnen Dateien klicken. | |||
Es gibt viele weitere Befehle zur Arbeit mit einem Git-Repository: Wiederherstellung von alten Versionen, Anlegen von Entwicklungszweigen (Branches), Zusammenführen von Entwicklungszweigen etc. Lesen Sie dazu bitte die oben genannte Git-Dokumentation. | Es gibt viele weitere Befehle zur Arbeit mit einem Git-Repository: Wiederherstellung von alten Versionen, Anlegen von Entwicklungszweigen (Branches), Zusammenführen von Entwicklungszweigen etc. Lesen Sie dazu bitte die oben genannte Git-Dokumentation. | ||
| Zeile 284: | Zeile 286: | ||
Sollte die URL korrekt sein, können Sie Ihr Repository auf den Git-Server kopieren: | Sollte die URL korrekt sein, können Sie Ihr Repository auf den Git-Server kopieren: | ||
* | * <code>git push</code> | ||
Beim ersten Mal müssen Sie allerdings <code>git push -u origin master</code> eingeben, um Git mitzuteilen, dass das Repository in den Master-Zweig des Repositories <code>origin</code> eingefügt werden soll. Sie werden nach einem Benutzernamen und einem Passwort gefragt. Geben Sie Ihren RZ-Account an. | |||
Sehen Sie jetzt noch einmal im Browser in Ihrem GitLab-Account nach. Dort sollte jetzt das Projekt <code>HelloWorld01</code> zu sehen sein. | Sehen Sie jetzt noch einmal im Browser in Ihrem GitLab-Account nach. Dort sollte jetzt das Projekt <code>HelloWorld01</code> zu sehen sein. | ||
Achtung: Dort ist nicht nur die aktuelle Version des Projektes gespeichert, sondern auch der Versionsbaum. Sie können die Geschichte einer Datei auch im Browser untersuchen. | |||
Anmerkung: Am linken unteren Rand des VSC-Fensters finden Sie wichtige Git-Informationen: | |||
Den aktuellen Git-Zweig (<code>master</code>) und die Anzahl der Dateien, die von Gitlab herunter bzw. dorthin hochgeladen werden können. Wenn Sie die entsprechenden Icons klicken. wird <code>git pull</code> bzw. <code>git push</code> ausgeführt. | |||
==Lizenz hinzufügen== | ==Lizenz hinzufügen== | ||
| Zeile 300: | Zeile 305: | ||
* <code>Commit changes</code> | * <code>Commit changes</code> | ||
Wenn Sie nun in | Wenn Sie nun in VSC <code>git fetch</code> ins Terminal eingeben, wird die neue LIZENZ-Datei in ihre lokale Kopie des Projektes übertragen. | ||
==Projekte aus einem Git-Repository laden== | ==Projekte aus einem Git-Repository laden== | ||
Unter {{Git-Server}}/kowa/WK_HelloWorld01.git finden Sie eine Musterlösung dieser Aufgabe. | Unter {{Git-Server}}/kowa/WK_HelloWorld01.git finden Sie eine Musterlösung dieser Aufgabe. | ||
Öffnen sie diese URL in einem Browser. | Öffnen sie diese URL in einem Browser. Auf der Web-Seite sehen Sie | ||
Drop-Down-Menü mit den beiden Labeln <code>SSH</code> und <code>HTTPS</code>. | ein Drop-Down-Menü mit den beiden Labeln <code>SSH</code> und <code>HTTPS</code>. | ||
In | In den zugehörigen Textboxen steht jeweils ein Link, den Sie zum Kopieren des Projektes | ||
auf Ihren Rechner verwenden können. Der SSH-Link wird {{iAllg}} verwendet, wenn | auf Ihren Rechner verwenden können. Der SSH-Link wird {{iAllg}} verwendet, wenn | ||
Sie die Git-Befehle von der Konsole absetzen. Dazu müssten Sie allerdings ein | Sie die Git-Befehle von der Konsole absetzen. Dazu müssten Sie allerdings ein | ||
Schlüsselpaar erzeugen und den öffentlichen Schlüssel in GitLab hinterlegen. | Schlüsselpaar erzeugen und den öffentlichen Schlüssel in GitLab hinterlegen. | ||
In | In VSC ist es daher einfacher, den HTTPS-Link zu verwenden. Dieser lautet für die Musterlösung: | ||
<div class="formula"><code>{{Git-Server}}/kowa/WK_HelloWorld01.git</code></div> | <div class="formula"><code>{{Git-Server}}/kowa/WK_HelloWorld01.git</code></div> | ||
Wenn Sie diesen Link im Browser | Wenn Sie diesen Link im Browser öffnen, werden Sie einfach zu der schon bekannten Repository-Seite weitergeleitet. | ||
Sie wollen aber den Inhalt des Repositories auf Ihrem Rechner speichern. | |||
Wechseln Sie dazu im Terminal mittels <code>cd</code> in ein Verzeichnis Ihrer Wahl. | |||
Wenn Sie beispielsweise <code>cd ..</code> eingeben, landen Sie in dem Ordner, | |||
in dem sich ihr Hello-World-01-Projekt befindet. Hier können Sie mein Projekt einfügen: | |||
<source lang="bash"> | |||
cd .. # cd <beliebigen Ordner Ihrer Wahl> | |||
# Der Ordner sollte aber nicht unter | |||
# der Kontrolle von Git stehen!! | |||
ls -al | |||
git clone {{Git-Server}}/kowa/WK_HelloWorld01.git | |||
ls -al | |||
</source> | |||
Nun können Sie die lokale Kopie mittels <code>File</code> → <code>Open Folder</code> in VSC öffnen.<br/> | |||
Oder Sie fügen den neuen Ordner mittels <code>File</code> → <code>Add Folder to Workspace</code> zu Ihrem aktuellen Workspace hinzu. Dann stehen Ihnen in VSC beide Projekte zur Bearbeitung zur Verfügung. Allerdings sollten Sie dann zwei Terminals mit den jeweiligen Wurzel-Verzeichnissen der beiden Projekte öffnen. Oder Sie wechseln im Terminal mittels <code>cd</code> zwischen den Wurzelverzeichnissen hin und her. | |||
Allerdings können Sie Ihre Änderungen nicht mittels <code>git push</code> in mein Server-Repository zurückspielen, da Ihnen dazu das Recht fehlt. Sie könnten allerdings das Projekt mit Ihrem GitLab-Account verknüpfen und Ihre Änderungen dort sichern. | |||
Allerdings können Sie Ihre Änderungen nicht mittels <code>git push</code> in mein Server-Repository zurückspielen, da Ihnen dazu das Recht fehlt. | Diesen Vorgang nennt man „forken“ oder „einen Fork erstellen“ (Fork = Gabel, Verzweigung). | ||
Sie könnten allerdings das Projekt mit Ihrem GitLab-Account verknüpfen und Ihre Änderungen dort sichern. | |||
==Fortsetzung des Tutoriums== | ==Fortsetzung des Tutoriums== | ||
Sie sollten nun [[HTML5-Tutorium: JavaScript: Hello World 02|Teil 2 des Tutoriums]] bearbeiten. | Sie sollten nun [[HTML5-Tutorium: JavaScript: Hello World 02|Teil 2 des Tutoriums]] bearbeiten. | ||
==Quellen== | ==Quellen== | ||
<references/> | <references/> | ||
Version vom 26. März 2021, 15:00 Uhr
Dieser Artikel erfüllt die GlossarWiki-Qualitätsanforderungen nur teilweise:
| Korrektheit: 3 (zu größeren Teilen überprüft) |
Umfang: 4 (unwichtige Fakten fehlen) |
Quellenangaben: 3 (wichtige Quellen vorhanden) |
Quellenarten: 5 (ausgezeichnet) |
Konformität: 3 (gut) |
Inhalt |
Teil 1 |
Teil 2 |
Teil 3 |
Teil 4 |
Teil 5 |
Teil 6
Musterlösung: index.html
(Git-Repository)
Ein neues Projekt erstellen
- Visual Studio Code (VSC) starten
File→Open Folder- Erstellen Sie unter einem sinnvollen Pfad auf Ihrem Rechner einen neuen Ordner (z. B.
.../webprog/hello_world/HelloWorld01und öffnen Sie diesen Ordner.
Links sehen Sie ein Icon bestehend aus zwei übereinander liegenden Papierblättern. Wenn Sie darauf klicken, sehen einen Dateibaum mit dem soeben geöffneten Ordner. Er enthält noch noch keine Dateien.
Der Ordnernamen wird mit Großbuchstaben dargestellt. Wenn Sie die Maus über diesen Ordnernamen bewegen, erscheinen Icons zum Erzeugen von Dateien und Ordnern (sowie zwei weitere Icons). Erstellen Sie eine HTML-Datei index.html.
Die HTML-Datei mit Inhalten füllen
Im nächsten Schritt wird die HTML-Datei mit Inhalten gefüllt:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>HelloWorld01</title>
</head>
<body>
<h1>Hello, World!</h1>
<p>Welcome to Multimedia Programming!</p>
</body>
</html>
Speichern Sie die Datei (STRG/CTRL/CMD-s). Im Reiter OPEN EDITORS wird angezeigt, ob es nicht gespeicherte Dateien gibt. Dort befindet sich auch ein Icon, um alle nicht gespeicherten Dateien auf die Festplatte zu schreiben. Man vergisst leider häufig, eine Datei zu speichern, bevor man sie in einem Browser öffnet und wundert sich dann, warum man keine Änderungen sieht. (In dieser Hinsicht ist WebStorm besser. Hier werden Dateien automatisch gespeichert, wenn sie für eine Browser-Darstellung benötigt werden.)
Die erste Zeile legt den Typ der Datei fest. Diese Information benötigen die Browser, damit
sie den nachfolgenden HTML-Code richtig interpretieren und rendern können.
Mit <!DOCTYPE html> wird festgelegt, dass es sich um eine HTML5-Datei handelt.
Eine HTML-4.01-Datei, die die sich an die strengen HTML-4-Vorgaben hält (strict)
würde eine wesentlich komplexere Doctype-Angabe erfordern:
<!DOCTYPE HTML PUBLIC
"-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd"
>
Es gibt noch diverse weitere HTML-Varianten. Wir werden uns allerdings auf HTML5 konzentrieren.
Die zweite und die letzte Zeile des Dokuments (<html lang="en"> und </html>)
begrenzen den eigentlichen HTML-Code. Das Attribut lang zeigt dem Browser an,
in welcher Sprache das Dokument verfasst ist. Wenn ein deutsches HTML-Dokument erstellt werden
soll, müssen Sie den Wert en (Englisch) in de (Deutsch) ändern.
Da es sich bei „Hello World“ jedoch um einen englischen Text handelt, ändern wir den Attributwert nicht.
Innerhalb des öffnenden und des schließenden HTML-Tags stehen die beiden wesentlichen Bereiche eines HTML-Dokuments, der Head- und der Body-Bereich.
Im Body-Bereich stehen die eigentlichen Inhalte, die dem Leser im Content-Bereich des Browsers angezeigt werden sollen.
Im Head-Bereich stehen dagegen Informationen, die für den Browser zwar interessant sind, die aber nicht gerendert und daher im Content-Bereich des Browsers nicht dargestellt werden müssen. Typische Vertreter sind der Titel des Dokuments, der im Browser-Tab angezeigt wird, sowie die Zeichenkodierung (UTF-8, ISO-8859-1, ASCII, ...). In HTML5 werden Zeichen standardmäßig in UTF-8 kodiert. In HTML 4 war noch ISO 8859-1 Standard. In ISO 8859-1 (ISO Latin 1) gibt es maximal 256 Zeichen. Davon sind 191 spezifiziert.[1] Mit UTF-8 können dagegen theoretisch über 4 Billionen Zeichen kodiert werden, praktisch werden aber (derzeit) nur etwas mehr als eine Million Kodierungen als korrekt angesehen.[2].
Gewöhnen Sie sich an, ineinander verschachtelte Elemente der HTML-Datei ganz akribisch einzurücken. Ein schließendes Tag steht entweder in derselben Zeile wie das öffnende Tag oder beide sind exakt gleich weit eingerückt. Tag-Blöcke, die innerhalb von anderen Tags platziert werden, werden um zwei Leerzeichen weiter eingerückt, als ihre Eltern-Tags. Vier Leerzeichen, wie oft von der IDE vorgegeben, sind für größere, tief verschachtelte Dateien zu viel. (Eventuell ist aber auch die Datei zu groß und daher zu tief verschachtelt. So etwas vermeiden Sie, wenn Sie strukturiert arbeiten.) Eine Datei mit Programmcode sollte in der Regel nicht mehr als 80 Zeichen breit sein. Sonst leidet die Lesbarkeit zu sehr.
Verwenden Sie im Programmcode niemals Tabulatorzeichen, sondern immer Leerzeichen. Für wie viele Leerzeichen ein Tabulatorzeichen steht, ist nicht genormt. Das heißt, wenn eine Programmcode-Datei mit Tabulatorzeichen in einem Text-Editor korrekt strukturiert wird, kann die Struktur derselben Datei in einem anderen Editor oder im Browser (z. B. bei einem Web-Zugriff auf ein Repository eines Versionsverwaltungssystems) fehlerhaft sein.
Fügen Sie nicht willkürlich Leerzeilen in den Code ein. Leerzeilen dienen ebenso wie Leerzeichen der Strukturierung und können – geschickt eingesetzt – die Lesbarkeit des Codes verbessern oder – unstrukturiert eingestreut – verschlechtern.
Alle drei der obigen Tipps sind für den Compiler oder den Interpreter eines Programmcodes vollkommen unerheblich. Diese Werkzeuge kommen mit jedem syntaktisch korrektem Code zurecht. Die Tipps sind ausschließlich für Personen wichtig, die den Code lesen müssen (Programmierer, Mitarbeiter der Qualitätssicherung, Studenten, Prüfer etc.). Menschen können schlecht strukturierten Code viel schlechter lesen, als gut strukturierten Code.
Folgende Variante des obigen Codes ist ebenfalls syntaktisch korrekt und wird vom Browser in derselben Weise interpretiert und dargestellt. Aber lesbar ist diese Variante nur noch sehr eingeschränkt.
<!DOCTYPE html> <html lang
="en">
<head
>
<meta
charset= "UTF-8"><title
>HelloWorld01</title>
</head
><body>
<h1 >Hello,
World!</h1> <p>Welcome to Multimedia Programming!
</p>
</body>
</html>
BTW (By the way): Auch die Einrückungen des HTML5-Templates sind nicht ganz korrekt. Eigentlich sollte der Code folgendermaßen aussehen:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>HelloWorld01</title>
</head>
<body>
<h1>Hello, World!</h1>
<p>Welcome to Multimedia Programming!</p>
</body>
</html>
Allerdings ist es durchaus sinnvoll, nicht nur das html-Element sondern auch das head-Element und das body-Element
am Zeilenanfang beginnen zu lassen, da diese Elemente in jeder HTML-Datei mit Sicherheit jeweils genau einmal und
jedes mal auch an derselben Stellen (am Datei-Anfang, am Datei-Ende sowie einmal in der Datei-„Mitte“) vorkommen.
Dadurch wird die Datei um zwei Zeichen schmäler, was ebenfalls der Lesbarkeit zugute kommt.
Fazit: Keine Regel ohne Ausnahme, aber Ausnahmen sollten begründet sein.
Start der Web-Anwendung
Um die zuvor erzeugte HTML-Datei in einem Browser ansehen zu können, muss sie in das Dokument-Verzeichnis eines Web-Servers gelegt werden. Dies ist normalerweise etwas umständlich, wenn der Web-Server nicht auf dem Entwicklungsrechner läuft. Eine Möglichkeit wäre nun, auf dem Entwicklungsrechner, also auf Ihrem Laptop oder PC, einen Server wie Apache oder Tomcat zu installieren. Das ist aber für einfache HTML-Seiten nicht notwendig, d. h. für HTML-Seiten, die keinen Python-, PHP-, Java-, JavaScript- oder sonstigen Code enthalten, der ausgeführt werden muss, bevor die Seite an den Client (Browser) ausgeliefert wird.
In diesem Tutorium werden nur HTML-Seiten erstellt, die JavaScript-Code enthalten.
Dieser Code soll nicht vom Server sondern vom Client ausgeführt werden,
nachdem die HTML-Seite (samt JavaScript-Code) an den Client übermittelt wurde.
Daher reicht uns ein ganz einfacher Server, der nichts weiter macht, als HTML-Seiten und JavaScript-Dateien auszuliefern.
Ein derartiger Server ist in VSC enthalten (wenn Sie die Erweiterung Life Server installiert haben).
Daher ist das Testen der Web-Anwendung ganz einfach.
Klicken Sie im Dateibaum von VSC mit der rechten Maustaste auf index.html
und klicken Sie dann auf Open with Life Server. Nach kurzer Zeit öffnet
sich im Standardbrowser die HTML-Seite, die man gerade erstellt hat.
Ersetzen Sie in der Datei index.html den veralteten Titel Multimedia Programming durch den neuen Titel
der Veranstaltung Web Programming. Sobald Sie die Datei speichern, sollte sich im Browser der Inhalt automatisch aktualisieren.
Der Life Server von VSC fügt der HTML-Datei eine JavaScript-Code hinzu, der dafür sorgt, dass die Seite im Browser jedes Mal neu geladen wird, sobald sich der Inhalt in VSC ändert.
Diesen Code können Sie sehen, wenn Sie im Browser den HTML-Code untersuchen (Firefox uns Safari: Rechtsklick → Element untersuchen, Chrome: Rechtsklick → Untersuchen). Wenn Sie im Inspektor das html-
und dann das body-Element öffnen, sehen Sie den zusätzlich JavaScript-Code den der VSC-Server ans Ende vom Body eingefügt hat.
Der Startbefehl hat zur Folge, dass ein lokaler Web-Server gestartet und die selektierte HTML-Datei in einem Browser geöffnet wird. Welcher Browser dies ist, kann in VSC folgendermaßen festgelegt werden:
- Fahren Sie mit der Maus in die rechte obere Ecke des Editor-Fensters von
index.html, bis dort ein kleines Fenster mit diversen Browser-Icons erscheint. - Klicken Sie auf das Icon eines Browsers, den Sie auf Ihrem Rechner auch installiert haben, dann wird die Datei in diesem Browser geöffnet..
Sie können den Default-Browser in VSC jederzeit ändern, indem sie den gewünschten Browser in die settings.json eintragen: vscode-live-server/docs/settings.md
Vermeidung von Sonderzeichen in Dateinamen
Da eine Web-Anwendung üblicherweise irgendwann einmal auf einen öffentlich zugänglichen Web-Server gelegt werden soll, sollten Sie bei der Bezeichnung von Ordner- und Dateinamen ein paar Namenskonventionen konsequent einhalten:
- keine Leerzeichen in Datei- und Ordnernamen
- keine Nicht-ASCII-Zeichen (wie ä, ö, ü, ß) in Datei- und Ordnernamen
- strikte Unterscheidung von Groß- und Kleinschreibung bei Datei- und Ordnernamen
Der Grund ist, dass Leer- und Sonderzeichen in Pfadnamen häufig Probleme
bereiten, wenn sie auf reguläre Web-Server gestellt werden. Noch schlimmer
ist die Groß- und Kleinschreibung. Wenn Sie eine Datei main.js
erzeugen und diese in einer Datei index.html unter dem Namen
Main.js einbinden, funktioniert Ihre Anwendung auf Ihrem
Windows-Rechner einwandfrei, da unter Windows bei Dateinamen zwischen
Groß- und Kleinschreibung nicht unterschieden wird. Sollten Sie die Anwendung später
auf einen Mac-Rechner (einer Teamkollegin) oder einen Unix-Web-Server kopieren,
funktioniert die Anwendung dagegen nicht mehr, da Mac OS X und Unix zwischen
Groß- und Kleinschreibung bei Datei- und Ordnernamen unterscheiden.
Speichern der Web-Anwendung in einem Git-Repository
Nun ist es an der Zeit, die erste Version Ihrer Web-Anwendung in einem Repository (= digitales Archiv) eines Versionsverwaltungssystems (version control system, VCS) zu speichern. Hier wird Git verwendet.
Sehen Sie zunächst nach, ob Git bei Ihnen funktioniert. Öffnen Sie das Terminal in VSC und
geben Sie dort git --version ein. Wenn sich Git mit einer Versionsnummer meldet,
haben Sie das Tool korrekt installiert.
Überprüfen Sie nun, ob Sie sich im Terminal im Wurzelverzeichnis Ihres Projektes befinden. Nun können sie im Terminal Git für Ihr Projekt aktivieren:
git init
Daraufhin wir im Wurzelordner des Projektes ein Ordner namens .git angelegt. Dieser wird im Dateibaum üblicherweise nicht angezeigt, da der Name mit einem Punkt beginnt. Sie können ihn aber trotzdem anzeigen:
ls -al
ls -al .git
In diesem Ordner sind alle Versionen Ihres Projektes gespeichert. Diese werden jedes Mal gespeichert, wenn Sie git commit ausführen. Allerdings werden nur Dateien gesichert, die zuvor mit git add hinzugefügt wurden.
VSC nimmt Ihnen diese Arbeit ab. Klicken Sie im linken Menü auf das Icon mit den drei Kreisen, die durch zwei Linien verbunden sind.
Damit öffnet sich der Git-Dateibrowser (Source Control). Eventuell müssen Sie das Reload-Icon hinter SOURCE CONTROL
anklicken, um die zuletzt geänderten DAateien zu sehen.
Schreiben Sie in das Feld Message den Text Initial Commit (wenn Sie sich an die Konvention halten möchten, alle Kommentare in Englisch zu schreiben). Klicken Sie dann auf das Haken-Icon hinter dem Text SOURCE CONTROL. Daraufhin erscheint eine Alert-Box, dass keine „staged changes“ vorhanden seien. Man wird gefragt, ob mal alle Änderungen „stagen“ und dann direkt committen wolle. Auf gut Deutsch wird man gefragt, ob man alle Dateien, die in der Dateiliste mit einen U markiert sind, ins Git-Repository einfügen wolle. Da Sie das wollen, klicken Sie auf Ja. (Irgendwann werden Sie auf Immer klicken, sobald Sie die ständigen Nachfragen nerven.)
Wenn Sie jetzt eine Änderung an der Datei index.html vornehmen (z. B. indem Sie Sie den Titel in Hello World 01 ändern), listet VSC die geänderte Datei im Git-Dateibaum auf und markiert sie mit einen M, sobald sie die Änderungen speichern. Damit sehen Sie, dass es eine neuere Version der Datei gibt, die noch nicht mittels Commit gesichert wurde.
Wenn Sie auf den Dateinamen klicken, sehen Sie, was sich geändert hat.
Sichern Sie auch diese Version der Datei mittels eines Commits. Vergessen Sie nicht, eine neue Commit Message einzugeben.
Selektieren Sie im linken Bereich das Git-Icon und öffnen Sie den Reiter Commit.
Dort sehen Sie eine Liste mit allen Commits. Wenn Sie einen Commitbereich öffnen, sehen Sie, welche Dateien dabei verändert wurden. Die Veränderungen können Sie betrachten, wenn Sie auf die einzelnen Dateien klicken.
Es gibt viele weitere Befehle zur Arbeit mit einem Git-Repository: Wiederherstellung von alten Versionen, Anlegen von Entwicklungszweigen (Branches), Zusammenführen von Entwicklungszweigen etc. Lesen Sie dazu bitte die oben genannte Git-Dokumentation.
Speichern eines Git-Repositories auf einem Git-Server
Für die Lehrveranstaltung steht Ihnen ein Git-Server zur Verfügung, den Sie auch benutzen müssen, wenn Sie an der Prüfung teilnehmen möchten:
Sie können sich dort mit Ihrem RZ-Account einloggen. (Wenn Sie kein Mitglied der Hochschule Augsburg sind, können alternativ einen beliebigen anderen öffentlichen Git-Server verwenden, wie z. B. https://gitlab.com/public oder https://github.com/. Sie müssen sich dort nur registrieren.)
Loggen Sie sich auf dem GitLab-Server ein. Bislang befindet sich dort keinerlei Projekte von Ihnen.
Öffnen Sie im WebStorm das Terminal und geben Sie dort folgende Befehle ein:
git remote add origin https://gitlab.multimedia.hs-augsburg.de/ACCOUNT/HelloWorld01.git(Ersetzen SieACCOUNTdurch Ihren RZ-Account.)git remote -v
Der letzte Befehl zeigt an, mit welchen externen Repositories Ihr Repository unter welchem Namen verbunden ist.
(Ein Git-Repository kann durchaus mit mehreren Repositories zur selben Zeit verbunden sein.) Der Standardname eines externen Repositories ist origin. Sie können aber theoretisch auch jeden anderen Namen wählen.
Falls Ihnen der letzte Befehl zeigt, dass Sie die falsche URL eingetragen haben (weil Sie z. B. vergessen haben ACCOUNT durch Ihren RZ-Account zu ersetzen),
können Sie die Verbindung auch wieder löschen und das Repository mit einer anderen URL verbinden_
git remote remove origingit remote -vgit remote add origin https://gitlab.multimedia.hs-augsburg.de/ACCOUNT/HelloWorld01.git(Ersetzen Sie auch diesmalACCOUNTdurch Ihren RZ-Account.)git remote -v
Sollte die URL korrekt sein, können Sie Ihr Repository auf den Git-Server kopieren:
git push
Beim ersten Mal müssen Sie allerdings git push -u origin master eingeben, um Git mitzuteilen, dass das Repository in den Master-Zweig des Repositories origin eingefügt werden soll. Sie werden nach einem Benutzernamen und einem Passwort gefragt. Geben Sie Ihren RZ-Account an.
Sehen Sie jetzt noch einmal im Browser in Ihrem GitLab-Account nach. Dort sollte jetzt das Projekt HelloWorld01 zu sehen sein.
Achtung: Dort ist nicht nur die aktuelle Version des Projektes gespeichert, sondern auch der Versionsbaum. Sie können die Geschichte einer Datei auch im Browser untersuchen.
Anmerkung: Am linken unteren Rand des VSC-Fensters finden Sie wichtige Git-Informationen:
Den aktuellen Git-Zweig (master) und die Anzahl der Dateien, die von Gitlab herunter bzw. dorthin hochgeladen werden können. Wenn Sie die entsprechenden Icons klicken. wird git pull bzw. git push ausgeführt.
Lizenz hinzufügen
In GitLab fügen Sie jetzt testhalber eine Lizenzdatei ein:
- Öffen Sie das Projekt im Browser.
- Klicken Sie auf
Add license - Es öffnet sich ein Texteditor, in dem Sie Ihre Lizenzbedingungen eintragen sollen (Autor, Copyright, Lizenzbezeichner, Link zur Lizenzbeschreibung; Beispiel: MIT-Lizenz)
Commit changes
Wenn Sie nun in VSC git fetch ins Terminal eingeben, wird die neue LIZENZ-Datei in ihre lokale Kopie des Projektes übertragen.
Projekte aus einem Git-Repository laden
Unter https://gitlab.multimedia.hs-augsburg.de/kowa/WK_HelloWorld01.git finden Sie eine Musterlösung dieser Aufgabe.
Öffnen sie diese URL in einem Browser. Auf der Web-Seite sehen Sie
ein Drop-Down-Menü mit den beiden Labeln SSH und HTTPS.
In den zugehörigen Textboxen steht jeweils ein Link, den Sie zum Kopieren des Projektes
auf Ihren Rechner verwenden können. Der SSH-Link wird i. Allg. verwendet, wenn
Sie die Git-Befehle von der Konsole absetzen. Dazu müssten Sie allerdings ein
Schlüsselpaar erzeugen und den öffentlichen Schlüssel in GitLab hinterlegen.
In VSC ist es daher einfacher, den HTTPS-Link zu verwenden. Dieser lautet für die Musterlösung:
Wenn Sie diesen Link im Browser öffnen, werden Sie einfach zu der schon bekannten Repository-Seite weitergeleitet.
Sie wollen aber den Inhalt des Repositories auf Ihrem Rechner speichern.
Wechseln Sie dazu im Terminal mittels cd in ein Verzeichnis Ihrer Wahl.
Wenn Sie beispielsweise cd .. eingeben, landen Sie in dem Ordner,
in dem sich ihr Hello-World-01-Projekt befindet. Hier können Sie mein Projekt einfügen:
cd .. # cd <beliebigen Ordner Ihrer Wahl>
# Der Ordner sollte aber nicht unter
# der Kontrolle von Git stehen!!
ls -al
git clone {{Git-Server}}/kowa/WK_HelloWorld01.git
ls -al
Nun können Sie die lokale Kopie mittels File → Open Folder in VSC öffnen.
Oder Sie fügen den neuen Ordner mittels File → Add Folder to Workspace zu Ihrem aktuellen Workspace hinzu. Dann stehen Ihnen in VSC beide Projekte zur Bearbeitung zur Verfügung. Allerdings sollten Sie dann zwei Terminals mit den jeweiligen Wurzel-Verzeichnissen der beiden Projekte öffnen. Oder Sie wechseln im Terminal mittels cd zwischen den Wurzelverzeichnissen hin und her.
Allerdings können Sie Ihre Änderungen nicht mittels git push in mein Server-Repository zurückspielen, da Ihnen dazu das Recht fehlt. Sie könnten allerdings das Projekt mit Ihrem GitLab-Account verknüpfen und Ihre Änderungen dort sichern.
Diesen Vorgang nennt man „forken“ oder „einen Fork erstellen“ (Fork = Gabel, Verzweigung).
Fortsetzung des Tutoriums
Sie sollten nun Teil 2 des Tutoriums bearbeiten.
Quellen
- ↑ ISO/IEC 8859-1:1998
- ↑ [https://tools.ietf.org/html/rfc3629 Request for Comments 3629, UTF-8, a transformation format of ISO 10646]
- Kowarschick (WebProg): Wolfgang Kowarschick; Vorlesung „Web-Programmierung“; Hochschule: Hochschule Augsburg; Adresse: Augsburg; Web-Link; 2024; Quellengüte: 3 (Vorlesung)
