HTML5-Tutorium: JavaScript: Hello World 01: Unterschied zwischen den Versionen

aus GlossarWiki, der Glossar-Datenbank der Fachhochschule Augsburg
Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
(27 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 1: Zeile 1:
{{HTML5-Tutorium:JavaScript:HelloWorld:Menü}}
{{HTML5-Tutorium:JavaScript:HelloWorld:Menü}}


'''Musterlösung''': [https://glossar.hs-augsburg.de/beispiel/tutorium/es6/hello_world/WK_HelloWorld01/index.html <code>index.html</code>]
'''Musterlösung''': [https://glossar.hs-augsburg.de/beispiel/tutorium/2018/helloworld/WK_HelloWorld01/index.html <code>index.html</code>]
([https://glossar.hs-augsburg.de/beispiel/tutorium/es6/hello_world/WK_HelloWorld01/ SVN-Repository])
([{{Git-Server}}/kowa/WK_HelloWorld01.git Git-Repository])
==Anwendungsfälle (Use Cases)==
==Anwendungsfälle (Use Cases)==
Im ersten Teil dieses Tutoriums wird zunächst mit Hilfe der [[IDE]] (integrated development environment) [[WebStorm]]
Im ersten Teil dieses Tutoriums wird zunächst mit Hilfe der [[IDE]] (integrated development environment) [[WebStorm]]
Zeile 17: Zeile 17:
==WebStorm starten==
==WebStorm starten==


Nach dem Starten der IDE sehen Sie ein Menü mit drei Alternativen, ein Projekt zu bearbeiten: Sie können  
In WebStorm gibt es drei Alternativen, ein Projekt zu bearbeiten: Sie können  
eine neues Projekt erstellen, ein bestehendes Projekt öffnen oder ein bestehendes Projekt aus einem  
eine neues Projekt erstellen, ein bestehendes Projekt öffnen oder ein bestehendes Projekt aus einem  
Versionsverwaltungstool laden (<code>check out</code>) und öffnen.  
Versionsverwaltungstool laden (<code>check out</code>) und öffnen.  


Sie werden zunächst die erste Möglichkeit nutzen und ein neues Projekt erstellen.  
Sie werden zunächst die erste Möglichkeit nutzen und ein neues Projekt erstellen.  
Anschließend werden Sie die Musterlösung für dieses Projekt aus einem [[Subversion|SVN-Repository]] herunterladen.
Anschließend werden Sie die Musterlösung für dieses Projekt aus einem [[Git|Git-Repository]] herunterladen.


==Ein neues Projekt erstellen==
==Ein neues Projekt erstellen==


Starten Sie WebStorm und klicken Sie auf <code>Create New Project</code>.
* WebStorm starten
Wählen Sie im linken Frame der Seite, die sich geöffnet hat, <code>Empty Project</code>,
* <code>File</code>/<code>WebStorm</code> → <code>New</code> → <code>Project</code>
wählen Sie im Feld <code>Location</code> einen sinnvollen Pfad aus, wo auf Ihrem
* <code>Empty Project</code>, im Feld <code>Location</code> einen sinnvollen Pfad auswählen, wo auf Ihrem Rechner das Projekt gespechert werden soll ({{zB}} <code>.../mmprog/hello_world/HelloWorld01</code>)
Rechner Sie das Projekt speichern wollen ({{zB}} <code>.../mmprog/hello_world/HelloWorld01</code>)
* <code>Create</code>.
und klicken Sie anschließend auf <code>Create</code>.


Links sehen Sie nun ein senkrechtes Menü mit zwei Menüpunkten, <code>Structure</code>
Links sehen Sie nun ein senkrechtes Menü mit mehreren Menüpunkten, <code>Structure</code>, <code>Favorites</code>
und <code>Project</code>. (Wenn Sie dieses Menü nicht sehen, müssen Sie
und <code>Project</code>. (Wenn Sie dieses Menü nicht sehen, müssen Sie
auf das Icon unten links in der Leiste klicken. Damit wird das Menü eingeblendet.)
auf das Icon unten links in der Leiste klicken. Damit wird es eingeblendet.)


Klicken Sie auf <code>Project</code>. Es erscheint ein Dateibaum,
Klicken Sie auf <code>Project</code>. Es erscheint ein Dateibaum,
der alle Dateien Ihres Projektes enthält. Bislang gibt es nur das Wurzelverzeichnis mit dem Projektnamen
der alle Dateien Ihres Projektes enthält. Bislang gibt es nur das Wurzelverzeichnis mit dem Projektnamen
<code>HelloWorld01</code> sowie eine Systemdatei <code>External Libraries</code>, die uns  
<code>HelloWorld01</code> sowie zwei Systemdateien <code>External Libraries</code> und <code>Scratches and Consoles</code>, die uns nicht weiter interessieren.
derzeit nicht weiter interessiert.


Aktivieren Sie zunächst die Toolbar:
Aktivieren Sie zunächst die Toolbar, sofern Sie dies noch nicht gemacht haben:
* <code>View</code> → Häkchen bei <code>Toolbar</code>
* <code>View</code> → Häkchen bei <code>Toolbar</code>
Hier finden Sie insbesondere den Reload-Button, mit dem Sie den Dateibaum in WebStrom neu laden können,
Hier finden Sie insbesondere den Reload-Button, mit dem Sie den Dateibaum in WebStorm neu laden können,
wenn dieser außerhalb von WebStorm verändert wurde.
wenn dieser außerhalb von WebStorm verändert wurde.


Zeile 65: Zeile 63:
</source>
</source>


Die erste Zeile legt den Typ der Datei fest. Diese Information benötigen dies Browser, damit  
Die erste Zeile legt den Typ der Datei fest. Diese Information benötigen die Browser, damit  
sie den nachfolgenden HTML-Code richtig interpretieren und [[Renderer|rendern]] können.
sie den nachfolgenden HTML-Code richtig interpretieren und [[Renderer|rendern]] können.
Mit <code><!DOCTYPE html></code> wird festgelegt, dass es sich um eine HTML5-Datei handelt.  
Mit <code><!DOCTYPE html></code> wird festgelegt, dass es sich um eine HTML5-Datei handelt.  
Zeile 131: Zeile 129:
Ein schließendes Tag steht entweder in derselben Zeile wie das öffnende Tag oder beide sind exakt gleich weit eingerückt.
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
Tag-Blöcke, die '''innerhalb von anderen Tags''' platziert werden, werden um '''zwei Leerzeichen''' weiter '''eingerückt''', als ihre
Elterntags. Vier Leerzeichen, wie oft von der IDE vorgegeben, sind für größere, tief verschachtelte Dateien zu viel. (Eventuell ist
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.)  
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  
Eine Datei mit Programmcode sollte in der Regel nicht mehr als  
Zeile 219: Zeile 217:
Klicken Sie im Dateibaum von WebStorm mit der rechten Maustaste auf <code>index.html</code>
Klicken Sie im Dateibaum von WebStorm mit der rechten Maustaste auf <code>index.html</code>
und klicken Sie dann auf <code>Run 'index.html'</code>. Wenn man diesen Befehl erstmals ausgeführt hat,
und klicken Sie dann auf <code>Run 'index.html'</code>. Wenn man diesen Befehl erstmals ausgeführt hat,
erscheint in der Hauptmenüleiste von WebStorm ein Drop-Down-Menü mit ausführbaren Dateien sowie rechts
erscheint in der Hauptmenü-Leiste von WebStorm ein Drop-Down-Menü mit ausführbaren Dateien sowie rechts
daneben ein grünes Dreieck als Icon, mit dem die im Menü selektierte Datei direkt gestartet werden kann.
daneben ein grünes Dreieck als Icon, mit dem die im Menü selektierte Datei direkt gestartet werden kann.


Der Startbefehl hat zur Folge, dass ein lokaler Web-Server gestartet und die selektierte HTML-Datei in einem Browser
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 WebStorm folgendermaßen festgelegt werden.
geöffnet wird. Welcher Browser dies ist, kann in WebStorm folgendermaßen festgelegt werden:


# Im Dateibaum „<code>index.html</code>“ selektieren.
* Fahren Sie mit der Maus in die rechte obere Ecke des Editor-Fensters von <code>index.html</code>, bis dort ein kleines Fenster mit diversen Browser-Icons erscheint.
# <code>Run</code> → <code>Edit Configurations...</code> → Klick auf <code>...</code> hinter dem Label <code>Browser</code> → Defaultbrowser festlegen
* Klicken Sie auf das Icon eines Browsers, den Sie auf Ihrem Rechner auch installiert haben, dann wird die Datei in diesem Browser geöffnet..
#Menü mit Klick auf <code>OK</code> verlassen.
 
Sie können den Defaultbrowser im Browser jederzeit ändern:
* Im Dateibaum <code>index.html</code> selektieren.
* Reiter <code>Run</code> → <code>Edit Configurations...</code> → Klick auf <code>...</code> hinter dem Label <code>Browser</code> → Defaultbrowser festlegen
*<code>OK</code>


Wenn man anschließend in WebStorm Änderungen an der im Browser geöffneten Datei vornimmt, muss man nicht jedes mal die
Wenn man anschließend in WebStorm Änderungen an der im Browser geöffneten Datei vornimmt, muss man nicht jedes mal die
Datei neu starten. Es reicht, im Browser den Reloadbutton zu drücken.
Datei neu starten. Es reicht, im Browser den Reload-Button zu drücken.


Der von WebStorm gestartete Web-Server bedient diverse Browser, die sich auf dem Entwicklungsrechner befinden.
Der von WebStorm gestartete Web-Server bedient diverse Browser, die sich auf dem Entwicklungsrechner befinden.
Wenn man dieselbe HTML-Datei in einem anderen Browser testen will, kann man dazu den URI im ersten Browser kopieren und in die URI-Leiste
Wenn man dieselbe HTML-Datei in einem anderen Browser testen will, kann man dazu den URI im ersten Browser kopieren und in die URI-Leiste
des zweiten Browsers einfügen. WebStorm bemerkt, dass der URI in einem anderen Browser geöffnet werden soll und stellt dazu eine Sicherheitsanfrage:
des zweiten Browsers einfügen. WebStorm bemerkt, dass der URI in einem anderen Browser geöffnet werden soll und stellt dazu eine Sicherheitsfrage:


<div class="formula"><code>Copy authorization URL to clipboard</code></div>
<div class="formula"><code>Copy authorization URL to clipboard</code></div>


Wenn man dies bestätigt enthält das Clipboard anschließend einen
Wenn man dies bestätigt, enthält das Clipboard anschließend einen
URI, die man mit <code>Strg-v</code> als Ersatz für den zuerst eingefügte URI in den neuen Browser kopieren kann.  
URI, die man mit <code>Strg-v</code> als Ersatz für den zuerst eingefügte URI in den neuen Browser kopieren kann.  
Dieser URI wird dann angezeigt und kann ebenfalls per Reload aktualisiert werden.
Dieser URI wird dann angezeigt und kann ebenfalls per Reload aktualisiert werden. Schneller geht der Test mit einem alternativen Browser jedoch mit den Browser-Icons in der rechten oberen Ecke des Editor-Fensters.


Man könnte die Seite sogar von einem anderen Device, wie {{zB}} einen Smartphone aus aufrufen.  
Man könnte die Seite sogar von einem anderen Device, wie {{zB}} einen Smartphone aus aufrufen.  
Zeile 246: Zeile 248:
unterbunden.
unterbunden.


Schneller geht der Test mit einem anderen Browser, indem man die zu testende Datei im WebStorm-Editor-Fenster öffnet und mit der Maus in die
==Vermeidung von Sonderzeichen in Dateinamen==
rechte obere Ecke dieses Fensters fährt. Irgendwann poppt in dieser Ecke in Menü mit fünf Browser-Icons auf. Durch einen Klick auf ein
Da eine Web-Anwendung üblicherweise irgendwann einmal auf einen
Icon kann man die geöffnete Datei im gewünschten Browser testen.
öffentlich zugänglichen Web-Server gelegt werden soll, sollten
 
Sie bei der Bezeichnung von Ordner- und Dateinamen ein paar Namenskonventionen konsequent einhalten:
==Speichern der Web-Anwendung in einem Subversion-Repository==
 
Nun ist es an der Zeit, die erste Version unserer Web-Anwendung in einem [[Repository]] (= digitales Archiv) eines
[[Versionsverwaltungssystem]]s (''version control system'', VCS) zu speichern. Hier wird
[[Subversion]] verwendet.
 
'''Anmerkung''': <i>Ich weiß, dass [[Git]] viel „cooler“ und „mächtiger“ ist als [[Subversion]]. Wenn Sie nicht
an der Lehrveranstaltung [[Lehrveranstaltung:IAM_2006:Multimedia-Anwendungen/Programmierung|Multimedia-Programmierung]] (MMProg)
teilnehmen, können Sie an Stelle von Subversion selbstverständlich auch [https://github.com/ GitHub] oder ein anderes Versionsverwaltungssystem verwenden,
um Ihre Projekte zu verwalten. Sie können aber auch Ihren eigenen Subversion-Server installieren, um die Tutorien „in voller Schönheit“ bearbeiten zu können: https://subversion.apache.org/packages.html. (Sie könnten sogar ganz darauf verzichten und Ihre Tutoriumslösungen nicht in einem
Versionsverwaltungssystem sichern. Davon rate ich aber ab.)</i>
<i>Im Praktikum zur Lehrveranstaltung wird jedoch Subversion verwendet, da die Administration von Dutzenden
von Subversion-Accounts für den Dozenten wesentlich einfacher ist als die Verwaltung von entsprechenden Git-Accounts.
</i>


Leider treten anscheinend sowohl unter Mac OS  X, als auch unter Windows 10 unterschiedliche
* keine Leerzeichen in Datei- und Ordnernamen
Probleme mit Subversion auf, da anscheinend veraltete SVN-Verisonen zum Einsatz kommen
* keine Nicht-ASCII-Zeichen (wie ä, ö, ü, ß) in Datei- und Ordnernamen
und/oder gewisse Softwarepakete fehlen.
* strikte Unterscheidung von Groß- und Kleinschreibung bei Datei- und Ordnernamen
(Mit Windows 7 hatte ich keine Probleme. :-) )


Ein großes Problem stellen (zumindest für ältere Subversion-Clients) häufig Dateipfade dar,  
Der Grund ist, dass Leer- und Sonderzeichen in Pfadnamen häufig Probleme
die Leerzeichen oder Sonderzeichen enthalten. (Unter Windows 10 scheinen
bereiten, wenn sie auf reguläre Web-Server gestellt werden. Noch schlimmer
auch der Benutzerordner und der Desktop teilweise Probleme zu bereiten.)
ist die Groß- und Kleinschreibung. Wenn Sie eine Datei <code>main.js</code>
Legen Sie Ihre WebStorm-Dateien daher in einen Ordner, bei dem weder der Ordner
erzeugen und diese in einer Datei <code>index.html</code> unter dem Namen
selbst noch die Elternordner derartige Zeichen enthalten. Es sollten also keine  
<code>Main.js</code> 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.
<!--
Es sollten also keine  
Ordner mit Namen wie „<code>3. Semester</code>“, „<code>Praktikum 01</code>“, „<code>Müller</code>“ etc.
Ordner mit Namen wie „<code>3. Semester</code>“, „<code>Praktikum 01</code>“, „<code>Müller</code>“ etc.
im Dateipfad enthalten sein.
im Dateipfad enthalten sein.-->


Eine Fehlermeldung der Art
==Speichern der Web-Anwendung in einem Git-Repository==
<source lang="bash">
Error:svn: E155007: '...' is not a working copy
</source>
können Sie üblicherweise ignorieren. Subversion funktioniert {{iAllg}} trozdem wie gewünscht.


===Subversion unter Windows===
Nun ist es an der Zeit, die erste Version Ihrer Web-Anwendung in einem [[Repository]] (= digitales Archiv) eines
Installieren Sie (zumindest unter Windows 10) eine neuere Version von Subversion auf Ihren Rechner:
[[Versionsverwaltungssystem]]s (''version control system'', VCS) zu speichern. Hier wird
[[Git]] verwendet.


* Laden Sie die „Apache Subversion command line tools“ herunter: https://www.visualsvn.com/downloads/
Sehen Sie zunächst nach, ob Git bei Ihnen funktioniert. Öffnen Sie das Terminal in WebStorm und
* Entpacken Sie die heruntergeledenen Dateien in einen Ordner Ihrer Wahl.
geben Sie dort <code>git --version</code> ein. Wenn sich Git mit einer Versionsnummer meldet,
* In WebStorm gehen Sie dann auf <code>File</code> → <code>Settings</code> → <code>Version Control</code> → <code>Subversion</code>.
haben Sie das Tool korrekt installiert.  
* Wählen Sie unter <code>Use command line client</code>“ im heruntergeladenen Ordner die Datei  <code>bin/svn.exe</code> als neuen SVN-Client aus.


===Subversion unter Mac OS 10===
Überprüfen Sie nun, ob WebStorm das Git-Tool auch findet:<br/>
* <code>WebStorm</code>/<code>File</code> → <code>Preferences</code>/<code>Settings</code> → <code>Version Control</code> → <code>Git</code><br/>
Solle hier im Attribut <code>Path to Git executable</code> kein Pfad eingetragen sein, müssten Sie das nachholen.


Mit einige Mac-OS-X-Versionen wird eine ältere Version von Apache Subversion ausgeliefert. Laut  http://www.apple.com/opensource/
Als nächstes sollten Sie in Ihrem Projekt eine Datei namens <code>.gitignore</code> einfügen,
ist dies die Version 1.6.16. Modernere Mac-OS-X-Versionen installieren die Version 1.9.x, was sehr gut ist. Überprüfen Sie die Version mittels
die bescheibt, welche Dateien '''nicht''' im Git-Repository gesichert werden sollen.
des Befehls
Das sind vor allem Dateien mit sensiblen Informationen (wie {{zB}} Passwörtern) sowie
Dateien, die automatisch generiert werden können.  


<source lang="bash">
Kopieren Sie die Datei <code>https://glossar.hs-augsburg.de/beispiel/tutorium/2018/.gitignore</code>
svn --version
in das Wurzelverzeichnis Ihres Web-Projektes. Speichern Sie sie unbedingt unter dem Namen
</source>
<code>.gitignore</code> (mit einem Punkt als erstes Zeichen). Diese Datei enthält die Namen und
Endungen zahlreicher Dateien und Ordner, die üblicherweise nicht auf einem Git-Server gespeichert
werden sollten. Sie können sie in Ihrer Studienarbeit natürlich an Ihre Bedürfnisse anpassen. 


Fall  im Terminal die Fehlermeldung <code>xcrun error: ...</code> kommt, muss Xcode mit Hilfe des folgenden
Um Ihr Projekt in einem Git-Repository zu speichern, dient das Git-Tool. Sie können den Befehl <code>git</code> von der Kommandozeile aufrufen,
Terminal-Befehls installiert werden:
eine Verwendung der WebStorm-Umgebung ist nicht zwingend notwendig: [https://git-scm.com/book/en/v2/ Pro Git von Scott Chacon und Ben Straub].
 
<source lang="bash">
xcode-select --install
</source>


Jetzt sollte der Befehl <code>svn --version</code> funktionieren.
Sie können aber in den meisten Fällen auch WebStorm zur Arbeit mit Git verwenden:
* Reiter <code>VCS</code>  →  <code>Enable Version Control Integration</code>
* <code>Git</code> auswählen
* <code>OK</code>


Es gibt allerdings auch aktuellere SVN-Versionen für Apple: https://subversion.apache.org/packages.html
Nun sehen Sie in der Toolbar den Eintrag <code>Git:</code> gefolgt von zwei grünen Icons, einem Pfeil und einem Häkchen.
Mit einem Klick auf den Pfeil können Sie Ihre lokale Version der Web-Anwendung aktualisieren, sofern sie
auf einem externen Server liegt und sich dort Änderungen ergeben haben. Das ist aber noch nicht der Fall.


* In WebStorm gehen Sie dann auf <code>WebStorm</code> → <code>Preferences</code> → <code>Version Control</code> → <code>Subversion</code>.
Mit einem Klick auf das Häkchen können Sie eine neue Version Ihres Dateibaums erstellen (Commit).
* Geben Sie unter <code>Use command line client</code>“ den Dateinamen  <code>svn</code> als neuen SVN-Client an.
Wenn Sie später Änderungen an einer Datei vornehmen, können Sie jederzeit auf ältere Versionen
der Datei zurückgreifen, die Sie mittels eines Commits gesichert haben.


===Verwendung von Subversion===
Klicken Sie nun auf das Häkchen. Es geht ein Fenster auf mit dem Titel <code>Commit Changes</code>.
Siehe auch: https://www.jetbrains.com/help/webstorm/2016.2/using-subversion-integration.html
Darin sehen Sie eine baumartige Listen von Dateien, die alle unter dem Ordner <code>Unversioned Files</code> zu finden sind.
Solange eine Datei nicht unter die Kontrolle von Git gestellt wurde, wird sie durch einen Commit auch nicht versioniert.
Es ist sinnvoll, nicht alle Dateien zu versionieren, da es Dateien gibt, die jederzeit wieder automatisch generiert werden können oder nur temporär existieren. Auch Dateien mit vertraulichen Inhalten sollte man nicht in einem öffentlichen Repository speichern. (Man findet dort allerdings immer wieder mal Dateien mit Kennungen und Passwörtern oder ähnlich vertraulichen Daten.)


Um Ihr Projekt in einem Subversion-Repository zu speichern, müssen Sie folgende Schritte ausführen:
Klicken Sie auf das rechteckige Kästchen vor <code>Unversioned Files</code>. Damit werden '''alle''' bislang unversionierten Ordner und Dateien des Projektes unter die Versionskontrolle von Git gestellt. Geben Sie nun eine <code>Commit Message</code> ein (Zum Beispiel: <code>Projekt neu angelegt</code>) und klicken Sie anschließend auf <code> Commit</code>. Damit sind Kopien aller Dateien des Projektes in einem Spezial-Ordner (<code>.git</code>) gesichert worden.  
<!--# Klick auf <code>VCS</code> in der Hauptmenüleiste
# Klick auf <code>Enable Version Control Integration</code>-->
# <code>Subversion</code> auswählen
# Klick auf <code>VCS</code> → <code>Import into Version Control</code> → <code>Share Project (Subversion)</code>
# Klick auf das Plus-Zeichen neben <code>Point to repository location</code>
# Tragen Sie den URI Ihres Subversion-Repositories ein. Für MMProg-Teilnehmer lautet der URI <code>https://praktikum.multimedia.hs-augsburg.de/svn/ACCOUNT/</code>, wobei die Zeichenkette <code>ACCOUNT</code> durch den eigenen RZ-Account ersetzt werden muss.
# Im darunterliegenden Fester erscheint ein neuer Eintrag mit dem URI des Repositories. Öffnen Sie diesen (Klick auf das Dreieckssymbol).
# Wenn Sie nach einer Kennung und einem Passwort gefragt werden, geben Sie die Daten Ihres Rechzentrumsaccounts an. Aktivieren Sie <code>Save credentials</code>, ansonsten werden Sei bei jedem Zugriff auf das Repository erneut nach den Zugangsdaten gefragt. → <code>OK</code>
#*Falls es bei MAC OS Probleme gibt, befolgen Sie folgende Schritte:
#**Klicken Sie links oben auf <code>WebStorm</code> → <code>Preferences</code> → <code>Version Control</code> → <code>Subversion</code>
#**Unter dem Reiter <code>Network</code> wählen Sie <code>TLSv1</code>.
#**Unter dem Reiter <code>General</code> klicken Sie auf Button <code>TLSv1</code>.
#**Danach starten Sie WebStorm neu.
#**
# Fügen Sie ins Repository einen neuen Ordner namens „<code>mmprog</code>“ ein:
## Rechtsklick auf den URI
## Klick auf <code>New</code> → <code>Remote Folder...</code>
## Geben Sie <code>mmprog</code> als Namen ein (<code>Remote folder name</code>)
## Klicken Sie auf <code>OK</code>.
# Fügen sie auf dieselbe Weise den Unterordner <code>praktikum</code> in den Ordner <code>mmprog</code> ein.
# Selektieren Sie im Dateibaum des Repositories den neu angelegten Ordner <code>praktikum</code> durch Linksklick.
# Wählen Sie unter <code>Define share target</code> den zweiten Eintrag ({{dh}} denjenigen URI, der auf <code>HelloWorld01</code> endet (sofern Sie Ihr Projekt wie vorgeschlagen benannt haben).
# Klicken Sie auf <code>Share</code>, um Ihr neu erstelltes Projekt im Repository anzulegen.
# Sie werden evtl.  gefragt, welches Subversion-Working-Copy-Format verwendet werden soll. Wählen Sie 1.8 (außer, Sie haben einen Uralt-Subversion-Server am Laufen).
# Klicken Sie auf <code>OK</code>.  


Wenn daraufhin die Frage aufpoppt, ob Sie die Datei <code>vcs.xml</code> ebenfalls unter Versionskontrolle stellen wollen,
Wenn Sie jetzt eine Änderung an der Datei <code>index.html</code> vornehmen ({{zB}} indem Sie die Anzahl der Ausrufezeichen in der Datei erhöhen),
markieren Sie <code>Remember, don't ask again</code> und beantworten die Frage mit <code>Yes</code>.
ändert WebStorm die Farbe der Datei im Dateibaum von schwarz nach blau. Damit sehen Sie, dass es eine neuere Version der Datei gibt, die noch nicht mittels <code>Commit</code> gesichert wurde.


Das Projekt ist nun im gewählten Ordner des Subversion-Repositories angelegt worden, aber es wurden noch keine Daten auf den Server übertragen.
Führen Sie testhalber folgende Befehle aus:
Die WebStorm-Ansicht hat sich ebenfalls geändert: Im Dateibaum des WebStorm-Projektes wurde die Datei <code>index.html</code> grün eingefärbt
* Rechtsklick auf <code>index.html</code> im Dateibaum → <code>Git</code> → <code>Compare with the Same Repository Version</code>
und in die Hauptmenü-Leiste von WebStorm sind zwei neue VCS-Icons eingetragen worden.


Falls die Datei <code>index.html</code> nicht grün eingefärbt wurde, müssen Sie sie per Hand unter die Versionkontrolle stellen:
Dann sehen Sie, welche Änderungen Sie an der Datei seit dem letzten Commit vorgenommen haben.
* Rechtsklick auf diese Datei → <code>Subversion</code> → <code>Add to VCS</code>
Sichern Sie auch diese Version der Datei mittels eines Commits (Vergessen Sie nicht, eine neue <code>Commit Message</code> einzugeben).


Die beiden neuen Icons ermöglichen eine schnellen Zugriff
Sehen Sie sich nun die Projekthistorie an:
auf die beiden wichtigsten Subversion-Befehle:
* Reiter <code>VCS</code> → <code>Git</code> → <code>Show History</code>


* VCS, zwei schwarze Punkte und ein grüner Pfeil durch Linien verbunden: ''Update Project''
Dann sehen Sie, dass es bislang zwei Versionen gibt. Bei jeder Version ist vermerkt, wer sie angelegt hat, wann dies geschah und was geändert wurde.
* VCS, zwei schwarze Punkte und ein dicker grüner Punkt durch Linien verbunden: ''Commit Project''
Sie können auch mit einem Doppelklick auf einen Eintrag in der Liste, weitergehende Informationen zur jeweiligen Aktion bekommen.


Mittels ''Commit Project'' werden Änderungen, die auf dem Entwicklungsrechner lokal vorgenommen wurden, ins Subversion-Repository übertragen.
Es gibt viele weitere Befehle zur Arbeit mit einem Git-Repository: Wiederherstellung von alten Versionen, Anlegen von Entwicklungszeigen (Branches), Zusammenführen von Entwicklungszeigen etc. Lesen Sie dazu bitte die oben genannte Git-Dokumentation.
Mittels ''Update Project'' werden Änderungen, die im Repository ({{iAllg}} auf einem anderen Rechner und/oder von einem anderen Entwickler) vorgenommen wurden, ins lokale Verzeichnis des Entwicklungsrechners übernommen. Es gibt noch diverse weitere Subversion-Befehle. Diese sind über den Dateibaum zugänglich:


* Rechtsklick auf den Projektnamen im Dateibaum → Klick auf <code>Subversion</code>
==Speichern eines Git-Repositories auf einem Git-Server==


Alle Dateien, die noch nicht im Repository enthalten sind (zurzeit sind noch überhaupt keine Daten darin enthalten), werden aufgelistet.
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:
Neben der von Ihnen erstellten Datei <code>index.html</code> gibt es noch einen Ordner namens <code>.idea</code>, der WebStrom-spezifische Projekt-Dateien enthält.
*{{Git-Server}}
Sie könnten theoretisch bestimmte Dateien deselektieren, um sie nicht ins Repository zu übertragen. Das wäre hier aber kontraproduktiv.
Im Gegenteil, falls es Dateien gibt, die nicht unter Versionskontrolle stehen, fügen Sie sie durch einen Klick auf das Feld <code>Unversioned Files</code> hinzu.


Tragen Sie in das Feld <code>Commit Message</code> einen sinnvollen Änderungstext ein, wie
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 {{zB}} https://gitlab.com/public oder https://github.com/. Sie müssen sich dort nur registrieren.)
{{zB}} „<code>HelloWorld01 created.</code>“ ein.
Klicken Sie dann auf <code>Commit</code> (dt.: ''übergeben'').


Üblicherweise werden in Projekten englische Dateinamen, Variablenbezeichner, Kommentare (einschließlich Subversion-Kommentaren)
Loggen Sie sich auf dem GitLab-Server ein. Bislang befindet sich dort keinerlei Projekte von Ihnen.
verwendet, um internationale Programmierer um Rat fragen (Diskussionsforen) oder sogar als Teammitglieder einstellen zu können.


Die Farbe der Datei <code>index.html</code> ändert sich bei einem erfolgreichen Commit abermals. Sie wird wieder schwarz.
Öffnen Sie im WebStorm das Terminal und geben Sie dort folgende Befehle ein:
Das bedeutet: Der Inhalt dieser Datei stimmt mit dem Inhalt der im Repository gespeicherten Version überein.
* <code>git remote add origin {{Git-Server}}/ACCOUNT/HelloWorld01.git</code> ('''Ersetzen Sie <code>ACCOUNT</code> durch Ihren RZ-Account.''')
Sobald der Inhalt der lokalen Version der Datei geändert wird, wird der Dateiname blau eingefärbt.
*  <code>git remote -v</code>
Neue Dateien werden – wie bereits gesehen – grün eingefärbt.
Bei einem erneuten Commit werden alle geänderten Dateien abermals ins Subversion-Repository eingetragen.
Allerdings werden die Vorgängerversionen nicht gelöscht. Das heißt, im Repository sind alle Versionen
einer jeden Datei dauerhaft zugänglich. Auf diese können Sie {{zB}} mittels


* Rechtsklick auf eine Datei im Dateibaum → Klick auf <code>Subversion</code> → Klick auf <code>Show History</code>  
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 <code>origin</code>. Sie können aber theoretisch auch jeden anderen Namen wählen.


zugreifen. Das heißt, es ist unnötig und sogar kontraproduktiv, lokale Versionen einer Datei anzulegen: <code>index.html</code>, <code>index.html.v01</code>, <code>index.html.v02</code>, ...
Falls Ihnen der letzte Befehl zeigt, dass Sie die falsche URL eingetragen haben (weil Sie {{zB}} vergessen haben <code>ACCOUNT</code> durch Ihren RZ-Account zu ersetzen),  
können Sie die Verbindung auch wieder löschen und das Repository mit einer anderen URL verbinden_


Um verschiedene Versionen im Versionskontrollsystem unterscheiden zu können, sind die Kommentare, die Sie beim
*  <code>git remote remove origin</code>
Commit angeben, von fundamentaler Bedeutung. Vergessen Sie diese daher nicht und versuchen Sie jeweils die wesentlichen
*  <code>git remote -v</code>
Änderungen, die Sie an einer Datei vorgenommen haben, möglichst kurz und prägnant zu beschreiben (mittels eines Einzeilers).
*  <code>git remote add origin {{Git-Server}}/ACCOUNT/HelloWorld01.git</code> ('''Ersetzen Sie auch diesmal <code>ACCOUNT</code> durch Ihren RZ-Account.''')</code>
.
* <code>git remote -v</code>
'''Anmerkung''': Falls der Commit einmal mit der Meldung <code>Performing VCS refresh</code> hängen bleibt, hilft Folgendes


* <code>File</code> → <code>Invalidate Caches / Restart...</code> → <code>Invalidate and Restart</code>
Sollte die URL korrekt sein, können Sie Ihr Repository auf den Git-Server kopieren:


==Projekte aus einem Subversion-Repository laden==
* Reiter <code>VCS</code> → <code>Git</code> →<code>Push</code>
* Klick auf <code>Push</code> (Wenn Sie nach einer Kennung und einem Passwort gefragt werden, verwenden Sie Ihren RZ-Account)


Projekte, die in einem Subversion-Repository gespeichert sind, können mit einem beliebigen [[Subversion/HowTo|Subversion-Client]] auf Ihren Rechner laden.
Dasselbe erreichen Sie, wenn Sie künftig im Terminal einfach den Befehl <code>git push</code> eingeben. (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.
Sofern Sie Schreibrechte für das Repository haben, können Sie danach Ihre Änderungen auch wieder per Commit ins Repository einspielen.


Damit ist Subversion (wie die meisten anderen Versionsverwaltungssysteme auch) sehr gut für Teamprojekte geeignet:
Sehen Sie jetzt noch einmal im Browser in Ihrem GitLab-Account nach. Dort sollte jetzt das Projekt <code>HelloWorld01</code> zu sehen sein.
Zunächst muss ein Versionsverwaltungssysteme ({{dh}} Subversion-Repository) verfügbar sein,
auf das alle Teammitglieder lesend und schreibend zugreifen können.  Ein Teammitglied fügt ein neues Projekt in dieses System ein.
Alle anderen Teammitglieder laden dieses Projekt auf ihren jeweiligen Entwicklungsrechner. Jedes Mal, wenn ein Teammitglied eine
signifikante Änderung am Projekt vorgenommen hat, testet er diese ausgiebig, bereinigt evtl. noch vorhandene Fehler
und com­mit­tet diese Änderungen dann (nicht früher). Wenn sich jeder Entwickler mit seiner eigenen Kennung mit dem Versionsverwaltungssystem
verbindet, kann in der Änderungshistorie jederzeit nachgesehen werden, wer für welche Änderung verantwortlich ist.
Das ist insbesondere dann wichtig, wenn zwei Entwickler ohne Absprache denselben Code gleichzeitig ändern und committen
wollen. Dann kann es nämlich zu einem sogenannten Mergekonflikt kommen: Der Entwickler, der seine Änderungen
als Zweiter committen will, würde damit die Änderungen, die der erste Entwickler bereits committet hat, einfach überschreiben.
Das wird vom Versionsverwaltungssystem verhindert. Der zweite Entwickler muss den Mergekonflikt von Hand – aber mit Unterstützung des
Versionsverwaltungssystems – beheben.


Um Mergekonflikte nach Möglichkeit zu vermeiden, ist die Modularisierung von Softwareprojekten, die im Teamarbeit erstellt werden,
==Lizenz hinzufügen==
von zentraler Bedeutung. Aber auch für Einzelentwickler ist der Einsatz eines Versionsverwaltungssystems vorteilhaft,
da er für alle wesentlichen Projektversionen stets einen Backup zur Verfügung hat. Da ein Versionsverwaltungstool
üblicherweise auf einem externen Server läuft, ist dieses Backup sogar räumlich vom Entwicklungsrechner getrennt.
'''Allerdings nützt das beste Versionsverwaltungstool nichts, wenn Sie nicht regelmäßig (getestete) Zwischenstände committen und damit dauerhaft abspeichern.'''


<strong>In der Lehrveranstaltung [[Lehrveranstaltung:IAM_2006:Multimedia-Anwendungen/Programmierung|MMProg]],
In GitLab fügen Sie jetzt testhalber eine Lizenzdatei ein:
für die dieses Tutorium entwickelt wurde, müssen sowohl Einzel- als auch Teamprojekte auf die zuvor beschriebene Weise realisiert werden.</strong>
Daher soll das Laden eines bereits vorhandenen Projektes geübt werden.


Für jedes Tutorium in diesem Wiki gibt es eine Musterlösung im Subversion-Repository <code>https://glossar.hs-augsburg.de/beispiel</code> des Wikis.
* Öffen Sie das Projekt im Browser.
Die Musterlösung für das aktuelle Tutorium kopieren Sie folgendermaßen auf Ihren Rechner.
* Klicken Sie auf <code>Add license</code>
(Beachten Sie, dass Sie nur lesend auf das GlossWiki-Subversion-Repository zugreifen können. Das heißt, Sie können die Musterlösungen
* Es öffnet sich ein Texteditor, in dem Sie Ihre Lizenzbedingungen eintragen sollen (Autor, Copyright, Lizenzbezeichner, Link zur Lizenzbeschreibung; Beispiel: [https://de.wikipedia.org/wiki/MIT-Lizenz MIT-Lizenz])  
nur lokal, aber nicht im GlossarWiki-Repository ändern.)
* <code>Commit changes</code>


Starten Sie WebStorm. Wenn der Startbildschirm mit den drei Möglichkeiten ein Projekt zu öffnen erschient, klicken Sie auf <code>Check out from Version Control</code>.
Wenn Sie nun in WebStorm auf das Update-Icon (grüner Pfeil nach links unten neben dem Text „Git:“) in der Toolbar klicken, wird die neue Datei in ihre lokale Kopie des Pojektes übertragen.
Es öffnet sich ein Drop-Down-Menü mit diversen Versionsverwaltungssystemen ([[GitHub]], [[CVS]], [[Git]], [[Mercurial]] und [[Subversion]]) .
Sie wählen <code>Subversion</code> aus.


Anderenfalls klicken Sie auf <code>VCS</code> → <code>Check out from Version Control</code> → <code>Subversion</code>.
==Projekte aus einem Git-Repository laden==


In beiden Fällen öffnet sich das schon bekannte Fenster mit einer Liste von verfügbaren Repositories.
Unter {{Git-Server}}/kowa/WK_HelloWorld01.git finden Sie eine Musterlösung dieser Aufgabe.
Tragen Sie – sofern es nicht bereits vorhanden ist – mittels eines Klicks auf das Plus-Symbol
Öffnen sie diese URL in einem Browser. Im Menü unterhalb der Projekt-ID sehen Sie
das Repository <code>https://glossar.hs-augsburg.de/beispiel/</code> in diese Liste ein.
Drop-Down-Menü mit den beiden Labeln <code>SSH</code> und <code>HTTPS</code>.  
In der Textbox dahinter steht jeweils ein Link, den Sie zum Kopieren des Projektes
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
Schlüsselpaar erzeugen und den öffentlichen Schlüssel in GitLab hinterlegen.


Öffnen Sie durch Klicks auf die Dreiecke vor dem jeweiligen Verzeichnis den Dateipfad
In WebStorm ist es daher einfacher, den HTTPS-Link zu verwenden. Dieser lautet für die Musterlösung:
<div class="formula">
<div class="formula"><code>{{Git-Server}}/kowa/WK_HelloWorld01.git</code></div>
<code>https://glossar.hs-augsburg.de/beispiel</code> → <code>tutorium</code> → <code>es5</code> → <code>hello_world</code> → <code>WK_HelloWorld01</code>  
</div>


Zum Schluss sollte der Ordner <code>WK_HelloWorld01</code> selektiert sein.
Wenn Sie diesen Link im Browser öffen, werden Sie einfach zu der schon bekannten Repository-Seite weitergeletet.
Klicken Sie auf <code>Checkout</code>, wählen Sie in dem Dateibrowser, der sich daraufhin öffnet,
Öffen Sie nun diesen Link ins WebStorm:
einen geeignet Speicherort ({{zB}} neben aber nicht in(!) Ihrem eigenen Projekt <code>HelloWorld01</code>)
und klicken Sie auf <code>OK</code>.


Daraufhin öffnet sich ein Fenster, in dem Sie festlegen sollen, in welchem Unterverzeichnis des zuvor gewählten Verzeichnisses
* <code>VCS</code> → <code>Checkout from Version Control</code> → <code>Git</code>
das Projekt lokal gespeichert soll (<code>Destination</code>). Wenn Sie zuvor das Elternverzeichnis gewählt haben, in dem auch Ihr Projekt
* URL: <code>{{Git-Server}}/kowa/WK_HelloWorld01.git</code> einfügen
<code>HelloWorld01</code> liegt, sollten Sie den zweiten der angebotenen Pfade selektieren.
* Directory: geeigneten lokalen Speicherplatz wählen
Anschließend klicken Sie abermals auf <code>OK</code>, wählen das Format 1.8 und klicken zum dritten Mal  <code>OK</code>.
* <code>Clone</code>
Danach stellt Ihnen WebStorm noch zwei Fragen. Sie sollten das Projekt öffnen (erste Frage). Ob Sie im Gegenzug das zuvor geöffnete
* <code>Yes</code> (neues Projekt in WebStorm öffnen)
Projekt schließen wollen oder nicht (zweite Frage), müssen Sie selbst entscheiden.
* <code>This Window</code> oder <code>New Window</code>, ganz nach Gusto


Nun ist die Musterlösung lokal verfügbar. Sie können sie auf dieselbe Art wie ihr eigenes Projekt ansehen, ausführen und '''lokal''' ändern.  
Nun können Sie die lokale Kopie betrachten und bearbeiten sowie Ihre Änderungen committen.  
Ein Commit ist allerdings – wie bereits gesagt – nicht möglich. Versuchen Sie es ruhig.
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.


==Fortsetzung des Tutoriums==
==Fortsetzung des Tutoriums==

Version vom 8. November 2018, 18:27 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)

Vorlesung WebProg

Inhalt | Teil 1 | Teil 2 | Teil 3 | Teil 4 | Teil 5 | Teil 6

Musterlösung: index.html (Git-Repository)

Anwendungsfälle (Use Cases)

Im ersten Teil dieses Tutoriums wird zunächst mit Hilfe der IDE (integrated development environment) WebStorm eine Web-Anwendung bestehend aus einem HTML-Dokument erstellt.

Das HTML-Dokument enthält als einzigen Inhalt eine Begrüßung der gesamten Welt.

WebStorm vorbereiten

Zur Erstellung der Anwendung wird WebStorm inklusive Node.js eingesetzt. Zunächst müssen Sie diese IDE installieren und konfigurieren. Es handelt sich um eine kommerzielle Software, aber als Student erhalten Sie eine kostenlose Lizenz.

WebStorm starten

In WebStorm gibt es drei Alternativen, ein Projekt zu bearbeiten: Sie können eine neues Projekt erstellen, ein bestehendes Projekt öffnen oder ein bestehendes Projekt aus einem Versionsverwaltungstool laden (check out) und öffnen.

Sie werden zunächst die erste Möglichkeit nutzen und ein neues Projekt erstellen. Anschließend werden Sie die Musterlösung für dieses Projekt aus einem Git-Repository herunterladen.

Ein neues Projekt erstellen

  • WebStorm starten
  • File/WebStorm → New → Project
  • Empty Project, im Feld Location einen sinnvollen Pfad auswählen, wo auf Ihrem Rechner das Projekt gespechert werden soll (z. B. .../mmprog/hello_world/HelloWorld01)
  • Create.

Links sehen Sie nun ein senkrechtes Menü mit mehreren Menüpunkten, Structure, Favorites und Project. (Wenn Sie dieses Menü nicht sehen, müssen Sie auf das Icon unten links in der Leiste klicken. Damit wird es eingeblendet.)

Klicken Sie auf Project. Es erscheint ein Dateibaum, der alle Dateien Ihres Projektes enthält. Bislang gibt es nur das Wurzelverzeichnis mit dem Projektnamen HelloWorld01 sowie zwei Systemdateien External Libraries und Scratches and Consoles, die uns nicht weiter interessieren.

Aktivieren Sie zunächst die Toolbar, sofern Sie dies noch nicht gemacht haben:

  • View → Häkchen bei Toolbar

Hier finden Sie insbesondere den Reload-Button, mit dem Sie den Dateibaum in WebStorm neu laden können, wenn dieser außerhalb von WebStorm verändert wurde.

Klicken Sie nun mit der rechten Maus auf das Wurzelverzeichnis des Baumes und anschließend auf New. Es öffnet sich ein Drop-Down-Menü mit einer Auswahl an Dateien, die Sie erstellen können.

Erstellen Sie eine HTML-Datei index.html vom Typ HTML 5 file. In die HTML-Datei wurde von WebStorm folgender Code automatisch eingefügt: 

<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <title>Title</title>
</head>
<body>

</body>
</html>

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 müssen die beiden wesentlichen Bereiche eines HTML-Dokuments mit Inhalt gefüllt werden.

Im Body-Bereich stehen die eigentlichen Inhalte, die dem Leser im Contentbereich des Browsers angezeigt werden sollen. Da WebStorm keine Ahnung hat, was für Inhalte präsentiert werden sollen, ist dieser Bereich noch leer.

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].

Die HTML-Datei mit Inhalten füllen

Im nächsten Schritt wird die von WebStorm erzeugte HTML-Datei mit Inhalten gefüllt. Es wird ein Titel in Head-Bereich eingetragen. Im Body-Bereich fügen Sie bitte eine Hauptüberschrift (heading, <h1>...</h1>) sowie anschließend einen Absatz (paragraph, <p>...</p>) mit sinnvollem Text ein. 

<!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>

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 von WebStorm 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 auszuliefern. Ein derartiger Server ist in WebStorm bereits enthalten. Daher ist das Testen der Web-Anwendung ganz einfach.

Klicken Sie im Dateibaum von WebStorm mit der rechten Maustaste auf index.html und klicken Sie dann auf Run 'index.html'. Wenn man diesen Befehl erstmals ausgeführt hat, erscheint in der Hauptmenü-Leiste von WebStorm ein Drop-Down-Menü mit ausführbaren Dateien sowie rechts daneben ein grünes Dreieck als Icon, mit dem die im Menü selektierte Datei direkt gestartet werden kann.

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 WebStorm 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 Defaultbrowser im Browser jederzeit ändern:

  • Im Dateibaum index.html selektieren.
  • Reiter Run → Edit Configurations... → Klick auf ... hinter dem Label Browser → Defaultbrowser festlegen
  • OK

Wenn man anschließend in WebStorm Änderungen an der im Browser geöffneten Datei vornimmt, muss man nicht jedes mal die Datei neu starten. Es reicht, im Browser den Reload-Button zu drücken.

Der von WebStorm gestartete Web-Server bedient diverse Browser, die sich auf dem Entwicklungsrechner befinden. Wenn man dieselbe HTML-Datei in einem anderen Browser testen will, kann man dazu den URI im ersten Browser kopieren und in die URI-Leiste des zweiten Browsers einfügen. WebStorm bemerkt, dass der URI in einem anderen Browser geöffnet werden soll und stellt dazu eine Sicherheitsfrage:

Copy authorization URL to clipboard

Wenn man dies bestätigt, enthält das Clipboard anschließend einen URI, die man mit Strg-v als Ersatz für den zuerst eingefügte URI in den neuen Browser kopieren kann. Dieser URI wird dann angezeigt und kann ebenfalls per Reload aktualisiert werden. Schneller geht der Test mit einem alternativen Browser jedoch mit den Browser-Icons in der rechten oberen Ecke des Editor-Fensters.

Man könnte die Seite sogar von einem anderen Device, wie z. B. einen Smartphone aus aufrufen. Dies ist jedoch im WebStorm-Server standardmäßig aus Sicherheitsgründen unterbunden.

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 WebStorm 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 WebStorm das Git-Tool auch findet:

  • WebStorm/File → Preferences/Settings → Version Control → Git

Solle hier im Attribut Path to Git executable kein Pfad eingetragen sein, müssten Sie das nachholen.

Als nächstes sollten Sie in Ihrem Projekt eine Datei namens .gitignore einfügen, die bescheibt, welche Dateien nicht im Git-Repository gesichert werden sollen. Das sind vor allem Dateien mit sensiblen Informationen (wie z. B. Passwörtern) sowie Dateien, die automatisch generiert werden können.

Kopieren Sie die Datei https://glossar.hs-augsburg.de/beispiel/tutorium/2018/.gitignore in das Wurzelverzeichnis Ihres Web-Projektes. Speichern Sie sie unbedingt unter dem Namen .gitignore (mit einem Punkt als erstes Zeichen). Diese Datei enthält die Namen und Endungen zahlreicher Dateien und Ordner, die üblicherweise nicht auf einem Git-Server gespeichert werden sollten. Sie können sie in Ihrer Studienarbeit natürlich an Ihre Bedürfnisse anpassen.

Um Ihr Projekt in einem Git-Repository zu speichern, dient das Git-Tool. Sie können den Befehl git von der Kommandozeile aufrufen, eine Verwendung der WebStorm-Umgebung ist nicht zwingend notwendig: Pro Git von Scott Chacon und Ben Straub.

Sie können aber in den meisten Fällen auch WebStorm zur Arbeit mit Git verwenden:

  • Reiter VCS → Enable Version Control Integration
  • Git auswählen
  • OK

Nun sehen Sie in der Toolbar den Eintrag Git: gefolgt von zwei grünen Icons, einem Pfeil und einem Häkchen. Mit einem Klick auf den Pfeil können Sie Ihre lokale Version der Web-Anwendung aktualisieren, sofern sie auf einem externen Server liegt und sich dort Änderungen ergeben haben. Das ist aber noch nicht der Fall.

Mit einem Klick auf das Häkchen können Sie eine neue Version Ihres Dateibaums erstellen (Commit). Wenn Sie später Änderungen an einer Datei vornehmen, können Sie jederzeit auf ältere Versionen der Datei zurückgreifen, die Sie mittels eines Commits gesichert haben.

Klicken Sie nun auf das Häkchen. Es geht ein Fenster auf mit dem Titel Commit Changes. Darin sehen Sie eine baumartige Listen von Dateien, die alle unter dem Ordner Unversioned Files zu finden sind. Solange eine Datei nicht unter die Kontrolle von Git gestellt wurde, wird sie durch einen Commit auch nicht versioniert. Es ist sinnvoll, nicht alle Dateien zu versionieren, da es Dateien gibt, die jederzeit wieder automatisch generiert werden können oder nur temporär existieren. Auch Dateien mit vertraulichen Inhalten sollte man nicht in einem öffentlichen Repository speichern. (Man findet dort allerdings immer wieder mal Dateien mit Kennungen und Passwörtern oder ähnlich vertraulichen Daten.)

Klicken Sie auf das rechteckige Kästchen vor Unversioned Files. Damit werden alle bislang unversionierten Ordner und Dateien des Projektes unter die Versionskontrolle von Git gestellt. Geben Sie nun eine Commit Message ein (Zum Beispiel: Projekt neu angelegt) und klicken Sie anschließend auf Commit. Damit sind Kopien aller Dateien des Projektes in einem Spezial-Ordner (.git) gesichert worden.

Wenn Sie jetzt eine Änderung an der Datei index.html vornehmen (z. B. indem Sie die Anzahl der Ausrufezeichen in der Datei erhöhen), ändert WebStorm die Farbe der Datei im Dateibaum von schwarz nach blau. Damit sehen Sie, dass es eine neuere Version der Datei gibt, die noch nicht mittels Commit gesichert wurde.

Führen Sie testhalber folgende Befehle aus:

  • Rechtsklick auf index.html im Dateibaum → Git → Compare with the Same Repository Version

Dann sehen Sie, welche Änderungen Sie an der Datei seit dem letzten Commit vorgenommen haben. Sichern Sie auch diese Version der Datei mittels eines Commits (Vergessen Sie nicht, eine neue Commit Message einzugeben).

Sehen Sie sich nun die Projekthistorie an:

  • Reiter VCS → Git → Show History

Dann sehen Sie, dass es bislang zwei Versionen gibt. Bei jeder Version ist vermerkt, wer sie angelegt hat, wann dies geschah und was geändert wurde. Sie können auch mit einem Doppelklick auf einen Eintrag in der Liste, weitergehende Informationen zur jeweiligen Aktion bekommen.

Es gibt viele weitere Befehle zur Arbeit mit einem Git-Repository: Wiederherstellung von alten Versionen, Anlegen von Entwicklungszeigen (Branches), Zusammenführen von Entwicklungszeigen 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:

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_

Sollte die URL korrekt sein, können Sie Ihr Repository auf den Git-Server kopieren:

  • Reiter VCS → Git →Push
  • Klick auf Push (Wenn Sie nach einer Kennung und einem Passwort gefragt werden, verwenden Sie Ihren RZ-Account)

Dasselbe erreichen Sie, wenn Sie künftig im Terminal einfach den Befehl git push eingeben. (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.

Sehen Sie jetzt noch einmal im Browser in Ihrem GitLab-Account nach. Dort sollte jetzt das Projekt HelloWorld01 zu sehen sein.

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 WebStorm auf das Update-Icon (grüner Pfeil nach links unten neben dem Text „Git:“) in der Toolbar klicken, wird die neue Datei in ihre lokale Kopie des Pojektes ü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. Im Menü unterhalb der Projekt-ID sehen Sie Drop-Down-Menü mit den beiden Labeln SSH und HTTPS. In der Textbox dahinter 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 WebStorm ist es daher einfacher, den HTTPS-Link zu verwenden. Dieser lautet für die Musterlösung:

https://gitlab.multimedia.hs-augsburg.de/kowa/WK_HelloWorld01.git

Wenn Sie diesen Link im Browser öffen, werden Sie einfach zu der schon bekannten Repository-Seite weitergeletet. Öffen Sie nun diesen Link ins WebStorm:

Nun können Sie die lokale Kopie betrachten und bearbeiten sowie Ihre Änderungen committen. 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.

Fortsetzung des Tutoriums

Sie sollten nun Teil 2 des Tutoriums bearbeiten.

Quellen

  1. ↑ ISO/IEC 8859-1:1998
  2. ↑ [https://tools.ietf.org/html/rfc3629 Request for Comments 3629, UTF-8, a transformation format of ISO 10646]
  1. Kowarschick (MMProg): Wolfgang Kowarschick; Vorlesung „Multimedia-Programmierung“; Hochschule: Hochschule Augsburg; Adresse: Augsburg; Web-Link; 2018; Quellengüte: 3 (Vorlesung)
Abgerufen von „https://glossar.hs-augsburg.de/w/index.php?title=HTML5-Tutorium:_JavaScript:_Hello_World_01&oldid=46158“