Difference between revisions of "Reference:ContentTransfer"
(Created page with "{{BSExtensionInfobox |desc=Copies new or existing wiki pages into a different wiki. (v3.2 and up) |status=stable |developer=HalloWelt |type=BlueSpice |edition=BlueSpice F...") (Tag: 2017 source edit) |
(Tag: Visual edit) |
Extension: ContentTransfer
Overview | |||
---|---|---|---|
Description: | Copies new or existing wiki pages into a different wiki. (v3.2 and up) | ||
State: | stable | Dependency: | BlueSpice |
Developer: | HalloWelt | License: | GPL v3 |
Type: | Category: | Qualitätssicherung"Qualitätssicherung" is not in the list (Administration, Editor, Export, Mobile, Reporting, Skinning, Book, Communication, Infrastructure, Personalization, ...) of allowed values for the "BSExtensionInfoCategory" property.Quality Assurance | |
Edition: | BlueSpice Farm | ||
Features[edit source]
The extension MergeArticles makes it possible to merge two corresponding wiki pages in different wiki instances.
ContentTransfer copies new or existing wiki pages in a different wiki on the same farm.
Usage / Features[edit | edit source]
Users can copy up to 200 pages per transfer form one wiki to the same namespace in a selected target wiki.
Technical information[edit | edit source]
Configuration[edit | edit source]
To setup the "Push and Merge" mechanism for wiki instances within the farm you need the following information:
- <source-instance-name>
-
The name of the Wiki instance that acts as the source of the "push". This must be the directory name from
/opt/mediawiki/w/_sf_instances/
- <target-instance-name>
-
The name of the Wiki instance that acts as the target of the "push". This must be the directory name from
/opt/mediawiki/w/_sf_instances/
- <servername>
- <username-provided-by>
-
A user name in form of
<username>@<id>
. Must first be generated using Special:BotPasswords on the target instance - <password-provided-by>
- An automatically generated password of that particular user
When provided with the required information, please open the file /opt/mediawiki/w/_sf_instances/<source-instance-name>/LocalSettings.custom.php
and add
$wgContentTransferTargets['<target-instance-name>'] = [ "url" => "https://<servername>/<target-instance-name>/api.php", "user" => "<username-provided-by>", "password" => "<password-provided-by", "draftNamespace" => "Draft", "pushToDraft" => true, "displayText" => "<target-instance-name>", ];
Additional settings:
$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
Rights (permissions)[edit | edit source]
Requirements[edit | edit source]
ContentTransfer requires BlueSpiceFoundation. To merge wiki pages that already exist in the target namespace, the extension MergeArticles is necessary.
{{BSExtensionInfobox |desc=Copies new or existing wiki pages into a different wiki. (v3.2 and up) |status=stable |developer=HalloWelt |type=BlueSpice |edition=BlueSpice Farm |active=No |compatible=BlueSpice |category=Qualitätssicherung Quality Assurance |license=GPL v3 }}The extension '''MergeArticles''' makes it possible to merge two corresponding wiki pages in different wiki instances. ContentTransfer copies new or existing wiki pages in a different wiki on the same farm. ==Usage / Features== Users can copy up to 200 pages per transfer form one wiki to the same namespace in a selected target wiki. ==Technical information== ===Configuration=== To setup the "Push and Merge" mechanism for wiki instances within the farm you need the following information: ; <source-instance-name> : The name of the Wiki instance that acts as the source of the "push". This must be the directory name from <code>/opt/mediawiki/w/_sf_instances/</code> ; <target-instance-name> : The name of the Wiki instance that acts as the target of the "push". This must be the directory name from <code>/opt/mediawiki/w/_sf_instances/</code> ; <servername> ; <username-provided-by> : A user name in form of <code><username>@<id></code>. Must first be generated using [https://wiki.hallowelt.com/wiki/Spezial:BotPasswords Special:BotPasswords] on the '''target instance''' ; <password-provided-by> : An automatically generated password of that particular user When provided with the required information, please open the file <code>/opt/mediawiki/w/_sf_instances/<source-instance-name>/LocalSettings.custom.php</code> and add <span class="nv">$wgContentTransferTargets</span><span class="p">[</span><span class="s1">'<target-instance-name>'</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span> <span class="s2">"url"</span> <span class="o">=></span> <span class="s2">"https://<servername>/<target-instance-name>/api.php"</span><span class="p">,</span> <span class="s2">"user"</span> <span class="o">=></span> <span class="s2">"<username-provided-by>"</span><span class="p">,</span> <span class="s2">"password"</span> <span class="o">=></span> <span class="s2">"<password-provided-by"</span><span class="p">,</span> <span class="s2">"draftNamespace"</span> <span class="o">=></span> <span class="s2">"Draft"</span><span class="p">,</span> <span class="s2">"pushToDraft"</span> <span class="o">=></span> <span class="k">true</span><span class="p">,</span> <span class="s2">"displayText"</span> <span class="o">=></span> <span class="s2">"<target-instance-name>"</span><span class="p">,</span> <span class="p">];</span> Additional settings: <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> ===Rights (permissions)=== ===Requirements=== {{PAGENAME}} requires [[Reference:BlueSpiceFoundation|BlueSpiceFoundation]]. To merge wiki pages that already exist in the target namespace, the extension [[Reference:MergeArticles|MergeArticles]] is necessary. [[Category:Extension]]
Line 7: | Line 7: | ||
|active=No | |active=No | ||
|compatible=BlueSpice | |compatible=BlueSpice | ||
− | |category= | + | |category=Quality Assurance |
|license=GPL v3 | |license=GPL v3 | ||
− | }} | + | }}ContentTransfer copies new or existing wiki pages in a different wiki on the same farm. |
− | |||
− | ContentTransfer copies new or existing wiki pages in a different wiki on the same farm. | ||
==Usage / Features== | ==Usage / Features== | ||
Users can copy up to 200 pages per transfer form one wiki to the same namespace in a selected target wiki. | Users can copy up to 200 pages per transfer form one wiki to the same namespace in a selected target wiki. | ||
Line 19: | Line 17: | ||
To setup the "Push and Merge" mechanism for wiki instances within the farm you need the following information: | To setup the "Push and Merge" mechanism for wiki instances within the farm you need the following information: | ||
− | ; <source-instance-name> | + | ;<source-instance-name> |
− | : The name of the Wiki instance that acts as the source of the "push". This must be the directory name from <code>/opt/mediawiki/w/_sf_instances/</code> | + | :The name of the Wiki instance that acts as the source of the "push". This must be the directory name from <code>/opt/mediawiki/w/_sf_instances/</code> |
− | ; <target-instance-name> | + | ;<target-instance-name> |
− | : The name of the Wiki instance that acts as the target of the "push". This must be the directory name from <code>/opt/mediawiki/w/_sf_instances/</code> | + | :The name of the Wiki instance that acts as the target of the "push". This must be the directory name from <code>/opt/mediawiki/w/_sf_instances/</code> |
− | ; <servername> | + | ;<servername> |
− | ; <username-provided-by> | + | ;<username-provided-by> |
− | : A user name in form of <code><username>@<id></code>. Must first be generated using [https://wiki.hallowelt.com/wiki/Spezial:BotPasswords Special:BotPasswords] on the '''target instance''' | + | :A user name in form of <code><username>@<id></code>. Must first be generated using [https://wiki.hallowelt.com/wiki/Spezial:BotPasswords Special:BotPasswords] on the '''target instance''' |
− | ; <password-provided-by> | + | ;<password-provided-by> |
− | : An automatically generated password of that particular user | + | :An automatically generated password of that particular user |
When provided with the required information, please open the file <code>/opt/mediawiki/w/_sf_instances/<source-instance-name>/LocalSettings.custom.php</code> and add | When provided with the required information, please open the file <code>/opt/mediawiki/w/_sf_instances/<source-instance-name>/LocalSettings.custom.php</code> and add |