Merge "Add a message next to undocumented parameters"

This commit is contained in:
jenkins-bot 2021-07-16 12:05:29 +00:00 committed by Gerrit Code Review
commit 4ab5fd5c6b
7 changed files with 37 additions and 2 deletions

View file

@ -2211,6 +2211,7 @@
"visualeditor-dialog-transclusion-param-example-long",
"visualeditor-dialog-transclusion-param-info",
"visualeditor-dialog-transclusion-param-info-missing",
"visualeditor-dialog-transclusion-param-undocumented",
"visualeditor-dialog-transclusion-placeholder",
"visualeditor-dialog-transclusion-raw-fallback",
"visualeditor-dialog-transclusion-remove-content",

View file

@ -191,6 +191,7 @@
"visualeditor-dialog-transclusion-param-example-long": "Example: $1",
"visualeditor-dialog-transclusion-param-info": "Field description",
"visualeditor-dialog-transclusion-param-info-missing": "No field description available",
"visualeditor-dialog-transclusion-param-undocumented": "(Undocumented parameter)",
"visualeditor-dialog-transclusion-placeholder": "Add a template",
"visualeditor-dialog-transclusion-raw-fallback": "Fall back to plain wikitext",
"visualeditor-dialog-transclusion-remove-content": "Remove content",

View file

@ -209,6 +209,7 @@
"visualeditor-dialog-transclusion-param-example-long": "Label for parameter's example value in the template dialog. If feasible without abbreviation. $1 - Parameter's example value.\n{{Identical|Example}}",
"visualeditor-dialog-transclusion-param-info": "Title of button that hides and shows parameter descriptions",
"visualeditor-dialog-transclusion-param-info-missing": "Title of button that hides and shows parameter descriptions when no description is available",
"visualeditor-dialog-transclusion-param-undocumented": "Label shown next to a parameter's name indicating that the parameter is undocumented.",
"visualeditor-dialog-transclusion-placeholder": "Label for section with options for adding a new template to a multi part transclusion.\n{{Identical|Add template}}",
"visualeditor-dialog-transclusion-raw-fallback": "Label of the button that converts complex validation-required type-based inputs back into plain wikitext inputs.",
"visualeditor-dialog-transclusion-remove-content": "Label for button that removes content between transclusion parts",

View file

@ -66,6 +66,13 @@ ve.dm.MWParameterModel.prototype.isDeprecated = function () {
return this.template.getSpec().isParameterDeprecated( this.name );
};
/**
* @return {boolean}
*/
ve.dm.MWParameterModel.prototype.isDocumented = function () {
return this.template.getSpec().isParameterDocumented( this.name );
};
/**
* Get template of which this parameter is part.
*

View file

@ -227,6 +227,14 @@ ve.dm.MWTemplateSpecModel.prototype.isParameterAlias = function ( name ) {
return name in this.aliases;
};
/**
* @param name Parameter name or alias
* @returns {boolean}
*/
ve.dm.MWTemplateSpecModel.prototype.isParameterDocumented = function ( name ) {
return name in this.templateData.params || name in this.aliases;
};
/**
* @param {string} name Parameter name or alias
* @param {string} [languageCode]

View file

@ -190,8 +190,18 @@ ve.ui.MWParameterPage = function VeUiMWParameterPage( parameter, name, config )
.append(
this.valueInput.$element
);
if (
veConfig.transclusionDialogSuggestedValues &&
if ( veConfig.transclusionDialogNewSidebar &&
!this.parameter.isDocumented()
) {
var undocumentedLabel = new OO.ui.LabelWidget( {
label: ve.msg( 'visualeditor-dialog-transclusion-param-undocumented' ),
classes: [ 've-ui-mwParameterPage-undocumentedLabel' ]
} );
this.$labelElement.after( undocumentedLabel.$element );
}
if ( veConfig.transclusionDialogSuggestedValues &&
this.parameter.getSuggestedValues().length
) {
this.warningMessage = new OO.ui.MessageWidget( {

View file

@ -29,3 +29,10 @@
.ve-ui-mwParameterPage-inlineDescription {
position: relative;
}
.ve-ui-mwParameterPage-undocumentedLabel {
margin-left: 0.4em;
font-size: 13px;
font-style: italic;
color: #72777d;
}