A page from a template with a header choice
The page template describes its parts, and one setting picks which header to use: compact or expanded. Both pages below are built from the same template files and differ only in the setting value.
This is an advanced feature for those who build pages with a program. Regular documentation pages do not need it.
Compact header
Expanded header
How it works
recipe.jsonis the template: the header gets a fragment chosen by theheaderModevalue, and the main part gets the text from thebodyvalue.- The values file sets
headerMode:compactorexpanded. Everything else is shared by the two pages. - The headers are separate files. The compact one has only the title. The expanded one has a line about the section and API version above the title and a summary below it: the request, the deadline and the event that arrives with the result.
- A Docara page points to its set of files with the
composition_recipeline at the start of the Markdown. SIMAI Framework builds the page during the site build; nothing is computed in the browser.
compact.md
---title: "Page from a template: compact header"description: A Docara page that the Framework builds from a file template, content and a setting.composition_recipe: composition/descriptor-compact.en.jsonnoindex: true---What you can change
| Parameter | What it changes |
|---|---|
headerMode |
The header variant: compact or expanded |
composition_recipe |
Which set of template files builds the page |