Template:Shelf:Allbooks category/doc
 | This is a documentation subpage for Template:Shelf:Allbooks category It may contain usage information, categories and other content that is not part of the original template page. |
Usage
editUse this template on the allbooks category page of a shelf in the Wikibooks Stacks; everything on the allbooks category page other than the template call should be noincluded.
An allbooks category is associated with a shelf category, Category:Shelf:shelf, and is automatically populated with all books that belong to either Shelf:shelf or any descendant subshelf of that shelf. The name of the allbooks category is formed by appending suffix "/all books" to the name of the shelf category, thus Category:Shelf:shelf/all books.
This template, when performing its full function, checks to make sure various associated pages are set up correctly, and generates the appropriate content for the allbooks category page. If unnamed parameter 1 is non-blank, or the template is called from a non-category page, or the transcluding page does not have prefix Shelf:, the template returns the pagename of the template itself, Template:Shelf:Allbooks category.
If this template finds a problem with associated pages, it displays a notice explaining the problem and suggesting how to fix it, with buttons to perform likely remedial actions.
Internals
editThis template itself determines which sort of information request is being made, and either provides information directly, or delegates the display function to {{Template:Shelf:Allbooks category/display}}.