Handbuch:Erweiterung/Workflows/Activity/EditPage: Unterschied zwischen den Versionen

Keine Bearbeitungszusammenfassung
Keine Bearbeitungszusammenfassung
Zeile 4: Zeile 4:
! colspan="2" |Kurzprofil
! colspan="2" |Kurzprofil
|-
|-
|Name
!Name
|EditPage
|EditPage
|-
|-
|Async
!Async
|ja
|ja
|-
|-
|Hat Benutzerformular
!Hat Benutzerformular
|nein
|nein
|-
|-
|Input data
!BPMN type
|
|task
* title
* user
* content
* mode
* minor
|-
|-
|Output
!BPMN extension element "wf:type"
|
|edit page
* revisionId
* timestamp
|-
|BPMN Typ
|bpmn:task
|}
|}


== Attribute ==
==Attribute ==
 
===Eingabe===
{| class="wikitable" style="width: 100%;"
{| class="wikitable" style="width: 100%;"
!Name des Attributs
!Name des Attributs
!Quelle
!Quelle  
!Beschreibung
!Beschreibung
!Typ
! Typ
|-
|-
|<code>title</code>
|<code>title</code>
Zeile 42: Zeile 34:
|string
|string
|-
|-
|<code>user</code>
|<code>user</code>  
|
|
|Benutzer, der in die Revisionsgeschichte geschrieben wird
|Benutzer, der in die Revisionsgeschichte geschrieben wird
Zeile 52: Zeile 44:
|string
|string
|-
|-
|<code>mode</code>
|<code>mode</code>  
|
|
|Mögliche Werte:
|Mögliche Werte:


* ''append:'' Fügt den Text am Seitenende hinzu
*''append:'' Fügt den Text am Seitenende hinzu
* ''replace:'' Tauscht den Wert in der Seite aus
*''replace:'' Tauscht den Wert in der Seite aus
* ''prepend:'' Fügt den Text am Seitenanfang hinzu
*''prepend:'' Fügt den Text am Seitenanfang hinzu
|string
|string  
|-
|-
|<code>minor</code>
|<code>minor</code>
|
|
|Markiert die Version als kleine Änderung, falls der Wert auf "1" gesetzt ist
|Markiert die Version als kleine Änderung, falls der Wert auf "1" gesetzt ist  
|boolean
|boolean
|-
|-
|<code>revisionID</code>
| <code>revisionID</code>
|
|
|Neue Seitenrevisions-ID
|Neue Seitenrevisions-ID
|number
|number
|-
|<code>timestamp</code>
|
|timestamp
|}
===Ausgabe===
{| class="wikitable" style="width: 100%;"
!Name des Attributs
!Quelle
!Beschreibung
! Typ
|-
|<code>revisionID</code>
|
|Neue Seitenrevisions-ID
|number
|-
|-
|<code>timestamp</code>
|<code>timestamp</code>
Zeile 78: Zeile 87:
</div>
</div>


== Beispiel ==
==Beispiel==


=== Workflow-Aufgabe ===
===Workflow-Aufgabe===
Die Beispielaufgabe hängt am Ende der Seite <code>Testpage1</code> den Text This is my test at editing an. Gleichzeitig wird die Änderung in der Versionsgeschichte als [https://de.wikipedia.org/wiki/Hilfe:Kleine_%C3%84nderungen kleinere Änderung] markiert. Die Änderung wird in der Versionsgeschichte dem Benutzer <code>WikiSysop</code> zugeschrieben.
Die Beispielaufgabe hängt am Ende der Seite <code>Testpage1</code> den Text This is my test at editing an. Gleichzeitig wird die Änderung in der Versionsgeschichte als [https://de.wikipedia.org/wiki/Hilfe:Kleine_%C3%84nderungen kleinere Änderung] markiert. Die Änderung wird in der Versionsgeschichte dem Benutzer <code>WikiSysop</code> zugeschrieben.
  <code><bpmn:task id=<span class="hljs-string">"EditPage"</span> name=<span class="hljs-string">"Edit page"</span>>
  <<bpmn:task id=<span class="hljs-string">"EditPage"</span> name=<span class="hljs-string">"Edit page"</span>>
  <nowiki> </nowiki>  <bpmn:extensionElements>
  <nowiki> </nowiki>  <bpmn:extensionElements>
  <wf:type>edit_page</wf:type>
  <wf:type>edit_page</wf:type>
Zeile 93: Zeile 102:
  <bpmn:property name="revisionId"/>
  <bpmn:property name="revisionId"/>
  <bpmn:property name="timestamp"/>
  <bpmn:property name="timestamp"/>
  </bpmn:task></code>
  </bpmn:task>
Der Kommentar für die Revisionsgeschichte muss in der Systemnachricht MediaWiki:workflows-activity-editpage-summary angelegt sein. Existiert diese Seite nicht, so wird der Name der Systemnachricht angezeigt:
Der Kommentar für die Revisionsgeschichte muss in der Systemnachricht MediaWiki:workflows-activity-editpage-summary angelegt sein. Existiert diese Seite nicht, so wird der Name der Systemnachricht angezeigt:
[[Datei:EditPage Kommentar.png|alternativtext=Screenshot der Versiongeschichte der Seite Testpage1|zentriert|mini|750x750px|Der Kommentar in der Versionsgeschichte ist als Systemnachricht hinterlegt.]]
[[Datei:EditPage Kommentar.png|alternativtext=Screenshot der Versiongeschichte der Seite Testpage1|zentriert|mini|750x750px|Der Kommentar in der Versionsgeschichte ist als Systemnachricht hinterlegt.]]


=== Komplettes BPMN-Beispiel ===
===Komplettes BPMN-Beispiel===
<syntaxhighlight lang="xml">
<syntaxhighlight lang="xml">
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>

Version vom 18. Oktober 2023, 10:36 Uhr

Die Aktivität ermöglicht es, zu einer bestehenden Wikiseite Text hinzuzufügen.

Profil

Kurzprofil
Name EditPage
Async ja
Hat Benutzerformular nein
BPMN type task
BPMN extension element "wf:type" edit page

Attribute

Eingabe

Name des Attributs Quelle Beschreibung Typ
title Name der Zielseite, auf der der Text aus content eingefügt wird string
user Benutzer, der in die Revisionsgeschichte geschrieben wird user
content Text, der auf der Zielseite eingefügt wird string
mode Mögliche Werte:
  • append: Fügt den Text am Seitenende hinzu
  • replace: Tauscht den Wert in der Seite aus
  • prepend: Fügt den Text am Seitenanfang hinzu
string
minor Markiert die Version als kleine Änderung, falls der Wert auf "1" gesetzt ist boolean
revisionID Neue Seitenrevisions-ID number
timestamp timestamp

Ausgabe

Name des Attributs Quelle Beschreibung Typ
revisionID Neue Seitenrevisions-ID number
timestamp Datumsstempel der Revision timestamp

Beispiel

Workflow-Aufgabe

Die Beispielaufgabe hängt am Ende der Seite Testpage1 den Text This is my test at editing an. Gleichzeitig wird die Änderung in der Versionsgeschichte als kleinere Änderung markiert. Die Änderung wird in der Versionsgeschichte dem Benutzer WikiSysop zugeschrieben.

<<bpmn:task id="EditPage" name="Edit page">
    <bpmn:extensionElements>
		<wf:type>edit_page</wf:type>
	</bpmn:extensionElements>
	<bpmn:property name="title" default="Testpage1" validation="required"/>
	<bpmn:property name="user" default="WikiSysop" validation="existing-user"/>
	<bpmn:property name="content" default="This is my test at editing"/>
	<bpmn:property name="mode" default="append"/> 
	<bpmn:property name="minor" default="1"/>
	<bpmn:property name="revisionId"/>
	<bpmn:property name="timestamp"/>
</bpmn:task>

Der Kommentar für die Revisionsgeschichte muss in der Systemnachricht MediaWiki:workflows-activity-editpage-summary angelegt sein. Existiert diese Seite nicht, so wird der Name der Systemnachricht angezeigt:

Screenshot der Versiongeschichte der Seite Testpage1
Der Kommentar in der Versionsgeschichte ist als Systemnachricht hinterlegt.

Komplettes BPMN-Beispiel

<?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="EditPage-Workflow" isExecutable="false">
        <bpmn:extensionElements>
            <wf:context>
                <wf:contextItem name="pageId"/>
            </wf:context>
        </bpmn:extensionElements>
        <bpmn:startEvent id="TheStart">
            <bpmn:outgoing>FromTheStartToEditWikiPage</bpmn:outgoing>
        </bpmn:startEvent>
        <bpmn:sequenceFlow id="FromTheStartToEditPage" sourceRef="TheStart" targetRef="EditPage" />
       <bpmn:task id="EditPage" name="Edit page">
    <bpmn:extensionElements>
		<wf:type>edit_page</wf:type>
	</bpmn:extensionElements>
	<bpmn:property name="title" default="Testpage1" validation="required"/>
	<bpmn:property name="user" default="{{#username:WikiSysop}}" validation="existing-user"/>
	<bpmn:property name="content" default="I have read this page"/>
	<bpmn:property name="mode" default="append"/> <!-- ALlowed: append, replace, prepend -->
	<bpmn:property name="minor" default="0"/>
	<!-- Output properties -->
	<bpmn:property name="revisionId"/>
	<bpmn:property name="timestamp"/>
	  <bpmn:incoming>FromTheStartToEditPage</bpmn:incoming>
	  <bpmn:outgoing>FromEditPageToTheEnd</bpmn:outgoing>
</bpmn:task>
        <bpmn:sequenceFlow id="FromEditPageToTheEnd" sourceRef="EditPage" targetRef="TheEnd" />
        <bpmn:endEvent id="TheEnd">
            <bpmn:incoming>FromEditPageToTheEnd</bpmn:incoming>
        </bpmn:endEvent>
    </bpmn:process>
</bpmn:definitions>




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

Keine Kategorien vergebenBearbeiten

Diskussionen