The full view
Open the manual in the widget, or a chapter in its table of contents, opens the whole manual in the content area: title and logo, the version and date of the manual, a table of contents with a search field next to the text, a Go back button to the dashboard, a Print or save as PDF button and, when configured, a Give feedback button.
The full view of the example manual.
The table of contents
- It stays in view while scrolling, and scrolls itself when it is taller than the screen.
- It marks the chapter or section the reader is at: the entry whose heading has just passed below the docheader. Nothing is marked in the introduction; at the end of the page the last entry is.
- A clicked entry stays marked until the reader scrolls again, because the last sections are often too short to reach the top.
- The marked entry looks like the selected page in the page tree (the core
tokens
--), so it follows the light and dark backend and a changed primary color. It hastypo3- component- active-* aria-.current="location" - A keyboard focus ring is shown inside the entry, also on the marked one.
- Without JavaScript everything works, only without the marking.
A click on an entry leaves room between the heading and the docheader.
Print or save as PDF
The print button opens the browser's print dialog, which also saves as PDF. The print styles:
- leave out the docheader
- put the table of contents above the text
- start every chapter after the first on a new page
- add the URL after each link to another site
- always use the light colors, also in a dark backend
Remove the button with printButton: false.
Search
The search field above the table of contents filters it while the reader types.
An entry stays when every word occurs in its heading or its text; a chapter
also stays when one of its sections matches. Case and accents are ignored, so
uber finds Über uns. Escape clears the field. Without JavaScript
the field is not shown.
Searching for "teaser" leaves the chapter and the section that mention it.
Feedback
With the option feedback, every chapter and section gets a small feedback icon next to its heading, and the docheader shows Give feedback for the manual as a whole.
For a mail address, the link next to a heading opens a mail about that section:
- the subject names the manual and the section, for example Feedback: Editor manual example.org – 3.2 Fields
- the first line of the mail repeats the section: Section: 3.2 Fields
A web address, for example a feedback form, opens in a new window. The links are added by JavaScript and have a hidden text for screen readers, Give feedback on 3.2 Fields. They are left out when printing.
Version and date
version and date from the front matter
are shown under the title, the date in the language of the backend user:
Version 1.2 · Updated October 16, 2026. Update them with every change, so
readers know whether they read the current text.
Route and errors
The full view is the backend route pn_ (GET only) with the
widget identifier as only parameter. The file comes from the widget
registration, and the widget permission of the user is checked.
- An unknown identifier, a widget that is not a manual or a widget the user may not use all give a 404 Manual not available.
- A manual that cannot be read or parsed, for example because of invalid YAML in the front matter, gives Manual cannot be shown, and the error is logged.
Like every backend route, the URL carries a token, so it cannot be bookmarked; link to the dashboard instead.