Quelltext der Seite NutzerHandbuch:Erweiterung/BlueSpiceSocialBlog

{{DISPLAYTITLE:Blogs einbinden}}
==Was ist ein Blog?==
[[File:Handbuch:nav-blog.png|alt=Blog link in the main navigation|200x200px|right]]Grundsätzlich ist ein Blog eine Liste von Kommentaren, Fragen oder Rückmeldungen verschiedener Benutzer. Das Blog ist oft chronologisch aufgebaut, wie ein öffentliches Tagebuch. 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 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''.

Beiträge aus all diesen Arten können mit ''BlueSpiceSocial'' in einer Timeline konsolidiert und chronologisch angezeigt sowie nach Bedarf gefiltert und sortiert 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. Es ist auch möglich, die Blog-Funktionalität in jede Wiki-Seite aufzunehmen. Legen wir also gleich los!

==Das Blog auf einer Seite einbinden==
<span title="" class="">Wenn Sie eine Ansicht Ihres Blogs auf einer anderen Seite Ihres Wikis einbinden möchten, beispielsweise auf Ihrer Homepage, müssen Sie den erforderlichen Codeblock in den Quellcode Ihrer Seite einfügen.</span><span title="">'''So fügen Sie eine Blogansicht hinzu:'''</span>

#'''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.[[Datei:editor.png|200x200px]]
#'''Kopieren''' Sie folgenden Codeblock zum Seitenabschnitt, in dem Sie das Blog anzeigen wollen. <syntaxhighlight lang="html">

<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>
</syntaxhighlight>Nach dem Speichern der Seite sehen Sie die Liste der Blogeinträge des Wikis. Die Liste basiert auf den angegebenen Filter- und Sortierungskriterien.[[Datei:Handbuch:blog-layout.PNG|alternativtext=Blog layout|zentriert|650x650px]]

==Blog Parameter==

===Ausgabeformat===
Die folgende Tabelle zeigt die Blog-Elemente und die erforderlichen Parameter zum Erstellen der Blogansicht:
{| class="wikitable"
|+
!Element
!Parameters
!Parameter and element description
!Type
!Default value
|-
| rowspan="2" |1 - Überschrift
|headlinemessagekey
|Überschrift
|string
|''Timeline''
|-
|showheadline
|Überschrift anzeigen
|boolean
|''true''
|-
| rowspan="7" |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:
<code>"availablesorterfields":["timestampcreated","ownerid"]</code>

[[Datei:Handbuch:blog-filter-availablesorterfields.PNG|350x350px]]

[[NutzerHandbuch:Erweiterung/BlueSpiceSocialBlog|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:

<code>"availablefilterfields":["timestampcreated","tags"]</code>

[[Datei:Handbuch:blog-filter-availablefilterfields.PNG|350x350px]]
|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:
<code>"lockedfilternames": ["tags"]</code>

[[Datei:Handbuch:blog-filter-lockedfilternames.PNG|350x350px]]
<br />
|array
|[]
|-
|persistsettings
|Initiale Einstellungen und vom Benutzer vorgenommene Einstellungen werden in die URL übernommen.
Die URL kann dann auf anderen Seiten verlinkt werden.
<code>"persistsettings":true</code>

[[File:Handbuch:blog-filter-persistsettings.PNG]]
|boolean
|''false''
|-
|3 -  Neuer Blogeintrag
|preloadentities<br />
|Zeigt das Textfeld zum Erstellen einen neuen Blogeintrags. Wenn es nicht angegeben ist, wird das Textfeld nicht nagezeigt.
Anzeige des Textfelds mit: 

<code>"preloadedentities": [{"type":"blog"}]</code>

[[Datei:Handbuch:blog-preloadentities.png|alternativtext=Preload entities|350x350px]]<br />
|array of objects
| -
|-
| rowspan="2" |4 - Existierender Blogeintrag
|outputtypes
|Definiert, welche Entitytypen mit welchem format angezeigt werden. Standardtypen sind: ''List, Short, Default, Page.'' ([[NutzerHandbuch:Erweiterung/BlueSpiceSocialBlog|siehe Beispiele]])
Jeder Blogeintrag ist eine ''social entity''.
|object
|''Default''
|-
|limit
|Definiert, wie viele ''social entities'' initial dargestellt werden.
|object
|''Default''
|-
|4a - Avatar
|<nowiki>-</nowiki>
|Zeigt den Avatar des Benutzers der den Blogeintrag oder den Kommentar erstellt hat. Er wird in allen Ausgabeformaten außer ''List'' angezeigt.
|<nowiki>-</nowiki>
|<nowiki>-</nowiki>
|-
|4b - Titelleiste
|<nowiki>-</nowiki>
|Im Ausgabeformat ''List'' wir der Benutzername in der Titelleiste nicht angezeigt.
|<nowiki>-</nowiki>
|<nowiki>-</nowiki>
|-
|4c - Inhalt des Blogeintrags
|<nowiki>-</nowiki>
|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.
|<nowiki>-</nowiki>
|<nowiki>-</nowiki>
|-
|4d - Social Tags
|<nowiki>-</nowiki>
|Blogeinträge enthalten immer die Social Tags ''Kommentar, Empfehlen, Verknüpfter Artikel, Beobachten/Nicht mehr beobachten''.
|<nowiki>-</nowiki>
|<nowiki>-</nowiki>
|-
|4e - Benutzermenu
|<nowiki>-</nowiki>
|Benutzer können Ihre eigenen Blogeinträge jederzeit bearbeiten oder löschen. Das Benutzermenü ist nur bei den eigenen Beiträgen sichtbar:
[[Datei:Handbuch:blog-editmenu.png|200x200px]]
|<nowiki>-</nowiki>
|<nowiki>-</nowiki>
|-
|5 - Neuer Kommentar
|<nowiki>-</nowiki>
|Textfeld zum Erstellen eines neuen Kommentars.
|<nowiki>-</nowiki>
|<nowiki>-</nowiki>
|-
|6 - Existierender Kommentar
|<nowiki>-</nowiki>
|Kommentare enthalten das Social Tag ''Empfehlen''.

Jeder Kommentar ist eine ''social entity''.
|<nowiki>-</nowiki>
|<nowiki>-</nowiki>
|-
| rowspan="3" |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====
<syntaxhighlight lang="json">
[{

"property": "timestamptouched",

"direction": "DESC"

}] 
</syntaxhighlight>

====Attribute====
Ein Blogeintrag hat einige Attribute, die für die Sortierung nützlich sind:
{| class="wikitable"
|+
!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.
{| class="wikitable"
|+
!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:<syntaxhighlight lang="json-object">
"filter": [ {
         "type": "list",
         "property": "type",
         "value": [ "blog" ],
         "comparison": "ct"
     }]
</syntaxhighlight>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'':<syntaxhighlight lang="json-object">
"filter": [ {
         "type": "list",
         "property": "type",
         "value": ["blog","topic","profile"],
         "comparison": "ct"
     }]
</syntaxhighlight>

==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):<syntaxhighlight lang="json-object">
"outputtypes": {
        "blog": "Default"
    }
</syntaxhighlight>
===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.
[[Datei:Handbuch:blog-output-default.PNG|alternativtext=Blog output default|zentriert|650x650px]]
===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.<br />
[[Datei:Handbuch:blog-output-short.PNG|alternativtext=blog output short|zentriert|650x650px]]
===Page===
Der Ausgabetyp ''Page'' zeigt alle Elemente des Blogs, einschließlich der Kommentare, vollständig ausgekappt an.<br />
[[Datei:Handbuch:blog-output-page.PNG|alternativtext=blog output page|zentriert|650x650px]]
===List===
Der Ausgabetyp ''List'' zeigt nur den Titel und das Erstellungsdatum an.
<br />
[[Datei:Handbuch:blog-output-list.PNG|alternativtext=BlogOutput List|zentriert]]

{{Translation}}