Template:Room/doc

This is a documentation subpage for Template:Room.
It may contain usage information, categories and other content that is not part of the original template page.

Usage

The {{Room}} template is a navbox that helps readers locate additional articles related to rooms and spaces found in and around houses and public buildings. The emphasis of this navbox is on rooms and spaces found in residential dwellings; the terms that tend to cross over between both residential and public buildings are listed too. Additionally, some common architectural elements are included as well. The latter are limited in number, and mostly point to main article that branch off into other topics. The navbox focuses primarily on Western single-family houses.

The great house areas are rooms not commonly found outside of large manors and mansions, or are otherwise associated with such buildings.

Some terms in this navbox redirect to a different article (in many cases, to the disambiguation page). Please do not pipe these terms to pass over the redirect. There usually are subtle or historical differences between the terms, and it is likely that by distinguishing the terms, new articles may be written to expand on those differences. Additionally, when a new article is written, the template will immediately access the new article instead of bypassing it in favor of the old article.

The navbox currently uses the {{Navbox}} template, but includes attributes for {{Navbox with collapsible groups}}. The template is undergoing development and redesign, so please leave these extra attributes in-place for now. Please leave comments on the talk page if you have a preference for or against changing the template to use {{Navbox with collapsible groups}} instead of {{Navbox}}. Thanks.

Syntax

Add this template near the bottom of an article after the content and before the list of categories and any stub templates. Generally every article listed in the template should include the template. If another navbox is at the bottom of the article, the one most relevant to the topic should appear first, with the next most relevant following. Two or three navboxes should be the limit.

Standard

{{Room}}

This is the usual way of including the template in an article. Simply enter the template's name in curly braces.

Sections

{{Room|shared}}
{{Room|private}}
{{Room|passages}}
{{Room|utility}}
{{Room|great}}
{{Room|other}}
{{Room|elements}}

If this template is changed to use {{Navbox with collapsible groups}}, then entering the abbreviation for a section will cause that section to appear uncollapsed and the other sections collapsed. Usually you would specify the abbreviation for the section that contains the article (e.g., Living room would use {{Room|shared}} since the Living room article appears in the Shared residential areas section).

At this time, adding one of these additional parameters doesn't do anything (good or bad). It's safe to add now in anticipation of that feature, but it is not necessary to do so.

This template's initial visibility currently defaults to autocollapse, meaning that if there is another collapsible item on the page (a navbox, sidebar, or table with the collapsible attribute), it is hidden apart from its title bar; if not, it is fully visible.

To change this template's initial visibility, the |state= parameter may be used:

{{Room|state=collapsed}} will show the template collapsed, i.e. hidden apart from its title bar.
{{Room|state=expanded}} will show the template expanded, i.e. fully visible.

Usage

Syntax

See also