Decker Anleitung

Weiterführende Anleitung für Links

Sebastian Lukas Hauer

Lehrstuhl für Computergraphik, TU Dortmund

🚀 by Decker

Linkvorlagen in den Metadaten

In yaml-Konfigurationen von decker können Sie Kurzlinkvorlagen definieren. Diese können Platzhalter beinhalten, deren Wert Sie erst bei Verwendung der Kurzlinksyntax bestimmen. Somit können Sie z.B. auf Unterseiten oder Ressourcen Ihrer Webseiten verweisen ohne jedes Mal den vollständigen Link im Quelltext erwähnen zu müssen.

Linkvorlagen werden in der Sammlung short-links angegeben. Zum Sortieren Ihrer Links können Sie diese Sammlungen auch beliebig tief schachteln.

short-links:
    mysite: "https://meine.webseite/@@"
    othersite: "https://andere.webseite/@@@"
    documtents:
        pdfs: "https://wichtige.webseite/unterlagen/@@.pdf"
        repo: "https://wichtige.webseite/anfrage?datei=@@@"
yaml-Konfiguration mit Platzhaltern

Linkvorlagen verwenden

Linkvorlagen können Sie im Quelltext nutzen, indem Sie den Kurzlink gefolgt von einem Doppelpunkt als Linkziel angeben. Der Text, der auf den Doppelpunkt folgt wird an die Stelle des im Kurzlink angegebenen Platzhalters gesetzt. Ein @@-Platzhalter wird verbatim übernommen. Der Text, der einen @@@-Platzhalter ersetzt wird URL-encodiert.

[Veranstaltungswebseite](ersteSeite:veranstaltung.html)
[Grundlagen](zweiteSeite:text-struktur.pdf)
[Wissenschaftliche Arbeit](sammlung.pdfs:paper)
[Dokumentation](sammlung.repo:test/klausur dokumentation.docx)

Beispiel: Linkvorlagen

short-links:
    example: "https://example.org/@@@"
    mypage:
        pdfs: "https://example.org/stuff/@@.pdf"
        repo: "https://example.org/request?file=@@@"
Beispiel-Konfiguration
[Veranstaltungswebseite](example:veranstaltung.html)

[Wissenschaftliche Arbeit](mypage.pdfs:paper)

[Dokumentation](mypage.repo:einfuehrung technik-1.docx)
Markdownquellcode zum Verwenden von Linkvorlagen

Veranstaltungswebseite

Wissenschaftliche Arbeit

Dokumentation

Verwechslungsgefahr mit Textabschnitten

Textabschnitte werden im Quelltext ebenso wie Links mit eckigen Klammern markiert.

Ein Link wird durch runde Klammern hinter den eckigen Klammern ausgezeichnet.

Ein Textabschnitt wird durch geschweifte Klammern hinter den eckigen Klammern ausgezeichnet.

Auch Links können geschweifte Klammern erhalten, um zusätzliche Eigenschaften zu spezifizieren.

[Dies ist ein Textabschnitt]{}

[Dies ist ein Link]()

[Dies ist auch ein Link](){}
Am Syntaxhighlighting ist zu erkennen was als Textabschnitt und was als Link verstanden wird.