Class AttributionNoticeAbstract

constructor

• new AttributionNotice(node): AttributionNotice

• Super constructor for AttributionNotice subclasses.

  Parameters

  • node: CTEParsoidTransclusionTemplateNode

    The ParsoidTransclusionTemplateNode of this notice.

  Returns AttributionNotice

Readonlyid

Readonlyname

Readonlynode

element

• get element(): HTMLElement

• Returns HTMLElement

  The HTMLElement of the node

i

• get i(): number

• Returns number

  This template's i variable, used to identify this template in the template's parts (data-mw).

parsoid

• get parsoid(): CTEParsoidDocument

• Returns CTEParsoidDocument

  The ParsoidDocument handling this notice (specifically its node).

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

Abstractdestroy

• 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

AbstractgeneratePage

• 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

generatePreview

• generatePreview(): Promise<string & {
      summary?: string;
  }>

• Converts this notice to parsed HTML.

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

Abstractparse

• 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

Abstractsave

• save(): void

• Save the existing template parameters into the Parsoid element for this notice.

  Returns void

toWikitext

• toWikitext(): string

• Gets a wikitext string representation of this template. Used for previews.

  Returns string

  wikitext.