Expand all

ve.dm

Namespace for all VisualEditor DataModel classes, static methods and static properties.

Classes

MWAlienAnnotationNode
DataModel MediaWiki alien annotation node.
MWAlienBlockExtensionNode
DataModel MediaWiki alien block extension node.
MWAlienExtensionNode
DataModel MediaWiki alien extension node.
MWAlienInlineExtensionNode
DataModel MediaWiki alien inline extension node.
MWAlienMetaItem
DataModel MW-specific meta item.
MWAnnotationNode
DataModel MW node for mw:Annotation tags.
MWBlockExtensionNode
DataModel MediaWiki block extension node.
MWBlockImageNode
DataModel MediaWiki image node.
MWCategoryMetaItem
DataModel category meta item.
MWDefaultSortMetaItem
DataModel category default sort meta item.
MWDisplayTitleMetaItem
DataModel display title meta item.
MWEntityNode
DataModel MediaWiki entity node.
MWExtensionNode
DataModel MediaWiki extension node.
MWExternalLinkAnnotation
DataModel MediaWiki external link annotation.
MWFlaggedMetaItem
DataModel flagged meta item abstract (for pairs of meta items).
MWGalleryCaptionNode
DataModel gallery caption node.
MWGalleryImageCaptionNode
DataModel gallery image caption node.
MWGalleryImageNode
DataModel MediaWiki gallery image node.
MWGalleryNode
DataModel MediaWiki gallery node.
MWHeadingNode
DataModel MediaWiki heading node.
MWHiddenCategoryMetaItem
DataModel hidden category meta item (for __HIDDENCAT__).
MWImageCaptionNode
DataModel image caption item node.
MWImageModel
MediaWiki image model.
MWImageNode
DataModel MediaWiki image node.
MWIncludesNode
DataModel MW node for noinclude, includeonly and onlyinclude tags.
MWIndexMetaItem
DataModel index meta item (for __INDEX__ and __NOINDEX__).
MWInlineExtensionNode
DataModel MediaWiki inline extension node.
MWInlineImageNode
DataModel MediaWiki image node.
MWInternalLinkAnnotation
DataModel MediaWiki internal link annotation.
MWLanguageMetaItem
DataModel language meta item.
MWLanguageVariantBlockNode
DataModel MediaWiki language variant block node.
MWLanguageVariantHiddenNode
DataModel MediaWiki language variant hidden node.
MWLanguageVariantInlineNode
DataModel MediaWiki language variant inline node.
MWLanguageVariantNode

DataModel MediaWiki language variant node, used to represent LanguageConverter markup.

MWMagicLinkIsbnType
An ISBN magic link.
MWMagicLinkNode
DataModel MediaWiki magic link node.
MWMagicLinkPmidType
A PMID magic link.
MWMagicLinkRfcType
An RFC magic link.
MWMagicLinkType
Encapsulation of a particular magic link type.
MWNewSectionEditMetaItem
DataModel new section edit link meta item (for __NEWSECTIONLINK__ and __NONEWSECTIONLINK__).
MWNoContentConvertMetaItem
DataModel disable content conversion meta item (for __NOCONTENTCONVERT__ and __NOCC__).
MWNoEditSectionMetaItem
DataModel disable section edit links meta item.
MWNoGalleryMetaItem
DataModel disable gallery meta item (for __NOGALLERY__).
MWNoTitleConvertMetaItem
DataModel disable title conversion meta item (for __NOTITILECONVERT__ and __NOTC__).
MWNowikiAnnotation

DataModel MediaWiki nowiki annotation

Represents <nowiki> tags (in HTML as <span typeof="mw:Nowiki">) and unwraps them when they change so as to retrigger Parsoid's escaping mechanism.

MWNumberedExternalLinkNode
DataModel MediaWiki numbered external link node.
MWParameterModel

Represents a parameter that's part of a template invocation, centered around the parameter's value.

MWPreNode
DataModel MediaWiki pre node.
MWPreformattedNode
DataModel MediaWiki preformatted node.
MWRedirectMetaItem
DataModel redirect meta item.
MWSignatureNode
DataModel MediaWiki signature node.
MWStaticRedirectMetaItem
DataModel enable static redirect meta item.
MWTOCMetaItem
DataModel TOC meta item (for __FORCETOC__ and __NOTOC__).
MWTableNode
DataModel MediaWiki table node.
MWTemplateModel

Represents a template invocation that's part of a (possibly unbalanced) sequence of template invocations and raw wikitext snippets.

MWTemplatePlaceholderModel

Represents a not yet realized template invocation as long as the user is still searching for a template name.

MWTemplateSpecModel

Holds a mixture of:

  • A copy of a template's specification as it is documented via TemplateData.
MWTransclusionBlockNode
DataModel MediaWiki transclusion block node.
MWTransclusionContentModel
Represents a raw wikitext snippet that is part of an unbalanced sequence of template invocations.
MWTransclusionInlineNode
DataModel MediaWiki transclusion inline node.
MWTransclusionModel
Represents a MediaWiki transclusion, i.e.
MWTransclusionNode
DataModel MediaWiki transclusion node.
MWTransclusionPartModel
Abstract base class for items in a ve.dm.MWTransclusionModel.
MWTransclusionTableCellNode
DataModel MediaWiki transclusion table cell node.
MWWikitextSurface
DataModel surface.
MWWikitextSurfaceFragment
DataModel MWWikitextSurfaceFragment.

Type Definitions

MWTemplatePageMetadata #

Object literal returned by the TemplataData API. Expected to be in formatversion=2, guaranteed via ve.init.mw.Target#getContentApi.

Properties:

Name Type Attributes Description
missing string | boolean optional

Either "1" or true

notemplatedata string | boolean optional

Either "1" or true when there is no user-provided documentation params are auto-detected in this case.

title string

Template page name including the "Template:" namespace

description string | Object.<string, string> optional

Template description

params Object.<string, ve.dm.MWTemplateParamDescription> optional

Parameters by param name

paramOrder Array.<string> optional

Preferred parameter order as documented via TemplateData. If given, the TemplateData API makes sure this contains the same parameters as params.

sets Array.<ve.dm.MWTemplateSpecModel.Set> optional

List of parameter sets, i.e. parameters that belong together (whatever that means, this feature is underspecified and unused)

maps Object.<string, Object> optional

Source to target parameter mappings for consumers like Citoid or gadgets

Source:
Object literal returned by the TemplataData API.

MWTemplateParamDescription #

Object literal

Properties:

Name Type Attributes Description
label string | Object.<string, string> optional
description string | Object.<string, string> optional
suggestedvalues Array.<string> optional
default string optional
example string | Object.<string, string> optional
autovalue string optional
type string optional
aliases Array.<string> optional
required boolean optional
suggested boolean optional
deprecated boolean | string optional
Source:
Object literal

MWTransclusionPartInstruction #

Object literal

Properties:

Name Type Attributes Description
remove ve.dm.MWTransclusionPartModel optional
add ve.dm.MWTransclusionPartModel optional
index number optional
deferred jQuery.Deferred optional
Source:
Object literal