2013-04-10 18:15:15 +00:00
|
|
|
/*!
|
2013-06-11 19:16:04 +00:00
|
|
|
* VisualEditor ContentEditable MWTransclusionNode class.
|
2013-04-10 18:15:15 +00:00
|
|
|
*
|
2014-01-05 12:05:05 +00:00
|
|
|
* @copyright 2011-2014 VisualEditor Team and others; see AUTHORS.txt
|
2013-04-10 18:15:15 +00:00
|
|
|
* @license The MIT License (MIT); see LICENSE.txt
|
|
|
|
*/
|
|
|
|
|
2013-05-15 23:51:11 +00:00
|
|
|
/*global mw */
|
|
|
|
|
2013-04-10 18:15:15 +00:00
|
|
|
/**
|
2013-06-11 19:16:04 +00:00
|
|
|
* ContentEditable MediaWiki transclusion node.
|
2013-04-10 18:15:15 +00:00
|
|
|
*
|
|
|
|
* @class
|
|
|
|
* @abstract
|
2013-05-29 01:35:42 +00:00
|
|
|
* @extends ve.ce.LeafNode
|
ve.ce.ProtectedNode
Objective:
Generalize the shield and phantom magic, so we can use it for pretty much
any node we like. Usually this will be used with generated content nodes,
but also with aliens (of course) and possible other stuff in the future.
Bonus:
Also fixes a bug in DM that would crash VE when you selected to the end
and hit backspace.
Changes:
*.php
* Added links to files
aliens.html
* Added attributes to aliens to make them aliens again
ve.ce.AlienNode.js
* Moved shield and phantom functionality to ve.ce.ProtectedNode
ve.ce.AlienNode.js, ve.ce.MWReferenceListNode.js,
ve.ce.MWReferenceNode.js, ve.ce.MWTemplateNode.js
* Mixed in ve.ce.ProtectedNode
ve.ce.Node.css
* Reorganized styles and updated class names
* Added simple light blue hover with outline (using inset box shadow) for
protected nodes, same style as before for aliens
ve.ce.Surface.css
* Moved phantom styles to ve.ce.Node.css
ve.ce.BranchNode.js
* Moved call to setLive(false) to happen before detach() so that the
surface object is still available and events can be disconnected
ve.ce.BranchNode.js, ve.ce.Document.js, ve.ce.js, ve.ce.Surface.js, ve.ce.SurfaceObserver.js
* Adjusted CSS class names
ve.ce.Node.js
* Moved shield template to ve.ce.ProtectedNode
ve.ce.ProtectedNode.js
* New class, mix into another class to protect it from editing
ve.ce.RelocatableNode.js
* Renamed temporary surface property to relocatingSurface to avoid
confusion when debugging
ve.ce.Surface.js
* Moved phantom template to ve.ce.ProtectedNode
ve.dm.Transaction.js
* Fixed bug where most of the internal list was being deleted when the
end of the document was selected and the user pressed backspace
Change-Id: I2468b16e1ba6785ad298e38190e33493135719c3
2013-05-07 00:07:01 +00:00
|
|
|
* @mixins ve.ce.ProtectedNode
|
2013-05-15 22:36:38 +00:00
|
|
|
* @mixins ve.ce.FocusableNode
|
2013-09-23 22:04:23 +00:00
|
|
|
* @mixins ve.ce.RelocatableNode
|
2013-05-29 01:35:42 +00:00
|
|
|
* @mixins ve.ce.GeneratedContentNode
|
ve.ce.ProtectedNode
Objective:
Generalize the shield and phantom magic, so we can use it for pretty much
any node we like. Usually this will be used with generated content nodes,
but also with aliens (of course) and possible other stuff in the future.
Bonus:
Also fixes a bug in DM that would crash VE when you selected to the end
and hit backspace.
Changes:
*.php
* Added links to files
aliens.html
* Added attributes to aliens to make them aliens again
ve.ce.AlienNode.js
* Moved shield and phantom functionality to ve.ce.ProtectedNode
ve.ce.AlienNode.js, ve.ce.MWReferenceListNode.js,
ve.ce.MWReferenceNode.js, ve.ce.MWTemplateNode.js
* Mixed in ve.ce.ProtectedNode
ve.ce.Node.css
* Reorganized styles and updated class names
* Added simple light blue hover with outline (using inset box shadow) for
protected nodes, same style as before for aliens
ve.ce.Surface.css
* Moved phantom styles to ve.ce.Node.css
ve.ce.BranchNode.js
* Moved call to setLive(false) to happen before detach() so that the
surface object is still available and events can be disconnected
ve.ce.BranchNode.js, ve.ce.Document.js, ve.ce.js, ve.ce.Surface.js, ve.ce.SurfaceObserver.js
* Adjusted CSS class names
ve.ce.Node.js
* Moved shield template to ve.ce.ProtectedNode
ve.ce.ProtectedNode.js
* New class, mix into another class to protect it from editing
ve.ce.RelocatableNode.js
* Renamed temporary surface property to relocatingSurface to avoid
confusion when debugging
ve.ce.Surface.js
* Moved phantom template to ve.ce.ProtectedNode
ve.dm.Transaction.js
* Fixed bug where most of the internal list was being deleted when the
end of the document was selected and the user pressed backspace
Change-Id: I2468b16e1ba6785ad298e38190e33493135719c3
2013-05-07 00:07:01 +00:00
|
|
|
*
|
2013-04-10 18:15:15 +00:00
|
|
|
* @constructor
|
2013-06-11 19:16:04 +00:00
|
|
|
* @param {ve.dm.MWTransclusionNode} model Model to observe
|
2013-09-25 10:21:09 +00:00
|
|
|
* @param {Object} [config] Configuration options
|
2013-04-10 18:15:15 +00:00
|
|
|
*/
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.MWTransclusionNode = function VeCeMWTransclusionNode( model, config ) {
|
2013-04-10 18:15:15 +00:00
|
|
|
// Parent constructor
|
2013-05-29 01:35:42 +00:00
|
|
|
ve.ce.LeafNode.call( this, model, config );
|
2013-04-10 18:15:15 +00:00
|
|
|
|
ve.ce.ProtectedNode
Objective:
Generalize the shield and phantom magic, so we can use it for pretty much
any node we like. Usually this will be used with generated content nodes,
but also with aliens (of course) and possible other stuff in the future.
Bonus:
Also fixes a bug in DM that would crash VE when you selected to the end
and hit backspace.
Changes:
*.php
* Added links to files
aliens.html
* Added attributes to aliens to make them aliens again
ve.ce.AlienNode.js
* Moved shield and phantom functionality to ve.ce.ProtectedNode
ve.ce.AlienNode.js, ve.ce.MWReferenceListNode.js,
ve.ce.MWReferenceNode.js, ve.ce.MWTemplateNode.js
* Mixed in ve.ce.ProtectedNode
ve.ce.Node.css
* Reorganized styles and updated class names
* Added simple light blue hover with outline (using inset box shadow) for
protected nodes, same style as before for aliens
ve.ce.Surface.css
* Moved phantom styles to ve.ce.Node.css
ve.ce.BranchNode.js
* Moved call to setLive(false) to happen before detach() so that the
surface object is still available and events can be disconnected
ve.ce.BranchNode.js, ve.ce.Document.js, ve.ce.js, ve.ce.Surface.js, ve.ce.SurfaceObserver.js
* Adjusted CSS class names
ve.ce.Node.js
* Moved shield template to ve.ce.ProtectedNode
ve.ce.ProtectedNode.js
* New class, mix into another class to protect it from editing
ve.ce.RelocatableNode.js
* Renamed temporary surface property to relocatingSurface to avoid
confusion when debugging
ve.ce.Surface.js
* Moved phantom template to ve.ce.ProtectedNode
ve.dm.Transaction.js
* Fixed bug where most of the internal list was being deleted when the
end of the document was selected and the user pressed backspace
Change-Id: I2468b16e1ba6785ad298e38190e33493135719c3
2013-05-07 00:07:01 +00:00
|
|
|
// Mixin constructors
|
|
|
|
ve.ce.ProtectedNode.call( this );
|
2013-05-15 22:36:38 +00:00
|
|
|
ve.ce.FocusableNode.call( this );
|
2013-09-23 22:04:23 +00:00
|
|
|
ve.ce.RelocatableNode.call( this );
|
2013-05-29 01:35:42 +00:00
|
|
|
ve.ce.GeneratedContentNode.call( this );
|
ve.ce.ProtectedNode
Objective:
Generalize the shield and phantom magic, so we can use it for pretty much
any node we like. Usually this will be used with generated content nodes,
but also with aliens (of course) and possible other stuff in the future.
Bonus:
Also fixes a bug in DM that would crash VE when you selected to the end
and hit backspace.
Changes:
*.php
* Added links to files
aliens.html
* Added attributes to aliens to make them aliens again
ve.ce.AlienNode.js
* Moved shield and phantom functionality to ve.ce.ProtectedNode
ve.ce.AlienNode.js, ve.ce.MWReferenceListNode.js,
ve.ce.MWReferenceNode.js, ve.ce.MWTemplateNode.js
* Mixed in ve.ce.ProtectedNode
ve.ce.Node.css
* Reorganized styles and updated class names
* Added simple light blue hover with outline (using inset box shadow) for
protected nodes, same style as before for aliens
ve.ce.Surface.css
* Moved phantom styles to ve.ce.Node.css
ve.ce.BranchNode.js
* Moved call to setLive(false) to happen before detach() so that the
surface object is still available and events can be disconnected
ve.ce.BranchNode.js, ve.ce.Document.js, ve.ce.js, ve.ce.Surface.js, ve.ce.SurfaceObserver.js
* Adjusted CSS class names
ve.ce.Node.js
* Moved shield template to ve.ce.ProtectedNode
ve.ce.ProtectedNode.js
* New class, mix into another class to protect it from editing
ve.ce.RelocatableNode.js
* Renamed temporary surface property to relocatingSurface to avoid
confusion when debugging
ve.ce.Surface.js
* Moved phantom template to ve.ce.ProtectedNode
ve.dm.Transaction.js
* Fixed bug where most of the internal list was being deleted when the
end of the document was selected and the user pressed backspace
Change-Id: I2468b16e1ba6785ad298e38190e33493135719c3
2013-05-07 00:07:01 +00:00
|
|
|
|
2013-08-28 22:55:35 +00:00
|
|
|
// DOM changes
|
2013-11-01 19:45:59 +00:00
|
|
|
this.$element.addClass( 've-ce-mwTransclusionNode' );
|
2013-04-10 18:15:15 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Inheritance */
|
|
|
|
|
2013-10-11 21:44:09 +00:00
|
|
|
OO.inheritClass( ve.ce.MWTransclusionNode, ve.ce.LeafNode );
|
2013-04-10 18:15:15 +00:00
|
|
|
|
2013-10-11 21:44:09 +00:00
|
|
|
OO.mixinClass( ve.ce.MWTransclusionNode, ve.ce.ProtectedNode );
|
ve.ce.ProtectedNode
Objective:
Generalize the shield and phantom magic, so we can use it for pretty much
any node we like. Usually this will be used with generated content nodes,
but also with aliens (of course) and possible other stuff in the future.
Bonus:
Also fixes a bug in DM that would crash VE when you selected to the end
and hit backspace.
Changes:
*.php
* Added links to files
aliens.html
* Added attributes to aliens to make them aliens again
ve.ce.AlienNode.js
* Moved shield and phantom functionality to ve.ce.ProtectedNode
ve.ce.AlienNode.js, ve.ce.MWReferenceListNode.js,
ve.ce.MWReferenceNode.js, ve.ce.MWTemplateNode.js
* Mixed in ve.ce.ProtectedNode
ve.ce.Node.css
* Reorganized styles and updated class names
* Added simple light blue hover with outline (using inset box shadow) for
protected nodes, same style as before for aliens
ve.ce.Surface.css
* Moved phantom styles to ve.ce.Node.css
ve.ce.BranchNode.js
* Moved call to setLive(false) to happen before detach() so that the
surface object is still available and events can be disconnected
ve.ce.BranchNode.js, ve.ce.Document.js, ve.ce.js, ve.ce.Surface.js, ve.ce.SurfaceObserver.js
* Adjusted CSS class names
ve.ce.Node.js
* Moved shield template to ve.ce.ProtectedNode
ve.ce.ProtectedNode.js
* New class, mix into another class to protect it from editing
ve.ce.RelocatableNode.js
* Renamed temporary surface property to relocatingSurface to avoid
confusion when debugging
ve.ce.Surface.js
* Moved phantom template to ve.ce.ProtectedNode
ve.dm.Transaction.js
* Fixed bug where most of the internal list was being deleted when the
end of the document was selected and the user pressed backspace
Change-Id: I2468b16e1ba6785ad298e38190e33493135719c3
2013-05-07 00:07:01 +00:00
|
|
|
|
2013-10-11 21:44:09 +00:00
|
|
|
OO.mixinClass( ve.ce.MWTransclusionNode, ve.ce.FocusableNode );
|
2013-05-15 22:36:38 +00:00
|
|
|
|
2013-10-11 21:44:09 +00:00
|
|
|
OO.mixinClass( ve.ce.MWTransclusionNode, ve.ce.RelocatableNode );
|
2013-09-23 22:04:23 +00:00
|
|
|
|
2013-10-11 21:44:09 +00:00
|
|
|
OO.mixinClass( ve.ce.MWTransclusionNode, ve.ce.GeneratedContentNode );
|
2013-05-29 01:35:42 +00:00
|
|
|
|
2013-04-10 18:15:15 +00:00
|
|
|
/* Static Properties */
|
|
|
|
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.MWTransclusionNode.static.name = 'mwTransclusion';
|
2013-04-10 18:15:15 +00:00
|
|
|
|
2013-06-28 19:52:53 +00:00
|
|
|
ve.ce.MWTransclusionNode.static.renderHtmlAttributes = false;
|
|
|
|
|
2013-04-10 18:15:15 +00:00
|
|
|
/* Methods */
|
|
|
|
|
2013-07-31 22:53:29 +00:00
|
|
|
/** */
|
2013-08-03 23:05:51 +00:00
|
|
|
ve.ce.MWTransclusionNode.prototype.generateContents = function ( config ) {
|
2013-10-17 11:39:27 +00:00
|
|
|
var xhr, deferred = $.Deferred();
|
2014-01-05 04:44:13 +00:00
|
|
|
xhr = ve.init.mw.Target.static.apiRequest( {
|
|
|
|
'action': 'visualeditor',
|
|
|
|
'paction': 'parsefragment',
|
|
|
|
'page': mw.config.get( 'wgRelevantPageName' ),
|
|
|
|
'wikitext': ( config && config.wikitext ) || this.model.getWikitext()
|
|
|
|
}, { 'type': 'POST' } )
|
2013-10-17 11:39:27 +00:00
|
|
|
.done( ve.bind( this.onParseSuccess, this, deferred ) )
|
|
|
|
.fail( ve.bind( this.onParseError, this, deferred ) );
|
|
|
|
|
2013-12-06 02:34:44 +00:00
|
|
|
return deferred.promise( { abort: xhr.abort } );
|
2013-05-15 23:51:11 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Handle a successful response from the parser for the wikitext fragment.
|
|
|
|
*
|
2013-08-02 22:35:42 +00:00
|
|
|
* @param {jQuery.Deferred} deferred The Deferred object created by #generateContents
|
2013-05-15 23:51:11 +00:00
|
|
|
* @param {Object} response Response data
|
|
|
|
*/
|
2013-06-18 17:56:56 +00:00
|
|
|
ve.ce.MWTransclusionNode.prototype.onParseSuccess = function ( deferred, response ) {
|
2013-10-16 20:36:03 +00:00
|
|
|
var contentNodes, $placeHolder;
|
2013-08-02 22:35:42 +00:00
|
|
|
|
|
|
|
if ( !response || response.error || !response.visualeditor || response.visualeditor.result !== 'success' ) {
|
|
|
|
return this.onParseError.call( this, deferred );
|
|
|
|
}
|
|
|
|
|
2014-01-05 05:05:59 +00:00
|
|
|
contentNodes = $.parseHTML( response.visualeditor.content );
|
2013-05-30 16:33:02 +00:00
|
|
|
// HACK: if $content consists of a single paragraph, unwrap it.
|
|
|
|
// We have to do this because the PHP parser wraps everything in <p>s, and inline templates
|
|
|
|
// will render strangely when wrapped in <p>s.
|
|
|
|
if ( contentNodes.length === 1 && contentNodes[0].nodeName.toLowerCase() === 'p' ) {
|
2013-06-18 23:18:51 +00:00
|
|
|
contentNodes = Array.prototype.slice.apply( contentNodes[0].childNodes );
|
2013-05-30 16:33:02 +00:00
|
|
|
}
|
2013-10-16 20:36:03 +00:00
|
|
|
|
|
|
|
// Check if the final result of the imported template is empty.
|
|
|
|
// If it is empty, put an inline placeholder inside it so that it can
|
|
|
|
// be accessible to users (either to remove or edit)
|
|
|
|
if ( contentNodes.length === 0 ) {
|
2013-11-01 19:45:59 +00:00
|
|
|
$placeHolder = this.$( '<span>' )
|
2013-10-16 20:36:03 +00:00
|
|
|
.css( { 'display': 'block' } )
|
|
|
|
// adapted from ve.ce.BranchNode.$blockSlugTemplate
|
|
|
|
// IE support may require using
|
|
|
|
.html( '' );
|
|
|
|
|
|
|
|
contentNodes.push( $placeHolder[0] );
|
|
|
|
}
|
2013-06-18 17:56:56 +00:00
|
|
|
deferred.resolve( contentNodes );
|
2013-05-15 23:51:11 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Handle an unsuccessful response from the parser for the wikitext fragment.
|
|
|
|
*
|
2013-08-02 22:35:42 +00:00
|
|
|
* @param {jQuery.Deferred} deferred The promise object created by #generateContents
|
2013-05-15 23:51:11 +00:00
|
|
|
* @param {Object} response Response data
|
|
|
|
*/
|
2013-06-18 17:56:56 +00:00
|
|
|
ve.ce.MWTransclusionNode.prototype.onParseError = function ( deferred ) {
|
|
|
|
deferred.reject();
|
2013-04-10 18:15:15 +00:00
|
|
|
};
|
|
|
|
|
2013-04-13 21:22:26 +00:00
|
|
|
/* Concrete subclasses */
|
|
|
|
|
|
|
|
/**
|
2013-06-11 19:16:04 +00:00
|
|
|
* ContentEditable MediaWiki transclusion block node.
|
2013-04-13 21:22:26 +00:00
|
|
|
*
|
|
|
|
* @class
|
2013-06-11 19:16:04 +00:00
|
|
|
* @extends ve.ce.MWTransclusionNode
|
2013-04-13 21:22:26 +00:00
|
|
|
* @constructor
|
2013-06-11 19:16:04 +00:00
|
|
|
* @param {ve.dm.MWTransclusionBlockNode} model Model to observe
|
2013-04-13 21:22:26 +00:00
|
|
|
*/
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.MWTransclusionBlockNode = function VeCeMWTransclusionBlockNode( model ) {
|
2013-04-13 21:22:26 +00:00
|
|
|
// Parent constructor
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.MWTransclusionNode.call( this, model );
|
2013-04-13 21:22:26 +00:00
|
|
|
|
2013-08-28 22:55:35 +00:00
|
|
|
// DOM changes
|
2013-11-01 19:45:59 +00:00
|
|
|
this.$element.addClass( 've-ce-mwTransclusionBlockNode' );
|
2013-04-13 21:22:26 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Inheritance */
|
|
|
|
|
2013-10-11 21:44:09 +00:00
|
|
|
OO.inheritClass( ve.ce.MWTransclusionBlockNode, ve.ce.MWTransclusionNode );
|
2013-04-13 21:22:26 +00:00
|
|
|
|
|
|
|
/* Static Properties */
|
|
|
|
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.MWTransclusionBlockNode.static.name = 'mwTransclusionBlock';
|
2013-04-13 21:22:26 +00:00
|
|
|
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.MWTransclusionBlockNode.static.tagName = 'div';
|
2013-06-07 01:04:53 +00:00
|
|
|
|
2013-04-13 21:22:26 +00:00
|
|
|
/**
|
2013-06-11 19:16:04 +00:00
|
|
|
* ContentEditable MediaWiki transclusion inline node.
|
2013-04-13 21:22:26 +00:00
|
|
|
*
|
|
|
|
* @class
|
2013-06-11 19:16:04 +00:00
|
|
|
* @extends ve.ce.MWTransclusionNode
|
2013-04-13 21:22:26 +00:00
|
|
|
* @constructor
|
2013-06-11 19:16:04 +00:00
|
|
|
* @param {ve.dm.MWTransclusionInlineNode} model Model to observe
|
2013-04-13 21:22:26 +00:00
|
|
|
*/
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.MWTransclusionInlineNode = function VeCeMWTransclusionInlineNode( model ) {
|
2013-04-13 21:22:26 +00:00
|
|
|
// Parent constructor
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.MWTransclusionNode.call( this, model );
|
2013-04-13 21:22:26 +00:00
|
|
|
|
2013-08-28 22:55:35 +00:00
|
|
|
// DOM changes
|
2013-11-01 19:45:59 +00:00
|
|
|
this.$element.addClass( 've-ce-mwTransclusionInlineNode' );
|
2013-04-13 21:22:26 +00:00
|
|
|
};
|
|
|
|
|
|
|
|
/* Inheritance */
|
|
|
|
|
2013-10-11 21:44:09 +00:00
|
|
|
OO.inheritClass( ve.ce.MWTransclusionInlineNode, ve.ce.MWTransclusionNode );
|
2013-04-13 21:22:26 +00:00
|
|
|
|
|
|
|
/* Static Properties */
|
|
|
|
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.MWTransclusionInlineNode.static.name = 'mwTransclusionInline';
|
2013-04-13 21:22:26 +00:00
|
|
|
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.MWTransclusionInlineNode.static.tagName = 'span';
|
2013-06-07 01:04:53 +00:00
|
|
|
|
2013-04-10 18:15:15 +00:00
|
|
|
/* Registration */
|
|
|
|
|
2013-06-11 19:16:04 +00:00
|
|
|
ve.ce.nodeFactory.register( ve.ce.MWTransclusionNode );
|
|
|
|
ve.ce.nodeFactory.register( ve.ce.MWTransclusionBlockNode );
|
|
|
|
ve.ce.nodeFactory.register( ve.ce.MWTransclusionInlineNode );
|