Dokumentation?

  • Affected Version
    WoltLab Suite 3.1

    Mal eine ganz dumme Newbie-Frage: Wo finde ich die Haupt-Dokumentation der Suite 3.1 mit ihren einzelnen Apps? Sowohl aus User-Sicht als auch als Administrator? Erläuterung der Konzepte für Artikel-Kategorien, User-Trophäen, Wysiwig-Editor mit den Buttons und den vordefinierten BBCodes etc.

    P.S.: Mit der Entwickler-Doku unter docs.woltlab.com komme ich klar, aber die meine ich nicht.

  • Danke Euch, die Guides kenne ich, und gerade zur Installation und Migration sind sehr hilfreiche Texte dabei. Ich meine aber ein simples, umfangreicheres Handbuch, das u.a. die in #1 genannten Beispiele enthält: Erläuterung der Konzepte für Artikel-Kategorien, User-Trophäen, Wysiwig-Editor mit den Buttons und den vordefinierten BBCodes etc.

    Beispiel 1 - für User und Admins: Was ist das Konzept hinter User-Trophäen, der Aktivitätenbewertung, dem User-Ranking und dem Like-System. Das ist nicht gleich jedem klar, vor allem nicht, wenn er ein User ohne Zugriff auf das ACP hat (wo man die Systematik indirekt aus den konkreten Konfigurationsmöglichkeiten herauslesen kann).

    Beispiel 2 - für Admins: Anpassung -> Stile -> Stil bearbeiten -> Daten -> Dateien, Option "Bilder-Pfad". Was bewirkt die Angabe des Pfads? Wie greift die Suite auf die Dateien dort zu? Ist der Pfad alternativ zu den Vorschau-Uploads zu sehen oder ergänzend? Darüber hinaus: Egal, ob ich einen absoluten, lokal (zum Web-Baum) absoluten oder relativen Pfad (zur Suite, CMS etc.) angebe, bekomme ich die Fehlermeldung, ich hätte einen ungültigen Pfad eingegeben.

    Beispiel 3 - für User: Wo findet sich die Erklärung der Verwendung des [img]-BBCodes mit der Bedeutung seiner drei Attribute? Eine simple Syntax-Angabe. Oder ein kurzer Satz, dass es besser ist, statt dem [img]-BBCode gleich den Wysiwig-Button zum Einfügen einer Grafik zu verwenden. [url]</kbd> dito. Dass man <kbd>[url=<Adresse>]<Text>[/url] schreiben kann, um einen Text über die URL zu legen. Basics eigentlich - und je Foren-Software ein bisschen anders.

    Beispiel 4 - für mich als Admin: Ich muss für die Migration eines Forums BBCodes erzeugen, dessen Wert (Parameter) ich im erzeugten HTML mehrfach verwende. Beispiel: Aus [thumb]<Adresse>[/thumb] soll das hier werden: (Ich weiß, später mit hübscher CSS-Klasse etc. Mir geht es hier um die Mehrfachverwendung.)

    Code
    <a target="Originalbild" href="{Adresse}"><img style="max-width:300px; margin-right:10px; height:auto;" src="{Adresse}" alt="Bild: {Adresse}" /></a>

    Geht das mit den ACP-Bordmitteln, oder muss ich dafür dann doch eine kleine PHP-Klasse schreiben?

    Ich bin mehrfach an solche Punkte gestoßen, für die ich mir eine ausführlichere Doku gewünscht hätte, als das, was im System selbst zu sehen ist.

  • Das ist so nicht ganz richtig, denn es gab eine integrierte Hilfe, nur gestaltet man Funktionen stattdessen besser selbsterklärend. Erklärungen, soweit überhaupt noch notwendig, findet man benutzerfreundlich bei der jeweiligen Funktion. Die frühere Hilfe, mit vielen für die jeweilige Community überhaupt nicht zutreffenden Informationen, war für die Benutzer höchst verwirrend.

  • Beispiel 2 - für Admins: Anpassung -> Stile -> Stil bearbeiten -> Daten -> Dateien, Option "Bilder-Pfad". Was bewirkt die Angabe des Pfads?

    Das steht in der Beschreibung direkt darunter.

    Wie greift die Suite auf die Dateien dort zu?

    Was meinst du damit?

    Ist der Pfad alternativ zu den Vorschau-Uploads zu sehen oder ergänzend?

    Es besteht kein Zusammenhang.

    Darüber hinaus: Egal, ob ich einen absoluten, lokal (zum Web-Baum) absoluten oder relativen Pfad (zur Suite, CMS etc.) angebe, bekomme ich die Fehlermeldung, ich hätte einen ungültigen Pfad eingegeben.

    Auch das steht in der Beschreibung. Gefragt ist ein direkter Unterordner des Ordners „Images“ für den jeweiligen Stil. Der Pfad könnte also beispielsweise „images/musterstil“ lauten. Das Feld ist außerdem bereits vorbelegt.

  • Beispiel 1 - für User und Admins: Was ist das Konzept hinter User-Trophäen, der Aktivitätenbewertung, dem User-Ranking und dem Like-System. Das ist nicht gleich jedem klar, vor allem nicht, wenn er ein User ohne Zugriff auf das ACP hat (wo man die Systematik indirekt aus den konkreten Konfigurationsmöglichkeiten herauslesen kann).

    Neu hinzugekommene Funktionen werden hier ausführlich vorgestellt und diskutiert. Die Suite lässt Betreibern maximale Entscheidungsfreiheit. Ob und wie man die einzelnen Möglichkeiten verwendet, muss jeder Betreiber selbst entscheiden, und das Konzept anschließend der jeweiligen Community vorstellen.

  • Danke für die ausführliche Antwort und auch den Hinweis, dass man für den Bilderpfad "images/" genau so mit angeben muss. Unerwähnt bleibt in der ACP-GUI übrigens, dass der Style-Export nur die Dateien im Bilderpfad-Verzeichnis sichert, nicht die dortigen Unterverzeichnisse (was für die Strukturierung bei vielen Dateien praktisch wäre).

    Beim Beispiel 4 (Parametrisierung der BBCodes) komme ich mit den Angaben in ACP-GUI im Augenblick nicht weiter und hoffe auf den ein oder anderen Foristen hier, der sich meiner erbarmt und mir einen kleinen Wink gibt.

  • Die Antworten habe ich selbst gefunden und als Ergebnis ein kleines Package mit BBCodes geschrieben. Einige ließen sich rein über die XML-Konfiguration realisieren (also theoretisch auch über die GUI), andere habe ich mit kleinen PHP-Klassen implementiert.

    Die beste Dokumentation ist immer noch der Sourcecode.

Participate now!

Don’t have an account yet? Register yourself now and be a part of our community!