Handbuch:Erweiterung/FlaggedRevs und Referenz:ContentTransfer: Unterschied zwischen den Seiten

(Unterschied zwischen Seiten)
Keine Bearbeitungszusammenfassung
 
K (Textersetzung - „Box Note“ durch „Hinweisbox“)
 
Zeile 1: Zeile 1:
{{DISPLAYTITLE:Seitenfreigaben}}
{{BSExtensionInfobox
|desc=Kopiert Wikiseiten in ein Zielwiki. (ab v3.2)
|status=stable
|developer=HalloWelt
|type=BlueSpice
|edition=BlueSpice Farm (deaktiviert)
|active=Nein
|compatible=BlueSpice
|category=Qualitätssicherung
|license=GPL v3
}}
'''ContentTransfer''' kopiert neue oder existierende Wikiseiten in ein anderes Wiki.


Die Erweiterung '''FlaggedRevs''' ist eine MediaWiki-Erweiterung, die einen Freigabemechanismus aktiviert. Neue Versionen einer Seite werden zunächst als Entwürfe markiert. Diese bleiben so lange bestehen, bis ein Benutzer mit Freigaberechten die Seite überprüft und genehmigt.
Benutzer mit der entsprechenden Berechtigung können bis zu 200 Seiten pro Transfer von einem Wiki in den gleichen Namensraum eines Zielwikis kopieren.  
==Seitenfreigabe aktivieren==
Die Aktivierung von Entwürfen erfolgt über die Namensraumverwaltung. Ein Benutzer mit Administratorrechten überprüft, ob ''Freigabe'' für einen Namensraum aktiviert ist. Dies geschieht unter ''Globale Aktionen > Verwaltung > Namensraumverwaltung''. Klicken Sie auf das Bearbeitungssymbol (Schraubenschlüssel) in der Spalte ''Aktionen''. Der Namensraumdialog öffnet sich. Wählen Sie Freigabe und klicken Sie auf ''Fertig''.
[[Datei:Handbuch:freigabe-namensraum.png|zentriert|mini|450x450px|Freigabe für einen Namensraum aktivieren|alternativtext=Freigabe für einen Namensraum aktivieren]]
===Bestehende Seiten===
Wenn die ''Freigabe'' für einen Namensraum aktiviert wurde, werden alle bereits bestehenden Seiten im Namensraum in den Entwurfsmodus versetzt. Die Seiten sind nun alle im Status ''Erstentwurf.''[[Datei:Handbuch:flaggedrevs-erstentwurf.png|zentriert|300x300px|mini|Erstentwurf|alternativtext=Erstentwurf]]Auf jeder Seite mit Freigabefunktion wird der Seitenstatus im Titelbereich angezeigt.


===Neue Seiten===
Je nach Einstellungen, die über die Spezialseite ContentTransfer, ausgewählt wurden, werden folgende Dateien kopiert:
Wenn eine neue Seite erstellt und zum ersten Mal gespeichert wird, wird sie als Erstentwurf angezeigt. Wenn Sie zuerst keine Informationen auf der Seite anzeigen möchten, speichern Sie die neue Seite einfach leer oder mit einer kurzen Benachrichtigung (z. B. ''In Bearbeitung'') und veröffentlichen Sie den Erstentwurf. Arbeiten Sie anschließend im Hintergrund an der Entwurfsseite weiter. Benutzern wird dann zuerst die freigegebene Version angezeigt. Ein Wechsel zur Entwurfsversion ist jedoch allen Benutzern möglich (Ausnahme: In der Konfigurationsverwaltung wurden die Benutzergruppen, die Entwürfe sehen können eingeschränkt. In diesem Fall können auch die Erstentwürfe nur von den berechtigten Gruppen gelesen werden).


Wenn eine Seite im Entwurfsmodus mehrmals bearbeitet und gespeichert wird, wird jede Bearbeitung im Versionsverlauf protokolliert:<br />[[Datei:Handbuch:flaggedrevs-revisions.png|zentriert|650x650px|mini|Entwurfsversionen in der Versionsgeschichte|alternativtext=Entwurfsversionen in der Versionsgeschichte]]
*die ausgewählten Wikiseiten
*die verbundenen Kategorienseiten
*die Buchseite, die mit Wikiseiten verbunden ist
*die Vorlagen, die mit Wikiseiten verbunden sind
*angehängte Dateien<br />


==Technische Information==
{{Hinweisbox|boxtype=important|Note text=Die Erweiterung ist standardmäßig deaktiviert und muss erst in der 060-ContentTransfer unter settings.d - oder in der LocalSettings.custom.php im Installationsordner aktiviert werden (also nicht nur in einer einzelnen Farm-Instanz).


Entwürfe sind in der Versionsgeschichte umrahmt und gelb hervorgehoben. Zusätzlich sind sie mit "Freigabe ausstehend" markiert.
wfLoadExtension('ContentTransfer');}}
===Konfiguration===
Folgende Information ist nötig, um Seiten zwischen Wikis zu transferieren:


==Akzeptieren einer Seite==
'''<source-instance-name>'''
Benutzer mit Freigaberechten können Seitenentwürfe automatisch akzeptieren, wenn sie eine Seite speichern. Im Dialogfenster zum Speichern gibt es hierfür das Kontrollkästchen ''Diese Version akzeptieren'':<br />
[[Datei:Handbuch:fff.png|zentriert|650x650px|mini|Seitenfreigabe beim Speichern]]


Name des Quellwikis. Dies muss der Ordnername aus <code>/opt/mediawiki/w/_sf_instances/</code> sein.


Wenn die Seite beim Speichern nicht akzeptiert wird, kann sie später unabhängig vom Bearbeitungsprozess akzeptiert werden.
'''<target-instance-descriptive-name>'''


Ein Benutzer mit Freigaberechten kann die Seite mit der Freigabefunktion im Titelbereich der Seite schnell akzeptieren. Der Entwurfshinweis zeigt die Option ''Freigeben'' an:
Beschreibungsname des Zielwikis. Das ist normalerweise der Name der Instanz (also <target-instance-name>), kann aber zur besseren Verständlichkeit frei gewählt werden. Kann keine Leerzeichen enthalten.
<br />
[[Datei:Handbuch:Seite freigeben.png|zentriert|277x277px|mini|Seitenfreigabe über den Titelbereich]]


'''<target-instance-name>'''


<br />Hinterläßt der Begutachter einen Kommentar, dann wird diese im Versionsverlauf der Seite angezeigt. Nachdem die Seite freigegeben wurde, wird dies entsprechend im Titelbereich angezeigt.<br />[[Datei:Handbuch:a2.png|zentriert|650x650px|mini|Freigegebene Seite]]
Name der Zielwiki-Instanz.
Dies muss der Ordnername aus <code>/opt/mediawiki/w/_sf_instances/</code> sein. Der Name läßt sich auch aus der url der Wiki-Instanz auslesen.


== Leserechte für Entwürfe==
'''<target-instance-label>'''
Standardmäßig können alle Benutzer die Entwürfe einer Seite sehen, also auch Benutzer mit Leserechten.


Um Entwürfe vor Lesern zu verbergen, muss die Gruppe ''user'' aus der Konfiguration entfernt werden. Ein Administrator löscht die Gruppe aus der Konfiguration unter  "Entwurfsversionen für die folgenden Gruppen anzeigen" unter ''Globale Aktionen > Verwaltung > Konfigurationsverwaltung'':
Der Anzeigename für das Zielwiki (kann auch Leerzeichen enthalten). Diese Angabe ist optional und kann auskommentiert werden.
<br />
[[Datei:Handbuch:Konfi.png|zentriert|650x650px|mini|Benutzergruppen für Entwürfe festlegen]]
<br />{{Hinweisbox|boxtype=warning|Note text=Wenn die Gruppe ''user'' aus der Konfiguration ''BlueSpiceFlaggedRevs'' entfernt wird, können Benutzer in dieser Gruppe Entwurfsversionen auch dann nicht sehen, wenn sie als Begutachter in einem Begutachtungsprozess bestimmt werden.}}


Wenn die Gruppe Benutzer entfernt wird, können nur Benutzer mit der Berechtigung ''sysop'' und ''reviewer'' auf Entwürfe zugreifen. Wenn Sie möchten, dass andere Gruppen, z. B. Editoren, Entwurfsversionen anzeigt bekommen, müssen Sie diese zur Konfiguration hinzufügen und speichern.
'''<servername>'''


<br />Die beiden Kontrollkästchen ''Seite automatisch als freigegeben markieren...'' (bis Version 3.1.) und ''Begutachtung einer Seite löschen ...''.legen fest, wie ein [[Handbuch:Erweiterung/BlueSpiceReview|Begutachtungsprozess]] für eine Seite mit Entwurfsversionen beendet wird. Eine Seite kann dann automatisch von einem Begutachtungsprozess freigegeben und der Workflow automatisch gelöscht werden.
Server-url
{{Hinweisbox|boxtype=note|Note text=Wenn im Konfigurationsfeld keine Benutzergruppen angegeben sind, sehen nicht einmal Überprüfer und Sysop-Benutzer eine visuelle Statusanzeige einer Seite. Sie haben stattdessen Zugriff auf Entwürfe über den Revisionsverlauf einer Seite.}}
Benutzer mit Bearbeitungsrechten erhalten eine Benachrichtigung, dass Seitenänderungen für die Seite ausstehen, wenn sie die Seite bearbeiten.
<br />
[[Datei:Handbuch:a3.png|zentriert|550x550px|Hinweis zum Entwurfsstatus einer Seite]]


==Änderungen an Vorlagen und eingebetteten Dateien==
'''<<span class="mw-lingo-term ve-pasteProtect" data-lingo-term-id="fabcaa97871555b68aa095335975e613" data-hasqtip="2" style="box-sizing: inherit; border-bottom: 1px dotted rgb(187, 187, 255); cursor: default;" data-ve-attributes="{&quot;style&quot;:&quot;box-sizing: inherit; border-bottom: 1px dotted rgb(187, 187, 255); cursor: default;&quot;}">bot</span>-username-provided>'''
Wenn eine Seite Vorlagen verwendet oder andere Dateien wie Bilder und eingebettete PDFs enthält und diese nach der Seitenfreigabe verändert wurden, wird dies entsprechend im Freigabestatus der Statusleiste angezeigt.
[[Datei:Referenz:Bot permissions.png|alternativtext=Bot-Berechtigungen|mini|Bot-Berechtigungen]]
<br />
Ein Benutzername in Form von <code style="box-sizing: inherit; font-family: monospace, Courier; font-size: 13.5px; padding: 1px 4px; color: black; background-color: rgb(249, 249, 249); border-radius: 2px; border: 1px solid rgb(221, 221, 221);" data-ve-attributes="{&quot;style&quot;:&quot;box-sizing: inherit; font-family: monospace, Courier; font-size: 13.5px; padding: 1px 4px; color: black; background-color: rgb(249, 249, 249); border-radius: 2px; border: 1px solid rgb(221, 221, 221);&quot;}"><username>@<id></code>.
Liegen die eingebetteten Ressourcen in einem Namensraum ohne eigene Freigabefunktion, so wird in der freigegebenen Version der Seite die Ressourcenversion zum Zeitpunkt der Seitenfreigabe angezeigt. Die Entwurfsversion zeigt entsprechend die aktuellste Version der eingebetteten Ressource.
Um die Ressourcenänderung freizugeben, muss diese auf der Seite freigegeben werden. Dies erzeugt eine neue freigegebene Seitenversion.
===Anzeigeeinstellungen für Ressourcen auf freigegebenen Seiten===
Es ist über  Serverkonfiguration möglich, eingebettete Ressourcen (also Dateien, Vorlagen, oder transkludierte Inhalte), die nach der Seitenfreigabe geändert werden, in einer bestimmten Version darzustellen. Folgende Möglichkeiten existieren:
{| class="wikitable" style="width:100%;"
|+
!Einstellung
!Verhalten
|-
|FR_INCLUDES_STABLE
|Zeigt immer die letzte freigegebene Version der Ressource an, auch wenn diese nach der Seitenfreigabe entstanden ist (gilt nur, wenn die Ressource in einem Namensraum mit Freigabefunktion ist).
|-
|FR_INCLUDES_CURRENT
|Zeigt in jedem Fall die aktuellste Version der Ressource an.
|}
==Auswirkungen auf semantische Attribute ==
Wenn in einem Namensraum gleichzeitig mit der Seitenfreigabe auch [[Handbuch:Semantic MediaWiki|Semantic MediaWiki]] aktiviert ist, sind je nach Freigabestatus der Seite folgende Attribute für SMW-Abfragen verfügbar:
{| class="wikitable" style="width:100%;"
!Seitenstatus
! Verfügbare Attribute
|-
|Erstentwurf
|Aktuelle Werte
|-
|Freigegeben
|Aktuelle Werte
|-
|Entwurf
|Werte der freigegebenen Version (Standardeinstellung)
|-
|Impliziter Entwurf
(Änderungen an eingebunden Ressourcen)
|Werte der freigegebenen Version
|}


Der Bot-Benutzer wird im Zielwiki auf der Seite <code style="box-sizing: inherit; font-family: monospace, Courier; font-size: 13.5px; padding: 1px 4px; color: black; background-color: rgb(249, 249, 249); border-radius: 2px; border: 1px solid rgb(221, 221, 221);" data-ve-attributes="{&quot;style&quot;:&quot;box-sizing: inherit; font-family: monospace, Courier; font-size: 13.5px; padding: 1px 4px; color: black; background-color: rgb(249, 249, 249); border-radius: 2px; border: 1px solid rgb(221, 221, 221);&quot;}">Special:BotPasswords</code> angelegt. Klicken Sie "Erstellen". Danach wird eine Seite mit den Bot-Berechtigungen angezeigt. Aktivieren Sie folgende Einstellungen:


*Massenbearbeitungen
*Vorhandene Seiten bearbeiten
*Geschützte Seiten bearbeiten
*Seiten erstellen, bearbeiten, verschieben
*Neue Dateien hochladen
*Dateien hochladen, ersetzten und verschieben


Die Darstellung der semantischen Attribute wird über folgende Einstellung bestimmt:<syntaxhighlight lang="text">
'''<bot-password-provided>'''
$bsgFlaggedRevsConnectorStabilizeSMWPropertyValues = true;
</syntaxhighlight>Über ''LocalSettings.php'' im Serverdateisystem kann  dieser Wert auf ''false'' gesetzt werden. Dies bewirkt, dass bei Entwurfsseiten die Attributswerte der Entwurfsversion abgefragt werden.


==Qualitätsmanagement Überblick==
Das Passwort wird im Wiki generiert und muss dann entsprechend verwendet werden.
Die Spezialseite ''Spezial:Qualitätsmanagement_Überblick'' ermöglicht es Benutzern mit Admin- oder Reviewer-Rechten, den Freigabestatus aller Wikiseiten zu sehen und entsprechend zu filtern.
 
<br />[[Datei:Handbuch:qm-overview-DE.png|zentriert|mini|650x650px|Spezialseite Qualitätsmanagement Überblick]]
Mit der nötigen Info öffnen Sie  <code>/opt/mediawiki/w/_sf_instances/<source-instance-name>/LocalSettings.custom.php</code> . Fügen Sie folgenden Block hinzu:
{{Box Links
<span class="nv">$wgContentTransferTargets</span><span class="p">[</span><span class="s1">'<target-instance-descriptive-name>'</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span>
|Thema2=[[Referenz:FlaggedRevs]]
    <span class="s2">"url"</span> <span class="o">=></span> <span class="s2">"https://<servername>/<target-instance-name>/api.php"</span><span class="p">,</span>
|Thema1=[[Qualitätsmanagement|Qualitätsmanagementwerkzeuge]]
    <span class="s2">"user"</span> <span class="o">=></span> <span class="s2">"<bot-username-provided>"</span><span class="p">,</span>
|Thema3=[[Referenz:BlueSpiceFlaggedRevsConnector]]}}  
    <span class="s2">"password"</span> <span class="o">=></span> <span class="s2">"<bot-password-provided>"</span><span class="p">,</span>
[[de:{{FULLPAGENAME}}]]
    <span class="s2">"draftNamespace"</span> <span class="o">=></span> <span class="s2">"Draft"</span><span class="p">,</span>
[[en:Manual:Extension/FlaggedRevisions]]
    <span class="s2">"pushToDraft"</span> <span class="o">=></span> <span class="k">true</span><span class="p">,</span>
[[Category:Qualität]]
    <span class="s2">"displayText"</span> <span class="o">=></span> <span class="s2">"<target-instance-label>"</span><span class="p">,</span>
<references />
<span class="p">];</span>
Wenn ContentTransfer ohne die Erweiterung [[Referenz:MergeArticles|MergeArticles]] benutzt wird, müssen die entsprechenden Angaben zu "Drafts" deaktiviert werden:<syntaxhighlight lang="text">
# "draftNamespace" => "Draft",
"pushToDraft" => false,
</syntaxhighlight>Beispiel:<syntaxhighlight>
$wgContentTransferTargets['MeinWiki'] = [
    "url" => "http://172.16.200.23/MeinWikiName/api.php",
    "user" => "Snow@Schneewittchen",
    "password" => "uuicqdv9mubfrepbpqu1bvsl5957cpa9",
#  "draftNamespace" => "Draft",
    "pushToDraft" => false,
    "displayText" => "Mein Wiki",
];
</syntaxhighlight>{{Hinweisbox|boxtype=note|Note text=Nach der Konfiguration muß die Datei update.php ausgeführt werden.}}
 
=== Zusätzliche Einstellungen ===
<span class="nv">$wgContentTransferIgnoreInsecureSSL</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span> <span class="c1">// Ignore invalid SSL certificates (for test systems)</span>
<span class="nv">$wgContentTransferPageLimit</span> <span class="o">=</span> <span class="mi">200</span><span class="p">;</span> <span class="c1">// Max number of pages to be allowed at one</span>
<span class="nv">$wgContentTransferOnlyContentNamespaces</span> <span class="o">=</span> <span class="k">true</span><span class="p">;</span> <span class="c1">// Only allow content namespaces to be selected in filters</span>
<span class="nv">$wgContentTransferAllowTalkNamespaces</span> <span class="o">=</span> <span class="k">false</span><span class="p">;</span> <span class="c1">// Allow talk namespaces to be selected in filters</span>
 
===Anforderungen===
{{PAGENAME}} benötigt [[Referenz:BlueSpiceFoundation|BlueSpiceFoundation]]. Bereits im Zielwiki existierende Seiten können optional über [[Referenz:MergeArticles|MergeArticles]] zusammengeführt werden.<br />
 
{{Translation}}
[[Category:Extension]]

Version vom 19. Januar 2022, 10:05 Uhr

Erweiterung: ContentTransfer

alle Erweiterungen

Übersicht
Beschreibung: Kopiert Wikiseiten in ein Zielwiki. (ab v3.2)
Status: stable Abhängigkeit: BlueSpice
Entwickler: HalloWelt Lizenz: GPL v3
Typ: BlueSpice Kategorie: Qualitätssicherung
Edition: BlueSpice Farm (deaktiviert) Version:

Funktionen / Anwendung[Bearbeiten | Quelltext bearbeiten]

ContentTransfer kopiert neue oder existierende Wikiseiten in ein anderes Wiki.

Benutzer mit der entsprechenden Berechtigung können bis zu 200 Seiten pro Transfer von einem Wiki in den gleichen Namensraum eines Zielwikis kopieren.

Je nach Einstellungen, die über die Spezialseite ContentTransfer, ausgewählt wurden, werden folgende Dateien kopiert:

  • die ausgewählten Wikiseiten
  • die verbundenen Kategorienseiten
  • die Buchseite, die mit Wikiseiten verbunden ist
  • die Vorlagen, die mit Wikiseiten verbunden sind
  • angehängte Dateien

Technische Information[Bearbeiten | Quelltext bearbeiten]

Wichtig!Die Erweiterung ist standardmäßig deaktiviert und muss erst in der 060-ContentTransfer unter settings.d - oder in der LocalSettings.custom.php im Installationsordner aktiviert werden (also nicht nur in einer einzelnen Farm-Instanz). wfLoadExtension('ContentTransfer');

Konfiguration[Bearbeiten | Quelltext bearbeiten]

Folgende Information ist nötig, um Seiten zwischen Wikis zu transferieren:

<source-instance-name>

Name des Quellwikis. Dies muss der Ordnername aus /opt/mediawiki/w/_sf_instances/ sein.

<target-instance-descriptive-name>

Beschreibungsname des Zielwikis. Das ist normalerweise der Name der Instanz (also <target-instance-name>), kann aber zur besseren Verständlichkeit frei gewählt werden. Kann keine Leerzeichen enthalten.

<target-instance-name>

Name der Zielwiki-Instanz. Dies muss der Ordnername aus /opt/mediawiki/w/_sf_instances/ sein. Der Name läßt sich auch aus der url der Wiki-Instanz auslesen.

<target-instance-label>

Der Anzeigename für das Zielwiki (kann auch Leerzeichen enthalten). Diese Angabe ist optional und kann auskommentiert werden.

<servername>

Server-url

<bot-username-provided>

Ein Benutzername in Form von <username>@<id>.

Der Bot-Benutzer wird im Zielwiki auf der Seite Special:BotPasswords angelegt. Klicken Sie "Erstellen". Danach wird eine Seite mit den Bot-Berechtigungen angezeigt. Aktivieren Sie folgende Einstellungen:

  • Massenbearbeitungen
  • Vorhandene Seiten bearbeiten
  • Geschützte Seiten bearbeiten
  • Seiten erstellen, bearbeiten, verschieben
  • Neue Dateien hochladen
  • Dateien hochladen, ersetzten und verschieben

<bot-password-provided>

Das Passwort wird im Wiki generiert und muss dann entsprechend verwendet werden.

Mit der nötigen Info öffnen Sie /opt/mediawiki/w/_sf_instances/<source-instance-name>/LocalSettings.custom.php . Fügen Sie folgenden Block hinzu:

$wgContentTransferTargets['<target-instance-descriptive-name>'] = [
    "url" => "https://<servername>/<target-instance-name>/api.php",
    "user" => "<bot-username-provided>",
    "password" => "<bot-password-provided>",
    "draftNamespace" => "Draft",
    "pushToDraft" => true,
    "displayText" => "<target-instance-label>",
];

Wenn ContentTransfer ohne die Erweiterung MergeArticles benutzt wird, müssen die entsprechenden Angaben zu "Drafts" deaktiviert werden:

# "draftNamespace" => "Draft", 
"pushToDraft" => false,

Beispiel:

$wgContentTransferTargets['MeinWiki'] = [
    "url" => "http://172.16.200.23/MeinWikiName/api.php",
    "user" => "Snow@Schneewittchen",
    "password" => "uuicqdv9mubfrepbpqu1bvsl5957cpa9",
 #  "draftNamespace" => "Draft",
    "pushToDraft" => false,
    "displayText" => "Mein Wiki",
];
Hinweis:Nach der Konfiguration muß die Datei update.php ausgeführt werden.


Zusätzliche Einstellungen[Bearbeiten | Quelltext bearbeiten]

$wgContentTransferIgnoreInsecureSSL = false; // Ignore invalid SSL certificates (for test systems)
$wgContentTransferPageLimit = 200; // Max number of pages to be allowed at one 
$wgContentTransferOnlyContentNamespaces = true; // Only allow content namespaces to be selected in filters
$wgContentTransferAllowTalkNamespaces = false; // Allow talk namespaces to be selected in filters

Anforderungen[Bearbeiten | Quelltext bearbeiten]

ContentTransfer benötigt BlueSpiceFoundation. Bereits im Zielwiki existierende Seiten können optional über MergeArticles zusammengeführt werden.




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

Diskussionen