Template:Saved book/doc
Appearance
This is a documentation subpage for Template:Terminate sentence It may contain usage information, categories and other content that is not part of the original template page. |
This template is used on 52,000+ pages and changes may be widely noticed. Test changes in the template's /sandbox or /testcases subpages, or in your own user subpage. Consider discussing changes on the talk page before implementing them. |
This template is automatically included at the top of stored books, and automatically categorizes pages in Category:Wikipedia books (community books), Category:Wikipedia books (user books) and Category:Wikipedia books (incorrectly categorized books), as appropriate.
Optional input
[edit]- Cover parameters
These parameters only show a preview of the book cover. As of yet, they are not actually used by the renderers for anything.
Input | What it does |
---|---|
|cover-image= |
Select the default cover image for the book. Just give the file name (for example, |cover-image=Enrico Fermi 1943-49.jpg ). Please keep in mind that the image must be freely licensed and not fair use.
|
|cover-color= |
Select the default cover color for the book. Default color is "Lavender". Colors are those named in HTML color#X11 color names or using the #RRGGBB format. |
|text-color= |
Select the default cover text color for the book. Default color is black. Colors are those named in HTML color#X11 color names or using the #RRGGBB format. |
|title= |
The title of the book. (This is only used to give a preview of the book cover.) |
|subtitle= |
The subtitle of the book (optional). (This is only used to give a preview of the book cover.) |
- Book Creator parameters
In the Book: namespace, only use default parameters. Non-default parameters can be selected in the book creator. Not fully supported yet.
Input | What it does |
---|---|
|setting-papersize= |
The paper size of the book. Accepts either |setting-papersize=A4 or |setting-papersize=Letter . Default is A4. Non-default values should only be used on user books.
|
|setting-showtoc= |
|setting-showtoc=1 enables the Table of Contents, |setting-showtoc=0 disables it. Default is enabled. Non-default values should only be used on user books.
|
|setting-columns= |
Whether the book should be rendered in single-column (|setting-columns=1 ) or double-column (|setting-columns=2 format. Default is single-column. Non-default values should only be used on user books.
|
- Maintenance parameters
Input | What it does |
---|---|
|description= |
A description of the scope of the book. |
|sort_as= |
The default sort key for the book. |
|editor= |
For user books only. Specifies the editor of the book. By default this is the username. |
|wildbot= |
Used by WildBot when problems are found. See {{User:WildBot/b01}} and BRFA: WildBot 5 for details. |
|bug= |
If the book does not render properly, describe the problem here. |