Skip to content

Annotator Settings

Vladimir Schneider edited this page Mar 30, 2019 · 5 revisions

Annotator configuration settings are found in Preferences on OS X and File/Settings on Windows and Linux, Languages & Frameworks > Markdown > Annotator

Screenshot_Settings_Annotator.png

Each checkbox corresponds to an annotation with the same text:

ℹ️ Duplicate .... definition annotations apply to the defining element when a duplicate definition exists for the same reference id. Duplicates exist for ... or Anchor reference has duplicates ... annotations apply to the referencing element when its reference id is defined by several defining elements.

  • Links
    • Case mismatch between link and target file name
    • File name contains spaces, use '-' instead
    • Image links only resolve when they target raw files on GitHub
    • Link extension does not match target file
    • Link file is missing an extension
    • Link has a wrong extension
    • Links to wiki pages with a file extension
    • Repository relative links cannot resolve across repository boundaries
    • Target file has an extension not compatible with link
    • Target file is missing an extension
    • Target file is not on GitHub
    • Target file not under the same git root directory as link source
    • Unresolved link reference
  • Link Anchors
    • Anchor line reference exceeds file line count
    • Anchor line reference format is not standard format for site
    • Anchor reference has duplicates in file
    • Anchor reference id is not resolved
    • Anchor reference is not validated
  • Link References
    • Duplicate reference definition
    • Unresolved reference id
      • Unresolved numeric reference id
    • Duplicates exist for reference id
    • Unused reference definition
  • Reference Elements
    • Abbreviations
      • Duplicate abbreviation definition
      • Unused abbreviation definition
    • Id Attribute
      • Duplicate id attribute
      • Unused id attribute
    • Enumerated References
      • Format
        • Duplicate enumerated reference format definition
        • Duplicates exist for enumerated reference
        • Unresolved enumerated reference format name
        • Unused enumerated reference format definition
      • Reference Id
        • Duplicate enumerated reference id
        • Unused enumerated reference id
    • Footnotes
      • Duplicate footnote definition
      • Unresolved footnote name
      • Duplicates exist for footnote
      • Unused footnote definition
    • Macros
      • Duplicate macro definition
      • Unresolved macro name
      • Duplicates exist for macro
      • Unused macro definition
  • Table of Contents
    • Table of Contents needs updating
    • Table of Contents Title should not be empty
  • Wiki
    • Case mismatch between wiki link and target file name
    • GitHub wiki links cannot contain slashes
    • GitHub wiki links resolve only in wiki pages
    • GitHub wiki page ref cannot consist only of an anchor reference
    • Path to wiki page contains anchor marker #
    • Target file not under wiki home directory
    • Wiki link contains '-', use ' ' instead
    • Wiki link matches multiple target files
    • Wiki link target file has an extension not compatible with link
    • Wiki link target file name contains anchor marker #
    • Wiki link target file not under the same wiki home directory as link source
    • Wiki link targets resolve by name only