Hilfe zur Hilfe: DocWiki

Aus RAD Studio
Wechseln zu: Navigation, Suche

Nach oben zu Hilfe zur Hilfe


Die Online-Hilfe von RAD Studio ist in drei separaten Wikis enthalten:

Alle Benutzer von RAD Studio sind eingeladen, sich am DocWiki zu beteiligen. Sie können ein eigenes Benutzerkonto erstellen, indem Sie auf einer beliebigen Seite im DocWiki auf Anmelden/Benutzerkonto anlegen klicken.

Erste Schritte

Um die Seite Diskussion bearbeiten zu können, müssen Sie sich anmelden. Wenden Sie sich wegen einer Berechtigung zum Bearbeiten von Hauptseiten an [email protected].

  • Klicken Sie auf die Registerkarte Diskussion, um Fragen zum Thema zu stellen oder zu beantworten.
  • Klicken Sie auf die Registerkarte Bearbeiten, um den Wiki-Quelltext anzuzeigen und optional das angezeigte Thema zu bearbeiten.

Wichtige Wiki-Tags zum Bearbeiten oder Schreiben von Beiträgen

Aufzählungszeichen

Zum Erstellen eines Absatzes mit Aufzählungszeichen geben Sie ein Sternchen (*) in die erste Spalte ein. Verwenden Sie für verschachtelte Ebenen mehrere Sternchen wie folgt:

  • * (ein Sternchen) erstellt ein Aufzählungszeichen auf der obersten Ebene, wie dieses.
    • ** (zwei Sternchen) erstellen ein Aufzählungszeichen auf der zweiten Ebene, wie dieses.
      • *** (drei Sternchen) erstellen ein Aufzählungszeichen auf der dritten Ebene, wie dieses.

Hyperlinks

Zum Erstellen eines Hyperlinks zu einem anderen Thema im DocWiki schließen Sie den Titel des Themas in doppelte, eckige Klammern ein: 

 [[Object Inspector]] = Objektinspektor

Verknüpfen zwischen Wikis

Das DocWiki ist in drei DocWikis unterteilt: Themen, Bibliotheken und Codebeispiele. Sie können diese DocWikis untereinander verknüpfen.

  • Fügen Sie zum Erstellen eines Hyperlinks zur Bibliotheksreferenz das Präfix "lib_de:" hinzu. Für andere Sprachen verwenden Sie "lib_en" (Englisch), "lib_fr" (Französisch) und "lib_ja" (Japanisch). Verwenden Sie zum Festlegen des Titels das Zeichen "|", um das Präfix aus dem Link zu entfernen:
    [[lib_de:FMX.Forms.TForm|FMX.Forms.TForm]] = FMX.Forms.TForm
  • Zum Verknüpfen von einem anderen DocWiki mit dem Themen-DocWiki fügen Sie das Präfix "rad_de:" hinzu:
    [[rad_de:Objektinspektor|Objektinspektor]] = Objektinspektor
  • Zum Verknüpfen mit dem DocWiki mit den Codebeispielen verwenden Sie das Präfix samp::
    [[samp:TrySystemTimeToDateTime ({{Delphi}})|TrySystemTimeToDateTime ({{Delphi}})]] = TrySystemTimeToDateTime (Delphi)

Überschriften

Um Überschriften verschiedener Gliederungsstufen zu erstellen, beginnen und beenden Sie die betreffende Zeile mit einem oder mehreren Gleichheitszeichen (=). Für eine Überschrift der obersten Ebene wird ein Gleichheitszeichen, für untergeordnete Überschriften werden mehrere Gleichheitszeichen verwendet: 

== Sample Heading 2 ==

erstellt eine Überschrift 2, wie die folgende:

Überschrift 2

=== Sample Heading 3 ===

erstellt eine Überschrift 3, wie die folgende:

Überschrift 3

Hinzufügen einer Seite zum DocWiki

  1. Fügen Sie in einem zugehörigen Thema (ein Thema, das einen Link zu dem zu erstellenden Thema enthalten soll) einen Link zu dem neuen Thema hinzu:
    [[Neues Thema]]
  2. Speichern Sie die Seite.
  3. Klicken Sie auf den (roten) Link zu Ihrer neuen Seite.
  4. Nun können Sie mit dem Schreiben des neuen Themas beginnen.
    • Fügen Sie oben ein übergeordnetes Tag hinzu (für den Link "Nach oben zu"):
    {{Parent|Übergeordnetes Thema}}
    Dieses Tag muss auf das Thema zeigen, das in der Hilfehierarchie (Inhaltsverzeichnis) Ihrem Thema übergeordnet ist.
    Hinweis: Wenn Sie nicht sicher sind, welches Thema das übergeordnete ist, wenden Sie sich an [email protected].
    • Fügen Sie unten optional die Rubrik Siehe auch hinzu:
    == Siehe auch ==

Hinzufügen von Wiki-Kategorien-Tags

Kategorien-Tags ermöglichen das Gruppieren zusammengehöriger Themen. Eine Liste der aktuell im DocWiki verwendeten Kategorien finden Sie unter Spezial:Kategorien.

Auf jeder Seite sollte mindestens eines der folgenden Tags enthalten sein:

  • Sprach-Tag, Delphi oder C++ oder beide
  • Versions-Tag
  • Optionales Technologie-Tag
  • Organisatorisches Tag (wie "Delphi-Sprachreferenz" oder "RAD Studio – Referenz")

Dazu einige Beispiele:

Nur Delphi: 


[[Category:{{Delphi}}]]

Nur C++: 


[[Category:C++]]

Beide: 


[[Category:C++]]
 [[Category:{{Delphi}}]]

Jede Seite sollte mit der Version versehen werden, in der sie zuerst erschienen ist, oder mit der Version, in der auf der Seite größere Änderungen vorgenommen wurden: [[Category:XE2]]

Weitere Kategorien betreffen die Technologie; hier einige Vorschläge dazu.

FireMonkey-Bibliothek: 


[[Category:FMX]]

RTTI-Bibliothek: 


[[Category:RTTI]]

Themen

Siehe auch

Abgerufen von „https://docwiki.embarcadero.com/RADStudio/Athens/d/index.php?title=Hilfe_zur_Hilfe:_DocWiki&oldid=216495“