Class CopyrightProblemsListing

constructor

• new CopyrightProblemsListing(data, listingPage?, i?): CopyrightProblemsListing

• Creates a new listing object.

  Parameters

  • data: CopyrightProblemsListingData

    Additional data about the page
  • OptionallistingPage: CopyrightProblemsPage

    The page that this listing is on. This is not necessarily the page that the listing's wikitext is on, nor is it necessarily the root page.
  • i: number = 1

    A discriminator used to avoid collisions when a page is listed multiple times.

  Returns CopyrightProblemsListing

anchor

basic

element

i

id

listingPage

plainlinks

title

anchorId

• get anchorId(): string

• Returns string

  an ID representation of this listing. Helps in finding it inside of wikitext.

StaticarticleCvRegex

• get articleCvRegex(): RegExp

• Responsible for determining listings on a page. This method allows for full-metadata listing detection, and makes the process of detecting a given listing much more precise.

  This regular expression must catch three groups:

  • $1 - The initial * , used to keep the correct number of whitespace between parts.
  • $2 - The page title in the id="...", ONLY IF the page is listed with an article-cv-like template.
  • $3 - The page title in the wikilink, ONLY IF the page is listed with an article-cv-like template.
  • $4 - The page title, ONLY IF the page is a bare link to another page and does not use article-cv.

  Returns RegExp

  A regular expression.

addComment

• addComment(message, indent?): Promise<string>

• Adds a comment to an existing listing.

  Parameters

  • message: string
  • indent: boolean = false

  Returns Promise<string>

  the modified page wikitext.

getListingWikitextLines

• getListingWikitextLines(): Promise<{
      end: number;
      start: number;
  }>

• Gets the line number of a listing based on the page's wikitext. This is further used when attempting to insert comments to listings.

  This provides an object with start and end keys. The start denotes the line on which the listing appears, the end denotes the last line where there is a comment on that specific listing.

  Use in conjunction with listingPage.getWikitext() to get the lines in wikitext.

  Returns Promise<{
      end: number;
      start: number;
  }>

  See documentation body.

respond

• respond(message, summary?, indent?): Promise<void>

• Adds a comment to an existing listing AND saves the page. To avoid saving the page, use addComment instead.

  Parameters

  • message: string
  • Optionalsummary: string
  • indent: boolean = false

  Returns Promise<void>

serialize

• serialize(): Promise<SerializedCopyrightProblemsListingData>

• Serialize this listing. Used for tests.

  Returns Promise<SerializedCopyrightProblemsListingData>

StaticgetBasicListing

• getBasicListing(el): false | BasicCopyrightProblemsListingData

• A much more loose version of CopyrightProblemsListing#getListing, which only checks if a given page is a link at the start of a paragraph or <[uo]l> list. Metadata is unavailable with this method.

  Parameters

  • el: HTMLElement

  Returns false | BasicCopyrightProblemsListingData

  Data related to the listing, for use in instantiation; false if not a listing.

StaticgetListing

• getListing(el): false | FullCopyrightProblemsListingData

• Determines if a given element is a valid anchor element (<a>) which makes up a "listing" (a page for checking on the Copyright Problems page).

  Detection is based on the {{article-cv}} template. Changes to the template must be reflected here, with backwards compatibility for older listings. The {{anchor}} is not the tracked element here, since it remains invisible to the user.

  Parameters

  • el: HTMLElement

  Returns false | FullCopyrightProblemsListingData

  Data related to the listing, for use in instantiation; false if not a listing.