Skip to content

Extension points

phil/footnotes-sidenotes

The library is plain PHP: it declares no service, and its classes are final. What an application chooses lives in the values it passes in.

PointHow
Where numbering starts againNoteOptions::$restart, $chapterLevel, $pageMarkers
How numbers are writtenNumbering::decimal(), lowerRoman(), upperRoman(), symbols($sequence)
The numbering of a localeNoteOptions::$locales, by locale or language
Where notes goThe Placement of each render()
The rendering of the other blocksThe HtmlRenderer given to NotesRenderer, with its own renderers and filters
What a note may holdThe InlineSanitizer and the profile given to NotesRenderer, rich by default
The wordsNoteLabels, built with the application's translations
Identifiers$idPrefix of render()
The lookThe application's own rules over the classes, or the tokens the sheets read; see Styling
The numbering of natural pagesThe application's print rules; see Print
The conversion of other blocks to textThe PlainText given to NotesPlainText
What to do about a problemThe application reads Resolution::$problems: refuse, warn or carry on
Catching the library's errorsEvery exception implements Exception\FootnotesException