Arbeiten mit Git und AsciiDoc

Erweitern Sie Ihre Datei Beispieldokumentation.adoc wie folgt:

== Kennenlernen der Syntax

Über die Aufgaben wird das Dokument Stück für Stück aufgebaut und angepasst.

=== Listen

.Beispiel: unsortierte Liste (1)
// Platzhalter

.Beispiel: sortierte Liste
// Platzhalter

Fügen Sie je ein Beispiel für eine unsortierte (Unordered list) und sortierte (Ordered list) Liste ein.

Speichern Sie und nehmen Sie Ihre Änderungen als neue Version in Ihr lokales Git-Repository (add, commit) und Ihr Repository auf GitHub (push) auf.

Erweitern Sie die Datei Beispieldokumentation.adoc um die Überschrift === Tabellen und Textformatierung

Fügen Sie folgende Tabelle (Tabelle 1, “Formatierung von Text”) für ausgewählte Textformatierungen hinzu:

Formatieren Sie das Wort Software Engeneering so, dass es wie folgt aussieht:

Speichern Sie und nehmen Sie Ihre Änderungen als neue Version in Ihr lokales Git-Repository und Ihr Repository auf GitHub auf.

Fügen Sie eine Überschrift === Quellcode hinzu und betten Sie folgendes Quellcode-Beispiel ein:

#include <stdio.h>

int main(int argc, char* argv[])
{
    printf("Hello, World!\n");
    return 0;
}

Speichern Sie und nehmen Sie Ihre Änderungen als neue Version in Ihr lokales Git-Repository und Ihr Repository auf GitHub auf.

Fügen Sie eine Überschrift === Bilder ein.

Legen Sie in docs ein Verzeichnis images an. Hier wollen wir alle für das Dokument benötigten Bilder ablegen.

Fügen Sie im Dokumentenkopf das Attribut :imagesdir: images hinzu, um das globale Bildverzeichnis für das Dokument festzulegen. Bei Einbindung eines Bildes reicht es nun nur den Dateinamen ohne vorangestelltes images/ anzugeben.

Erstellen Sie einen Screenshot ihres Editors und legen Sie die Bilddatei in das images Verzeichnis.

Binden Sie den Screenshot in ihr Dokument ein und vergeben Sie einen Bildtitel.

Abbildung 2. Screenshot VSCode mit AsciiDoc

Speichern Sie und nehmen Sie Ihre Änderungen als neue Version in Ihr lokales Git-Repository und Ihr Repository auf GitHub auf.

Fügen Sie eine Überschrift === Verweise ein und schreiben Sie einen Text, welcher Verweise auf die in Ihrem Dokument enthaltene Überschrift: 1. AsciiDoc Syntax kennenlernen, die Tabelle: Tabelle 1, “Formatierung von Text”, den Quellcode: hello_world.c und das Bild: Abbildung 2, “Screenshot VSCode mit AsciiDoc” enthält.

== 1. AsciiDoc Syntax

[#exercise_01] (1)
=== 1.1 Aufgabe

[#image_screenshot] (1)
.Screenshot
image::screenshot.png[]

* <<1. AsciiDoc Syntax>> und <<_1_asciidoc_syntax>> (2)
* <<exercise_01>>, <<image_screenshot>> (3)
* <<image_screenshot, Bildschirmfoto des Editors>> (4)

Speichern Sie und nehmen Sie Ihre Änderungen als neue Version in Ihr lokales Git-Repository und Ihr Remote-Repository auf GitHub auf.

Fügen Sie eine Überschrift === Includes ein.

Legen sie parallel zu docs ein neues Verzeichnis src an.

Lagern Sie den Quelltext aus Aufgabe 1.3 - Quellcode in eine extra hello_world.c Datei in das Verzeichnis src aus.

Binden Sie diese Datei, limitiert auf die Zeilen der main()-Funktion, mit einem include als Quellcode-Abschnitt wie folgt ein:

int main(int argc, char* argv[])
{
    printf("Hello, World!\n");
    return 0;
}

include::path/to/sub-document.adoc[] (1)
include::../src/hello_world.c[lines=3..7] (2)

=== Systemweite funktionale Anforderungen

// tag::nfaf1[] (1)
* *NFAF-1*: ...
// end::nfaf1[] (2)

=== Zuverlässigkeit (Reliability)

// tag::nfar1[]
* *NFAR-1*: ...
// end::nfar1[]

== Architektur-relevante Anforderungen

=== Funktional
include::../requirements/system-wide_requirements.adoc[tag=nfaf1] (1)

=== Zuverlässigkeit (Reliability)
include::../requirements/system-wide_requirements.adoc[tag=nfar1]

Command Palette über Hauptmenü: View  Command Palette…​ öffnen.

Folgende Befehle eingeben:

Generieren Sie mit der AsciiDoc Erweiterung in Visual Studio Code die HTML- und PDF-Version des AsciiDoc-Dokumentes Beispieldokumentation.adoc.

Generieren Sie mit den lokal installierten Asciidoctor Tools über das Terminal (oder das in Visual Studio Code integrierte Terminal) die HTML- und PDF-Version des AsciiDoc-Dokumentes Beispieldokumentation.adoc:

$ cd docs
$ asciidoctor Beispieldokumentation.adoc
$ asciidoctor-pdf Beispieldokumentation.adoc

Schauen Sie sich die Ergebnisse an.

Legen Sie im Projektverzeichnis (Workspace) die Datei .gitignore mit folgendem Inhalt an:

*.html
*.pdf

# ignore unwanted files (1)
*~
.DS_Store

# ignore special folder '.asciidoctor'
.asciidoctor/ (2)

# ignore generated files
docs/*.html (3)
docs/*.pdf

Nehmen Sie die Datei .gitignore als neue Version in Ihr lokales Git-Repository und Ihr Remote-Repository auf GitHub auf.