Handbuch:Erweiterung/BlueSpiceSocialBlog

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 oder Microblogs.

Was ist ein Blog?

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

• 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

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:

1. Gehen Sie zu der Seite, auf der Sie das Blog einfügen möchten oder erstellen Sie eine neue Seite.
2. Öffnen Sie die Seite in der Quellbearbeitung.
3. 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

Ausgabeformat

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
	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"}] Wenn die Wikiseite, die das <bstimeline>-Tag eingebunden hat, nur ihre eigenen Blogeinträge zeigen soll, werden alle Seiten mit dem Seitennamen oder ähnlichem getagged, z.B.: "preloadedentities": [{          "type": "blog",          "tags":["Blog1"]      }] Hier ist Blog1 die assozieerte Seite jedes Blogeintrags. Entsprechend muss dann auch der Blog-Filter angepasst werden, um diesesTag zu berücksichtigen.	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
	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

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

[{

"property": "timestamptouched",

"direction": "DESC"

}]

Attribute

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

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

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"
     }]

Verknüpfte Seiten filtern

Wenn ein eingebundenes Blog nur Beiträge zeigen soll, die mit dem Seitennamen (z.B. Blog1) verknüpft sind, muss dieses in den Blog-Parametern (siehe preloadedentities) definiert werden und anschließend im Filter angegeben werden:

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

Beispiele für die Ausgabeformate

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

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

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.

Ausgabe "Short"

Page

Der Ausgabetyp Page zeigt alle Elemente des Blogs, einschließlich der Kommentare, vollständig ausgekappt an.

Ausgabe "Page"

List

Der Ausgabetyp List zeigt nur den Titel und das Erstellungsdatum an.

Ausgabe "List"

Blog-Berechtigungen setzen

Über die Rolle "commenter"

Generell können alle Benutzer mit Bearbeitungsrechten Blogeinträge und Kommentare erstellen. Die Rolle commenter in der Rechteverwaltung erlaubt es jedoch nicht, Blogeinträge zu erstellen. Diese Rolle weist lediglich das Recht zu, Kommentare zu bestehenden Blogeinträgen zu erstellen. Siehe auch BlueSpiceSocial Berechtigungen.

Über Benutzergruppen

ist ab BlueSpice 4.2 enthalten.

Wenn ein Blog auf einer Seite eingebunden wird, so kann die Erstellung und Bearbeitung von Diskussionsbeiträgen und Kommentaren auf bestimmte Benutzergruppen beschränkt werden. Diese Möglichkeit besteht nicht auf der Seite Spezial:Blog selbst.

Fügen Sie das Blog folgendermaßen auf einer Wikiseite ein. Ändern Sie anschließend die Gruppen editgroups, commentgroups, deletegroups und readgroups.

Wichtig!Setzen Sie nur die Gruppen, die Sie wirklich benötigen, da die Vererbung der einzelnen Rechte nicht gegeben ist. Lesen Sie die folgenden Erklärungen daher sorgfältig durch!

<bs:timeline>
{
    "showentitylistmenu": true,
      "preloadedentities": [{
       "type": "groupblog",
       "editgroups": ["blog_GF"],
       "commentgroups": ["blog_commenter"],
       "deletegroups": ["blog_delete"],
       "readgroups": ["blog_reader","blog_GF","blog_commenter","blog_delete"]
    }],
    "headlinemessagekey": "My Blog",
    "showheadline": true,
    "usemorescroll": true,   
    "limit": 5,
    "sort": [ {
        "property": "timestampcreated",
        "direction": "DESC"
    }],
    "lockedfilternames": [
        "type"
    ],
    "filter": [ {
        "type": "list",
        "property": "type",
        "value": [ "groupblog" ],
        "comparison": "ct"
    }]
}
</bs:timeline>

Im Objekt preloadedentities werden die unterschiedlichen Berechtigungen definiert:

Name	Wert	Beschreibung
type	groupblog	Der Typ groupblog erlaubt die Sonderverrechtung des Blogs
editgroups	["blog_GF"]	Berechtigung, Blogeinträge zu erstellen
commentgroups	["blog_commenter"]	Berechtigung, Kommentare zu erstellen
deletegroups	["blog_delete"]	Löschberechtigung
readgroups	["blog_reader","blog_GF","blog_commenter","blog_delete"]	Leseberechtigung: Alle Gruppen die in editgroups, commentgroups und deletegroups aufgeführt sind, müssen auch hier explizit aufgeführt werden.

Wichtige Hinweise:

1. Wenn das Blog bereits auf einer Seite existiert und die Gruppenzuweisungen nachträglich erstellt werden, so werden die Berechtigungen nicht auf vorhandene Blogeinträge angewandt.
2. Es gibt keine Vererbung, falls eine Gruppendefinition explizit angegeben wird: z. B. kann eine Benutzergruppe, die sich in „editgroups“, aber nicht in „commentgroups“ (falls vorhanden) befindet, keine Kommentare hinzufügen.

“editgroups” existiert:

• nur Benutzer in diesen Gruppen sehen die Schaltfläche, um einen neuen Blogeintrag zu starten.

“commentgroups” existiert:

• nur Benutzer in diesen Gruppen sehen die Schaltfläche “answer here” und können Kommentare hinzufügen

“deletegroups” existiert:

• nur Benutzer in diesen Gruppen sehen den Link “Löschen” und können die Beiträge anderer Benutzer löschen. Hinweis: “sysop” Benutzer können immer einen Beitrag löschen oder wiederherstellen. Siehe unten zu Leseberechtigungen von Sysop-Benutzern.

“readgroups” existiert:

Nur bei Bedarf setzen, da keine Vererbung erfolgt. Falls vorhanden, müssen alle Benutzergruppen der anderen Bloggruppen hier hinzugefügt werden.

Beispiele:

• Wenn die Benutzergruppe blog_GF in „editgroups“, aber nicht in „readgroups“ ist, wird der „create“-Button trotz der expliziten Bearbeitungsrechte nicht angezeigt.
• Wenn sich die Benutzergruppe blog_commenter in „commentgroups“, aber nicht in „readgroups“ befindet, sind die neuen Blogeinträge, auf die diese Einstellung angewendet wurde, nicht sichtbar.
• Wenn sich die Benutzergruppe blog_delete in „deletegroups“, aber nicht in „readgroups“ befindet, sind die neuen Blogeinträge nicht sichtbar und können daher nicht gelöscht werden.

user group “sysop”:

• Wenn „readgroups“ nicht definiert ist, kann Gruppe sysop alle Blogeinträge löschen
• Wenn „readgroups“ definiert ist und sysop kein Teil dieser Gruppe ist, kann sysop keine Blogeinträge sehen und sie daher nicht auf der Seite löschen. Aber mit einem direkten Link zur eigentlichen Blogseite kann der sysop-Benutzer den Eintrag von dort löschen/wiederherstellen.

Wichtig!Die Standard-Benutzergruppe „sysop“ kann nicht als Benutzergruppe zu einer Definition hinzugefügt werden. Um beispielsweise einem Admin-Benutzer Leserechte zuzuweisen (falls „readgroups“ existiert), muss der Benutzer einer Benutzergruppe hinzugefügt werden, die in „readgroups“ definiert ist ( z.B. blog_reader)

more”-Schaltfläche:

Um zu vermeiden, dass am Ende des Blogs auf die Standardseite Spezial:Blog gewechselt wird, muss der Mehr-Button als Scroll-Button eingestellt werden, anstatt auf die Spezialseite zu verlinken. Hierfür setzen Sie (wie im Beispiel bereits angegeben):

"usemorescroll": true

Benachrichtigungen

Wenn Benutzer Benachrichtigungen zu Blogbeiträgen im Wiki oder per Email erhalten wollen, muss die Einstellung "Beitragsaktionen auf beobachteten Seiten" in den Benutzereinstellungen (Reiter "Benachrichtigungen") aktiviert sein.

Blog-Benachrichtigungen

Weiterführende Links

• Referenz:BlueSpiceSocial
• Micro-Blog
• Benutzerprofil

Wird im Wiki von einem "Artikel" gesprochen, so ist damit in der Regel der Inhalt einer Einzelseite gemeint. Im Zusammenhang mit im Wiki erstellten Büchern ist ein Artikel oft gleichbedeutend mit einem Buchkapitel.

Ein Uniform Resource Locator (Abk. URL; englisch für „einheitlicher Ressourcenverorter“) identifiziert und lokalisiert eine Ressource, beispielsweise eine Webseite, über die zu verwendende Zugriffsmethode (zum Beispiel das verwendete Netzwerkprotokoll wie HTTP oder FTP) und den Ort (englisch location) der Ressource in Computernetzwerken.

Tag: XML-Tags, welche beliebig parametrisiert werden können und eine vom Programmierer gewünschte Ausgabe produzieren. Fügt man beispielsweise das <bs:bookshelf>-Tag ein, dann erhält der Artikel die Kapitelnavigation des PDF-Buches, in dem der Artikel verlinkt ist.

Technische Referenz: BlueSpiceSocialBlog

---

Feedback zur Dokumentation ist im Community-Forum möglich.