模組:Subject bar/doc

此頁面是Module:Subject bar的模块文档。
此頁面可能包含了模板的使用說明、分類和其他内容。

此模块使用Lua语言：

Module:Subject bar

This navigational template is intended be placed at the end of an article, after the References or External links and before the categories. It offers an variant to several floating box templates that link to books, portals, and Wikipedia's sister projects but also typically cause formatting issues because of their size and alignment.

Usage

Note: None of the parameters should be capitalized. For example, use "commons", "v"…, not "Commons", "V"…

All parameters

When copying all parameters in either the vertical or horizontal layouts, delete those which are not needed. If no links are needed for a particular type, such as "books", that part of the template will not appear on the page.

All parameters, horizontal layout: {{Subject bar |book= |portal= |commons= |commons-search= |species= |species-search= |n= |n-search= |wikt= |wikt-search= |b= |b-search= |q= |q-search= |s= |s-search= |v= |v-search= |voy= |voy-search=}}

All parameters, vertical layout

{{Subject bar
|book           = 
|portal         = 
|commons        = 
|commons-search = 
|species        = 
|species-search = 
|n              = 
|n-search       = 
|wikt           = 
|wikt-search    = 
|b              = 
|b-search       = 
|q              = 
|q-search       = 
|s              = 
|s-search       =
|spoken         =
|v              = 
|v-search       = 
|voy            = 
|voy-search     = 
}}

Using multiple books and portals

The for articles linking to a single book or portal, use the sample code that follows. If more than one book or portal is needed (up to 10 of each), append a number as follows:
{{Subject bar |book1= |book2= |book3= | ... | |portal1= |portal2= |portal3= |...}}

Required parameters

No single parameter is required, however, at least one book, portal, or sister project should be utilized with the use of this template. Since Wikipedia articles typically are in the domain of one or more WikiProjects, and since WikiProjects often have a portal, almost every article should list at least one portal.

Optional parameters

Book parameters
- book
- book1, book2, book3, ...
Portal parameters
- portal
- portal1, portal2, portal3, ...
Sister project parameters
- commons: Setting any value for this parameter will result in a link to WikiMedia Commons. The default search string is the article name.
- commons-search: This value replaces the default Commons search string. To search by category, start with "Category:".
- species: Setting any value for this parameter will result in a link to Wikispecies. The default search string is the article name.
- species-search: This value replaces the default Wikispecies search string.
- n: Setting any value for this parameter will result in a link to Wikinews. The default search string is the article name.
- n-search: This value replaces the default Wikinews search string.
- wikt: Setting any value for this parameter will result in a link to Wiktionary. The default search string is the article name.
- wikt-search: This value replaces the default Wiktionary search string.
- b: Setting any value for this parameter will result in a link to Wikibooks. The default search string is the article name.
- b-search: This value replaces the default Wikibooks search string.
- q: Setting any value for this parameter will result in a link to Wikiquote. The default search string is the article name.
- q-search: This value replaces the default Wikiquote search string.
- s: Setting any value for this parameter will result in a link to Wikisource. The default search string is the article name.
- s-search: This value replaces the default Wikisource search string. To search by author, start with "Author:".
- spoken: This parameter is for the spoken Wikipedia. Provide the name of the sound file, omitting the "File:" prefix.
- v: Setting any value for this parameter will result in a link to Wikiversity. The default search string is the article name.
- v-search: This value replaces the default Wikiversity search string.
- voy: Setting any value for this parameter will result in a link to Wikivoyage. The default search string is the article name.
- voy-search: This value replaces the default Wikivoyage search string.

Examples

Examples using one or more of each type

Article name = Lemur

{{Subject bar |book= Lemurs |portal1= Primates |portal2= Madagascar |commons= y |commons-search= Category:Lemuriformes |species= y |species-search= Lemuriformes }}

Article name = Ring-tailed lemur

{{Subject bar |book1= Lemurs |portal1= Primates |portal2= Madagascar |commons= y |commons-search= Category:Lemur catta |species= y |species-search= Lemur catta |n= y |wikt= y |wikt-search= Lemur |b= y |q= y |s= y |v= y |voy= y |voy-search= Madagascar }}