Dingshow ist da!

Ich habe mich endlich dazu entschlossen, das Plugin, an dem ich hier die ganze Zeit werkel, zu veröffentlichen. Zur Seite des Plugins, die auch den Downloadlink enthält kommt man hier.

Da ich mir gerade eben die Mühe gemacht habe, eine wirklich ausführliche readme.txt zu schreiben, spare ich mir jetzt die Wiederholung dessen, und poste hier einfach den Inhalt der readme.txt:

=== Dingshow ===
Autor: Philipp ‘Filzo’ Czora
Blog des Autors: http://filzo.de
Plugin-URL: http://filzo.de

=== Kurzbeschreibung ===
Dingshow zeigt deine letzten Einträge auf identi.ca oder einem beliebigen anderen Dienst, welcher auf dem laconi.ca-Skript basiert, als Sidebar-Widget oder an beliebiger Stelle im Theme an.

A C H T U N G
Dinglist ist momentan noch in einem recht frühen Stadium. Zwar wurde es bisher gut getestet, Fehler sind dennoch nicht auszuschließen. Sollte dir ein Fehler auffallen, melde dich bitte bei mir.

=== Installation ===
Um Dingshow zu installieren, muss der Ordner ‘dingshow’ in das Pluginverzeichnis von WordPress (normalerweise: /wp-content/plugins/) kopiert, und anschließend im Pluginmenü von WordPress aktiviert werden.

=== Benutzung ===
Dingshow kann auf drei Arten benutzt werden: die elegante, die altmodische und die komplizierte.

1. Das Widget – die elegante Art
Die eleganteste Art der Benutzung von Dingshow, ist die Verwendung des Dingshow-Widgets. Um das Widget benutzen zu können, muss das verwendete Theme dies unterstützen. Ist dies gewährleistet, kann das Widget unter “Darstellung->Widgets” konfiguriert werden. Die Optionen sind hierbei größtenteils selbsterklärend:
Widget Überschrift: Legt die Überschrift des Widgets in der Sidebar fest
RSS URL: Die Adresse des RSS-Feeds, bei identi.ca ist es http://identi.ca/username/rss (username bitte einsetzen)
Anzahl der anzuzeigenden Dinger: Legt fest, wieviele Einträge angezeigt werden sollen
Nickname anzeigen: Soll der eigene Nick angezeigt werden?
Nickname verlinken: Wenn der Nickname angezeigt wird, soll er mit dem Profil verlinkt werden?
Link zum Profil anzeigen: Soll unter der Liste der letzten Einträge ein Link zum Profil angezeigt werden?
Text des Links zum Profil: Welcher Linktext soll dabei dargestellt werden? (z.B. “Mein Profil”)
Umbrechen nach: Da lange Wörter nicht umgebrochen werden, und somit das Design zerschießen können, kann hier der Umbruch nach beliebig vielen Zeichen erzwungen werden

2. Das Theme-Tag – die altmodische Art
Unterstützt das verwendete Theme keine Widgets, kann die Ding-Liste als Template-Tag eingebunden werden. Die Einstellungen hierfür finden sich unter “Einstellungen->Dingshow”, und sind ähnlich beschriftet, aber gleich in ihrer Wirkung wie die Widgetoptionen, weshalb ich auf die Verwendung an dieser Stelle nicht weiter eingehe.
Oben auf der Einstellungsseite befindet sich eine Textbox, welche das zu verwendene Template-Tag anzeigt:

< ?php
if (function_exists('dingshow_showdings'))
{
	dingshow_showdings();
}
?>

Diese sechs Zeilen müssen in den Theme-Dateien (meist unter “/wp-content/themes/THEMENAME”) an der Stelle eingetragen werden, wo die Liste angezeigt werden soll.

3. Die komplizierte Art – der direkte Funktionsaufruf
Um die volle Kontrolle über die Darstellung und die Optionen zu erhalten, und um die Dings verschiedener Leute auf einem Blog anzeigen zu lassen gibt es noch eine weitere Möglichkeit, die Liste anzeigen zu lassen. Sie funktioniert ähnlich wie der Weg über das Theme-Tag. Folgender Code muss an den/der entsprechenden Stelle/n eingesetzt werden:

< ?php
if (function_exists('ding_show'))
{
	ding_show($URL, $ANZAHL, $NICK_ZEIGEN, $NICK_VERLINKEN, $PROFILLINK_ZEIGEN, $PROFILLINKTEXT, $UMBRECHEN_NACH);
}
?>

Dabei sind folgende Werte einzutragen:
$URL: Die RSS-URL in Anführungszeichen
$ANZAHL: Die Zahl der zu zeigenden Dings
$NICK_ZEIGEN: 1 oder 0, gibt an, ob der Nickname angezeigt wird
$NICK_VERLINKEN: 1 oder 0, gibt an, ob der Nickname verlinkt wird
$PROFILLINK_ZEIGEN: 1 oder 0, gibt an, ob der Link zum Profil angezeigt wird
$PROFILLINKTEXT: Der Linktext in Anführungszeichen
$UMBRECHEN_NACH: Nach wievielen Zeichen soll ein Zeilenumbruch erzwungen werden?

Als Beispiel: die Anzeige der letzten 5 von mir auf identi.ca geschriebenen Einträge, mein Nickname soll nicht angezeigt werden, dafür aber der Link zum Profil mit dem Text “Filzos Profil bei identi.ca”, wobei nach 30 Zeichen ein Zeilenumbruch erzwungen werden soll:

< ?php
if (function_exists('ding_show'))
{
	ding_show("http://identi.ca/filzo/rss", 5, 0, 0, 1, "Filzos Profil bei identi.ca", 30);
}
?>

Auf diesem Wege sollte man Dingshow allerdings nur einbinden, wenn man es wirklich muss, und weiß, was man tut.

=== Das Aussehen ===
Das Aussehen der Liste lässt sich über die CSS-Dateien im Pluginordner leicht verändern. Die HTML-Struktur der Dingliste besteht im wesentlichen aus einer ungeordneten Liste “ul”. Die Einzelnen Dings sind dabei normale Listenelemente “li”. Um das Anpassen ans eigene Design zu vereinfachen, sind die Elemente bestimmten Klassen zugeordnet. Verwendet man das Dingshow-Widget, heißt die Klasse für die Liste “widget_dinglist” und die Klasse für die einzelnen Elemente “widget_dinglist_item”. Bindet man die Liste über den Template-Tag ein, heißen die Klassen “dinglist” für die Liste, und “dinglist_item” für ein Ding.

=== Schlusswort & Danksagungen ===
Das war’s für’s erste. Es hat mich einige Stunden Arbeit gekostet, um Dingshow zu programmieren. Da dies mein erstes WordPress-Plugin ist, konnte ich so eine Menge über das Schreiben von Plugins für diese wundervolle Blogsoftware lernen. Wenn du in Zukunft einen PHP-Programmierer brauchst, melde dich bitte einfach bei mir – ich arbeite auch für Geld ;) Wenn du kein Geld hast, und einfach nur dieses Plugin benutzt, dann sei doch so nett und schreibe vielleicht in deinem Blog darüber bzw. setze einen Link zu mir. Danke!

Danken möchte ich im Allgemeinen allen, die Vorschläge für Features gemacht, und das Betatesting übernommen haben, und im Speziellen chris, von dem ich am meisten Feedback bekam.

6 Kommentare zu Dingshow ist da!

  1. Cem's Gravatar Cem
    Geschrieben am 3. September 2008 um 13:32 | Permalink

    Wäre ja auch nicht schlecht im Stream von der Dingshow auf einen einzelnen Dent klicken zu können… ;-)

  2. Geschrieben am 3. September 2008 um 15:22 | Permalink

    Ganz grosse Show, dieses Dingdings. Danke.

  3. Cem's Gravatar Cem
    Geschrieben am 3. September 2008 um 16:24 | Permalink

    @filzo, nein: Dingshow ist ja ein Stream von Dents. Ich meinte, es wäre schön, in diesem Stream auf einen einzelnen Dent klicken zu können bzw. um irgendwie beispielsweise von dem Widget auch deinen Stream in identi.ca zu kommen. Wenn ich den Stream bei dir sehe, will ich dann auch von dort weiter durchkommen nach identi.ca. Und nicht nur auf einen verlinkten Account Namen wie beispielsweise @filzo oder @cemb.

  4. Geschrieben am 4. September 2008 um 15:11 | Permalink

    Sehr interessantes Ding!

  1. By on 2. September 2008 at 21:20
  2. By on 3. September 2008 at 10:56
  3. By on 6. September 2008 at 10:56
  4. By on 6. September 2008 at 20:44

Einen Kommentar hinterlassen