wikimedia/mediawiki-extensions-VisualEditor
1
0
Fork 0
mirror of https://gerrit.wikimedia.org/r/mediawiki/extensions/VisualEditor synced 2024-11-28 16:20:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge "Use TemplateData's suggested status for parameters"

Browse source
This commit is contained in:
jenkins-bot 2014-04-28 19:15:53 +00:00 committed by Gerrit Code Review
parent a72da562a7 3569efba3b
commit 0e4ed61772
4 changed files with 34 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
modules/ve-mw/dm/models/ve.dm.MWParameterModel.js
View file

@ -51,6 +51,17 @@ ve.dm.MWParameterModel.prototype.isRequired = function () {
return this.template.getSpec().isParameterRequired( this.name );
};
/**
* Check if parameter is suggestyed.
*
* @method
* @param {string} name Parameter name
* @returns {boolean} Parameter is suggested
*/
ve.dm.MWParameterModel.prototype.isSuggested = function () {
return this.template.getSpec().isParameterSuggested( this.name );
};
/**
* Get template parameter is part of.
*

12
modules/ve-mw/dm/models/ve.dm.MWTemplateModel.js
View file

@ -285,17 +285,23 @@ ve.dm.MWTemplateModel.prototype.removeParameter = function ( param ) {
};
/**
* Add all non-existing required parameters, if any.
* Add all non-existing required and suggested parameters, if any.
*
* @method
*/
ve.dm.MWTemplateModel.prototype.addRequiredParameters = function () {
ve.dm.MWTemplateModel.prototype.addPromptedParameters = function () {
var i, len,
spec = this.getSpec(),
names = spec.getParameterNames();
for ( i = 0, len = names.length; i < len; i++ ) {
if ( !this.params[name] && spec.isParameterRequired( names[i] ) ) {
if (
!this.params[name] &&
(
spec.isParameterRequired( names[i] ) ||
spec.isParameterSuggested( names[i] )
)
) {
this.addParameter( new ve.dm.MWParameterModel( this, names[i] ) );
}
}

11
modules/ve-mw/dm/models/ve.dm.MWTemplateSpecModel.js
View file

@ -106,6 +106,7 @@ ve.dm.MWTemplateSpecModel.prototype.getDefaultParameterSpec = function ( name )
'aliases': [],
'name': name,
'required': false,
'suggested': false,
'deprecated': false
};
};
@ -256,6 +257,16 @@ ve.dm.MWTemplateSpecModel.prototype.isParameterRequired = function ( name ) {
return !!this.params[name].required;
};
/**
* Check if parameter is suggsted.
*
* @param {string} name Parameter name
* @returns {boolean} Parameter is suggested
*/
ve.dm.MWTemplateSpecModel.prototype.isParameterSuggested = function ( name ) {
return !!this.params[name].suggested;
};
/**
* Check if parameter is deprecated.
*

6
modules/ve-mw/ui/dialogs/ve.ui.MWTemplateDialog.js
View file

@ -106,11 +106,11 @@ ve.ui.MWTemplateDialog.prototype.onReplacePart = function ( removed, added ) {
}
}
// Add required params to user created templates
// Add required and suggested params to user created templates
if ( added instanceof ve.dm.MWTemplateModel && this.loaded ) {
// Prevent selection changes
this.preventReselection = true;
added.addRequiredParameters();
added.addPromptedParameters();
this.preventReselection = false;
names = added.getParameterNames();
params = added.getParameters();
@ -333,7 +333,7 @@ ve.ui.MWTemplateDialog.prototype.setup = function ( data ) {
if ( data.template ) {
template = ve.dm.MWTemplateModel.newFromName( this.transclusion, data.template );
promise = this.transclusion.addPart( template ).done( function () {
template.addRequiredParameters();
template.addPromptedParameters();
} );
} else {
promise = this.transclusion.addPart(