-
Notifications
You must be signed in to change notification settings - Fork 3
/
plugins_seitenleisten.tex
2010 lines (1647 loc) · 93 KB
/
plugins_seitenleisten.tex
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
%revised
\chapter{Seitenleisten-Plugins}
\index{Plugins}%
\label{Plugins}
Serendipity bietet eine große Menge von Plugins an. Einige davon werden
direkt bei Serendipity mitgeliefert, andere sind im externen
Spartacus-Archiv (siehe Seite \pageref{Spartacus})
verfügbar.
\index{Seitenleisten-Plugins}%
\index{Ereignis-Plugins}%
Plugins sind bei Serendipity in \emph{Seitenleisten-} und
\emph{Ereignis-Plugins} unterteilt. Wie im Kapitel zur Plugin-Verwaltung
(siehe Seite \pageref{Plugins verwalten})
erwähnt, binden sich Seitenleisten-Plugins zur Ausgabe in den
Rahmenbereich Ihres Blogs ein. Ereignis-Plugins hingegen dienen der
funktionellen Erweiterung Ihres Blogs.
Auf den folgenden Seiten finden Sie eine Übersicht der am häufigsten
genutzten Plugins und aller mitgelieferten Plugins. Aus Platzmangel können
wir leider nicht auf jedes Plugin eingehen, verzeihen Sie also bitte,
falls Ihr Lieblings-Plugin nicht beschrieben wird.
Die meisten Plugins sind trotz kurzer Beschreibung leicht zu benutzen
und zu konfigurieren. Sollte es darüber hinaus Fragen zu der Benutzung
eines Plugins geben, wird man Ihnen im
Serendipity-Forum\footnote{\cmd{http://board.s9y.org/}} sicherlich
helfen.
\index{Gekoppelte Plugins}%
Einige Plugins bestehen aus einer Kombination von Seitenleisten-
und Ereignis"=Plugins. Sie werden als \emph{Gekoppelte Plugins} bezeichnet
und in einem eigenen Kapitel (ab Seite \pageref{Gekoppelte Plugins}) behandelt.
\index{Plugins!mehrfach installieren}%
Plugins können häufig mehr als einmal installiert werden. Gerade bei
Seitenleisten"=Plugins wie dem HTML-Klotz macht dies Sinn, damit man
beliebig viele Inhalte im Blog anzeigen kann. Wenn ein Plugin nicht
mehrfach installiert werden kann, erscheint es in der Plugin-Liste mit dem
Hinweis "`bereits installiert"'. Bei Ereignis-Plugins ist es
hingegen seltener notwendig, mehr als eine Instanz des Plugins zu
installieren. Jedes mehrfach installierte Plugin kann individuell
konfiguriert werden, da jede Instanz unabhängig agiert.
Die Konfigurationsoptionen der jeweiligen Plugins sind hier auf die essentiellen
Parameter beschränkt und daher nicht vollständig aufgeführt. Im Buch nicht
beschriebene Optionen sind jedoch in der Konfigurationsoberfläche eines Plugins
aufgeführt und werden dort auch grob beschrieben oder sind meistens
selbsterklärend.
Leider sind nicht alle Plugins bisher ins Deutsche übersetzt, daher
wird bei einigen Beschreibungen und Plugin-Namen im Folgenden auf das
englische Original zurückgegriffen.
\label{Seitenleisten-Plugins}
\index{Plugins!Seitenleisten}%
Damit Sie ein Seitenleisten-Plugin innerhalb der Verzeichnisstruktur besser
finden, geben wir in der Übersicht neben dessen Namen
auch den Klassennamen der Datei an.
\section{Standardmäßig aktivierte Plugins}
Seitenleisten-Plugins werden im Frontend Ihres Blogs angezeigt und können
dort beliebige Inhalte darstellen oder einbinden. Im Gegensatz zu Ereignis"=Plugins
kann ein Seitenleisten-Plugin ausschließlich Ausgaben in der Seitenleiste vornehmen
und keine weitere Kernfunktionalität zur Verfügung stellen.
Die folgenden Seitenleisten-Plugins werden bei Serendipity mitgeliefert und sind
standardmäßig aktiviert. Einige besitzen keine eigene
Plugin-Datei im Unterverzeichnis \cmd{plugins}, sondern sind aus Performancegründen
in \cmd{include/plugin\_internal.inc.php} zusammengefasst.
\index{Plugins!Kalender}%
\index{Plugins!serendipity\_calendar\_plugin}%
\subsection{Kalender\newline serendipity\_calendar\_plugin}
Der Kalender zeigt einen blätterbaren Kalender eines Monats in der
Seitenleiste an. Einzelne Tage des Kalenders können dabei hervorgehoben
werden und zeigen dem Besucher an, dass an diesem Tag ein Blog-Artikel
verfasst wurde. Der aktuelle Tag wird ebenfalls hervorgehoben.
In den Konfigurationsoptionen können Sie den Tag des Wochenanfangs
festlegen und die Anzeige von Artikeln zu einem Tag auf eine spezielle
Kategorie beschränken.
Die Option \menu{Plugin-Schnittstelle aktivieren} können Sie aktivieren,
wenn Sie anderen Plugins erlauben wollen, Tage im Kalender
hervorzuheben. Das Plugin \emph{Mein Kalender} kann diese Option
beispielsweise benutzen, um Ihre persönlichen Termine anzufügen.
Zuletzt können Sie einstellen, welche Kategorie als Ausgangspunkt
der im Kalender angezeigten Blog-Artikel verwendet wird. Standardmäßig werden
alle Kategorien dafür benutzt, Sie können aber auch eine spezielle Kategorie
auswählen. Wenn der Besucher die Blog-Artikel selbständig auf eine
spezielle Kategorie eingrenzt und das Plugin als Ausgangspunkt \menu{Alle
Kategorien} verwendet, so wird automatisch die aktuelle Kategorie als
Datenquelle zur Kalenderdarstellung eingesetzt.
Die Darstellung erfolgt mittels der Template-Datei
\index{Template-Dateien!plugin\_calendar.tpl}%
\cmd{plugin\_calendar.tpl}, deren
Variablen auf Seite \pageref{plugin-calendar-tpl} erklärt werden.
\label{quicksearch}%
\index{Plugins!Suche}%
\index{Plugins!serendipity\_quicksearch\_plugin}%
\subsection{Suche\newline serendipity\_quicksearch\_plugin}
Das Plugin \emph{Suche} ist ein simples Seitenleisten-Plugin, das eine
Sucheingabe-Box anzeigt. Dort können Besucher Suchwörter eintragen, um
Artikel zu durchsuchen. Weitere Hinweise zur Volltextsuche finden Sie auf
Seite \pageref{Suche}.
Dieses Plugin bietet keine Konfigurationsmöglichkeiten an.
\index{Plugins!Archive}%
\index{Plugins!serendipity\_archives\_plugin}%
\subsection{Archive\newline serendipity\_archives\_plugin}
Das Plugin \emph{Archive} zeigt eine Übersicht der letzten Monate an. Ein
Klick auf den jeweiligen Monat öffnet die Artikelübersicht für den
gewünschten Zeitraum.
In der Konfiguration des Plugins können Sie neben der Überschrift des
Plugins auch angeben, ob das Plugin Monate, Wochen oder Tage gliedern
soll. Die \menu{Anzahl der Einträge im Archiv} gibt an, wie viele Ausgaben
im Plugin erfolgen sollen.
Wenn Sie die Option \menu{Anzahl der Einträge pro Kategorie anzeigen}
aktivieren, wird hinter jeder Ausgabe des Plugins in der Seitenleiste die
Anzahl von Einträgen eingeblendet, die Sie in diesem Zeitraum erstellt
haben. Achten Sie beim Aktivieren dieser Option darauf, dass diese die
Geschwindigkeit des Plugins stark verringert. Das Auslesen der Anzahl
aller Artikel pro Zeitraum ist eine komplexe Datenbankabfrage.
Wenn Sie die Option \menu{Hide archives link when no entries were made in that
timespan (requires counting entries)} aktivieren, können in der Ausgabe der
Monatsarchive diejenigen Monate übergangen werden, in denen Sie keine
Blog-Artikel geschrieben haben. Damit dies klappt, müssen Sie die Option
\menu{Anzahl der Einträge pro Kategorie anzeigen} ebenfalls aktivieren.
\index{Plugins!Kategorien}%
\index{Plugins!serendipity\_categories\_plugin}%
\label{categoriesplugin}%
\subsection{Kategorien\newline serendipity\_categories\_plugin}
Dieses Plugin blendet die im Blog verfügbaren Kategorien ein. Wenn Sie
Ihr Blog als eine Art CMS betreiben, wird dieses Seitenleisten-Plugin daher
oft als Menü benutzt, um auf die jeweiligen Unterbereiche zu gelangen.
Ein Klick auf die im Plugin dargestellte Kategorie ruft dabei jeweils die
Artikelübersicht dieser Kategorie auf.
Konfigurationsoptionen sind:
\begin{ospdescription}
\ospitem{\menu{Quelle der Kategorien}}
Wie im Kapitel \ref{kategorie-leserechte} auf Seite
\pageref{kategorie-leserechte} erwähnt, können für Kategorien besondere
Leserechte gelten, so dass nur eingeloggte Mitglieder einer Benutzergruppe
Einträge dieser Kategorie lesen können.
Standardmäßig stellt das Kategorien-Plugin alle Kategorien dar, die im
Blog angelegt sind -- ganz gleich, ob dafür besondere Leserechte gelten,
oder nicht. Wenn ein Besucher auf eine solche Kategorie klickt, kann es
daher sein, dass er darin keine Artikel angezeigt bekommt. Deshalb ist es
möglicherweise wünschenswert, wenn einem Leser auch nur die Kategorien
angezeigt werden, zu denen er auch Leserechte besitzt.
Dafür ist das Auswahlfeld \menu{Quelle der Kategorien} vorgesehen. Dort
wählen Sie eine Benutzergruppe aus, so dass nur Kategorien angezeigt
werden, die für die gewählte Benutzergruppe sichtbar sind. Standardmäßig
steht diese Option auf \menu{Alle Autoren}. Sie müssen die Sonderoption
\menu{Derzeitiger Autor} wählen, wenn die Kategorieliste sich nach den
Rechten des aktuell eingeloggten Besuchers richten soll.
\ospitem{\menu{Zeige nur Kategorien unterhalb\ldots}}
Da Kategorien in Serendipity schachtelbar sind, kann es recht komplexe
Kategorie- bzw. Menüstrukturen abbilden. Möglicherweise soll in der
Seitenleiste aber nur ein Teil dieser Struktur angezeigt werden. Daher
können Sie im Auswahlfeld \menu{Zeige nur Kategorien unterhalb\ldots}
festlegen, ab welcher Oberkategorie die Unterrubriken angezeigt werden.
\osppagebreak
\ospitem{\menu{Die gewählte Oberkategorie verstecken}}
Wenn Sie im obigen Konfigurationsfeld eine Kategorie ausgewählt haben,
bestimmt die Option \menu{Die gewählte Oberkategorie verstecken}, ob der
Name dieser Oberkategorie angezeigt (\menu{Nein}) oder versteckt
(\menu{Ja}) wird.
\ospitem{\menu{XML-Button}}
Für die Artikel jeder einzelnen Kategorie kann ein RSS-Feed abonniert
werden. Dazu wird neben jedem Kategorienamen ein kleines Bild
eingeblendet, auf das ein Benutzer klicken kann, um den RSS-Feed der
Kategorie zu abonnieren.
Dieses Bild stellt üblicherweise ein universelles RSS-Icon dar, das von
zahlreichen Blogsystemen und Browsern einheitlich benutzt wird. Sie
können aber gerne in dem Konfigurationsfeld \menu{XML-Button} ein
abweichendes Bild eintragen. Dazu müssen Sie den vollständigen HTTP-Pfad
(alles hinter \cmd{http://www.example.com/}) eingeben.
Wenn Sie kein Bild einbinden wollen, tragen Sie hier \cmd{none} ein.
\index{Sortierung!Kategorien}%
\ospitem{\menu{Sortierung}}
Zwei Auswahlfelder untereinander werden bei der Konfigurationsoption
\menu{Sortierung} dargestellt. Das obere Auswahlfeld bestimmt, nach
welchem Kriterium die Liste der Kategorien sortiert werden soll.
Da Kategorien innerhalb Serendipity noch nicht beliebig sortiert werden
können, entscheidet also ausschließlich diese Sortierungsreihenfolge die
Reihenfolge der Darstellung in der Seitenleiste. Standardmäßig werden die
Kategorien nach dem Namen der Kategorie alphabetisch sortiert. Weitere
Möglichkeiten sind eine Sortierung nach Beschreibung oder der ID einer
Kategorie. Auch kann eine Sortierung nach \emph{keinem} Kriterium
ausgewählt werden, in diesem Fall werden die Kategorien nach
Erstellungszeit in der Datenbank sortiert.
Das zweite Auswahlfeld gibt dabei an, ob die Kategorien absteigend (also
von A bis Z oder 0 bis 9) oder aufsteigend (von Z bis A bzw. 9 bis 0)
sortiert werden sollen.
Wenn Sie eine ganz individuelle Auflistung von Kategorien haben möchten,
gibt es zwei Möglichkeiten. Die erste Möglichkeit wäre, einfach eine
manuelle HTML-Liste der Kategorien zu erstellen und als \emph{HTML-Klotz
Seitenleisten-Plugin} (Seite \pageref{htmlnugget}) einzufügen. Dadurch
verlieren Sie natürlich die anderen dynamischen Möglichkeiten des Plugins.
Die zweite Möglichkeit wäre, das Feld \menu{Beschreibung} einer
Kategorie zu missbrauchen, indem Sie nicht einen Text, sondern eine Zahl darin
aufschreiben. Durch die Eingabe einer Zahl für die Reihenfolge der
Kategorien können Sie in der Sortierung die Reihenfolge beeinflussen. Das
bedeutet jedoch auch, dass Sie dann keine normale textliche Beschreibung
der Kategorie mehr nutzen können. Da diese Beschreibung sonst aber nur
für Redakteure gilt, ist dies möglicherweise zu verkraften.
\index{Mehrere Kategorien!darstellen}%
\ospitem{\menu{Besuchern erlauben, mehrere Kategorien gleichzeitig
darzustellen?}}
Wenn ein Besucher in der Darstellung des Plugins auf eine einzelne
Kategorie klickt, sieht er alle Einträge dieser Kategorie. In manchen
Fällen möchte ein Besucher aber gerne Inhalte mehrerer Kategorien auf
einmal ansehen.
Wenn Sie die Option \menu{Besuchern erlauben, mehrere Kategorien
gleichzeitig darzustellen} aktivieren, wird neben jeder Kategorie ein
Ankreuzfeld angezeigt. Der Besucher kann alle gewünschten Kategorien
markieren und danach auf den Button \menu{Los} klicken, um die Auswahl zu
setzen.
Ist die Option deaktiviert, wird diese Auswahlbox nicht mehr angezeigt. Dennoch
kann ein Besucher spezielle URLs aufrufen, in denen er mehrere Kategorien auf
einmal ansehen kann (siehe Seite \pageref{Permalinks-Kategorien}). Die
Deaktivierung der Option nimmt dem Benutzer also höchstens die komfortable
Möglichkeit zu einer solchen Übersicht und beeinflusst die Darstellungsweise des
Plugins.
\ospitem{\menu{Kategorien verstecken, die nicht Teil des vom Besucher gewählten}}
\ospadditem{\menu{Kategoriebaums sind}}
Wenn Sie eine verschachtelte Kategoriestruktur eingerichtet haben, stellt
diese eine Baumstruktur dar. Dabei sind jeweils einer Oberkategorie eine
oder mehrere Unterkategorien zugeordnet.
Wenn Sie Serendipity als eine Art CMS einsetzen, bei dem die Kategorien
Menüpunkten entsprechen, wünschen Sie sich möglicherweise, dass bei einem
Klick auf eine Unterkategorie die anderen "`parallelen"' Menüpunkte nicht
mehr angezeigt werden.
Stellen Sie sich folgenden Kategorienbaum vor: Oberkategorien A, B und C.
Jede Kategorie besitzt zwei Unterkategorien: A1 und A2, B1 und B2 sowie
C1 und C2. Wenn der Besucher nun auf die Unterkategorie A1 klickt, würden
Sie gerne nur die Kategorien A und A2 anzeigen. Die Kategorien und
Unterkategorien von B und C sollen verschwinden. Genau zu diesem Zweck
dient die Option \menu{Kategorien verstecken\ldots} Wenn diese Option
aktiviert ist, werden die nicht zum gewählten Kategoriebaum passenden
restlichen Kategorien nicht mehr in der Ausgabe des Plugins angezeigt.
Sie müssten dann zuerst wieder auf die Startseite zurück (oder auf andere
Menüpunkte klicken), um die ausgeblendeten Kategorien wieder zu sehen.
\ospitem{\menu{Anzahl der Einträge pro Kategorie anzeigen}}
Wenn Sie möchten, dass die Anzahl der Artikel in einer Kategorie in der
Ausgabe des Plugins neben dem Kategorienamen angezeigt wird, können Sie
die Option \menu{Anzahl der Einträge pro Kategorie anzeigen} aktivieren.
\index{Performance}%
Beachten Sie auch hier, dass die Aktivierung die Geschwindigkeit des
Plugins stark beeinflusst, da das Zählen aller Artikel der Datenbank
einige Zeit beansprucht.
Wenn Sie Einträge zu mehr als einer Kategorie zuweisen, wird dieses
Plugin (leider) für jede zugewiesene Kategorie den Artikel erneut zählen.
Daher kann es passieren, dass die angezeigte Artikelzahl höher ist als
die in Wirklichkeit vorhandenen Artikel.
\ospitem{\menu{Smarty-Templating aktivieren}}
Damit Sie dieses Plugin möglichst komfortabel anpassen können, gibt es
die Template-Datei
\index{Template-Dateien!plugin\_categories.tpl}%
\cmd{plugin\_categories.tpl}. Nur wenige Seitenleisten"=Plugins verfügen
über ein eigenes Smarty-Template, da meistens Änderungen per CSS bereits
vollkommen ausreichen. Aus Performancegründen wird diese Template-Datei
daher auch standardmäßig nicht benutzt. Wenn Sie also ein eigenes Template
für das Aussehen der Kategorie-Auflistung benutzen wollen, müssen Sie die
Konfigurationsoption \menu{Smarty-Templating aktivieren} auf \cmd{Ja} setzen.
Die eingesetzten Variablen dieser Datei werden auf Seite
\pageref{plugin-categories-tpl} erklärt.
\end{ospdescription}
\index{Plugins!Blog abonnieren}%
\index{Plugins!serendipity\_syndication\_plugin}%
\label{syndication}%
\subsection{Blog abonnieren\newline serendipity\_syndication\_plugin}
Das Plugin stellt die verschiedenen Optionen zum Abonnieren Ihres
Blogs mittels RSS-Feed dar. Dabei wird in der Seitenleiste für jedes
gewünschte Format ein Link eingebunden, den Ihre Besucher in ihr
RSS-Programm übernehmen können.
Neben dem Titel des Plugins in der Seitenleiste sowie der Aktivierung der
zahlreichen Feed-Formate bietet das Plugin folgende
Konfigurationsoptionen:
\begin{ospdescription}
\index{FullFeed}%
\label{syndication-fullfeed}%
\index{Vollständige RSS-Feeds}%
\ospitem{\menu{Volle Einträge mit erweitertem Text im RSS-Feed einbinden}}
Ein RSS-Feed enthält üblicherweise nur den Text eines Artikels, den Sie
im Feld \emph{Eintrag} erfasst haben. Der \emph{Erweiterte Eintrag} ist
nicht Bestandteil der RSS-Feeds, und somit muss ein Benutzer Ihr Blog
besuchen, um den vollständigen Artikel lesen zu können. Dies ist häufig
gewünscht, um mehr Besucher auf die Webseite zu "`locken"'. Um Ihren
Besuchern mehr Komfort zu bieten, können Sie aber auch den vollständigen
Artikel im RSS-Feed eintragen.
Mit dieser Konfigurationsoption können Sie dieses Verhalten beeinflussen.
Wenn Sie die Option \menu{Client} aktivieren, kann, wie im Abschnitt
\ref{FullFeed} auf Seite \pageref{FullFeed} erwähnt, der Leser selbst
bestimmen, ob er einen vollständigen RSS-Feed haben will oder nicht. Dazu
muss er Ihren RSS-Feed über die Datei \cmd{rss.php?fullFeed=true}
abonnieren. Dies ist natürlich relativ versteckt, so dass Sie Ihre Besucher
über diese mögliche Variante informieren müssten.
\label{syndication-feedburner}%
\index{FeedBurner}%
\ospitem{\menu{FeedBurner Feed}}
Der Webservice \cmd{http://www.feedburner.com/} ist ein Angebot von
Google, das Statistiken über die Auslieferung Ihres
RSS-Feeds und einige weitere Möglichkeiten
der Einbettung bietet. Bei einem Feed\-Bur\-ner-Feed kann der Aufruf des
RSS-Feeds im Browser direkt hübsch formatiert sein, statt
als für den Besucher merkwürdiger XML"=Datensatz zu erscheinen. FeedBurner
ermöglicht auch die Einbindung von Werbung und verwandten Tags.
Bei FeedBurner müssen Sie sich separat anmelden und dem Service die URL
Ihres RSS-Feeds mitteilen. FeedBurner wird dann regelmäßig diese URL
aufrufen, Ihren RSS-Feed einlesen, ihn konvertieren und danach unter
einer eigenen FeedBurner-URL (die Sie konfigurieren können) anbieten.
Damit die Statistikzählung aktiviert wird, müssen Ihre Besucher künftig
diesen FeedBurner-Feed abonnieren und nicht den üblichen
Serendipity"=Feed. Dazu dient die Einstellung \menu{Feedburner Feed} im
Plugin. Wenn diese Variable auf \menu{Ja} steht, wird der Link zum
Feedburner-Feed in Ihrer Seitenleiste angezeigt. In diesem Fall sollten
Sie alle anderen Feed-Formate deaktivieren, da die Besucher ja nur noch
den FeedBurner-Feed aufrufen sollen.
Wenn Sie die FeedBurner-Option lediglich auf \menu{Ja} gestellt haben,
bleiben die URLs zu Ihren alten RSS-Feeds weiterhin intakt, sie werden
lediglich versteckt. Wenn Sie Ihre Besucher aber in Zukunft auch von
diesen verstecken URLs fernhalten wollen, stellen Sie die
FeedBurner-Option auf \menu{Erzwingen}. Dadurch wird jeder Aufruf des
Serendipity-RSS-Feeds automatisch auf die FeedBurner-Feeds umgeleitet.
Zu welchem FeedBurner-Feed Serendipity verweist, stellen Sie am Ende der
Konfigurationsoptionen ein.
\ospitem{\menu{E-Mail-Adresse einbinden?}}
Standardmäßig muss ein RSS-Feed zu jedem Autor eine E-Mail"=Adresse
anzeigen. Dies wird leider gegenwärtig häufig von SPAM-Robotern
missbraucht, um E-Mail-Adressen im Internet zu sammeln. Daher können Sie
über die Option \menu{E-Mail-Adresse einbinden} einstellen, ob Ihre
echte E-Mail-Adresse oder eine vorgetäuschte E-Mail-Adresse (\cmd{[email protected]})
eingebunden wird.
Beachten Sie, dass, wenn Sie im Anti-Spam-Plugin (Seite \pageref{spamblock})
die gleichnamige Option aktiviert haben, diese ebenfalls die Darstellung der
E-Mail-Adressen beeinflusst.
In abgegrenzten Blogs (im Intranet zum Beispiel) macht die Aktivierung
dieser Option noch Sinn, beim Einsatz im Internet ist es jedoch
empfehlenswert, die Option auf \menu{Nein} zu setzen.
\ospitem{\menu{Feld "`managingEditor"'}}
Der RSS 2.0-Feed ermöglicht die Einbindung eines optionalen Feldes, das
die E-Mail-Adresse des leitenden Redakteurs eines Blogs enthalten kann.
Abonnenten des RSS-Feeds können sich so leicht an den inhaltlich
Verantwortlichen wenden. Auch hier gelten die obigen Bedenken,
dass enthaltene E-Mail-Adressen oft Spammern zum Opfer fallen könnten.
\ospitem{\menu{Feld "`webMaster"'}}
Analog zu einem inhaltlich Verantwortlichen kann diese Option eine
E-Mail-Adresse des technisch Verantwortlichen enthalten.
\ospitem{\menu{Feld "`ttl"' (time-to-live)}}
RSS-Feeds müssen von RSS-Readern regelmäßig abgerufen werden, damit neue
Artikel gefunden werden können. Üblicherweise wird ein solcher RSS-Reader
alle 30 oder 60 Minuten (je nach Einstellung Ihrer Besucher) Ihre
RSS-Feeds abrufen. Sie können über das Feld \menu{ttl} (\emph{Gültigkeitsdauer}) innerhalb des RSS-Feeds für RSS-Reader vorschlagen,
wie lange Ihr Feed üblicherweise gültig ist. Diesen eingestellten Wert
können RSS-Programme dann als Richtlinie für die
Aktualisierungshäufigkeit benutzen.
\index{Traffic}%
Der \menu{ttl}-Wert wird in Minuten angegeben, wenn Sie also
üblicherweise nur einen Artikel pro Tag online stellen, können Sie ihn auf 1440
stellen (entspricht 24 Stunden). Damit können Sie dann möglicherweise einiges an
Traffic auf Ihrem Webserver sparen, wenn sich die RSS-Reader daran
halten.
\ospitem{\menu{Feld "`pubDate"'}}
Ein RSS-Feed kann ein optionales \menu{pubDate}-Feld enthalten, das
Auskunft über den Erstellungszeitpunkt des letzten Artikels gibt. Dieser
Wert wird von vielen RSS-Readern benutzt, um Aktualisierungen
festzustellen, daher raten wir von der Deaktivierung dieser Option ab.
\ospitem{\menu{XML-Button}}
Neben jedem RSS-Feed wird in der Seitenleiste eine kleine Grafik
angezeigt, die standardmäßig dem Standardsymbol für RSS-Feeds
entspricht. Wenn Sie eine eigene Grafik benutzen wollen, können Sie den
Pfad zu der Grafik in dem Feld \menu{XML-Button} eintragen. Die Grafik
muss sich dabei in Ihrem Template-Verzeichnis befinden, und der hier
eingetragene Pfad muss relativ zu Ihrem Template-Verzeichnis sein. Wenn
die Datei also in
\cmd{/var/www/example.com/serendipity/""templates/meinTemplate/bilder/MeinRSS.gif}
liegt, tragen Sie\osplinebreak{} im Konfigurationsfeld \cmd{bilder/MeinRSS.gif} ein.
\ospitem{\menu{Bild für den RSS-Feed}}
Das RSS 2.0-Format ermöglicht es, ein eigenes Logo für den Feed
einzutragen. Diese Grafik kann dann von RSS-Readern in der Titelzeile
oder an anderen Stellen angezeigt werden. Wenn Sie hier nichts eintragen,
wird standardmäßig das Serendipity-Logo eingebunden.
Tragen Sie in diesem Feld die vollständige URL zu einem Bild ein, also
etwa \cmd{http://www.example.com/MeinLogo.jpg}. Diese Grafikdatei darf
maximal 144 Pixel breit und 400 Pixel hoch sein. Die genauen
Maße
des Bildes müssen Sie in den beiden darunterliegenden Feldern
\menu{Breite des Bildes} und \menu{Höhe des Bildes} eintragen.
\ospitem{\menu{FeedBurner-ID, Titel, Bildunterschrift und Bild}}
Die letzten vier Konfigurationsoptionen betreffen Sie nur, wenn Sie den
oben erwähnten FeedBurner-Service benutzen. Als \menu{ID} müssen Sie die
im FeedBurner dargestellte ID Ihres Feeds eintragen, sie entspricht dem
Namen, den Sie in der URL \cmd{http://feeds.feedburner.""com/\cmdvar{ID}}
sehen.
Wenn Sie den Feedburner-Feed aktiviert haben, wird ein Link dorthin im
Seitenleisten-Plugin angezeigt. Dieser Link wird begleitet von einem Bild
und einem Linktitel. Im Feld \menu{FeedBurner Titel} können Sie
diesen Titel vergeben, der neben der Grafik dargestellt wird. Die Grafikdatei
müssen Sie mit einer vollständigen URL wie
\cmd{http://www.ex\-ample.com/feedburner.jpg} eintragen. Wenn Sie dieses
Feld leer lassen, sehen Sie eine Standardgrafik, die den Besucherzähler
darstellt. Im Feld \menu{FeedBurner Bild-Unterschrift} können Sie einen
Text hinterlegen, der angezeigt wird, wenn Sie mit der Maus über die
Feed\-Burner-Grafik fahren. Dort können Sie beispielsweise eine kurze
Beschreibung eintragen, warum Sie FeedBurner benutzen.
\end{ospdescription}
\index{Plugins!Verwaltung des Blogs}%
\index{Plugins!serendipity\_superuser\_plugin}%
\subsection{Verwaltung des Blogs\newline serendipity\_superuser\_plugin}
Mit dem Plugin \emph{Verwaltung des Blogs} binden Sie einen einfachen
Link im Frontend ein, auf den Sie als Redakteur klicken können, um ins
Backend zu gelangen. Das Plugin erkennt dabei automatisch, ob Sie schon
eingeloggt sind, und gibt dementsprechend entweder einen Link zum Login oder direkt
zum Backend aus.
\index{HTTPS}%
Die einzige Konfigurationsoption des Plugins gibt an, ob Sie
das \menu{HTTPS} zum Login benutzen möchten. Ihr Server muss HTTPS (siehe
Terminologie auf Seite \pageref{https}) unterstützen und ein gültiges Zertifikat
für den Server besitzen, auf dem Serendipity installiert ist. Nur bei der
Benutzung von HTTPS ist gewährleistet, dass Ihr Benutzername und Passwort
nicht im Klartext (sondern verschlüsselt) an den Server übertragen werden
und niemand Ihre Logindaten abfangen kann.
\index{Plugins!Powered by}%
\index{Plugins!serendipity\_plug\_plugin}%
\label{plugplugin}%
\subsection{Powered by\newline serendipity\_plug\_plugin}
Ein ebenfalls recht simples Plugin ist \emph{Powered by}. Es gibt das
Logo von Serendipity mit einem Link zur Webseite
\cmd{http://www.s9y.org/} aus und erlaubt es Ihren Besuchern, zu sehen,
welche großartige Software hinter Ihrem Blog steckt.
Die Konfigurationsoptionen des Plugins ermöglichen eine Feineinstellung,
ob man nur das Logo oder nur den Text anzeigen möchte.
\section{Weitere mitgelieferte Plugins}
Neben den standardmäßig aktivierten Plugins können Sie natürlich auch
weitere Seitenleisten-Plugins installieren. Es folgt eine Liste der
Seitenleisten"=Plugins, die bei Serendipity standardmäßig mitgeliefert
werden.
\subsection{Fremder RSS/OPML-Blogroll Feed\newline
serendipity\_plugin\_remoterss}
\index{Plugins!Fremder RSS/OPML-Blogroll Feed}%
\index{Plugins!serendipity\_plugin\_remoterss}%
\index{Syndication}%
\label{remoterss}%
Dieses leicht kryptisch klingende Plugin bietet eine recht einfache
Möglichkeit, die RSS-Feeds fremder Seiten einzubinden.
So können Sie in Ihrer Seitenleiste beispielsweise RSS-Feeds von
Newstickern einbinden oder auch die RSS-Feeds von diversen Webservices
wie del.icio.us oder last.fm einbinden, die Daten von diesem Webserver
anzeigen können.
Das Plugin lässt sich auch mehrfach installieren, so dass Sie beliebig
viele RSS-Feeds einbinden können.
\index{OPML}%
\index{Blogroll}%
Abgesehen von RSS-Feeds sind auch sogenannte OPML-Blogrolls möglich.
OPML-Dateien werden von vielen RSS-Readern erstellt und können Linklisten
enthalten, welche Blogs Sie lesen. Wenn diese OPML-Datei dann in Ihrer
Seitenleiste eingebunden wird, können Sie so relativ leicht automatisch
Ihre Lieblingsblogs auflisten.
Das RSS-Seitenleisten-Plugin agiert grundsätzlich wie ein eigenständiger
RSS-Reader: Ihr Blog wird in einem definierten Zeitraum die RSS-Feeds
selbständig abholen, einbinden und für einen gewissen Zeitraum
zwischenspeichern, um Bandbreite zu sparen. Damit das Plugin
funktionieren kann, gelten dieselben Rahmenbedingungen wie für Spartacus
(siehe Seite \pageref{Spartacus}): Ihr Server darf nicht von einer Firewall
für ausgehende Verbindungen blockiert werden.
Pro installiertem RSS-Feed-Plugin kann eine Vielzahl an Optionen
eingestellt werden:
\begin{ospdescription}
\ospitem{\menu{Feed-Titel}}
Im Feld \menu{Feed-Titel} stellen Sie ein, wie die Überschrift des
RSS-Feeds innerhalb der Seitenleiste lauten soll.
\ospitem{\menu{Typ des Feeds}}
In diesem Auswahlfeld legen Sie das Format des fremden Feeds fest. Sie
können zwischen RSS und OPML wählen, wobei für RSS-Feeds alle Versionen
von 0.91 bis 2.0 unterstützt werden, und von OPML die (einzig
existierende) Version 1.0.
\ospitem{\menu{RSS/OPML-URI}}
Die Quell-URL des RSS-Feeds (oder des OPML-Feeds) müssen Sie in das Feld
\menu{RSS-OPML-URI} eintragen. Geben Sie dort eine vollständige URL an,
also beispielsweise \cmd{http://www.example.com/serendipi\-ty/rss.php?version=2.0}.
\ospitem{\menu{RSS-Zielelement}}
In einem RSS-Feed stehen mehrere Felder zur Verfügung, die das
Seitenleisten-Plugin darstellen kann. Im Feld \cmd{title} wird
beispielsweise der Titel eingebunden, das Feld \cmd{content} enthält den
Artikelinhalt. Manchmal kann es jedoch sein, dass die Felder für den
Inhalt \cmd{content:encoded} oder \cmd{body} lauten.
Damit das Seitenleisten-Plugin flexibel eingesetzt werden kann, müssen Sie den
Namen des Feldes angeben, das Serendipity in der Seitenleiste darstellen
soll. Die Liste der verfügbaren Felder können Sie in der Spezifikation
des jeweiligen RSS-Formats nachlesen\footnote{\cmd{http://www.rssboard.org/rss-2-0} für RSS 2.0; weitere Links finden
Sie auf \cmd{http://de.wikipedia.org/wiki/RSS}}. Sie können beliebig
viele Feldinhalte anzeigen lassen, indem Sie mehrere Felder mittels
\cmd{,} voneinander trennen.
Damit nicht zu viel Platz verschwendet wird, gibt Serendipity
üblicherweise nur den Titel (\cmd{title}) eines RSS-Feeds an.
\ospitem{\menu{Smarty-Templating aktivieren}}
Die Darstellung des Feeds in der Seitenleiste kann über die
Smarty-Template-Datei
\index{Template-Dateien!plugin\_remoterss.tpl}%
\cmd{plugin\_remoterss.tpl} gesteuert werden, wenn die Option
\menu{Smarty-Templating aktivieren} gewählt wurde. Andernfalls
benutzt das Plugin für seine Ausgaben die integrierte HTML"=Darstellung.
Ein Beispiel für eine Template-Datei liegt im Verzeichnis
\cmd{plugins/""serendipity\_plugin\_remoterss/plugin\_remoterss.tpl}. Die\osplinebreak{} dort
verfügbaren Variablen sind auf Seite \pageref{plugin-remoterss.tpl}
dokumentiert.
Grundsätzlich sollten Sie die Templating-Option nur dann benutzen, wenn Sie an
der Standardausgabe Anpassungen vornehmen wollen, die Sie nicht bereits mittels
CSS-Anpassung oder Konfiguration des Plugins beeinflussen können.
\ospitem{\menu{Anzahl der Einträge}}
Standardmäßig zeigt das Seitenleisten-Plugin alle Einträge/Artikel eines
RSS-Feeds. Wenn Sie aber die Anzahl auf eine gewisse Zahl begrenzen
möchten, können Sie diese hier eintragen.
\ospitem{\menu{RSS-Link verwenden}}
Jeder Artikel eines RSS-Feeds besitzt üblicherweise einen Link, der zu
der Quellseite des Artikels im Original-Blog (oder Webservice) führt.
Falls die Option \menu{RSS-Link verwenden} aktiviert ist, wird dieser
Link in der Ausgabe des Plugins dargestellt.
\index{Sicherheit!fremde RSS-Feeds}%
\index{Sicherheit!XSS}%
\ospitem{\menu{HTML-Ausgabe escapen}}
Es ist möglich (und erlaubt), dass ein Artikel eines (fremden) RSS-Feeds
HTML-Code enthält. Dies ermöglicht z.\,B.\ Fettungen und eigene HTML-Links
in den dargestellten Artikeln.
Bei der Darstellung fremder RSS-Feeds könnte dies jedoch zu
Sicherheitsproblemen führen, denn immerhin kann so auch möglicherweise
bösartiges JavaScript in Ihrem Blog ausgeführt werden, das bei Ihren
Besuchern Logindaten oder anderes ausspäht (dies nennt man
\emph{XSS-Angriff}).
Bei RSS-Feeds, deren Quelle Sie nicht absolut vertrauen, sollten Sie die
Option \menu{HTML-Ausgabe escapen} unbedingt aktivieren. Wenn Sie jedoch
RSS-Feeds von vertrauenswürdigen Webservices einbinden (wie etwa Ihre
Bilderliste von Flickr), dann werden Sie diese Option deaktivieren
müssen, weil sonst keine Bilder angezeigt würden.
\ospitem{\menu{Display Date, Datumsformat}}
Jeder Artikel eines RSS-Feeds besitzt üblicherweise ein
Veröffentlichungsdatum. Wenn Sie dieses zusätzlich unterhalb des
RSS-Artikels anzeigen wollen, stellen Sie die Option \menu{Display Date}
auf \menu{Ja}.
Die Option \menu{Datumsformat} bezieht sich auf die Formatierung des
Veröffentlichungsdatums. Die Variablen, die Sie hier benutzen können,
sind auf \cmd{http://de3.php.net/strftime} zusammengefasst.
\osppagebreak
\ospitem{\menu{Zeichensatz}}
Jeder RSS-Feed enthält Artikel in einem speziellen Zeichensatz. Ein
Großteil der RSS-Feeds ist im \menu{UTF-8}-Zeichensatz verfasst, aber
einige Feeds (gerade deutsche) enthalten die Artikel im
\menu{ISO-8859-1}-Zeichensatz.
Damit Serendipity fremde Artikel später im Blog mit korrekten
Sonderzeichen darstellen kann, müssen Sie Serendipity über die Option
\menu{Zeichensatz} mitteilen, welchen Zeichensatz der RSS/OPML-Feed
benutzt. Sie können dies manuell relativ leicht herausfinden, indem Sie die fremde
URL aufrufen und in der XML-Ausgabe nach einer Angabe mit dem Titel
\menu{charset} in der ersten Zeile der Datei suchen.
Leider benutzt Serendipity eine ältere RSS-Bibliothek zum Einlesen der
RSS-Feeds, daher wird Ihnen diese Aufgabe derzeit noch nicht vom System
abgenommen.
\label{remoterss-linktarget}%
\ospitem{\menu{Link-Target}}
Wenn Sie bei einem Artikel Hyperlinks zulassen (Option \menu{RSS-Link
verwenden}), wird ein Link standardmäßig im selben Browser-Fenster wie
Ihr Blog geöffnet. Über das HTML-Attribut namens \cmd{target} kann man
jedoch auch ein neues Browser-Fenster öffnen, wenn man bei der Option
\menu{Link-Target} ein \cmd{\_blank} einträgt.
\index{Popups}%
Bitte beachten Sie, dass ein solches \cmd{target=\_blank} dazu
führt, dass ein Besucher einen Link nicht so einfach \emph{nicht} in einem neuen
Fenster öffnen kann und dass ihn dies möglicherweise stört. Neue
XHTML-Standards empfehlen daher, auf die Benutzung von \cmd{target} im
Optimalfall zu verzichten und dem Besucher die volle Kontrolle zu
überlassen, wie er einen Link in seinem Browser öffnen möchte.
\ospitem{\menu{Wann wird der Feed aktualisiert}}
Theoretisch würde bei jedem Besuch Ihres Blogs der fremde RSS-Feed neu
aufgerufen und angezeigt. Da dies viel Bandbreite und auch viel Zeit
kosten würde, speichert das Plugin die Ausgaben des fremden Feeds für
einen gewissen Zeitraum. Diesen Zeitraum können Sie über die
Option \menu{Wann wird der Feed aktualisiert} selber vorgeben, indem Sie
hier eine Dauer (in Sekunden) eintragen. Standardmäßig wird ein Feed für
drei Stunden gecached, bevor ein neuer Besucher Ihrer Webseite ihn neu
erzeugt.
Bei besonders häufig aktualisierenden RSS-Feeds können Sie dieses Limit
natürlich heruntersetzen.
\ospitem{\menu{Bullet Image}}
Falls Sie gerne die einzelnen Artikel eines fremden RSS-Feeds voneinander
trennen wollen, können Sie in dem Feld \menu{Bullet Image} eine beliebige
vollständige URL einer Grafikdatei eintragen. Diese Grafik wird dann nach
jedem Artikel angezeigt.
\ospitem{\menu{Textformatierung(en) durchführen}}
Wenn die Option \menu{Textformatierung(en) durchführen} aktiviert ist,
wird die Ausgabe des RSS-Feeds an alle bei Ihnen installierten
Textformatierungs"=Plugins weitergereicht (siehe Seite
\pageref{Textformatierungs-Plugins}). Diese können beliebige Umwandlungen
vornehmen, die dann auch die Darstellung des RSS-Feeds beeinflussen.
\end{ospdescription}
\label{ausgabewrapper}%
\index{Plugins!Event-Ausgabe Wrapper}%
\index{Plugins!serendipity\_plugin\_eventwrapper}%
\index{Plugins!Unterschied Seitenleisten- und Ereignis-Plugins}%
\subsection{Event-Ausgabe Wrapper\newline
serendipity\_plugin\_eventwrapper}
Das Plugin \menu{Event-Ausgabe Wrapper} ist ein recht spezielles Plugin,
da es die Grenze zwischen Seitenleisten-Plugin und Ereignis-Plugin etwas
aufweicht.
Eigentlich ist es ausschließlich Seitenleisten-Plugins möglich, eine
Ausgabe in der Seitenleiste vorzunehmen. Ereignis-Plugins können nur auf
andere Bereiche und Funktionalitäten Serendipitys Einfluss nehmen, was
wiederum Seitenleisten-Plugins nicht erlaubt ist.
\index{Plugins!gekoppelt}%
\index{Gekoppelte Plugins}%
Seltene Fälle von Ereignis-Plugins bieten jedoch auch
die Möglichkeit an, eine spezielle Ausgabe in der Seitenleiste vorzunehmen. Diese Möglichkeit
wurde eher in frühen Versionen Serendipitys benutzt (z.\,B.\ vom Plugin
"`Link List"' oder "`Worte ersetzen"'). Inzwischen nutzen fast alle
Plugins die einfachere Möglichkeit, ein zugehöriges Seitenleisten-Plugin
(siehe \ref{Gekoppelte Plugins} ab Seite \pageref{Gekoppelte Plugins}) zu
bestimmen und dieses konzeptionelle Problem für Sie als Benutzer
einfacher zu lösen.
Wenn dieses Ausgabe-Wrapper-Plugin von einem anderen benötigt wird, finden Sie
einen Hinweis dazu in dem jeweiligen Plugin.
In der Konfiguration dieses Plugins können Sie das
\menu{Quell-Ereignis-Plugin}, das eingebunden werden soll, über ein
Auswahlfeld bestimmen. Den Titel des Plugins in der Seitenleiste können
Sie ebenfalls in einem Eingabefeld eintragen.
Wenn Sie im Frontend keine Ausgaben zu dem gewählten Ereignis-Plugin
auffinden, bedeutet das lediglich, dass das gewählte Plugin keine
Ausgaben anbietet. Sie können also z.\,B.\ zwar das Plugin
\emph{Textformatierung: Smilies} auswählen, da dieses aber den
\emph{Event-Ausgabe Wrapper} nicht unterstützt, werden Sie keine Ausgabe
sehen.
Für Techniker ist erwähnenswert, dass alles, was dieses Plugin tut, darin
besteht, die \cmd{generate\_content()}-Methode eines Ereignis-Plugins
aufzurufen und die Ausgaben dieser Funktion an die für
Seitenleisten-Plugins übliche (gleichbenannte) Methode
\cmd{generate\_content()} weiterzureichen. Aus Performance-Gründen (und
Separierungsgründen) gibt es keinen Event-Hook, um ein
Seitenleisten-Plugin zu \emph{emulieren}.
\index{Plugins!aktuelle Einträge}%
\index{Plugins!serendipity\_plugin\_recententries}%
\label{serendipity-plugin-recententries}%
\subsection{Aktuelle Einträge\newline
serendipity\_plugin\_recententries}
Das Plugin \emph{Aktuelle Einträge} zeigt in der Seitenleiste eine kurze
Übersicht der neuesten Artikel in Ihrem Blog an. Dies ermöglicht eine
konzentrierte Übersicht der Artikel an zentraler Stelle, die ein Besucher
auch dann sieht, wenn er gerade die Detailseite eines Artikels anschaut.
Neben dem üblichen Seitenleisten-Titel und der Anzahl
an Artikeln, die eingebettet werden sollen, bietet das Plugin folgende besonderen
Optionen:
\begin{ospdescription}
\ospitem{\menu{Angezeigte Einträge überspringen}}
Wenn Sie die Option \menu{Angezeigte Einträge überspringen} auf
\menu{Alle Anzeigen} stellen, zeigt die Seitenleiste stets die letzten
aktuellen Einträge. Dies kann jedoch zu einer Dopplung führen, da Sie ja
auf der Startseite des Frontends bereits die letzten 15 Artikel anzeigen.
Wenn Sie also nur die aktuellsten Artikel anzeigen wollen und dabei die
auf der Startseite bereits angezeigten Einträge überspringen wollen,
wählen Sie die Option \menu{Einträge auf der Hauptseite überspringen}.
\ospitem{\menu{Datumsformat}}
Zu jedem Artikel wird das Erstellungsdatum angezeigt. Wie dieses
formatiert wird, tragen Sie im Feld \menu{Datumsformat} ein. Die zur
Verfügung stehenden Variablen finden Sie auf
\cmd{http://de3.php.net/strftime}.
\ospitem{\menu{Kategorie}}
Standardmäßig zeigt das Plugin die Artikel aller Kategorien chronologisch
sortiert an. Wenn Sie jedoch in der Seitenleiste nur die letzten Einträge
in einer speziellen Kategorie darstellen wollen, können Sie diese
spezielle Kategorie in dem Mehrfach-Auswahlfeld angeben. Mehrere
Kategorien können Sie hier auch wählen, indem Sie mit gedrückter
\taste{Strg/Apfel}-Taste auf die Kategorien klicken.
Die Sonderoption \menu{Übergeordnete Kategorie} bedeutet, dass als Quelle für
die Liste der aktuellen Einträge die Kategorie verwendet wird, die der Besucher
im Blog gerade aufgerufen hat.
\ospitem{\menu{Show Random Articles}}
Wenn Sie eine zufällige Auswahl von Artikeln darstellen wollen, können Sie
die Option \menu{Show Random Articles} aktivieren. Bei jedem Seitenaufruf
werden dann zufällig andere Artikel in der Seitenleiste angezeigt.
\end{ospdescription}
\index{Plugins!Autoren}%
\index{Plugins!serendipity\_authors\_plugin}%
\subsection{Autoren\newline serendipity\_authors\_plugin}
Das Plugin \emph{Autoren} stellt in der Seitenleiste eine Liste aller im
Blog eingetragenen Redakteure dar. Ein Klick auf einen Autor führt dann
zu der Übersicht der von ihm geschriebenen Artikel.
Die Konfigurationsoptionen des Plugins sind:
\begin{ospdescription}
\ospitem{\menu{XML-Button}}
Für jeden Autor steht ein eigener RSS-Feed-Link zur Verfügung, über den
Einträge dieses Autors abonniert werden können. Die Grafik muss sich
dabei in Ihrem Template-Verzeichnis befinden, und der hier eingetragene
Pfad muss relativ zu Ihrem Template-Verzeichnis sein.\osplinebreak{} Wenn die Datei also
in \cmd{/var/www/example.com/serendipity/tem\-plates/meinTemplate/bilder/MeinRSS.gif}
liegt, tragen Sie im\osplinebreak{} Konfigurationsfeld \cmd{bilder/MeinRSS.gif} ein.
\ospitem{\menu{Ermöglicht Besuchern, Einträge mehrerer Autoren gleichzeitig
darzustellen}}
Ähnlich wie bei der Liste aller Kategorien, kann in der Liste aller
Autoren vom Besucher eine Auswahl getroffen werden, welche Artikel er
dargestellt sehen will. Üblicherweise kann er mit dem Klick auf den Link
eines Redakteurs nur die Einträge eines einzelnen Redakteurs sehen.
Ist die Option \menu{Ermöglicht Besuchern, Einträge mehrerer Autoren
gleichzeitig darzustellen} aktiviert, wird neben jedem Redakteur ein
Ankreuzfeld angezeigt, das der Besucher für alle gewünschten Redakteure
markieren kann, um so die Übersicht der Artikel dieser Redakteursgruppe
lesen zu können.
\ospitem{\menu{Anzahl der Artikel neben dem Autor-Namen anzeigen}}
Wenn Sie diese Option aktivieren, wird in Klammern hinter dem
Redakteursnamen die Anzahl der von ihm verfassten Artikel angezeigt.
Bitte beachten Sie, dass die Aktivierung dieser Zählung relativ
datenbankintensive Abfragen durchführen muss und daher möglicherweise zu
Geschwindigkeitseinbußen führen kann.
\ospitem{\menu{Nur Autoren mit mindestens X Beiträgen anzeigen}}
Möglicherweise möchten Sie nur aktive Redakteure des Blogs aufführen.
Daher können Sie in dem Eingabefeld eine Mindestzahl an Beiträgen eintragen, die ein
Redakteur geschrieben haben muss, um in der Seitenleiste angezeigt zu
werden. Für diese Option gelten dieselben Performance-Bedenken wie bei
der vorherigen. Sollten Sie eine von beiden aktivieren, wird die
Aktivierung der anderen Option jedoch darüber hinaus keine
weiteren Einbußen zur Folge haben.
\end{ospdescription}
\subsection{HTML-Klotz\newline serendipity\_html\_nugget\_plugin}
\index{HTMLKlotz@HTML-Klotz}%
\index{Plugins!HTML-Klotz}%
\index{Plugins!serendipity\_html\_nugget\_plugin}%
\label{htmlnugget}%
Das Plugin namens \emph{HTML-Klotz} ist wohl das meistunterschätzte
Plugin -- sobald man es einmal einzusetzen weiß, ist es aus einem
Blog nicht mehr wegzudenken. Denn mit diesem Plugin können Sie
beliebiges HTML und beliebiges JavaScript in Ihre Seitenleiste einfügen.
Dieses Plugin lässt sich beliebig oft installieren und kann daher
flexibel positioniert werden. Der Einsatz eines HTML-Klotzes macht zudem
Dateiänderungen auf dem Server unnötig, denn alles kann über die
Plugin-Verwaltung eingestellt werden.
Pro HTML-Klotz gelten folgende Konfigurationsoptionen:
\begin{ospdescription}
\ospitem{\menu{Titel}}
Die Überschrift des HTML-Klotzes, die in der Seitenleiste angezeigt wird.
Wenn Sie den Titel leer lassen, wird kein Titel angezeigt. Dies ist
besonders dann hilfreich, wenn Sie ein JavaScript einfügen wollen, das
keine Ausgabe besitzt und sonst nur zur Anzeige eines leeren Klotzes
führen würde.
Der Titel eines Plugins wird zusätzlich in der Plugin-Verwaltung mit
ausgegeben, damit Sie mehrere HTML-Klötze voneinander unterscheiden
können.
\ospitem{\menu{Zusätzlicher Informationstext, der auf der Plugin-Oberfläche}}
\ospadditem{\menu{dargestellt wird}}
In diesem Eingabefeld können Sie eine kleine Beschreibung angeben, die in
der Plugin-Verwaltung neben jedem HTML-Klotz angezeigt wird. Dies ist
besonders hilfreich in Fällen, bei denen ein HTML-Klotz ohne Titel
angelegt wurde.
\index{JavaScript!in der Seitenleiste}%
\index{HTML!in der Seitenleiste}%
\ospitem{\menu{Inhalt}}
In diesem großen Eingabefeld tragen Sie den HTML-Code oder das JavaScript
ein, das Sie in der Seitenleiste darstellen wollen. Wenn Sie den
WYSIWYG-Editor in den \menu{Eigenen Einstellungen} aktiviert haben, wird
hier die vom Eintrags-Editor bekannte Oberfläche angezeigt.
Beachten Sie, dass der WYSIWYG-Editor intern bereits HTML-Code speichert.
Würden Sie in ein WYSIWYG-Editor-Fenster HTML-Code eintragen, würde dies
später im Frontend "`gedoppelt"' angezeigt werden. Für eigenes HTML oder
JavaScript gilt daher, entweder den WY\-SIWYG-Editor vorübergehend zu
deaktivieren oder im Quelltext"=Modus des Editors zu arbeiten.
\index{Fehler!falsche Darstellung in HTML-Klötzen}%
\ospitem{\menu{Textformatierung(en) durchführen}}
Die Ausgabe des Seitenleisten-Plugins wird auch stark von der Option
\menu{Textformatierung(en) durchführen} beeinflusst. Ist diese Option
aktiviert, wird alles, was Sie im HTML-Klotz eingetragen haben, mit
denselben Textformatierungs-Plugins (siehe Seite
\pageref{Textformatierungs-Plugins}) verarbeitet, wie Sie es von ihren Artikeln kennen.
Besonders wenn Sie JavaScript oder eigenen HTML-Code in einem HTML-Klotz
einbinden wollen, müssen Sie unbedingt darauf achten, diese Option auf
\cmd{Nein} zu setzen. Andernfalls könnten destruktive Textformatierungen
auf Ihren Code angewendet werden, was dann zu einer Fehldarstellung
führen würde.
\ospitem{\menu{Wo soll dieses Plugin angezeigt werden}}
Mit diesem Auswahlfeld legen Sie fest, an welcher Stelle ein HTML-Klotz
angezeigt werden soll: \menu{Überall}, \menu{Nur Artikelübersicht} oder
\menu{Nur Artikel-Detailansicht}.
Speziellere Möglichkeiten, ein Seitenleisten-Plugin vor bestimmten
Benutzern zu verstecken, bietet das Plugin \emph{Seitenleisten
verstecken} (siehe Seite \pageref{sidebarhider}).
\end{ospdescription}
\index{Plugins!Kommentare}%
\index{Plugins!serendipity\_plugin\_comments}%
\label{Plugin-Kommentare}%
\subsection{Kommentare\newline serendipity\_plugin\_comments}
Wenn Ihre Besucher Kommentare zu einem Beitrag hinterlassen, können Sie
als Redakteur diese relativ leicht über den Backend-Menüpunkt
\menu{Kommentare} einsehen oder werden sogar per E-Mail darüber
benachrichtigt. Normale Besucher haben diese Möglichkeit nicht und
können daher entweder den RSS-Feed der letzten Kommentare abonnieren oder
müssten jeden Blog-Artikel individuell aufrufen, um sich über neue
Kommentare zu informieren.
Daher bietet das Seitenleisten-Plugin \emph{Kommentare} eine einfache
Möglichkeit, die letzten Kommentare aller Artikel anzuzeigen und so für
den Besucher übersichtlich einzubinden.
Folgende Konfigurationsoptionen bietet das Plugin, abgesehen vom
Seitenleisten"=typischen Titel:
\begin{ospdescription}
\ospitem{\menu{Zeilenumbruch}}
In der Seitenleiste steht meist nur begrenzt Platz zur Darstellung von
Text zur Verfügung. Gerade Kommentare können jedoch die zur Verfügung
stehende Breite übermäßig strapazieren. Daher bietet die Option
\menu{Zeilenumbruch} die Möglichkeit, den Platzbedarf einzuschränken,
indem nach einer festgelegten Anzahl von Buchstaben ein harter Zeilenumbruch
eingefügt wird.
Der Zeilenumbruch wird dabei auch Wörter mittendrin trennen, um das Limit
nicht zu überschreiten. Dies ist notwendig, damit überlange Wörter
Ihrer Besucher (wie z.\,B.\ "`Coooooooooooooooooooool!"') nicht das
Layout Ihrer Seite sprengen.
Leider bereitet der Zeilenumbruch gerade dann Probleme, wenn Besucher
lange Links posten, die dann auseinandergebrochen werden. Sollte dies bei
Ihnen häufig vorkommen, können Sie die Buchstabenanzahl des Zeilenumbruchs
auf eine hohe Zahl wie 999 setzen und dann den Zeilenumbruch dem Browser
überlassen. Dabei empfiehlt es sich dann, mittels CSS mögliche
Layoutprobleme zu verhindern. Fügen Sie dazu die Zeile
\begin{ospcode}
.plugin_comment_body \{ overflow: scroll \}
\end{ospcode}
am Ende der Datei \cmd{style.css} Ihres gewählten Templates hinzu (siehe Kapitel
\pageref{template-css}). Dies wird den Browser dazu anweisen, überlange Wörter
durch Scrollbalken innerhalb der Seitenleiste anzuzeigen und nicht die ganze
Seitenleiste an die Wortbreite anzupassen.
\ospitem{\menu{Zeichen pro Kommentar}}
Um nicht zu viel Platz zu beanspruchen, werden immer nur die ersten 120
Zeichen eines Kommentars in der Seitenleiste angezeigt. Dies reicht
meistens, um sich als Besucher einen Überblick zu verschaffen und bei
Interesse den vollständigen Kommentar in der Artikel-Detailseite zu
lesen. Im Eingabefeld \menu{Zeichen pro Kommentar} können Sie diese
Zeichenanzahl vorgeben.
\ospitem{\menu{Anzahl an Kommentaren}}
Üblicherweise zeigt das Plugin die letzten 15 Kommentare. Diese Anzahl
können Sie mit dem Eingabefeld \menu{Anzahl an Kommentaren} verändern.
\ospitem{\menu{Datumsformat}}
Zu jedem Kommentar wird das Erstellungsdatum mit angezeigt. Wie dieses
formatiert wird, tragen Sie im Feld \menu{Datumsformat} ein. Die zur
Verfügung stehenden Variablen finden Sie auf
\cmd{http://de3.php.net/""strftime}.