jenkins-bot has submitted this change and it was merged.

Change subject: WikiEditor: Improve help section
......................................................................


WikiEditor: Improve help section

* Internal links: Show simple example first
* References: Show use of unnamed references
* Discussion: Use --~~~~ for consistency with what the toolbar button inserts

Bug: T26128
Change-Id: I08de0ad416727447eccad914c2ade3a93e5a8ae2
---
M extension.json
M i18n/en.json
M i18n/qqq.json
M modules/jquery.wikiEditor.toolbar.config.js
4 files changed, 22 insertions(+), 8 deletions(-)

Approvals:
  Alex Monk: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/extension.json b/extension.json
index 0d0ccfe..a70ecd7 100644
--- a/extension.json
+++ b/extension.json
@@ -322,6 +322,9 @@
                                
"wikieditor-toolbar-help-content-reference-description",
                                
"wikieditor-toolbar-help-content-reference-syntax",
                                
"wikieditor-toolbar-help-content-reference-result",
+                               
"wikieditor-toolbar-help-content-named-reference-description",
+                               
"wikieditor-toolbar-help-content-named-reference-syntax",
+                               
"wikieditor-toolbar-help-content-named-reference-result",
                                
"wikieditor-toolbar-help-content-rereference-description",
                                
"wikieditor-toolbar-help-content-rereference-syntax",
                                
"wikieditor-toolbar-help-content-rereference-result",
diff --git a/i18n/en.json b/i18n/en.json
index d516768..cca3585 100644
--- a/i18n/en.json
+++ b/i18n/en.json
@@ -160,8 +160,8 @@
     "wikieditor-toolbar-help-content-bolditalic-syntax": "'''''Bold & 
italic text'''''",
     "wikieditor-toolbar-help-content-bolditalic-result": "<strong><em>Bold 
&amp; italic text</em></strong>",
     "wikieditor-toolbar-help-content-ilink-description": "Internal link",
-    "wikieditor-toolbar-help-content-ilink-syntax": "[[Page title|Link 
label]]<br />[[Page title]]",
-    "wikieditor-toolbar-help-content-ilink-result": "<a href='#'>Link 
label</a><br /><a href='#'>Page title</a>",
+    "wikieditor-toolbar-help-content-ilink-syntax": "[[Page title]]<br 
/>[[Page title|Link label]]",
+    "wikieditor-toolbar-help-content-ilink-result": "<a href='#'>Page 
title</a><br /><a href='#'>Link label</a>",
     "wikieditor-toolbar-help-content-xlink-description": "External link",
     "wikieditor-toolbar-help-content-xlink-syntax": "[http://www.example.org 
Link label]<br />[http://www.example.org]<br />http://www.example.org";,
     "wikieditor-toolbar-help-content-xlink-result": "<a href='#' 
class='external'>Link label</a><br /><a href='#' class='external 
autonumber'>[1]</a><br /><a href='#' 
class='external'>http://www.example.org</a>",
@@ -187,17 +187,20 @@
     "wikieditor-toolbar-help-content-file-syntax": "[[$1:Example.png|$2|$3]]",
     "wikieditor-toolbar-help-content-file-caption": "Caption text",
     "wikieditor-toolbar-help-content-reference-description": "Reference",
-    "wikieditor-toolbar-help-content-reference-syntax": "Page text.&lt;ref 
name=\"test\"&gt;[http://www.example.org Link text], additional 
text.&lt;/ref&gt;",
+    "wikieditor-toolbar-help-content-reference-syntax": "Page 
text.&lt;ref&gt;[http://www.example.org Link text], additional 
text.&lt;/ref&gt;",
     "wikieditor-toolbar-help-content-reference-result": "Page text.<sup><a 
href='#'>[1]</a></sup>",
+    "wikieditor-toolbar-help-content-named-reference-description": "Named 
reference",
+    "wikieditor-toolbar-help-content-named-reference-syntax": "Page 
text.&lt;ref name=\"test\"&gt;[http://www.example.org Link text]&lt;/ref&gt;",
+    "wikieditor-toolbar-help-content-named-reference-result": "Page 
text.<sup><a href='#'>[2]</a></sup>",
     "wikieditor-toolbar-help-content-rereference-description": "Additional use 
of same reference",
     "wikieditor-toolbar-help-content-rereference-syntax": "&lt;ref 
name=\"test\" /&gt;",
-    "wikieditor-toolbar-help-content-rereference-result": "Page text.<sup><a 
href='#'>[1]</a></sup>",
+    "wikieditor-toolbar-help-content-rereference-result": "Page text.<sup><a 
href='#'>[2]</a></sup>",
     "wikieditor-toolbar-help-content-showreferences-description": "Display 
references",
     "wikieditor-toolbar-help-content-showreferences-syntax": "&lt;references 
/&gt;",
-    "wikieditor-toolbar-help-content-showreferences-result": "<ol 
class='references'><li id='cite_note-test-0'><b><a title='' href='#'>^</a></b> 
<a rel='nofollow' title='http://www.example.org' class='external text' 
href='#'>Link text</a>, additional text.</li></ol>",
+    "wikieditor-toolbar-help-content-showreferences-result": "<ol 
class='references'><li id='cite_note-test-0'><b><a title='' href='#'>^</a></b> 
<a rel='nofollow' title='http://www.example.org' class='external text' 
href='#'>Link text</a>, additional text.</li><li id='cite_note-test-1'><b><a 
title='' href='#'>^</a></b> <a rel='nofollow' title='http://www.example.org' 
class='external text' href='#'>Link text</a></li></ol>",
     "wikieditor-toolbar-help-content-signaturetimestamp-description": 
"Signature with timestamp",
-    "wikieditor-toolbar-help-content-signaturetimestamp-syntax": "~~~~",
-    "wikieditor-toolbar-help-content-signaturetimestamp-result": "<a href='#' 
title='{{#special:mypage}}'>Username</a> (<a href='#' 
title='{{#special:mytalk}}'>talk</a>) 15:54, 10 June 2009 (UTC)",
+    "wikieditor-toolbar-help-content-signaturetimestamp-syntax": "--~~~~",
+    "wikieditor-toolbar-help-content-signaturetimestamp-result": "--<a 
href='#' title='{{#special:mypage}}'>Username</a> (<a href='#' 
title='{{#special:mytalk}}'>talk</a>) 15:54, 10 June 2009 (UTC)",
     "wikieditor-toolbar-help-content-signature-description": "Signature",
     "wikieditor-toolbar-help-content-signature-syntax": "~~~",
     "wikieditor-toolbar-help-content-signature-result": "<a href='#' 
title='{{#special:mypage}}'>Username</a> (<a href='#' 
title='{{#special:mytalk}}'>talk</a>)",
diff --git a/i18n/qqq.json b/i18n/qqq.json
index 43c186f..a34e058 100644
--- a/i18n/qqq.json
+++ b/i18n/qqq.json
@@ -209,8 +209,11 @@
        "wikieditor-toolbar-help-content-file-syntax": "Parameters:\n* $1 - 
\"File\" namespace name\n* $2 - the image syntax parameter for a thumbnail\n* 
$3 - the caption for the a thumbnail",
        "wikieditor-toolbar-help-content-file-caption": "Placeholder text for 
file caption. Must match 
{{msg-mw|wikieditor-toolbar-help-content-file-syntax}}.",
        "wikieditor-toolbar-help-content-reference-description": 
"{{Identical|Reference}}",
-       "wikieditor-toolbar-help-content-reference-syntax": "Syntax example 
used in the help section \"reference\" of the toolbar\n\nIt is suggest to leave 
the <code>name=\"test\"</code> string in English\n\nwww.example.org is not a 
real website, but it has been reserved to use in software documentation. If you 
translate the word example and try to go to that web address then you might get 
a message that it doesn't exist. But somebody may have created a commercial web 
page for that address, such as www.Beispiel.org, using the German word for 
example. It is therefore recommended that you do not translate 
http://www.example.org at all. If you do wish to translate it you should first 
check where the translated link takes you.",
+       "wikieditor-toolbar-help-content-reference-syntax": "Syntax example 
used in the help section \"reference\" of the toolbar\n\nwww.example.org is not 
a real website, but it has been reserved to use in software documentation. If 
you translate the word example and try to go to that web address then you might 
get a message that it doesn't exist. But somebody may have created a commercial 
web page for that address, such as www.Beispiel.org, using the German word for 
example. It is therefore recommended that you do not translate 
http://www.example.org at all. If you do wish to translate it you should first 
check where the translated link takes you.",
        "wikieditor-toolbar-help-content-reference-result": "Html example used 
in the help section \"reference\" of the toolbar",
+       "wikieditor-toolbar-help-content-named-reference-description": 
"Description used in the help section \"reference\" of the toolbar",
+       "wikieditor-toolbar-help-content-named-reference-syntax": 
"{{Optional}}\nSyntax example used in the help section \"reference\" of the 
toolbar\n\nIt is suggest to leave the <code>name=\"test\"</code> string in 
English",
+       "wikieditor-toolbar-help-content-named-reference-result": "Html example 
used in the help section \"reference\" of the toolbar",
        "wikieditor-toolbar-help-content-rereference-description": "Description 
used in the help section \"reference\" of the toolbar",
        "wikieditor-toolbar-help-content-rereference-syntax": 
"{{Optional}}\nSyntax example used in the help section \"reference\" of the 
toolbar",
        "wikieditor-toolbar-help-content-rereference-result": "Html example 
used in the help section \"reference\" of the toolbar",
diff --git a/modules/jquery.wikiEditor.toolbar.config.js 
b/modules/jquery.wikiEditor.toolbar.config.js
index 8e36879..8dc0d0a 100644
--- a/modules/jquery.wikiEditor.toolbar.config.js
+++ b/modules/jquery.wikiEditor.toolbar.config.js
@@ -725,6 +725,11 @@
                                                        'result': { 'htmlMsg': 
'wikieditor-toolbar-help-content-reference-result' }
                                                },
                                                {
+                                                       'description': { 
'htmlMsg': 'wikieditor-toolbar-help-content-named-reference-description' },
+                                                       'syntax': { 'htmlMsg': 
'wikieditor-toolbar-help-content-named-reference-syntax' },
+                                                       'result': { 'htmlMsg': 
'wikieditor-toolbar-help-content-named-reference-result' }
+                                               },
+                                               {
                                                        'description': { 
'htmlMsg': 'wikieditor-toolbar-help-content-rereference-description' },
                                                        'syntax': { 'htmlMsg': 
'wikieditor-toolbar-help-content-rereference-syntax' },
                                                        'result': { 'htmlMsg': 
'wikieditor-toolbar-help-content-rereference-result' }

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

Gerrit-MessageType: merged
Gerrit-Change-Id: I08de0ad416727447eccad914c2ade3a93e5a8ae2
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/WikiEditor
Gerrit-Branch: master
Gerrit-Owner: Gerrit Patch Uploader <gerritpatchuploa...@gmail.com>
Gerrit-Reviewer: Alex Monk <kren...@gmail.com>
Gerrit-Reviewer: Gerrit Patch Uploader <gerritpatchuploa...@gmail.com>
Gerrit-Reviewer: Schnark <listenle...@gmail.com>
Gerrit-Reviewer: Siebrand <siebr...@kitano.nl>
Gerrit-Reviewer: TheDJ <hartman.w...@gmail.com>
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