11.2 Handbuch:Erweiterung/BlueSpiceSocialBlog: Unterschied zwischen den Versionen

Version vom 5. April 2022, 15:51 Uhr

Die Erweiterung BlueSpiceSocialBlog ist Teil von BlueSpiceSocial, dem Kommunikationsmodul von BlueSpice. Neben dem Typ Blog gibt es noch andere Typen von sogenannten sozialen Einheiten, z. B. Kommentare, Diskussionsthemen, Anhänge oder Microblogs.

Was ist ein Blog?[Bearbeiten | Quelltext bearbeiten]

Grundsätzlich ist ein Blog eine Liste von Beiträgen wie Kommentare, Fragen oder Rückmeldungen verschiedener Benutzer. Das Blog ist oft chronologisch aufgebaut. Eine lebhafte Kommunikation kann entstehen, wenn die Beiträge weiter kommentiert, empfohlen, mit verwandten Seiten verknüpft oder auf eine persönliche Beobachtungsliste gesetzt werden.

Die Blog-Funktion steht auf der Seite Spezial:Blog zur Verfügung. Diese Seite ist in jeder neuen Wiki-Installation direkt von der Hauptnavigation aus verlinkt. So können Sie sofort mit der Nutzung des Blogs beginnen.

Navigationslink

Merkmale und Funktionen[Bearbeiten | Quelltext bearbeiten]

Ein Blogeintrag besteht aus einem Titel und dem Inhalt.
Kommentare: Jeder Blogeintrag kann von den Benutzern kommentiert werden.
Aktionen:
- Löschen: Bearbeiter können ihre eigenen Beiträge löschen. Administratoren können alle Beiträge löschen. Gelöschte Beiträge werden nicht mehr angezeigt. Ausnahme: Administratoren sehen gelöschte Artikel mit rotem Hintergrund und können diese wiederherstellen.
- Empfehlen: Blogbeiträge können eine Empfehlung erhalten. Es ist möglich, über den Timeline-Filter eine Liste von Beiträgen mit den meisten Empfehlungen zu generieren. (Siehe hierzu: Das Blog auf einer Seite einbinden)
- Verknüpfter Artikel: Jeder Blogeintrag ist systembedingt mit einer Wikiseite verknüpft. Standardmäßig ist das die Hauptseite des Wikis. Es können aber weitere Seiten verlinkt werden. Blogeinträge können dann über die Seite Spezial:Timeline nach verlinkten Seiten gefiltert werden.
- Beobachten: Eigene Blogbeiträge und Kommentare werden automatisch auf die Beobachtungsliste gesetzt.
Berechtigungen: Es ist möglich, Benutzern mit Leserechten im Wiki das Kommentieren von Blogeinträgen zu erlauben. Siehe: BlueSpiceSocial Berechtigungen.

Das Blog auf einer Seite einbinden[Bearbeiten | Quelltext bearbeiten]

Es ist auch möglich, die Blog-Funktionalität in jede Wiki-Seite aufzunehmen. Beiträge können alternativ in einer Timeline konsolidiert und chronologisch angezeigt sowie nach Bedarf gefiltert und sortiert werden. Hierzu wird der erforderliche Codeblock in den Quellcode einer Seite einfügt.

So fügen Sie eine Blogansicht hinzu:

Gehen Sie zu der Seite, auf der Sie das Blog einfügen möchten oder erstellen Sie eine neue Seite.
Öffnen Sie die Seite in der Quellbearbeitung.

Kopieren Sie folgenden Codeblock zum Seitenabschnitt, in dem Sie das Blog anzeigen wollen.

<bs:timeline>
 {
     "showentitylistmenu": true,
     "preloadtitles": {
         "blog": "Vorlage:Blog"
     },
     "preloadedentities": [{
         "type": "blog"
     }],
     "headlinemessagekey": "Community-Blog",
      "showheadline": true,
     "usemorescroll": false,
     "morelink": "Special:Blog",
     "limit": 5,
     "sort": [ {
         "property": "timestampcreated",
         "direction": "DESC"
     }],
     "lockedfilternames": [
         "type"
     ],
     "filter": [ {
         "type": "list",
         "property": "type",
         "value": [ "blog" ],
         "comparison": "ct"
     }]
 }
</bs:timeline>

Nach dem Speichern der Seite sehen Sie die Liste der Blogeinträge des Wikis. Die Liste basiert auf den angegebenen Filter- und Sortierungskriterien.

Blog Parameter[Bearbeiten | Quelltext bearbeiten]

Ausgabeformat[Bearbeiten | Quelltext bearbeiten]

Die folgende Tabelle zeigt die Blog-Elemente und die erforderlichen Parameter zum Erstellen der Blogansicht.

Eingebundenes Blog


Element	Parameters	Parameter and element description	Type	Default value
1 - Überschrift	headlinemessagekey	Überschrift	string	Timeline
1 - Überschrift	showheadline	Überschrift anzeigen	boolean	true
2 - Blogmenü	showentitylistmenu	Blogmenü anzeigen	boolean	true
	showentityspawner	Textfeld zum Erstellen eines Blogeintrags anzeigen	boolean	true
	availablesorterfields	Datenfelder die als Sortieroptionen im Sortierungsmenü verfügbar sind. Beispiel: Benutzer können nur nach Erstellungsdatum oder Urheber sortieren: `"availablesorterfields":["timestampcreated","ownerid"]` Liste typischer Sortierfelder	array	alle
	lockedoptionnames	Diese Sortierfelder können vom Benutzer nicht geändert werden.	array	[]
	availablefilterfields	Datenfelder die als Filteroptionen im Filtermenü vorhanden sind. Beispiel: Benutzer können nach Erstellungsdatum oder Verknüpfte Artikel filtern: `"availablefilterfields":["timestampcreated","tags"]`	array	alle
	lockedfilternames	Diese Filtereinstellungen können nicht geändert werden. Beispiel: Ein Benutzer kann den Filter Verknüpfte Seiten nicht verändern. Das Feld ist ausgegraut: `"lockedfilternames": ["tags"]`	array	[]
	persistsettings	Initiale Einstellungen und vom Benutzer vorgenommene Einstellungen werden in die URL übernommen. Die URL kann dann auf anderen Seiten verlinkt werden. `"persistsettings":true`	boolean	false
3 - Neuer Blogeintrag	preloadentities	Zeigt das Textfeld zum Erstellen einen neuen Blogeintrags. Wenn es nicht angegeben ist, wird das Textfeld nicht nagezeigt. Anzeige des Textfelds mit: `"preloadedentities": [{"type":"blog"}]`	array of objects	-
4 - Existierender Blogeintrag	outputtypes	Definiert, welche Entitytypen mit welchem format angezeigt werden. Standardtypen sind: List, Short, Default, Page. (siehe Beispiele) Jeder Blogeintrag ist eine social entity.	object	Default
4 - Existierender Blogeintrag	limit	Definiert, wie viele social entities initial dargestellt werden.	object	Default
4a - Avatar	-	Zeigt den Avatar des Benutzers der den Blogeintrag oder den Kommentar erstellt hat. Er wird in allen Ausgabeformaten außer List angezeigt.	-	-
4b - Infoleiste	-	Link zu den Kommentaren und Bearbeitungsinfo.	-	-
4c - Inhalt des Blogeintrags	-	Zeigt den Textkörper des Blogeintrags an. Das Ausgabeformat Default klappt den Inhalt nach dem ersten Paragraphen ein. Der Inhalt wird über den Link Mehr ausgeklappt.	-	-
4d - Aktionsmenü	-	Funktionen: bearbeiten, löschen, empfehlen, Verknüpfter Artikel, beobachten	-	-
5 - Neuer Kommentar	-	Schaltfläche und Textfeld zum Erstellen eines neuen Kommentars.	-	-
6 - Existierender Kommentar	-	Kommentare enthalten das Social Tag Empfehlen. Jeder Kommentar ist eine social entity.	-	-
7 - Schaltfläche "Mehr"	morelink	Linkziel für die Schaltfläche Mehr. Für Blogs ist es sinnvoll, zur Seite Spezial:Blog zu verlinken.	str	Spezial:Timeline
	useendlessscroll	Mehr Blogeinträge werden nachgeladen, wenn der Benutzer ans Ende der Liste scrollt.	boolean	true
	showentitylistmore	Zeigt die Schaltfläche Mehr an, welche beim Anklicken mehr Blogeinträge lädt. Dies ist nur möglich, wenn useendlessscroll auf false eingstellt ist.	boolean	false

Sortierung[Bearbeiten | Quelltext bearbeiten]

Generell werden in einem Blog die neuesten Blogeinträge zuerst angezeigt. Es gibt jedoch viele verschiedene Möglichkeiten, die Liste der Blogeinträge zu sortieren.

Syntax[Bearbeiten | Quelltext bearbeiten]

[{

"property": "timestamptouched",

"direction": "DESC"

}]

Attribute[Bearbeiten | Quelltext bearbeiten]

Ein Blogeintrag hat einige Attribute, die für die Sortierung nützlich sind:


Attribut	Beschreibung
timestampcreated	creation date
timestamptouched	last edit date
commentcount	number of comments
ratingcount	number of ratings
ownerid	username of the creator of a blog entry
ownerrealname	real name of the user

Richtung[Bearbeiten | Quelltext bearbeiten]

Blogeinträge können in absteigender und aufsteigender Reihenfolge sortiert werden. Absteigend ist die Standardsortierung.


Wert	Beschreibung
DESC	sorts the blog entries in descending order
ASC	sorts the blog entries in ascending order

Filtern[Bearbeiten | Quelltext bearbeiten]

Wenn der Parameter Filter nicht existiert, gibt es keine Blogausgabe.

Um die Blogeinträge Ihres Wikis anzuzeigen, schließen Sie den folgenden Codeblock ein, wie im obigen Codebeispiel gezeigt:

"filter": [ {
         "type": "list",
         "property": "type",
         "value": [ "blog" ],
         "comparison": "ct"
     }]

Dieser Filter enthält alle sozialen Einheiten, die dem Typ Blog entsprechen. Da wir nur social entities vom Typ Blog anzeigen möchten, nehmen wir auch nur Blogeinträge in unseren Filter auf. Wenn Sie anstelle einer Blogansicht eine Timeline erstellen möchten, können Sie auch andere Arten von social entities hinzufügen. Das folgende Beispiel zeigt eine Timeline-Ansicht mit Blogeinträgen, Diskussionseinträgen von Wiki-Seiten und Benutzerprofilinformationen:

"filter": [ {
         "type": "list",
         "property": "type",
         "value": ["blog","topic","profile"],
         "comparison": "ct"
     }]

Beispiele für die Ausgabeformate[Bearbeiten | Quelltext bearbeiten]

Der Ausgabetyp für ein Blog wird mit dem Parameter outputtypes hinzugefügt. Vergessen Sie nicht, vor und nach diesem Parameter ein Komma einzufügen (es sei denn, dies ist der letzte Parameter in Ihrem Codeblock):

"outputtypes": {
        "blog": "Default"
    }

Default[Bearbeiten | Quelltext bearbeiten]

Der Ausgabetyp Default zeigt den Inhalt eines Blogeintrags an, der nach dem ersten Absatz eingeklappt wird. Um den vollständigen Text anzuzeigen, können Benutzer auf den Link Mehr klicken.

Ausgabe "Default"

Short[Bearbeiten | Quelltext bearbeiten]

Der Ausgabetyp Short zeigt den Inhalt des Blogeintrags nicht an. Um den Inhalt anzuzeigen, müssen Benutzer auf den Titel eines Blogeintrags klicken. Dadurch wird die aktuelle Seite für den ausgewählten Blogeintrag geladen.