Template:BookCat/doc

From Wikibooks, open books for an open world
Jump to: navigation, search

This template puts the page on which it's used ({{FULLPAGENAME}}) into appropriate categories, based on certain page-naming and page-categorization conventions.

Usage[edit]

When used without parameters, it

  • places subpages of a book in the book's category (Category:{{ROOTBOOKNAME}}) and sorts them by chapter name.
  • places a book's templates in the book's template category (Category:{{ROOTBOOKNAME}}/Templates). This only works if a book's templates begin with  Template:{{ROOTBOOKNAME}} .
  • places a book's template category in the book's category and in  Category:Book-specific templates .
  • places any other category in its parent, sorted by the category's last name. The parent has the same name except removing everything from the last slash on; and the last name is the part that was removed after that last slash. For example, Category:My Book/Images  would go in  Category:My Book  with sort key  Images .

Parameters[edit]

Optional parameter  filing=deep  changes the behavior on book pages, so that a book page with more than one slash in its name is placed in a subcategory of the category where its parent page would be placed, sorted by the page's last name. For example, using  {{BookCat|filing=deep}}  on page  My Book/Maps/Asia  would put that page in  Category:My Book/Maps  with sort key  Asia .

Optional parameter  template-filing=deep  changes the behavior on template pages to deep filing (so  Template:My book/Maps/Asia  would go in  Category:My book/Templates/Maps).

Optional first unnamed parameter is a sort key for use when categorizing the page.

Internals[edit]

This template delegates to different subtemplates, depending on namespace. Besides making the markup easier to read, this means both that changes in handling of one namespace will not affect transcluding pages in a different namespace, and that transcluding pages in a given namespace can be listed using Special:WhatLinksHere on the appropriate subtemplate.

See also[edit]