Template:Book Header/Doc

From Starfield Wiki
Jump to: navigation, search

Summary[edit]

This template creates the header for a book and adds relevant categories and trail entries. While primarily intended to be used with the various book-related templates like {{Lore Book}} and {{Game Book}}, it can also be used on its own for special cases. Note that unlike the aforementioned templates, Book Header does not alter subsequent formatting.

Parameters[edit]

All parameters listed here are automatically inherited from the calling template. It should only be necessary to specify them if calling Book Header directly from a page. The calling template is responsible for saving the data, if necessary—this template only displays and categorizes the information.

Book Header
Parameter Scope Description
sumtitle optional The title to use in the book summary if it doesn't match the title to be used elsewhere. If not provided, LABELNAME will be used.
author optional Name of the author of the book.
sumauthor optional The name of the author to use in the book summary if it doesn't match the title to be used elsewhere.
description required A brief description of the book.
textnote optional An out-of-game note about the book, displayed at the bottom of the header. An extra dividing line will be added so the note is clearly separated from both the header and the body of the book.
Category/Trail Parameters
coded optional Set to "yes" to add the page to the Coded Documents category
collection optional The name of the collection the book belongs to.
compilation optional Set to "yes" if the book is a compilation.
faction optional Associated faction for book.
grouping optional Which letter page to group the book in. Must be upper case. Only used in Lore space.
hasmap optional Set to "yes" to add the page to the Map Notes category
map optional Map marker(s) added by book.
news optional Set to "yes" to add the pages to the Newspaper category instead of Books
note optional Set to "yes" to add the pages to the Notes category instead of Books
quest optional Quest for which the book is needed.
questrel optional Quest to which the book is related, but not needed.
skill optional Skill trained by book.
sortkey optional Title of book to be used for alphabetical sorting in categories. This will also be used for the trail if grouping is not provided. If not provided, standard DEFAULTSORT rules apply.
spell optional Spell trained by book.
type optional The type of book, for categorization purposes (e.g., Category:Skyrim-Books-List 0).
nocat optional Set to "yes" to skip Categories.
notrail optional Set to "yes" to hide the usual breadcrumb trail.