Options
All
  • Public
  • Public/Protected
  • All
Menu

Module chapter-navigation

Index

Functions

Functions

addChapterEndAnchor

addChapterInPageNavigation

  • addChapterInPageNavigation(doc: Document, root: DOMStringLike): void

  • Adds navigation between chapters (prev chapter link at the beggining and next chapter link at the end) to a provided list of documents (chapters).

    Parameters

    • doc: Document

      Document representing a chapter

    • root: DOMStringLike

      DOMString for selecting content root

    Returns void

addChapterStartAnchor

  • addChapterStartAnchor(doc: Document, root: DOMStringLike): void

addFullTextUrl

  • addFullTextUrl(doc: Document, url: string, root: DOMStringLike): void

createLink

  • createLink(doc: Document, rel: Rel, urlFragment: URLFragment, text: string, callback: (anchor: Node) => void): void

  • Parameters

    • doc: Document
    • rel: Rel
    • urlFragment: URLFragment
    • text: string
    • callback: (anchor: Node) => void
        • (anchor: Node): void

        • Parameters

          • anchor: Node

          Returns void

    Returns void

Generated using TypeDoc