Template documentationedit documentation
This template is a meta template for building menu templates.
Menus are useful for linking to related pages and easing navigation through them. Menus that use this template adapt well to mobile and desktop devices, big and small screens, dark and light mode, print and read mode. You can also use the "book" parameter to enable downloading all pages in the menu as a single PDF.
To create a new menu, first read the documentation below and then use the following form:
Examples
Basic
{{Menu | list = * First group ** [[First page]] ** [[Second page]] ** [[Third page]] * Second group ** [[Fourth page]] ** [[Fifth page]] ** [[Sixth page]] * Third group ** [[Seventh page]] ** [[Eighth page]] ** [[Ninth page]] }}
Intermediate
{{Menu | center = yes | title = Title of the collection | list = First group * [[First page]] * [[Second page]] * [[Third page]] Second group * [[Fourth page]] * [[Fifth page]] * [[Sixth page]] Third group * [[Seventh page]] * [[Eighth page]] * [[Ninth page]] }}
Advanced
{{Menu | collapse = yes | center = yes | name = Menu name | logo = Appropedia.png | logo-link = Welcome to Appropedia | title = Appropedia | subtitle = The Sustainability Wiki | image = Tctscover.png | image-link = To Catch the Sun | image-size = x90px | text = "Sometimes the answer is nothing." | list = * [[First page]] * [[Second page]] * [[Third page]] Second group * [[Fourth page]] * [[Fifth page]] * [[Sixth page]] Third group * [[Seventh page]] * [[Eighth page]] * [[Ninth page]] }}
See also
- Template:Subpages menu - Generic menu for displaying the subpages of a page
- MediaWiki:TemplateMenu.js - JavaScript code run when this template is found
- Category:Menu templates - Templates that use this meta template
- Template:Horizontal menu - Meta template for creating horizontal menus
- Category:Meta templates - Other meta templates
Template data
Use this meta template to build navigation menus.
Parameter | Description | Type | Status | |
---|---|---|---|---|
Center | center | Center the content of the menu
| Boolean | optional |
Collapse | collapse | Collapse the menu by default
| Boolean | optional |
Progress bar | progress-bar | Enable the progress bar
| Boolean | optional |
Progress buttons | progress-buttons | Enable the Start / Previous / Next buttons
| Boolean | optional |
Name | name | Name of the menu
| String | optional |
Title | title | Title of the menu, usually linked to the main page of the collection
| String | optional |
Subtitle | subtitle | Subtitle of the menu | String | optional |
Text | text | Free-form text after the subtitle but before the links | String | optional |
Logo | logo | Logo above the title
| File | optional |
Logo size | logo-size | Size of the logo
| String | optional |
Logo link | logo-link | Link of the logo
| Page name | optional |
Image | image | Image below the title and subtitle
| File | optional |
Image size | image-size | Size of the image
| String | optional |
Image link | image-link | Link of the image
| Page name | optional |
Book | book | Enable button to download all pages linked in the menu as a single PDF
| Boolean | optional |
Book title | book-title | Title of the generated book, if different from the menu title
| String | optional |
Book subtitle | book-subtitle | Subtitle of the generated book, if different from the menu subtitle
| String | optional |
Book image | book-image | Image of the generated book, if different from the menu image
| String | optional |
Book subtitle | book-authors | Authors of the generated book
| String | optional |