Thomas.Eyre: 1 revision imported

2025-01-07T20:32:08Z

1 revision imported

← Older revision		Revision as of 20:32, 7 January 2025
(No difference)

en>Thomas Eyre: 1 revision imported

2018-03-06T01:14:36Z

1 revision imported

New page

{{Documentation subpage}}
{{possible-risk}}


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

=== Usage ===
When used without parameters, it
*places subpages of a book in the book's category ({{nowrap|<code>{{BOOKCATEGORY|}}{{tlx|BOOKNAME}}</code>}}) and sorts them by chapter name.
*places a book's templates in the book's template category ({{nowrap|<code>{{BOOKCATEGORY|}}{{tlx|BOOKNAME}}/Templates</code>}}). ''This only does the right thing if a book's templates begin with''  {{nowrap|<code>Template:{{tlx|BOOKNAME}}</code>}} .
*places a book's template category in the book's category and in  {{nowrap|<code>[[:Category:Book-specific templates]]</code>}} .
*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, {{nowrap|<code>Category:My Book/Images</code>}}  would go in  {{nowrap|<code>Category:My Book</code>}}  with sort key  <code>Images</code> .

===Parameters===
Optional parameter  {{nowrap|<code><nowiki>filing=deep</nowiki></code>}}  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  {{nowrap|<code><nowiki>{{BookCat|filing=deep}}</nowiki></code>}}  on page  {{nowrap|<code>My Book/Maps/Asia</code>}}  would put that page in  {{nowrap|<code>Category:My Book/Maps</code>}}  with sort key  <code>Asia</code> .

Optional parameter  {{nowrap|<code><nowiki>template-filing=deep</nowiki></code>}}  changes the behavior on template pages to deep filing (so  {{nowrap|<code>Template:My book/Maps/Asia</code>}}  would go in  {{nowrap|<code>Category:My book/Templates/Maps</code>}}).

Optional parameter  <code>sort</code> or <code>sortkey</code> specifies a sort key to be used for categorization instead of relying on {{tl|BOOKSORTKEY}}.

Optional first unnamed parameter is a full page name to use instead of the <code><nowiki>{{FULLPAGENAME}}</nowiki></code> of the current page.

An alternative template {{tl|BookCat/diagnose}} reports the output of {{tl|BookCat}} (with or without parameters) as an inert string, rather than categorizing the current page.

=== Eamples ===
{{magic word templates/book page examples|BookCat/diagnose}}

=== Internals ===
This template itself only contains the logic to sort out the identity of the target page; deducing the appropriate categorization is then delegated to {{tl|BookCat/core}}. As of this writing, parameters assembled here are <code>namespace</code>, <code>pagename</code>, <code>fullpagename</code>, and <code>sortkey</code>; the first unnamed parameter is [[Module:TScope/doc#shiftLeft|removed]], and all other parameters are passed through to the subtemplate.

=== See also ===
* See [[Using Wikibooks/Subjects, Categories, and Classifications#Deep filing (advanced)]] for more information.
*Instances are listed at
:* [[:Category:Pages with deep filing]].
:* [[:Category:Pages passing sort key to BookCat]]
:* [[:Category:Pages passing page name to BookCat]]
* {{tl|BOOKCATEGORY}} is closely related.
<includeonly>

[[Category:Catalogue templates|{{PAGENAME}}]]

[[fr:Modèle:AutoCat]]
[[pt:Predefinição:AutoCat]]
[[ru:Шаблон:BookCat]]
[[tr:Şablon:KitapKat]]
</includeonly>

Template:BookCat/doc - Revision history

Thomas.Eyre: 1 revision imported

en>Thomas Eyre: 1 revision imported