Zuletzt bearbeitet vor 4 Monaten
von Margit Link-Rodrigue

BlueSpice 4.3 und Handbuch:Erweiterung/Workflows/Activity/SetTemplateParams: Unterschied zwischen den Seiten

(Unterschied zwischen Seiten)
Keine Bearbeitungszusammenfassung
Markierungen: Zurückgesetzt 2017-Quelltext-Bearbeitung
 
Keine Bearbeitungszusammenfassung
 
Zeile 1: Zeile 1:
__TOC__
==Beschreibung==
Die ''SetTemplateParams''-Activity ermöglicht das automatische Festlegen eines Vorlagenparameters auf einer Wiki-Seite.


==Releases==
* Auf Vorlagen wird in der Reihenfolge zugegriffen, in der sie auf der Seite erscheinen, beginnend bei 0. Nicht-existierende Vorlagen werden als Links gezählt und werden daher beim Zählen ignoriert.
* Parameter innerhalb der Vorlage können über ihren Namen oder im Falle von nicht benannten Parametern über den Index angegeben werden.
* Der Index für nicht benannte Parameter beginnt bei 1 (nicht 0!).
* Verschachtelte Vorlagen werden derzeit nicht unterstützt.


{{#ask: [[Release::4.3]]
== Profil ==
|?Releasepatch = Release
{| class="wikitable"
|?Releasedate#LOCL = Release date
! colspan="2" |'''Kurzprofil'''
|mainlabel= -
|headers = plain
|sort=Releasedate
|order=desc
|default=There have been no patch releases so far.
}}
 
==Einführung==
Releasedatum:  29.06.2023
 
BlueSpice 4.3 ist ein Minor Release   
 
Die Codebasis wurde auf  '''MW 1.39''' aktualisiert. 
 
===Kompatibilität===
 
*unterstützt '''PHP 8.2'''
*LDAP, Simple SAMLphp, OpenIDConnect : Upgrade zur Kompatibilität mit PluggableAuth 6/7
 
==Neue Funktionen==
{| class="wikitable" style="width:100%;"
!Funktion
!Beschreibung
!Screenshot
|-
|-
!Content Droplets
|Name
|Wir führen Content Droplets ein, um spezielle Inhalte in eine Wiki-Seite einzufügen. Dazu gehören Tags, Parser-Funktionen und Vorlagen. Die Funktion ersetzt den Menüpunkt „Magisches Wort“ des Visual Editors.
|SetTemplateParams
*
 
{{Icon|bi bi-arrow-right-circle||#0d6efd}}[[Handbuch:Erweiterung/ContentDroplets|Content Droplets Dokumentation]]
|[[Datei:Droplet Menü.png|alternativtext=Screenshot des Menüs für Content Droplets|zentriert|mini|450x450px|Content Droplets Menü]]
|-
|-
!Erweiterter Menü-Editor
|Async
|
|ja
Die Hauptnavigation kann jetzt hierarchische Links enthalten. Darüber hinaus sind 4 Konfigurationen der Seitenleiste möglich.
 
|[[File:Enhanced MenuEditor DE.png|center|thumb|320x320px|Hierarchische Navigation]]
|-
|-
!PDF Embed
|BPMN type
 
|<code>bpmn:task</code>
|Für einen einfachen Zugriff ist es im Menü „Content Droplets“ enthalten.
 
 
|[[File:Extension PDFEmbed.png|center|thumb|450x450px|Extension PDFEmbed|alt=Screenshot eines eingebetteten PDFs]]
|-
|-
!Startseitenvorlagen
|BPMN Extension Element "wf:type"
|Zwei Startseitenvorlagen  sind nun vorinstalliert, um die Erstellung von Portalseiten für die Hauptseite und für Namensräume zu unterstützen.
|<code>set_template_param</code>
|}


 
==Attribute==
 
{| class="wikitable"
 
! style="vertical-align:middle;text-align:left;" |'''Name des Attributs'''
 
!'''Beschreibung'''
Um Benutzer bei der Gestaltung von Portalseiten noch weiter zu unterstützen, ist die renommierte Icon-Bibliothek Font Awesome jetzt mit BlueSpice gebündelt.
!'''Typ'''
 
|<gallery widths="170" heights="200">
File:Startseite Intranet.png|alt=Screenshot der "Startseite Intranet"|Startseitenvorlage 1
File:Startseite Team.png|alt=Screenshot der "Startseite Team"|Startseitenvorlage 2
</gallery>
|-
|-
!Container Filter
|<code>title</code>
|You can now mark sections of a page for filtering and display a filter just for the content located within these sections of the page.
|Name der Seite, auf der der Vorlagenparameter geändert wird. Wenn der Wert auf der Seite geändert wird, auf der der Workflow ausgeführt wird, ist der Wert <code><nowiki>{{FULLPAGENAME}}</nowiki></code>
|[[File:ContainerFilter example.png|center|thumb|450x450px|alt=Screenshot einer Tabelle mit Container-Filter]]
|string
|}
 
==Zusätzliche Verbesserungen==
 
*VisualEditor: Die Kopier- und Einfügefunktionalität aus anderen Anwendungen (z. B. MS Word) wurde merklich verbessert.
*Tagging von Seitenvorlagen: In der Seitenvorlagenverwaltung können Seitenvorlagen mit Tags kategorisiert werden. Die Tags funktionieren als Filter bei der Auswahl von Seitenvorlagen.
*Benutzeroberfläche:
**Leichte Anpassungen des Menü-Editors.
**Neue Grid-Ansicht des Qualitätsmanagement Überblicks  und der Workflow-Übersicht.
 
==Hinzugefügte Erweiterungen (8)==
{| class="contenttable" style="width:100%;"
|+Developer: MW=MediaWiki extension; HW=Hallo Welt! extension
!Erweiterung
!Beschreibung
!Entwickler
|-
|-
!ContainerFilter
| style="width:70px;" |<code>user</code>
 
|Benutzer der in die Revisionsgeschichte geschrieben wird
| Ermöglicht das Filtern von Inhaltselementen innerhalb einer Seite.
|user
|Hallo Welt!
|-
|-
!ContentDroplets
|<code>template-index</code>
|VisualEditor-Integration zum Einfügen vordefinierter Inhalte.
|Index der Vorlage auf der Wikiseite (beginnend bei 0)
|Hallo Welt!
|number
|-
|-
!ContentStabilization
|<code>template- param</code>
|<span style="color: rgb(32, 33, 34)">Ersetzt den zuvor von den Erweiterungen FlaggedRevs / BlueSpiceFlaggedRevsConnector bereitgestellten Freigabemechanismus.</span>
|Vorlagen-Parameter, der geändert wird. Dies kann eine Zeichenfolge (im Fall eines benannten Parameters) oder eine Zahl (im Fall eines nicht benannten Parameters; beginnend bei 1, Zugriffsmethode für den Parameter) sein.
|Hallo Welt!
|<nowiki>int|string</nowiki>
|-
|-
!FontAwesome
|<code>value</code>
| Icon-Bibliothek zur Verwendung in Vorlagen und im Quelltext.
|Neuer Wert des Parameters, der durch den Workflow gesetzt wurde.
|MediaWiki
|string
|-
|-
! InstanceStatus
|<code>minor</code>
|Anzeige der Benutzerlizenzen auf einer Spezialseite.
|Markiert die Version als kleine Änderung, falls der Wert auf "1" gesetzt ist.
 
|boolean
|Hallo Welt!
 
|-
|-
!PDFEmbed
|<code>revisionId</code>
|Einbetten von PDFs auf Wikiseiten.
|Neue Seitenrevisions-ID
|MediaWiki
|number
|-
|-
!PreToClip
|<code>timestamp</code>
|Kopiert den Inhalt von <code><nowiki><pre></nowiki></code> und <code><nowiki><syntaxhighlight></nowiki></code> Tags in die Zwischenablage.
|Datumsstempel der Revision
|MediaWiki
|timestamp
|-
|-
!SectionAnchors
|comment
|Fügt einen Link zu Überschriften hinzu, um den Ankerpfad in die Zwischenablage zu kopieren.
|Kommentar in der Revisionsgeschichte.
|Hallo Welt!
|string
|}
|}


==Entfernte Erweiterungen (4)==
== Beispiel ==
*'''FlaggedRevs:''' Ersetzt durch die Erweiterung ''ContentStabilization''
 
*'''BlueSpiceDrawioConnector:''' In die Erweiterung ''BlueSpiceDrawio'' integriert
=== Workflow-Aufgabe ===
*'''BlueSpiceFlaggedRevsConnector''': Ersetzt durch die Erweiterung ''ContentStabilization''
Diese Workflow-Aufgabe setzt den Wert des Parameters <code><nowiki>{{{status}}}</nowiki></code> auf der ersten Vorlage einer Seite auf „Aktualisiert“.<syntaxhighlight lang="xml">
*'''BlueSpiceInsertMagic:''' Ersetzt durch die Erweiterung ''ContentDroplet''
<bpmn:task id="EditTemplate" name="Edit template">
    <bpmn:extensionElements>
<wf:type>set_template_param</wf:type>
</bpmn:extensionElements>
<bpmn:property name="title" default="Testpage" validation="required,existing-title"/>
<bpmn:property name="user" default="WikiSysop" validation="existing-user"/>
<!-- Index of the template on page (starting from 0) -->
<bpmn:property name="template-index" default="0"/>
<!-- Param to modify. Can be a string in case of named params, or a number, in case of non-named params (starting from 1, accessor for the param) -->
<bpmn:property name="template-param" default="status"/>
<!-- New value to set -->
<bpmn:property name="value" default="Aktualisiert"/>
<bpmn:property name="minor" default="0"/>
 
<!-- Output properties -->
<bpmn:property name="revisionId"/>
<bpmn:property name="timestamp"/>
      <bpmn:incoming>Flow_1qh6vpl</bpmn:incoming>
      <bpmn:outgoing>Flow_0if1kyp</bpmn:outgoing>
 
    </bpmn:task>
</syntaxhighlight>


=== Vorlage ===
The template content has the parameter <code><nowiki>{{{status}}}</nowiki></code> At the time of writing this, the workflow produced an error tif the parameter was wrapped in a <code><nowiki><div></nowiki></code> tag. Therefore, in the example below, the parameter is defined in a variable first. If the parameter is not in  a  <code>div</code> tag, using a variable is not necessary.


===Inhaltsänderungen===
Der Vorlageninhalt hat den Parameter <code><nowiki>{{{status}}}</nowiki></code>  . Zum jetzigen Zeitpunkt erzeugt der Workflow einen Fehler, wenn der Parameter in ein<div><code>div</code>-Tag eingeschlossen sit. Daher wird im folgenden Beispiel der Parameter zunächst in einer Variablen definiert. Wenn sich der Parameter nicht in einem div-Tag befindet, ist die Verwendung einer Variablen nicht erforderlich. Es kann sein, dass dieses Verhalten zwischenzeitlich korriegiert wurde.<syntaxhighlight lang="text">
Folgende Inhaltsänderungen können die Darstellung der Inhalte im Wiki beeinflussen und benötigen eventuell manuelle Anpassungen:
{{#vardefine:status|{{{status|not set}}}}}
<div style="background:#fbfaef;">Page status: {{#var:status}}</div>
</syntaxhighlight>


* Fehlende Datenschutzseiten können einen gelben Banner verursachen. Dieser wird nur den Admin-Benutzern angezeigt.
=== Komplettes BPMN-Beispiel ===
* Die Startseitenvorlagen können eventuell nicht alle Stile anzeigen, wenn darin enthaltende Vorlagen bereits vor dem Update im Wiki existieren.
<syntaxhighlight lang="xml">
* Stile, die in Vorlagen oder in „MediaWiki:Common.css“ definiert sind, werden möglicherweise nicht mehr angewendet.
<?xml version="1.0" encoding="UTF-8"?>
* Das ContentDroplet ''Icon'' kann nur im Block-Modus eingefügt werden.
<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:wf="http://hallowelt.com/schema/bpmn/wf">
* Fehlender Sprachwechsler auf Seiten, deren Titelbereich ausgeblendet ist.
    <bpmn:process id="SetTemplateParams-Process" isExecutable="false">
        <bpmn:extensionElements>
            <wf:context>
                <wf:contextItem name="pageId"/>
            </wf:context>
        </bpmn:extensionElements>
        <bpmn:startEvent id="TheStart">
            <bpmn:outgoing>FromTheStartToEditTemplate</bpmn:outgoing>
        </bpmn:startEvent>
        <bpmn:sequenceFlow id="FromTheStartToEditTemplate" sourceRef="TheStart" targetRef="EditTemplate" />
        <bpmn:task id="EditTemplate" name="Edit template">
            <bpmn:extensionElements>
                <wf:type>set_template_param</wf:type>
            </bpmn:extensionElements>
            <bpmn:property name="title" default="" validation="required,existing-title">{{FULLPAGENAME}}</bpmn:property>
            <bpmn:property name="user" default="WikiSysop" validation="existing-user">WikiSysop</bpmn:property>
            <!-- Index of the template on page (starting from 0) -->
            <bpmn:property name="template-index" default="0"/>
            <!-- Param to modify. Can be a string in case of named params, or a number, in case of non-named params (starting from 1, accessor for the param) -->
            <bpmn:property name="template-param" default="status"/>
            <!-- New value to set -->
            <bpmn:property name="value" default="Super edited param"/>
            <bpmn:property name="comment" default="Edited template param"/>
            <bpmn:property name="minor" default="1"/>
            <!-- Output properties -->
            <bpmn:property name="revisionId"/>
            <bpmn:property name="timestamp"/>
            <bpmn:incoming>FromTheStartToEditTemplate</bpmn:incoming>
            <bpmn:outgoing>FromEditTemplateToTheEnd</bpmn:outgoing>
        </bpmn:task>
        <bpmn:sequenceFlow id="FromEditTemplateToTheEnd" sourceRef="EditTemplate" targetRef="TheEnd" />
        <bpmn:endEvent id="TheEnd">
            <bpmn:incoming>FromEditTemplateToTheEnd</bpmn:incoming>
        </bpmn:endEvent>
    </bpmn:process>
</bpmn:definitions>


{{Icon|bi bi-arrow-right-circle|||}} [[Bekannte Probleme|Mehr Infos zu den Inhaltsänderungen]]
</syntaxhighlight>


[[en:BlueSpice 4.3]]
[[en:Manual:Extension/Workflows/Activity/SetTemplateParams]]
[[de:{{FULLPAGENAME}}]]

Version vom 5. Februar 2024, 14:51 Uhr

Beschreibung[Bearbeiten | Quelltext bearbeiten]

Die SetTemplateParams-Activity ermöglicht das automatische Festlegen eines Vorlagenparameters auf einer Wiki-Seite.

  • Auf Vorlagen wird in der Reihenfolge zugegriffen, in der sie auf der Seite erscheinen, beginnend bei 0. Nicht-existierende Vorlagen werden als Links gezählt und werden daher beim Zählen ignoriert.
  • Parameter innerhalb der Vorlage können über ihren Namen oder im Falle von nicht benannten Parametern über den Index angegeben werden.
  • Der Index für nicht benannte Parameter beginnt bei 1 (nicht 0!).
  • Verschachtelte Vorlagen werden derzeit nicht unterstützt.

Profil[Bearbeiten | Quelltext bearbeiten]

Kurzprofil
Name SetTemplateParams
Async ja
BPMN type bpmn:task
BPMN Extension Element "wf:type" set_template_param

Attribute[Bearbeiten | Quelltext bearbeiten]

Name des Attributs Beschreibung Typ
title Name der Seite, auf der der Vorlagenparameter geändert wird. Wenn der Wert auf der Seite geändert wird, auf der der Workflow ausgeführt wird, ist der Wert {{FULLPAGENAME}} string
user Benutzer der in die Revisionsgeschichte geschrieben wird user
template-index Index der Vorlage auf der Wikiseite (beginnend bei 0) number
template- param Vorlagen-Parameter, der geändert wird. Dies kann eine Zeichenfolge (im Fall eines benannten Parameters) oder eine Zahl (im Fall eines nicht benannten Parameters; beginnend bei 1, Zugriffsmethode für den Parameter) sein. int|string
value Neuer Wert des Parameters, der durch den Workflow gesetzt wurde. string
minor Markiert die Version als kleine Änderung, falls der Wert auf "1" gesetzt ist. boolean
revisionId Neue Seitenrevisions-ID number
timestamp Datumsstempel der Revision timestamp
comment Kommentar in der Revisionsgeschichte. string

Beispiel[Bearbeiten | Quelltext bearbeiten]

Workflow-Aufgabe[Bearbeiten | Quelltext bearbeiten]

Diese Workflow-Aufgabe setzt den Wert des Parameters {{{status}}} auf der ersten Vorlage einer Seite auf „Aktualisiert“.

<bpmn:task id="EditTemplate" name="Edit template">
    	<bpmn:extensionElements>
			<wf:type>set_template_param</wf:type>
		</bpmn:extensionElements>
		<bpmn:property name="title" default="Testpage" validation="required,existing-title"/>
		<bpmn:property name="user" default="WikiSysop" validation="existing-user"/>
		<!-- Index of the template on page (starting from 0) -->
		<bpmn:property name="template-index" default="0"/>
		<!-- Param to modify. Can be a string in case of named params, or a number, in case of non-named params (starting from 1, accessor for the param) -->
		<bpmn:property name="template-param" default="status"/>
		<!-- New value to set -->
		<bpmn:property name="value" default="Aktualisiert"/>
		<bpmn:property name="minor" default="0"/>

		<!-- Output properties -->
		<bpmn:property name="revisionId"/>
		<bpmn:property name="timestamp"/>
      <bpmn:incoming>Flow_1qh6vpl</bpmn:incoming>
      <bpmn:outgoing>Flow_0if1kyp</bpmn:outgoing>

    </bpmn:task>

Vorlage[Bearbeiten | Quelltext bearbeiten]

The template content has the parameter {{{status}}} At the time of writing this, the workflow produced an error tif the parameter was wrapped in a <div> tag. Therefore, in the example below, the parameter is defined in a variable first. If the parameter is not in a div tag, using a variable is not necessary.

Der Vorlageninhalt hat den Parameter {{{status}}} . Zum jetzigen Zeitpunkt erzeugt der Workflow einen Fehler, wenn der Parameter in ein

div-Tag eingeschlossen sit. Daher wird im folgenden Beispiel der Parameter zunächst in einer Variablen definiert. Wenn sich der Parameter nicht in einem div-Tag befindet, ist die Verwendung einer Variablen nicht erforderlich. Es kann sein, dass dieses Verhalten zwischenzeitlich korriegiert wurde.
{{#vardefine:status|{{{status|not set}}}}}
<div style="background:#fbfaef;">Page status: {{#var:status}}</div>

Komplettes BPMN-Beispiel[Bearbeiten | Quelltext bearbeiten]

<?xml version="1.0" encoding="UTF-8"?>
<bpmn:definitions xmlns:bpmn="http://www.omg.org/spec/BPMN/20100524/MODEL" xmlns:wf="http://hallowelt.com/schema/bpmn/wf">
    <bpmn:process id="SetTemplateParams-Process" isExecutable="false">
        <bpmn:extensionElements>
            <wf:context>
                <wf:contextItem name="pageId"/>
            </wf:context>
        </bpmn:extensionElements>
        <bpmn:startEvent id="TheStart">
            <bpmn:outgoing>FromTheStartToEditTemplate</bpmn:outgoing>
        </bpmn:startEvent>
        <bpmn:sequenceFlow id="FromTheStartToEditTemplate" sourceRef="TheStart" targetRef="EditTemplate" />
        <bpmn:task id="EditTemplate" name="Edit template">
            <bpmn:extensionElements>
                <wf:type>set_template_param</wf:type>
            </bpmn:extensionElements>
            <bpmn:property name="title" default="" validation="required,existing-title">{{FULLPAGENAME}}</bpmn:property>
            <bpmn:property name="user" default="WikiSysop" validation="existing-user">WikiSysop</bpmn:property>
            <!-- Index of the template on page (starting from 0) -->
            <bpmn:property name="template-index" default="0"/>
            <!-- Param to modify. Can be a string in case of named params, or a number, in case of non-named params (starting from 1, accessor for the param) -->
            <bpmn:property name="template-param" default="status"/>
            <!-- New value to set -->
            <bpmn:property name="value" default="Super edited param"/>
            <bpmn:property name="comment" default="Edited template param"/>
            <bpmn:property name="minor" default="1"/>
            <!-- Output properties -->
            <bpmn:property name="revisionId"/>
            <bpmn:property name="timestamp"/>
            <bpmn:incoming>FromTheStartToEditTemplate</bpmn:incoming>
            <bpmn:outgoing>FromEditTemplateToTheEnd</bpmn:outgoing>
        </bpmn:task>
        <bpmn:sequenceFlow id="FromEditTemplateToTheEnd" sourceRef="EditTemplate" targetRef="TheEnd" />
        <bpmn:endEvent id="TheEnd">
            <bpmn:incoming>FromEditTemplateToTheEnd</bpmn:incoming>
        </bpmn:endEvent>
    </bpmn:process>
</bpmn:definitions>



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

Keine Kategorien vergebenBearbeiten

Diskussionen