Jforrester has uploaded a new change for review.
https://gerrit.wikimedia.org/r/186108
Change subject: MWMediaDialog: Add contextual help for controls
......................................................................
MWMediaDialog: Add contextual help for controls
Bug: T53798
Bug: T75731
Change-Id: Ideae0052c366a8c4e03285270569e5c5ca608ad8
---
M VisualEditor.php
M modules/ve-mw/i18n/en.json
M modules/ve-mw/i18n/qqq.json
M modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
4 files changed, 28 insertions(+), 4 deletions(-)
git pull ssh://gerrit.wikimedia.org:29418/mediawiki/extensions/VisualEditor
refs/changes/08/186108/1
diff --git a/VisualEditor.php b/VisualEditor.php
index df108ac..f569f92 100644
--- a/VisualEditor.php
+++ b/VisualEditor.php
@@ -1004,10 +1004,12 @@
),
'messages' => array(
'visualeditor-dialog-media-alttext-section',
+ 'visualeditor-dialog-media-alttext-section-help',
'visualeditor-dialog-media-change-image',
'visualeditor-dialog-media-choose-image',
'visualeditor-dialog-media-content-filename',
'visualeditor-dialog-media-content-section',
+ 'visualeditor-dialog-media-content-section-help',
'visualeditor-dialog-media-dimensionseparator',
'visualeditor-dialog-media-goback',
'visualeditor-dialog-media-info-artist',
@@ -1028,13 +1030,16 @@
'visualeditor-dialog-media-page-general',
'visualeditor-dialog-media-position-center',
'visualeditor-dialog-media-position-checkbox',
+ 'visualeditor-dialog-media-position-checkbox-help',
'visualeditor-dialog-media-position-left',
'visualeditor-dialog-media-position-none',
'visualeditor-dialog-media-position-right',
'visualeditor-dialog-media-position-section',
+ 'visualeditor-dialog-media-position-section-help',
'visualeditor-dialog-media-searchselect',
'visualeditor-dialog-media-size-originalsize-error',
'visualeditor-dialog-media-size-section',
+ 'visualeditor-dialog-media-size-section-help',
'visualeditor-dialog-media-thumbdimensions',
'visualeditor-dialog-media-title',
'visualeditor-dialog-media-type-border',
@@ -1042,6 +1047,7 @@
'visualeditor-dialog-media-type-frameless',
'visualeditor-dialog-media-type-none',
'visualeditor-dialog-media-type-section',
+ 'visualeditor-dialog-media-type-section-help',
'visualeditor-dialog-media-type-thumb',
'visualeditor-dialogbutton-media-tooltip',
'visualeditor-media-input-placeholder',
diff --git a/modules/ve-mw/i18n/en.json b/modules/ve-mw/i18n/en.json
index e59719a..76db587 100644
--- a/modules/ve-mw/i18n/en.json
+++ b/modules/ve-mw/i18n/en.json
@@ -71,10 +71,12 @@
"visualeditor-dialog-beta-welcome-content": "This is our new, easier
way to edit. It's still in beta, which means you might find parts of the page
you can't edit, or encounter issues that need to be fixed. We encourage you to
review your changes, and we welcome reports about any issues you might
encounter in using VisualEditor (click the \"{{int:visualeditor-help-tool}}\"
button to submit feedback). You can switch to the wikitext editor at any time
by clicking on the \"$1\" tab, keeping any changes you have made.",
"visualeditor-dialog-beta-welcome-title": "{{GENDER:$1|Welcome}} to
VisualEditor",
"visualeditor-dialog-media-alttext-section": "Alternative text",
+ "visualeditor-dialog-media-alttext-section-help": "You can use this to
give a text description which is used for people who can't see the item. The
description should be good enough for them to understand the purpose and
information given by the media item. This is vital for blind users and other
people using screen-reader software or text-only browsers.",
"visualeditor-dialog-media-change-image": "Change image",
"visualeditor-dialog-media-choose-image": "Use this image",
- "visualeditor-dialog-media-content-section": "Caption",
"visualeditor-dialog-media-content-filename": "File name",
+ "visualeditor-dialog-media-content-section": "Caption",
+ "visualeditor-dialog-media-content-section-help": "You can use this to
show a label that shows next to the item for all readers. This is often used to
explain why the item is relevant to the context in which it is shown. It should
be succinct and informative.",
"visualeditor-dialog-media-dimensionseparator": " × ",
"visualeditor-dialog-media-goback": "Back",
"visualeditor-dialog-media-info-artist": "Uploaded by $1",
@@ -95,16 +97,19 @@
"visualeditor-dialog-media-page-general": "General settings",
"visualeditor-dialog-media-position-center": "Center",
"visualeditor-dialog-media-position-checkbox": "Wrap text around this
item",
+ "visualeditor-dialog-media-position-checkbox-help": "You can make this
media item appear inline with the text of the page instead of floating. You
should only do this rarely, as it will break up the flow of the text if you
uncheck this box.",
"visualeditor-dialog-media-position-left": "Left",
"visualeditor-dialog-media-position-none": "None",
"visualeditor-dialog-media-position-right": "Right",
"visualeditor-dialog-media-position-section": "Position",
+ "visualeditor-dialog-media-position-section-help": "You can set where
this media item appears on the page. This is sometimes used to break up a long
line of images on one side of the page.",
"visualeditor-dialog-media-searchselect": "Select",
"visualeditor-dialog-media-size-choosecustom": "Set custom size",
"visualeditor-dialog-media-size-choosedefault": "Set to default size",
"visualeditor-dialog-media-size-choosefull": "Set to full size",
"visualeditor-dialog-media-size-originalsize-error": "Could not
retrieve original file size.",
"visualeditor-dialog-media-size-section": "Image size",
+ "visualeditor-dialog-media-size-section-help": "You can set how large
the media item appears on the page. This should almost always be the normal
size, as a custom size will interfere with the layout of the page for readers
and make them inconsistent.",
"visualeditor-dialog-media-thumbdimensions": "Thumbnail dimensions",
"visualeditor-dialog-media-title": "Media settings",
"visualeditor-dialog-media-type-border": "Border",
@@ -112,6 +117,7 @@
"visualeditor-dialog-media-type-frameless": "Frameless",
"visualeditor-dialog-media-type-none": "Basic",
"visualeditor-dialog-media-type-section": "Image type",
+ "visualeditor-dialog-media-type-section-help": "You can set how the
media item appears on the page. This should be the thumbnail format to be
consistent with other pages in almost all cases.",
"visualeditor-dialog-media-type-thumb": "Thumbnail",
"visualeditor-dialog-meta-advancedsettings-label": "Advanced settings",
"visualeditor-dialog-meta-advancedsettings-section": "Advanced
settings",
diff --git a/modules/ve-mw/i18n/qqq.json b/modules/ve-mw/i18n/qqq.json
index 09e487c..b642f12 100644
--- a/modules/ve-mw/i18n/qqq.json
+++ b/modules/ve-mw/i18n/qqq.json
@@ -80,10 +80,12 @@
"visualeditor-dialog-beta-welcome-content": "Text explaining
VisualEditor is in beta.\n\nRefers to
{{msg-mw|Visualeditor-help-tool}}.\n\nParameters:\n* $1 - {{msg-mw|Edit}}",
"visualeditor-dialog-beta-welcome-title": "Title of the beta welcome
dialog. Parameters:\n* $1 - username or empty string, for GENDER support",
"visualeditor-dialog-media-alttext-section": "Label for the image
alternative text sub-section.",
+ "visualeditor-dialog-media-alttext-section-help": "Message displayed as
contextual help about the alternative text box to editors in the media editing
dialog.",
"visualeditor-dialog-media-change-image": "Label for the button to
change the current image in the media edit dialog.",
"visualeditor-dialog-media-choose-image": "Label for the button to use
the selected image in the media edit dialog.",
- "visualeditor-dialog-media-content-section": "Label for the image
content sub-section.\n{{Identical|Caption}}",
"visualeditor-dialog-media-content-filename": "Label for the image
filename.\n{{Identical|Filename}}",
+ "visualeditor-dialog-media-content-section": "Label for the image
content sub-section.\n{{Identical|Caption}}",
+ "visualeditor-dialog-media-content-section-help": "Message displayed as
contextual help about the caption box to editors in the media editing dialog.",
"visualeditor-dialog-media-dimensionseparator": "Label dimensions
separator in the image size display.{{Optional}}",
"visualeditor-dialog-media-goback": "Label for the button to go back to
edit settings in the media dialog.\n{{Identical|Go back}}",
"visualeditor-dialog-media-info-artist": "Label for the author
information for the image in the media dialog. $1 - Author name.",
@@ -104,16 +106,19 @@
"visualeditor-dialog-media-page-general": "Label for the general
settings page in the media edit dialog.\n{{Identical|General settings}}",
"visualeditor-dialog-media-position-center": "Label for the image
position option for aligning to the
center.\n{{Related|Visualeditor-dialog-media-position}}\n{{Identical|Center}}",
"visualeditor-dialog-media-position-checkbox": "Label for the position
checkbox, denoting whether to use a set float position.",
+ "visualeditor-dialog-media-position-checkbox-help": "Message displayed
as contextual help about the checkbox control to enable floating display
positions (<code>left</code>, <code>right</code>, etc.) to editors in the media
editing dialog.",
"visualeditor-dialog-media-position-left": "Label for the image
position option for aligning to the
left.\n{{Related|Visualeditor-dialog-media-position}}\n{{Identical|Left}}",
"visualeditor-dialog-media-position-none": "Label for the image
position option for no
alignment.\n{{Related|Visualeditor-dialog-media-position}}\n{{Identical|None}}",
"visualeditor-dialog-media-position-right": "Label for the image
position option for aligning to the
right.\n{{Related|Visualeditor-dialog-media-position}}\n{{Identical|Right}}",
"visualeditor-dialog-media-position-section": "Label for the image
position sub-section.\n\nSee also:\n*
{{msg-mw|Visualeditor-dialog-media-position-center}}\n*
{{msg-mw|Visualeditor-dialog-media-position-left}}\n*
{{msg-mw|Visualeditor-dialog-media-position-none}}\n*
{{msg-mw|Visualeditor-dialog-media-position-right}}\n{{Identical|Position}}",
+ "visualeditor-dialog-media-position-section-help": "Message displayed
as contextual help about the control for which display position to use
(<code>left</code>, <code>right</code>, etc.) to editors in the media editing
dialog.",
"visualeditor-dialog-media-searchselect": "Button for choosing media
item from the search results in the media dialog.\n{{Identical|Select}}",
"visualeditor-dialog-media-size-choosecustom": "Label for setting image
size to custom dimensions.\n{{Related|Visualeditor-dialog-media-size}}",
"visualeditor-dialog-media-size-choosedefault": "Label for setting
image size to wiki default thumbnail
dimensions.\n{{Related|Visualeditor-dialog-media-size}}",
"visualeditor-dialog-media-size-choosefull": "Label for setting image
size to full size.\n{{Related|Visualeditor-dialog-media-size}}",
"visualeditor-dialog-media-size-originalsize-error": "Error message for
failing to retrieve original file size from the API.",
"visualeditor-dialog-media-size-section": "Label for the image size
sub-section.\n{{Identical|Image size}}",
+ "visualeditor-dialog-media-size-section-help": "Message displayed as
contextual help about the controls for display size to editors in the media
editing dialog.",
"visualeditor-dialog-media-thumbdimensions": "Label for the original
dimensions of the image in the media search dialog.",
"visualeditor-dialog-media-title": "Title for the editing dialog to set
how a media item is displayed on the page",
"visualeditor-dialog-media-type-border": "Label for the image type
option for bordered image.\n{{Identical|Border}}",
@@ -121,6 +126,7 @@
"visualeditor-dialog-media-type-frameless": "Label for the image type
option for frameless.",
"visualeditor-dialog-media-type-none": "Label for the image type option
for basic image.\n{{Identical|Basic}}",
"visualeditor-dialog-media-type-section": "Label for the image type
sub-section.\n\nFollowed by the following buttons:\n*
{{msg-mw|Visualeditor-dialog-media-type-thumb}}\n*
{{msg-mw|Visualeditor-dialog-media-type-frame}}\n*
{{msg-mw|Visualeditor-dialog-media-type-frameless}}\n*
{{msg-mw|Visualeditor-dialog-media-type-border}}",
+ "visualeditor-dialog-media-type-section-help": "Message displayed as
contextual help about the controls for display type (<code>thumb</code>,
<code>frameless</code>, etc.) to editors in the media editing dialog.",
"visualeditor-dialog-media-type-thumb": "Label for the image type
option for thumbnail.\n{{Identical|Thumbnail}}",
"visualeditor-dialog-meta-advancedsettings-label": "Title for the
advanced settings dialog section.\n{{Identical|Advanced settings}}",
"visualeditor-dialog-meta-advancedsettings-section": "Label for the
advanced settings dialog section.\n{{Identical|Advanced settings}}",
diff --git a/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
b/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
index d6c7d0b..daeb2f6 100644
--- a/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
+++ b/modules/ve-mw/ui/dialogs/ve.ui.MWMediaDialog.js
@@ -219,6 +219,7 @@
this.captionFieldset = new OO.ui.FieldsetLayout( {
$: this.$,
label: ve.msg( 'visualeditor-dialog-media-content-section' ),
+ help: ve.msg( 'visualeditor-dialog-media-content-section-help'
),
icon: 'parameter',
classes: [ 've-ui-mwMediaDialog-caption-fielset']
} );
@@ -227,6 +228,7 @@
altTextFieldset = new OO.ui.FieldsetLayout( {
$: this.$,
label: ve.msg( 'visualeditor-dialog-media-alttext-section' ),
+ help: ve.msg( 'visualeditor-dialog-media-alttext-section-help'
),
icon: 'parameter'
} );
@@ -276,12 +278,14 @@
positionField = new OO.ui.FieldLayout( this.positionCheckbox, {
$: this.$,
align: 'inline',
- label: ve.msg( 'visualeditor-dialog-media-position-checkbox' )
+ label: ve.msg( 'visualeditor-dialog-media-position-checkbox' ),
+ help: ve.msg(
'visualeditor-dialog-media-position-checkbox-help' )
} );
positionFieldset = new OO.ui.FieldsetLayout( {
$: this.$,
label: ve.msg( 'visualeditor-dialog-media-position-section' ),
+ help: ve.msg( 'visualeditor-dialog-media-position-section-help'
),
icon: 'parameter'
} );
@@ -295,6 +299,7 @@
this.typeFieldset = new OO.ui.FieldsetLayout( {
$: this.$,
label: ve.msg( 'visualeditor-dialog-media-type-section' ),
+ help: ve.msg( 'visualeditor-dialog-media-type-section-help' ),
icon: 'parameter'
} );
@@ -347,7 +352,8 @@
this.sizeFieldset = new OO.ui.FieldsetLayout( {
$: this.$,
label: ve.msg( 'visualeditor-dialog-media-size-section' ),
- icon: 'parameter'
+ icon: 'parameter',
+ help: ve.msg( 'visualeditor-dialog-media-size-section-help' )
} );
this.sizeErrorLabel = new OO.ui.LabelWidget( {
--
To view, visit https://gerrit.wikimedia.org/r/186108
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings
Gerrit-MessageType: newchange
Gerrit-Change-Id: Ideae0052c366a8c4e03285270569e5c5ca608ad8
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/VisualEditor
Gerrit-Branch: master
Gerrit-Owner: Jforrester <[email protected]>
_______________________________________________
MediaWiki-commits mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits
