Expand all

mw.editcheck.DisambiguationEditCheck

Extends

Constructor

new mw.editcheck.DisambiguationEditCheck(controller, [config], [includeSuggestions]) #

Edit check to detect links to disambiguation pages

Parameters:

Name Type Attributes Default Description
controller
config Object optional
includeSuggestions boolean optional
 false
Source:
Edit check to detect links to disambiguation pages

Properties

onBeforeSaveabstract #

Get actions to show before save

Inherited from:
Source:
Get actions to show before save

onBranchNodeChangeabstract #

Get actions to show when the focused branch node changed

Inherited from:
Source:
Get actions to show when the focused branch node changed

onDocumentChangeabstract #

Get actions to show when document changed

Overrides:
Source:
Get actions to show when document changed

Methods

act(choice, action, surface) → {jQuery.Promise|undefined}abstract #

User performs an action on an check

Parameters:

Name Type Description
choice string

action key from static.choices
action mw.editcheck.EditCheckAction
surface ve.ui.Surface

Returns:

Promise which resolves when action is complete, or undefined if there's nothing to wait on

Type
jQuery.Promise | undefined
Overrides:
Source:
User performs an action on an check

buildActionFromLinkRange(range, surfaceModel, [extraConfig]) → {mw.editcheck.EditCheckAction} #

Build an EditCheckAction from a link range

Parameters:

Name Type Attributes Description
range ve.Range
surfaceModel ve.ui.SurfaceModel
extraConfig Object optional

Extra configuration for the EditCheckAction

Returns:

Type
mw.editcheck.EditCheckAction
Inherited from:
Source:
Build an EditCheckAction from a link range

canBeShown([documentModel], [suggestion]) → {boolean} #

Find out whether the check should be applied

This is a general check for its applicability to the viewer / page, rather than a specific check based on the current edit. It's used to filter out checks before any maybe-expensive content analysis happens.

Parameters:

Name Type Attributes Default Description
documentModel ve.dm.Document optional

if attached to a known document
suggestion boolean optional
 false

Whether we are checking for suggestion mode

Returns:

Whether the check should be shown

Type
boolean
Inherited from:
Source:

Find out whether the check should be applied

This is a general check for its applicability to the viewer / page, rather than a specific check based on the current edit.

canBeStale() → {boolean} #

Check if the edit check can be stale

Returns:

Type
boolean
Inherited from:
Source:
Check if the edit check can be stale

dismiss(action) #

Dismiss a check action

Parameters:

Name Type Description
action mw.editCheck.EditCheckAction
Inherited from:
Source:
Dismiss a check action

getAddedContentRanges(documentModel) → {Array.<ve.Range>} #

Get content ranges where at least the minimum about of text has been added

Parameters:

Name Type Description
documentModel ve.dm.Document

Returns:

Type
Array.<ve.Range>
Inherited from:
Source:
Get content ranges where at least the minimum about of text has been added

getAddedNodes(documentModel, [type]) → {Array.<ve.dm.Node>} #

Find nodes that were added during the edit session

Parameters:

Name Type Attributes Description
documentModel ve.dm.Document
type string optional

Type of nodes to find, or all nodes if false

Returns:

Type
Array.<ve.dm.Node>
Inherited from:
Source:
Find nodes that were added during the edit session

getAddedRanges(documentModel, coveredNodesOnly, onlyContentRanges) → {Array.<ve.Range>} #

Get content ranges which have been inserted

Parameters:

Name Type Description
documentModel ve.dm.Document
coveredNodesOnly boolean

Only include ranges which cover the whole of their node
onlyContentRanges boolean

Only return ranges which are content branch node interiors

Returns:

Type
Array.<ve.Range>
Inherited from:
Source:
Get content ranges which have been inserted

getContentRangesFromRange(documentModel, range, covers) → {Array.<ve.Range>} #

Return the content ranges (content branch node interiors) contained within a range

For a content branch node entirely contained within the range, its entire interior range will be included. For a content branch node overlapping with the range boundary, only the covered part of its interior range will be included.

Parameters:

Name Type Description
documentModel ve.dm.Document

The documentModel to search
range ve.Range

The range to include
covers boolean

Only include ranges which cover the whole of their node

Returns:

The contained content ranges (content branch node interiors)

Type
Array.<ve.Range>
Inherited from:
Source:

Return the content ranges (content branch node interiors) contained within a range

For a content branch node entirely contained within the range, its entire interior range will be included.

getDescription(action) → {jQuery|string|function|OO.ui.HtmlSnippet} #

Parameters:

Name Type Description
action mw.editcheck.EditCheckAction

Returns:

Type
jQuery | string | function | OO.ui.HtmlSnippet
Inherited from:
Source:

getFooter(action) → {jQuery|string|function|OO.ui.HtmlSnippet|undefined} #

Get the footer of the check, if any

Parameters:

Name Type Description
action mw.editcheck.EditCheckAction

Returns:

Type
jQuery | string | function | OO.ui.HtmlSnippet | undefined
Inherited from:
Source:
Get the footer of the check, if any

getHeadingHierarchyFromOffset(offset, documentModel) → {Array.<ve.dm.MWHeadingNode>} #

Get the heading hierarchy at a given range

Parameters:

Name Type Description
offset number
documentModel ve.dm.Document

Returns:

Heading nodes from nearest to furthest

Type
Array.<ve.dm.MWHeadingNode>
Inherited from:
Source:
Get the heading hierarchy at a given range

getLinkFromFragment(fragment) → {ve.dm.LinkAnnotation|null} #

Get the link annotation from a fragment

Parameters:

Name Type Description
fragment ve.dm.LinearFragment

Returns:

The link annotation, or null if none found

Type
ve.dm.LinkAnnotation | null
Inherited from:
Source:
Get the link annotation from a fragment

getModifiedAnnotationRanges(documentModel, [names]) → {Array.<ve.dm.LinearData.AnnotationRange>} #

Get annotation ranges where at least some content has been modified

Parameters:

Name Type Attributes Description
documentModel ve.dm.Document
names Array.<string> optional

Names of annotations to filter for

Returns:

Annotation ranges, containing an annotation and its range

Type
Array.<ve.dm.LinearData.AnnotationRange>
Inherited from:
Source:
Get annotation ranges where at least some content has been modified

getModifiedContentBranchNodes(documentModel) → {Array.<ve.dm.ContentBranchNode>} #

Get ContentBranchNodes where some text has been changed

Parameters:

Name Type Description
documentModel ve.dm.Document

Returns:

Type
Array.<ve.dm.ContentBranchNode>
Inherited from:
Source:
Get ContentBranchNodes where some text has been changed

getModifiedContentRanges(documentModel) → {Array.<ve.Range>} #

Get content ranges where at least the minimum about of text has been changed

Parameters:

Name Type Description
documentModel ve.dm.Document

Returns:

Type
Array.<ve.Range>
Inherited from:
Source:
Get content ranges where at least the minimum about of text has been changed

getModifiedLinkRanges(surfaceModel) → {Array.<ve.dm.LinearData.AnnotationRange>} #

Get modified link annotation ranges in the document

Parameters:

Name Type Description
surfaceModel ve.ui.SurfaceModel

Returns:

Annotation ranges, containing a link annotation and its range

Type
Array.<ve.dm.LinearData.AnnotationRange>
Inherited from:
Source:
Get modified link annotation ranges in the document

getModifiedRanges(documentModel, coveredNodesOnly, onlyContentRanges, onlyPureInsertions) → {Array.<ve.Range>} #

Get content ranges which have been modified

In suggestion mode, this will return all content ranges.

Parameters:

Name Type Description
documentModel ve.dm.Document
coveredNodesOnly boolean

Only include ranges which cover the whole of their node
onlyContentRanges boolean

Only return ranges which are content branch node interiors
onlyPureInsertions boolean

Only return ranges which didn't replace any other content

Returns:

Type
Array.<ve.Range>
Inherited from:
Source:

Get content ranges which have been modified

In suggestion mode, this will return all content ranges.

getName() → {string} #

Get the name of the check type

Returns:

Check type name

Type
string
Inherited from:
Source:
Get the name of the check type

getPrompt(action) → {jQuery|string|function|OO.ui.HtmlSnippet|undefined} #

Get the prompt for the check's actions, if any

Parameters:

Name Type Description
action mw.editcheck.EditCheckAction

Returns:

Type
jQuery | string | function | OO.ui.HtmlSnippet | undefined
Inherited from:
Source:
Get the prompt for the check's actions, if any

getTitle(action) → {jQuery|string|function|OO.ui.HtmlSnippet} #

Get the title of the check

Parameters:

Name Type Description
action mw.editcheck.EditCheckAction

Returns:

Type
jQuery | string | function | OO.ui.HtmlSnippet
Inherited from:
Source:
Get the title of the check

isDismissedId(id) → {boolean} #

Check if an action with a given ID has been dismissed

Parameters:

Name Type Description
id string

Returns:

Type
boolean
Inherited from:
Source:
Check if an action with a given ID has been dismissed

isDismissedRange(range, name) → {boolean} #

Check if this type of check has been dismissed covering a specific range

Parameters:

Name Type Description
range ve.Range
name string

of the tag

Returns:

Type
boolean
Inherited from:
Source:
Check if this type of check has been dismissed covering a specific range

isOffsetQuoted(offset, documentModel) → {boolean} #

Check if a specific offset in the document counts as being quoted

This is approximate because "quoted" is complicated. Various types of quotes are grouped together, and we count whether there's an odd number of any group preceding the offset within the current content-containing node.

Special attention is paid to distinguishing apostrophes from single-quotes, and blockquote nodes are explicitly always quoted.

Parameters:

Name Type Description
offset number
documentModel ve.dm.Document

Returns:

Type
boolean
Inherited from:
Source:

Check if a specific offset in the document counts as being quoted

This is approximate because "quoted" is complicated.

isRangeInValidSection(range, documentModel, [config]) → {boolean} #

Check if a modified range is a section we allow

This checks config.ignoreSections and config.includeSections, which are arrays containing strings that will be compared to the heading names. As a special-case, an empty string will be treated as referring to the lead section. Articles that don't contain any headings at all are "stubs" and won't be treated as having a lead section.

Parameters:

Name Type Attributes Description
range ve.Range
documentModel ve.dm.Document
config Object optional

Override config to use instead of the check's default

Returns:

Whether the range is in a section we don't ignore

Type
boolean
Inherited from:
Source:

Check if a modified range is a section we allow

This checks config.ignoreSections and config.includeSections, which are arrays containing strings that will be compared to the heading names.

isRangeValid(range, documentModel, [config]) → {boolean} #

Test whether the range is valid for the check to apply

Parameters:

Name Type Attributes Description
range ve.Range
documentModel ve.dm.Document
config Object optional

Override config to use instead of the check's default

Returns:

Type
boolean
Inherited from:
Source:
Test whether the range is valid for the check to apply

isTaggedId(tag, id) → {boolean} #

Check if an action with a given ID has a given tag

Parameters:

Name Type Description
tag string
id string

Returns:

Type
boolean
Inherited from:
Source:
Check if an action with a given ID has a given tag

isTaggedRange(tag, range, name) → {boolean} #

Check if this type of check has a given tag

Parameters:

Name Type Description
tag string
range ve.Range
name string

of the tag

Returns:

Type
boolean
Inherited from:
Source:
Check if this type of check has a given tag

selectAnnotation(fragment, surface) #

Select the link annotation in the fragment

Parameters:

Name Type Description
fragment ve.dm.LinearFragment
surface ve.ui.Surface
Inherited from:
Source:
Select the link annotation in the fragment

showSuccess([message]) #

Show a success notification

Parameters:

Name Type Attributes Description
message string optional

Message to show; defaults to static.success
Inherited from:
Source:
Show a success notification

tag(tag, action) #

Tag a check action

TODO: This is asymmetrical. Do we want to split this into two functions, or unify isTaggedRange/isTaggedId into one function?

Parameters:

Name Type Description
tag string
action mw.editCheck.EditCheckAction
Inherited from:
Source:

Tag a check action

TODO: This is asymmetrical.

takesFocus() → {boolean} #

Returns:

Type
boolean
Inherited from:
Source:

untag(tag, action) → {boolean} #

Untag a check action

TODO: This is asymmetrical. Do we want to split this into two functions, or unify isTaggedRange/isTaggedId into one function?

Parameters:

Name Type Description
tag string
action mw.editCheck.EditCheckAction

Returns:

Whether anything was untagged

Type
boolean
Inherited from:
Source:

Untag a check action

TODO: This is asymmetrical.