Class MergedFromTemplate

Represents a single {{merged-from}} template in the Parsoid document.

Hierarchy (view full)

AttributionNotice
- MergedFromTemplate

Implements

Index

Constructors

constructor

new MergedFromTemplate(node): MergedFromTemplate
Super constructor for AttributionNotice subclasses.
Parameters
- node: CTEParsoidTransclusionTemplateNode
  The ParsoidTransclusionTemplateNode of this notice.
Returns MergedFromTemplate
Inherited from AttributionNotice.constructor
- Defined in src/modules/ante/models/AttributionNotice.ts:57

Properties

`Optional`afd

afd?: string

If the merge was the result of an AfD, this should be the full page title of the AfD discussion.

Example

"Wikipedia:Articles for deletion/Wikipedia"

article

article: string

The article that content from the target page was originally from.

date

date: string

The date of the merge

`Readonly`id

id: string

A unique ID for this template. Derived from the template name and its Parsoid about.

`Readonly`name

name: string

A unique name for this template. Derived from the Parsoid about for its node.

`Readonly`node

node: CTEParsoidTransclusionTemplateNode

The template transclusion node that serves as a reference to an element on the Parsoid DOM.

`Optional`talk

talk?: string

Whether to link to the original article's talk page or not.

`Optional`target

target?: string

The target of the merge.

Accessors

element

get element(): HTMLElement
Returns HTMLElement
The HTMLElement of the node
Inherited from AttributionNotice.element
- Defined in src/modules/ante/models/AttributionNotice.ts:39

i

get i(): number
Returns number
This template's i variable, used to identify this template in the template's parts (data-mw).
Inherited from AttributionNotice.i
- Defined in src/modules/ante/models/AttributionNotice.ts:47

parsoid

get parsoid(): CTEParsoidDocument
Returns CTEParsoidDocument
The ParsoidDocument handling this notice (specifically its node).
Inherited from AttributionNotice.parsoid
- Defined in src/modules/ante/models/AttributionNotice.ts:33

Methods

accessTemplateData

accessTemplateData(callback): void
Provides low-level access to a template's data-mw entry. When possible, use functions from .node instead, as these are much more stable.
Parameters
- callback: TemplateDataModifier
  The callback for data-modifying operations.
Returns void
Inherited from AttributionNotice.accessTemplateData
- Defined in src/modules/ante/models/AttributionNotice.ts:72

destroy

destroy(): void
Destroys the notice by removing it from the Parsoid document. Optionally, a subclass can mark itself as destroyed or wipe its values.

Returns void
Overrides AttributionNotice.destroy
- Defined in src/modules/ante/models/templates/MergedFromTemplate.ts:98

generatePage

generatePage(dialog): AttributionNoticePageLayout
Generates an OOUI PageLayout for this notice. Used by the main dialog to generate pages. Do not cache - the dialog is responsible for caching.
Parameters
- dialog: any
Returns AttributionNoticePageLayout
Implementation of AttributionNoticePageGenerator.generatePage
Overrides AttributionNotice.generatePage
- Defined in src/modules/ante/models/templates/MergedFromTemplate.ts:108

generatePreview

generatePreview(): Promise<string & {
summary?: string;
}>
Converts this notice to parsed HTML.

Returns Promise<string & {
summary?: string;
}>
Inherited from AttributionNotice.generatePreview
- Defined in src/modules/ante/models/AttributionNotice.ts:168

parse

parse(): void
Extracts the parameters from this notice and stores them in the object. This must NEVER destroy unknown parameters. This function does not always pull all parameters from the template, only those that are known.

This should be implemented by subclasses.

Returns void
Overrides AttributionNotice.parse
- Defined in src/modules/ante/models/templates/MergedFromTemplate.ts:56

save

save(): void
Save the existing template parameters into the Parsoid element for this notice.

Returns void
Overrides AttributionNotice.save
- Defined in src/modules/ante/models/templates/MergedFromTemplate.ts:77

toWikitext

toWikitext(): string
Gets a wikitext string representation of this template. Used for previews.

Returns string
wikitext.
Inherited from AttributionNotice.toWikitext
- Defined in src/modules/ante/models/AttributionNotice.ts:146

Class MergedFromTemplate

Hierarchy (view full)

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MergedFromTemplate

Properties

Optionalafd

Example

article

date

Readonlyid

Readonlyname

Readonlynode

Optionaltalk

Optionaltarget

Accessors

element

Returns HTMLElement

i

Returns number

parsoid

Returns CTEParsoidDocument

Methods

accessTemplateData

Parameters

Returns void

destroy

Returns void

generatePage

Parameters

Returns AttributionNoticePageLayout

generatePreview

Returns Promise<string & { summary?: string; }>

parse

Returns void

save

Returns void

toWikitext

Returns string

Settings

On This Page

`Optional`afd

`Readonly`id

`Readonly`name

`Readonly`node

`Optional`talk

`Optional`target

Returns Promise<string & {
summary?: string;
}>