Expand all

abstract ve.dm.MWTransclusionNode

Extends

Constructor

new ve.dm.MWTransclusionNode([element])abstract #

DataModel MediaWiki transclusion node.

Parameters:

Name Type Attributes Description
element Object optional

Reference to element in linear model
Mixes in:
Source:
DataModel MediaWiki transclusion node.

Properties

blockTypestatic #

Node type to use when the transclusion is a block

Properties:

Type Description
string
Source:
Node type to use when the transclusion is a block

cellTypestatic #

Node type to use when the transclusion is cellable

Properties:

Type Description
string
Source:
Node type to use when the transclusion is cellable

inlineTypestatic #

Node type to use when the transclusion is inline

Properties:

Type Description
string
Source:
Node type to use when the transclusion is inline

Methods

getPartsList() → {Array.<Object>} #

Get a simplified description of the transclusion's parts.

Returns:

List of objects with either template or content properties

Type
Array.<Object>
Source:
Get a simplified description of the transclusion's parts.

getSingleTemplateName() → {string|undefined} #

Get the name of the template if it's a single template transclusion

Returns:

Name of the template, undefined if not a single template transclusion

Type
string | undefined
Source:
Get the name of the template if it's a single template transclusion

getSingleTemplatePart() → {Object|undefined} #

Get the transclusion's template part if it's a single template transclusion

Returns:

Object with template properties, undefined if not a single template transclusion

Type
Object | undefined
Source:
Get the transclusion's template part if it's a single template transclusion

getWikitext(skipParameters) → {string} #

Wrapper for static method, ve.dm.MWTransclusionNode.static.getWikitext above.

Parameters:

Name Type Description
skipParameters boolean

Exclude parameters from result

Returns:

Wikitext

Type
string
Source:
Wrapper for static method, ve.dm.MWTransclusionNode.static.getWikitext above.

isSingleTemplate([allowedTemplates]) → {boolean} #

Check if transclusion contains only a single template.

Parameters:

Name Type Attributes Description
allowedTemplates string | Array.<string> optional

Names of templates to allow, omit to allow any template name

Returns:

Transclusion only contains a single template, which is one of the ones in templates

Type
boolean
Source:
Check if transclusion contains only a single template.

onAttributeChange(key, from, to) #

Handle attribute change events.

Parameters:

Name Type Description
key string

Attribute key
from string

Old value
to string

New value
Source:
Handle attribute change events.

cloneElement()static #

Source:

escapeParameter(param) → {string}static #

Escape a template parameter. Helper function for #getWikitext.

Parameters:

Name Type Description
param string

Parameter value

Returns:

Escaped parameter value

Type
string
Source:
Escape a template parameter.

getWikitext(content, [skipParameters]) → {string}static #

Recreate the wikitext for this transclusion, possibly containing multiple template invocations, mixed with raw wikitext snippets.

Parameters:

Name Type Attributes Default Description
content Object

MW data content
skipParameters boolean optional
 false

Exclude parameters from result

Returns:

Wikitext

Type
string
Source:

Recreate the wikitext for this transclusion, possibly containing multiple template invocations, mixed with raw wikitext snippets.