Pwirth has submitted this change and it was merged.

Change subject: Checklist: Improved tag documentation
......................................................................


Checklist: Improved tag documentation

New tag description. Thanks to Sabine Gürtler and Anja Ebersbach.

Change-Id: I1ebf3d437cfc426e5d57aa599a193d66ca2498b7
---
M Checklist/Checklist.class.php
M Checklist/i18n/en.json
M Checklist/i18n/qqq.json
3 files changed, 17 insertions(+), 14 deletions(-)

Approvals:
  Pwirth: Looks good to me, approved
  Raimond Spekking: Looks good to me, but someone else must approve
  jenkins-bot: Verified



diff --git a/Checklist/Checklist.class.php b/Checklist/Checklist.class.php
index f8cbfc1..c2d528d 100644
--- a/Checklist/Checklist.class.php
+++ b/Checklist/Checklist.class.php
@@ -160,18 +160,23 @@
        public function onBSInsertMagicAjaxGetData( &$oResponse, $type ) {
                if( $type != 'tags' ) return true;
 
-               $aMessage = array();
-               $aMessage[] = wfMessage( 'bs-checklist-tag-checklist-desc' 
)->plain().'<br />';
-               $aMessage[] = wfMessage( 
'bs-checklist-tag-checklist-param-type' )->plain();
-               $aMessage[] = wfMessage( 
'bs-checklist-tag-checklist-param-list' )->plain();
-               $aMessage[] = wfMessage( 
'bs-checklist-tag-checklist-param-value' )->plain();
-
                $oResponse->result[] = array(
                        'id' => 'bs:checklist',
                        'type' => 'tag',
                        'name' => 'checklist',
-                       'desc' => implode( '<br />', $aMessage ),
+                       'desc' => wfMessage( 'bs-checklist-tag-checklist-desc' 
)->text(),
                        'code' => '<bs:checklist />',
+                       'examples' => array(
+                               array(
+                                       'label' => wfMessage( 
'bs-checklist-tag-checklist-example-check' )->text(),
+                                       'code' => '<bs:checklist type="check" 
value="checked" />'
+                               ),
+                               array(
+                                       'label' => wfMessage( 
'bs-checklist-tag-checklist-example-list' )->text(),
+                                       'code' => '<bs:checklist type="list" 
value="false" list="Status" />'
+                               ),
+                       ),
+                       'helplink' => 
'https://help.bluespice.com/index.php/Checklist'
                );
 
                return true;
diff --git a/Checklist/i18n/en.json b/Checklist/i18n/en.json
index 36c329d..7382dac 100644
--- a/Checklist/i18n/en.json
+++ b/Checklist/i18n/en.json
@@ -11,10 +11,9 @@
        "bs-checklist-menu-insert-checkbox": "Checkbox",
        "bs-checklist-dlg-insert-list-title": "Insert a checklist",
        "bs-checklist-dlg-insert-list-value-list": "Value list",
-       "bs-checklist-tag-checklist-desc": "Renders a checkbox or select field. 
Available configuration attributes:",
-       "bs-checklist-tag-checklist-param-type": "<code>type</code>: 
<code>list</code> renders a select list.",
-       "bs-checklist-tag-checklist-param-list": "<code>list</code>: Name of 
the template with the available values. Parameter <code>type</code> must be set 
to <code>list</code>.",
-       "bs-checklist-tag-checklist-param-value": "<code>value</code>: 
<code>checked</code> or a value out of the list template.",
+       "bs-checklist-tag-checklist-desc": "Generates a checkbox or a select 
menu. The checklist can be modified by various parameters.",
+       "bs-checklist-tag-checklist-example-check": "Checkbox",
+       "bs-checklist-tag-checklist-example-list": "Select menu",
        "bs-checklist-dlg-new-list": "Create a new list",
        "bs-checklist-dlg-save-list": "Save changes to list",
        "bs-checklist-dlg-items-label" : "Items in list",
diff --git a/Checklist/i18n/qqq.json b/Checklist/i18n/qqq.json
index 3cc22ea..ec38efa 100644
--- a/Checklist/i18n/qqq.json
+++ b/Checklist/i18n/qqq.json
@@ -15,9 +15,8 @@
        "bs-checklist-dlg-insert-list-title": "Title for insert checklist 
dialogue",
        "bs-checklist-dlg-insert-list-value-list": "Label for value 
list\n{{Identical|Value list}}",
        "bs-checklist-tag-checklist-desc": "Text for renders a checkbox or 
select field. Available configuration attributes:\n{{Related|Bs-tag-desc}}",
-       "bs-checklist-tag-checklist-param-type": "Text for <code>type</code>: 
<code>list</code> renders a select list. \n\n\"type\" has to be lowercase",
-       "bs-checklist-tag-checklist-param-list": "Text for <code>list</code>: 
Name of the template with the available values. Parameter <code>type</code> 
must be set to <code>list</code>. \n \"list\" has to be lowercase",
-       "bs-checklist-tag-checklist-param-value": "Text for <code>value</code>: 
<code>checked</code> or a value out of the list template. \n\n\"value\" has to 
be lowercase",
+       "bs-checklist-tag-checklist-example-check": "Description of example for 
checkbox. Used in InsertMagic tag description.",
+       "bs-checklist-tag-checklist-example-list": "Description of example for 
select menu. Used in InsertMagic tag description.",
        "bs-checklist-dlg-new-list": "Button text for creating a new checklist",
        "bs-checklist-dlg-save-list": "Button text for saving changes in a 
checklist",
        "bs-checklist-dlg-items-label": "Label for list of checklist items",

-- 
To view, visit https://gerrit.wikimedia.org/r/291573
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I1ebf3d437cfc426e5d57aa599a193d66ca2498b7
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/BlueSpiceExtensions
Gerrit-Branch: master
Gerrit-Owner: Mglaser <gla...@hallowelt.biz>
Gerrit-Reviewer: Dvogel hallowelt <daniel.vo...@hallowelt.com>
Gerrit-Reviewer: Ljonka <l.verhovs...@gmail.com>
Gerrit-Reviewer: Pwirth <wi...@hallowelt.biz>
Gerrit-Reviewer: Raimond Spekking <raimond.spekk...@gmail.com>
Gerrit-Reviewer: Robert Vogel <vo...@hallowelt.biz>
Gerrit-Reviewer: Siebrand <siebr...@kitano.nl>
Gerrit-Reviewer: jenkins-bot <>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to