ARUNOX Framework

Erstellung einer neuen Dokumentationsseite

Gehen Sie wie folgt vor, um eine neue Seite zu erstellen:

1. Erstellen Sie eine neue PHP-Datei im Verzeichnis pages/docu/.
2. Der Name und die Unterverzeichnisstruktur sollten der Originaldateistruktur entsprechen.
3. Fügen Sie den folgenden Code als Grundgerüst ein:

<header>
    <h2>[Titel der Dokumentation]</h2>
    <p>[Kurze Beschreibung der Seite]</p>
</header>

<section>
    <h3>Einleitung</h2>
    <p>[Überblick über die Funktionalität]</p>
</section>

<section>
    <h3>Strukturübersicht</h2>
    <p>[Überblick über die Verzeichnisstruktur und Datenbankstruktur]</p>
</section>

<section>
    <h3>Voraussetzungen</h2>
    <p>[Überblick über die Voraussetzungen z.B. erforderliche Konfigurationen]</p>
</section>

<section>
    <h3>Anwendung</h2>
    <p>[Erklärung zur Anwendung von z.B. Methoden]</p>
</section>

<section>
    <h3>Sourcecode</h2>
    <p>Pfad: <code>[Pfad und Name der Quelldatei]</code></p>
    [Quellcode]
</pre>
</section>

Die Datei wird automatisch erkannt und in die Sitemap integriert.

Sourcecode

Der Abschnitt Sourcecode beschreibt, wie der Originalcode einer Klasse dynamisch eingebunden wird.

Codebeispiele

Code für dynamisches Laden von Dateien, z. B. für den Originalcode:

<?php showSourceCode('/path/to/your/file.php'); ?>

Die Funktion generiert automatisch den passenden Code-Block.

Anweisung zur Verwendung von showSourceCode()

• Im Abschnitt Sourcecode wird immer die Funktion showSourceCode() verwendet.
• Parameter: Es wird ausschließlich der relative Dateipfad zur Klasse bzw. Datei übergeben, z. B.:

  <?php showSourceCode('/path/to/your/file.php'); ?>

• Der Namespace der Klasse wird nicht verwendet.
• Keine weiteren Inhalte oder Kommentare sind in diesem Abschnitt erlaubt.

Hinweis:

• Der Pfad muss korrekt definiert sein.
• Die Datei muss existieren, damit der Quellcode geladen werden kann.

Best Practices

• Struktur: Halten Sie die Struktur der Dokumentation klar und konsistent.
• Codebeispiele: Stellen Sie sicher, dass alle Beispiele funktionsfähig sind.
• Kommentare: Kommentieren Sie Code, um ihn verständlicher zu machen.
• Fehlerbehandlung: Dokumentieren Sie typische Fehler und deren Lösungen.

Codeblöcke

Um Codeblöcke optisch ansprechend zu gestalten, verwenden Sie die CSS-Klasse pre.code-block:

/* Codeblock-Styling */
pre.code-block {
    background: #1a1a1a; /* Dunkler Hintergrund */
    color: #33abc9; /* Türkiser Text */
    border-left: 5px solid #800080; /* Pinke Linie */
    padding: 15px;
    font-family: monospace;
    font-size: 0.95rem;
    overflow-x: auto;
    border-radius: 4px;
    margin-bottom: 20px;
    white-space: pre-wrap; /* Zeilenumbruch für lange Codezeilen */
}

Codeblöcken <pre> kann durch das Attribut data-code angegeben werden und welche Art Code es sich handelt. Dies wird dann als Badge rechts oben angezeigt.

<pre data-code="HTML"><code></code></pre>