Equation Citator v1.3.7 Documentation
    Preparing search index...

    Function renderCalloutCitation

    • Render function for callout citations

      This implementation follows the same pattern as renderFigureCitation() but adapted for callouts/quotes.

      Usage:

      • User writes: $\ref{table:1.1}$ or $\ref{thm:2.3}$ in markdown
      • Parser detects configured prefix (e.g., "table:", "thm:", "def:")
      • Routes to this function
      • Displays as: Table. 1.1 or Theorem 2.3 (based on format setting)

      IMPORTANT: All tags in a single citation must be of the same type/prefix

      • Valid: $\ref{table:1.1, 1.2}$ (both are tables, "1.2" is short for "table:1.2")
      • Invalid: $\ref{table:1.1, thm:2.3}$ (mixed types not allowed)

      Parameters

      • plugin: default

        The main plugin instance

      • sourcePath: string

        Path to the current file

      • parent: HoverParent | null

        Hover parent for popover support

      • prefix: string

        The callout prefix (e.g., "table:", "thm:", "def:")

      • citeCalloutTags: string[]

        Array of callout tags to cite (e.g., ["1.1", "1.2"])

      • isInteractive: boolean = false

        Whether to show preview without Ctrl key (for reading mode)

      Returns HTMLElement

      HTMLElement containing the rendered citation

    Settings

    Member Visibility