1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
|
/*!
* VisualEditor MWDefinedTransclusionContextItem class.
*
* @copyright 2011-2018 VisualEditor Team and others; see http://ve.mit-license.org
*/
/**
* Context item for a defined MWTransclusion.
*
* Templates are defined on-wiki using the message page
* [[MediaWiki:Visualeditor-template-tools-definition.json]]
*
* Example:
* {
* // This key is the static name of the ve.ui.ContextItem
* "citationNeeded": [
* {
* // Normalized title string, or list of strings (for redirects)
* "title": [ "Citation needed", "cn" ],
* // Extra params. This whole object can be accessed
* // via #getMatchedTool
* "params": {
* "reason": "reason",
* "date": "date"
* }
* },
* {
* "title": "Cite quote",
* "params": {
* "date": "date"
* }
* }
* ]
* }
*
* @class
* @abstract
* @extends ve.ui.MWTransclusionContextItem
*
* @constructor
* @param {ve.ui.Context} context Context item is in
* @param {ve.dm.Model} model Model item is related to
* @param {Object} config Configuration options
*/
ve.ui.MWDefinedTransclusionContextItem = function VeUiMWDefinedTransclusionContextItem() {
// Parent constructor
ve.ui.MWDefinedTransclusionContextItem.super.apply( this, arguments );
};
/* Inheritance */
OO.inheritClass( ve.ui.MWDefinedTransclusionContextItem, ve.ui.MWTransclusionContextItem );
/* Static Properties */
ve.ui.MWDefinedTransclusionContextItem.static.name = null;
ve.ui.MWDefinedTransclusionContextItem.static.toolDefinitions = ( function () {
var tools;
try {
// Must use mw.message to avoid JSON being parsed as Wikitext
tools = JSON.parse( mw.message( 'visualeditor-template-tools-definition.json' ).plain() );
} catch ( e ) {}
return tools || {};
}() );
/**
* Only display item for single-template transclusions of these templates.
*
* @property {string|string[]|null}
* @static
* @inheritable
*/
ve.ui.MWDefinedTransclusionContextItem.static.template = null;
/* Static Methods */
/**
* @inheritdoc
*/
ve.ui.MWDefinedTransclusionContextItem.static.isCompatibleWith = function ( model ) {
// Parent method
return ve.ui.MWDefinedTransclusionContextItem.super.static.isCompatibleWith.apply( this, arguments ) &&
!!this.getMatchedTool( model );
};
/**
* Get tool definitions, indexed by normalized title
*
* @return {Object} Collection of tool definitions
*/
ve.ui.MWDefinedTransclusionContextItem.static.getToolsByTitle = function () {
var toolsByTitle;
if ( !this.toolsByTitle ) {
this.toolsByTitle = toolsByTitle = {};
( this.toolDefinitions[ this.name ] || [] ).forEach( function ( template ) {
var titles = Array.isArray( template.title ) ? template.title : [ template.title ];
// 'title' can be a single title, or list of titles (including redirects)
titles.forEach( function ( title ) {
toolsByTitle[ mw.Title.newFromText( title, mw.config.get( 'wgNamespaceIds' ).template ).getPrefixedText() ] = template;
} );
} );
}
return this.toolsByTitle;
};
/**
* Get the tool definition that matches a specific model, if any
*
* @param {ve.dm.Model} model Model
* @return {Object|null} Tool definition, or null if no match
*/
ve.ui.MWDefinedTransclusionContextItem.static.getMatchedTool = function ( model ) {
var resource, title;
resource = ve.getProp( model.getAttribute( 'mw' ), 'parts', 0, 'template', 'target', 'href' );
if ( resource ) {
title = mw.Title.newFromText( mw.libs.ve.normalizeParsoidResourceName( resource ) ).getPrefixedText();
return this.getToolsByTitle()[ title ] || null;
}
return null;
};
|
