Mittwoch, 09. August 2006

State of the WordPress Documentation

Ich hatte ja schon an anderer Stelle geschrieben, dass ich mein Blog technisch ein bisschen aufbohren möchte, in der Hoffnung, euch einen Anreiz zu geben, öfter vorbei zu schauen. Das ist jetzt auch voll im Gange, gestaltet sich aber gar nicht mal so einfach. Oder ums mal mit Pablos Worten zu sagen:

Gute Nacht. Hoffentlich gibts du nicht am miserablen Code, an den fehlenden Kommentaren und an der schlechten Dokumentation auf. Aber viel Glück.

Nein! Nein, das kann nicht sein! Glauben wollte ich es ihm nicht, schließlich gibt es doch diesen kleinen Unterschied zwischen erkennen und wirklich wahr haben. Und solange man an der Oberfläche des technisch Machbaren schwimmt – also der alltägliche Kram wie Themes erstellen zum Beispiel – ist es auch wirklich kein Problem, schnell Hilfe zu bekommen. Aber wehe, man begibt sich in die Tiefen des WordPress-Codes… Also dann, was macht euer Jeriko eigentlich, wenn Hilfe braucht?

wordpress.de

Das Forum der deutschen WordPress Community ist wohl Anlaufstelle Nr. 1 in Deutschland, wenns um irgendwelche Fragen geht. Hab mich vor ein paar Monaten selber dort eingeklinkt und helfe mit meinem beschränkten Wissen weiter, wo es nur geht. Leider wiederholen sich doch die meisten Fragen, und meistens sind es nur einfachere Dinge. Sicher, da gibt es auch welche mit einem abartigen Hintergrundwissen, aber dann sind die Probleme meistens schon wieder so speziell, das man nur schlecht helfen kann. Sei’s drum.

Moment, das klingt jetzt zu negativ. Also bei Alltagsproblemen wird einem sofort geholfen, bei wirklich, wirklich speziellen Dingen ist man beim nächsten Anlaufpunkt vielleicht besser aufgehoben.

WordPress Codex

Muss man da drüber noch Worte verlieren? Jeder, der auch nur mal versucht hat, etwas an seinem Blog anzupassen, dürfte zwangsläufig schon über den Codex gestolpert sein. Aber hier wird es auch schwer: Informationen befinden sich an zu vielen Stellen, sind dürftig oder erst gar nicht vorhanden. Ich kreide dies mal dem Wiki an, es gibt einfach keine klare Linie, die einem helfen könnte, das Gesuchte schnell zu finden. Man muss schon ein klein wenig masochistisch veranlagt sein und Zeit aufbringen, um dort weiter zu kommen.

WordPress selber ist in der Tat schlecht dokumentiert. Als eine mögliche Anlaufstelle ist mir die Funktionsreferenz von RedAlt aufgefallen (die Referenz aus dem Codex kann man eigentlich nur in die Tonne kloppen) – nur was nützts? Man kann Funktionen nur suchen, muss als vorher ihren Namen wissen. Dürfte dann wohl auch der Grund sein, warum nichtmal 7% der 1283 gelisteten Funktionen dokumentiert sind – und das dürften auch nur die Infos aus dem Codex sein. Ich hatte dem Betreiber Owen Winkler mal eine Mail geschrieben, ob er die Liste nicht vielleicht rausrücken würde, damit man es besser anstellen könnte, aber der wollte wohl nicht.

Und nu?

Soviel also von meiner Seite zur State of the WordPress Documentation. Ich gebe trotzdem nicht auf, und plane auch, hier ein paar Dinge anzuschneiden, die bei weitem nicht alltäglich sind, aber dennoch für den ein oder anderen nützlich sein können. Und hey, vielleicht gibts ja noch ein paar andere Stellen im Internet, die ich noch gar nicht kenne? Her damit! :-)

9 Kommentare

  1. Martin Labuschin

    Ich sietze auch gerade am Motor von einem WordPress-Blog (ich sag jetzt aber nicht welcher *fg*) und ich muss sagen, dass ich sehr gut zurecht komme. Ich denke, wenn man etwas PHP-Wissen mitbringt, kann man gut mit den Dokumentationen, die einem WordPress bietet sehr gut klarkommen.
    Was mir nicht gefällt ist, dass die WordPress-Funktionen zig Parameter-Möglichkeiten haben… Da ist es echt teilweise schwer hinterzusteigen.
    Viel Spass wünsche ich dir trotzdem beim Tuning.

  2. Jeriko

    Stellt sich natürlich die Frage was du vorhast. Ich sitz gerade noch über einem Beitrag, der heute oder morgen online geht und ein bisschen zeigt, wie komplex es doch werden kann.

    Und, WordPress? DU? Der “Ich schreib mir mal gerade mein eigenes Blogsystem weil mir langweilig ist” Blogger? Na jetzt bin ich aber gespannt :-)

  3. Martin Labuschin

    Ja ich. Wenn du dir Mühe gibts, kannste es finden. Als Experiment: Ich announce das Blog nicht, ich verlinke es auch nicht. Wer kommt, der kommt…

  4. Peti

    Moment, das klingt jetzt zu negativ. Also bei Alltagsproblemen wird einem sofort geholfen, bei wirklich, wirklich speziellen Dingen ist man beim nächsten Anlaufpunkt vielleicht besser aufgehoben.

    Na das macht mich ja traurig…

  5. Malte Jan ‘Schneggerich’ Kaffenberger

    Ich finde ja WordPress ist irgendwie wie Reason von Propellerhead (SoftSynth, einigermaßen professionell…): man kann damit oberflächlich arbeiten, man kann sich damit lange beschäftigen und man kann sich die Zähne dran ausbeißen. Allen Dokumentationen zum Trotz, die ja größtenteils als Wiki vorhanden sind und mir als Modembenutzer im größtenteils Offlinebetrieb nichts bringen (weil mein Server mit wget oder w3mir da drei Tage dran spiegelt, es lebe die dynamische Webseite :)), empfehle ich einfach mal die aktuelle WordPressversion mit phpxref zu scannen. (Ich weiß den Link zu dem Programm leider nicht mehr, wenns keiner beim googeln findet meldet man sich halt bei mir.) Phpxref erstellt aus PHP-Dateien, die irgendwie zusammenhängen einen netten durchsuchbaren Überblick über alle vorhandenen Funktionen und gibt eventuelle PHP-Doc kompatible Kommentare mit als Beschreibung aus. Das Ganze gibts es dann in Form von übersichtlichen HTML-Dateien.
    Ist zwar ein bisschen geeky, aber wenn man sich mal n bisschen Zeit ans Bein bindet, dann kann man ne Menge entdecken.
    Ebenfalls nicht übel ist einfach mal während einer Themeentwicklungssitzung irgendwo im Theme
    echo String(GLOBALS)
    auszugeben. Sehr aufschlussreich.
    Hoffe, ich habe das Thema nicht allzusehr verfehlt :) Dieser Beitrag ist mir zur Zeit wie aus der Seele gesprochen…

  6. tboley

    Sein wir doch mal ehrlich: Wer sich mit WordPress intensiver beschäftigt, dem wird so schnell nicht mehr langweilig ;-)

    An den Codex kann man sich ganz gut gewöhnen , wo bei ich wärmsten das Mono-Book-Theme empfehlen würde, da sich die Artikel damit deutlich besser lesen lassen (Wiki-Account nötig).

  7. Jeriko

    Peti ich habe es ja auch am Ende relativiert. wordpress.de ist nach wie vor meine Anlaufstelle Nr. 1 wenn es irgendwo mal hakt, und ich bringe mich ja auch selber ein, da ich das Ganze ja für eine gute Sache halte. Und mit “speziell” meine ich auch genau das, das muss schon ein sehr extravagantes Problem sein bevor es dort nicht beantwortet werden kann. Also wo es wirklich ans Eingemachte von WordPress geht. Sorry wenn das falsch rüber gekommen sein sollte.

    Malte ich war mal so frei und habs entsprechend geändert. Und endlich habe ich auch im Codex den vertrauten MediaWiki Look, danke tboley :-)

  8. Felix

    Ich finde das Design deiner Page sehr gut… brauchst dir also garnicht so viel Gedanken machen ;)

  9. Anne

    Ich finde es schon ziemlich schwierig das ganze zu bearbeiten
    aber wenn man zeit und muse hat, dann gehts schon

Kommentar schreiben

SEOs brauchen es erst gar nicht probieren, Kommentare mit dem Zweck der kommerziellen Eigenwerbung (Links zu Shops, Firmen, o.ä.) sowie sinnloser Schrott werden ebenfalls als Spam markiert. Wenn ihr etwas völlig anderes beisteuern wollt, dann bitte über den normalen Kontakt.