Difference between revisions of "Template:Infobox/doc"

From BESA® Wiki
Jump to: navigation, search
(rm unnecessary sortkeys)
Line 1: Line 1:
{{documentation header}}
+
{{SPW|is newer|name=Infobox}}
{{lua}}
+
;Description:
This is a skeleton for infoboxes, for use in other infobox templates or standalone.
+
*This template produces an [[Help:Infobox|infobox]]-style template.
 +
*You may want to copy and modify this to create a specific infobox (e.g. character infobox).
 +
*This template requires [[Help:Parser functions|parser functions]] to be enabled (Wikia default: on).
  
== Usage ==
+
;Syntax:
 +
<pre>
 +
{{infobox
 +
| Box title    =  
 +
| image        = Example.jpg
 +
| imagewidth  = [defaults to 250]
 +
| caption      =  
 +
| Row 1 title  =
 +
| Row 1 info  =
 +
| Row 2 title  =
 +
| Row 2 info  =
 +
| Row 3 title  =
 +
| Row 3 info  =
 +
| Row 4 title  =
 +
| Row 4 info  =
 +
| Row 5 title  =
 +
| Row 5 info  =
 +
| Row 6 title  =
 +
| Row 6 info  =
 +
| Row 7 title  =
 +
| Row 7 info  =
 +
| Row 8 title  =
 +
| Row 8 info  =
 +
| Row 9 title  =
 +
| Row 9 info  =
 +
| Row 10 title =
 +
| Row 10 info  =
 +
}}
 +
</pre>
  
  {<nowiki/>{infobox
+
;Notes:
  | title = box title, defaults to page's name
+
* Keeping the '''Box Title''' empty will result in displaying '''No title'''
  | image''n'' = Images displayed below the title. Supports [[Template:Animate|animation]]. First image defaults to {{{title}}}.png. Set to "none" to remove.
+
* If you don't want to display image, just keep '''Image file Name''' and '''Image Size''' empty.
  | defaultimagesize = Set the default size used by the above images. Defaults to 150px.
+
* Keeping the '''Row 1 title''' empty will result in displaying '''No title'''.
  | image''n''size = Sets the size of the corresponding image, overriding {{{defaultimagesize}}}.
+
* Keeping the '''Row (any row) info''' empty will result in displaying '''No information'''.
  | invimage''n'' = Invimages displayed under the images, using {{tl|grid}}. Set to "----" to add a line break. First invimage defaults to {{{title}}}, set to "none" to remove.
+
* Keeping the '''Row (any below row 1) title''' empty will result in that row and the rest of the rows below it will not be displayed.
  | imagearea = Completely replaces the functionality of the above 4 parameters, leaving a blank canvas below the title to put whatever
+
* Max row for information: 10 rows.
  | rows = all rows go here using {{tl|infobox row}}
+
 
  | footer = optional centered footer that goes across both columns
+
;Sample output:
  }}
+
{{Infobox
 +
|Box title    = Info Title
 +
|image        = Example.jpg
 +
|imagewidth  = 120
 +
|caption      = A flower
 +
|Row 1 title = Title row 1
 +
|Row 1 info  = Info row 1
 +
|Row 2 title  = Title row 2
 +
|Row 2 info  = Info row 2
 +
|Row 3 title  = Title row 3
 +
|Row 3 info  = Info row 3
 +
|Row 4 title  = Title row 4
 +
|Row 4 info  = Info row 4
 +
|Row 5 title  = Title row 5
 +
|Row 5 info  = Info row 5
 +
|Row 6 title  = Title row 6
 +
|Row 6 info  = Info row 6
 +
|Row 7 title  = Title row 7
 +
|Row 7 info  = Info row 7
 +
|Row 8 title  = Title row 8
 +
|Row 8 info  = Info row 8
 +
|Row 9 title  = Title row 9
 +
|Row 9 info  = Info row 9
 +
|Row 10 title = Title row 10
 +
|Row 10 info  = Info row 10
 +
}}
 +
Complete Infobox:<br />
 +
<code>
 +
'''<nowiki>{{</nowiki>Infobox'''<br />
 +
'''|'''Box title    = Info Title<br />
 +
'''|'''image        = Example.jpg<br />
 +
'''|'''imagewidth  = 120<br />
 +
'''|'''caption      = A flower<br />
 +
'''|'''Row 1 title = Title row 1<br />
 +
'''|'''Row 1 info  = Info row 1<br />
 +
'''|'''Row 2 title = Title row 2<br />
 +
'''|'''Row 2 info  = Info row 2<br />
 +
'''|'''Row 3 title = Title row 3<br />
 +
'''|'''Row 3 info  = Info row 3<br />
 +
'''|'''Row 4 title = Title row 4<br />
 +
'''|'''Row 4 info  = Info row 4<br />
 +
'''|'''Row 5 title  = Title row 5<br />
 +
'''|'''Row 5 info  = Info row 5<br />
 +
'''|'''Row 6 title = Title row 6<br />
 +
'''|'''Row 6 info  = Info row 6<br />
 +
'''|'''Row 7 title = Title row 7<br />
 +
'''|'''Row 7 info  = Info row 7<br />
 +
'''|'''Row 8 title  = Title row 8<br />
 +
'''|'''Row 8 info  = Info row 8<br />
 +
'''|'''Row 9 title  = Title row 9<br />
 +
'''|'''Row 9 info  = Info row 9<br />
 +
'''|'''Row 10 title = Title row 10<br />
 +
'''|'''Row 10 info  = Info row 10<br />
 +
'''<nowiki>}}</nowiki>'''
 +
</code>
 +
 
 +
<br style="clear:both; margin-bottom:3em;"/>
 +
 
 +
{{Infobox
 +
|Box title    = Info Title
 +
|Row 1 title = Title row 1
 +
|Row 1 info  = Info row 1
 +
|Row 2 title = Title row 2
 +
|Row 2 info  = Info row 2
 +
|Row 3 title  = Title row 3
 +
|Row 3 info  = Info row 3
 +
|Row 4 title  = Title row 4
 +
|Row 4 info  = Info row 4
 +
|Row 5 title  = Title row 5
 +
|Row 5 info  = Info row 5
 +
|Row 6 title  = Title row 6
 +
|Row 6 info  = Info row 6
 +
|Row 7 title  = Title row 7
 +
|Row 7 info  = Info row 7
 +
|Row 8 title  = Title row 8
 +
|Row 8 info  = Info row 8
 +
|Row 9 title  = Title row 9
 +
|Row 9 info  = Info row 9
 +
|Row 10 title = Title row 10
 +
|Row 10 info  = Info row 10
 +
}}
 +
Infobox '''Image''' omitted :<br />
 +
<code>
 +
'''<nowiki>{{</nowiki>Infobox'''<br />
 +
'''|'''Box title    = Info Title<br />
 +
'''|'''Row 1 title = Title row 1<br />
 +
'''|'''Row 1 info  = Info row 1<br />
 +
'''|'''Row 2 title  = Title row 2<br />
 +
'''|'''Row 2 info  = Info row 2<br />
 +
'''|'''Row 3 title  = Title row 3<br />
 +
'''|'''Row 3 info  = Info row 3<br />
 +
'''|'''Row 4 title  = Title row 4<br />
 +
'''|'''Row 4 info  = Info row 4<br />
 +
'''|'''Row 5 title  = Title row 5<br />
 +
'''|'''Row 5 info  = Info row 5<br />
 +
'''|'''Row 6 title  = Title row 6<br />
 +
'''|'''Row 6 info  = Info row 6<br />
 +
'''|'''Row 7 title  = Title row 7<br />
 +
'''|'''Row 7 info  = Info row 7<br />
 +
'''|'''Row 8 title  = Title row 8<br />
 +
'''|'''Row 8 info  = Info row 8<br />
 +
'''|'''Row 9 title  = Title row 9<br />
 +
'''|'''Row 9 info  = Info row 9<br />
 +
'''|'''Row 10 title = Title row 10<br />
 +
'''|'''Row 10 info  = Info row 10<br />
 +
'''<nowiki>}}</nowiki>'''
 +
</code>
 +
 
 +
<br style="clear:both; margin-bottom:3em;"/>
 +
 
 +
{{Infobox
 +
|Box title   = Info Title
 +
|Row 1 title  = Title row 1
 +
|Row 1 info  = Info row 1
 +
|Row 2 title  = Title row 2
 +
|Row 2 info  = Info row 2
 +
|Row 3 title  = Title row 3
 +
|Row 3 info  = Info row 3
 +
}}
 +
Infobox '''Image''' omitted and displaying only 3 rows of information:<br />
 +
<code>
 +
'''<nowiki>{{</nowiki>Infobox'''<br />
 +
'''|'''Box title    = Info Title<br />
 +
'''|'''Row 1 title  = Title row 1<br />
 +
'''|'''Row 1 info  = Info row 1<br />
 +
'''|'''Row 2 title  = Title row 2<br />
 +
'''|'''Row 2 info  = Info row 2<br />
 +
'''|'''Row 3 title  = Title row 3<br />
 +
'''|'''Row 3 info  = Info row 3<br />
 +
'''<nowiki>}}</nowiki>'''
 +
</code>
 +
 
 +
<br style="clear:both; margin-bottom:3em;"/>
 +
 
 +
{{Infobox
 +
|Box title    = Info Title
 +
|Row 1 title = Title row 1
 +
|Row 1 info  = Info row 1
 +
|Row 2 title  = Title row 2
 +
|Row 2 info  = Info row 2
 +
|Row 3 title  = Title row 3
 +
|Row 3 info  = Info row 3
 +
|Row 4 info  = Info row 4
 +
|Row 5 title = Title row 5
 +
|Row 5 info  = Info row 5
 +
|Row 6 title = Title row 6
 +
|Row 6 info  = Info row 6
 +
}}
 +
Infobox '''Image''' and '''title row 4''' omited:<br />
 +
Result: Row 4, 5, and 6 will not be displayed.<br />
 +
<code>
 +
'''<nowiki>{{</nowiki>Infobox'''<br />
 +
'''|'''Box title    = Info Title<br />
 +
'''|'''Row 1 title  = Title row 1<br />
 +
'''|'''Row 1 info  = Info row 1<br />
 +
'''|'''Row 2 title = Title row 2<br />
 +
'''|'''Row 2 info  = Info row 2<br />
 +
'''|'''Row 3 title = Title row 3<br />
 +
'''|'''Row 3 info  = Info row 3<br />
 +
'''|'''Row 4 info  = Info row 4<br />
 +
'''|'''Row 5 title  = Title row 5<br />
 +
'''|'''Row 5 info  = Info row 5<br />
 +
'''|'''Row 6 title  = Title row 6<br />
 +
'''|'''Row 6 info  = Info row 6<br />
 +
'''<nowiki>}}</nowiki>'''
 +
</code>
  
 
<includeonly>
 
<includeonly>
<!-- Template categories/interwiki -->
+
[[Category:Infobox templates| ]]
[[Category:Infobox templates|*]]
+
[[Category:General wiki templates]]
[[de:Vorlage:Infobox]]
+
[[ja:テンプレート:Infobox]]
[[es:Plantilla:Infobox]]
+
[[zh:Template:Infobox]]
[[fr:Modèle:Infobox common]]
+
</includeonly><noinclude>
</includeonly>
+
[[Category:Template documentation]]
<noinclude>
+
[[ja:テンプレート:Infobox/doc]]
<!-- Documentation categories/interwiki -->
+
[[fr:Modèle:Infobox common/doc]]
+
 
</noinclude>
 
</noinclude>

Revision as of 08:24, 9 August 2015

Description
  • This template produces an infobox-style template.
  • You may want to copy and modify this to create a specific infobox (e.g. character infobox).
  • This template requires parser functions to be enabled (Wikia default: on).
Syntax
{{infobox
| Box title    = 
| image        = Example.jpg
| imagewidth   = [defaults to 250]
| caption      = 
| Row 1 title  = 
| Row 1 info   = 
| Row 2 title  = 
| Row 2 info   = 
| Row 3 title  = 
| Row 3 info   = 
| Row 4 title  = 
| Row 4 info   = 
| Row 5 title  = 
| Row 5 info   = 
| Row 6 title  = 
| Row 6 info   = 
| Row 7 title  = 
| Row 7 info   = 
| Row 8 title  = 
| Row 8 info   = 
| Row 9 title  = 
| Row 9 info   = 
| Row 10 title = 
| Row 10 info  = 
}}
Notes
  • Keeping the Box Title empty will result in displaying No title
  • If you don't want to display image, just keep Image file Name and Image Size empty.
  • Keeping the Row 1 title empty will result in displaying No title.
  • Keeping the Row (any row) info empty will result in displaying No information.
  • Keeping the Row (any below row 1) title empty will result in that row and the rest of the rows below it will not be displayed.
  • Max row for information: 10 rows.
Sample output
Info Title
Example.jpg
A flower

Family)

Info row 1

Title row 2

Info row 2

Title row 3

Info row 3

Title row 4

Info row 4

Title row 5

Info row 5

Title row 6

Info row 6

Title row 7

Info row 7

Title row 8

Info row 8

Title row 9

Info row 9

Title row 10

Info row 10

Complete Infobox:
{{Infobox
|Box title = Info Title
|image = Example.jpg
|imagewidth = 120
|caption = A flower
|Row 1 title = Title row 1
|Row 1 info = Info row 1
|Row 2 title = Title row 2
|Row 2 info = Info row 2
|Row 3 title = Title row 3
|Row 3 info = Info row 3
|Row 4 title = Title row 4
|Row 4 info = Info row 4
|Row 5 title = Title row 5
|Row 5 info = Info row 5
|Row 6 title = Title row 6
|Row 6 info = Info row 6
|Row 7 title = Title row 7
|Row 7 info = Info row 7
|Row 8 title = Title row 8
|Row 8 info = Info row 8
|Row 9 title = Title row 9
|Row 9 info = Info row 9
|Row 10 title = Title row 10
|Row 10 info = Info row 10
}}


Info Title

Family)

Info row 1

Title row 2

Info row 2

Title row 3

Info row 3

Title row 4

Info row 4

Title row 5

Info row 5

Title row 6

Info row 6

Title row 7

Info row 7

Title row 8

Info row 8

Title row 9

Info row 9

Title row 10

Info row 10

Infobox Image omitted :
{{Infobox
|Box title = Info Title
|Row 1 title = Title row 1
|Row 1 info = Info row 1
|Row 2 title = Title row 2
|Row 2 info = Info row 2
|Row 3 title = Title row 3
|Row 3 info = Info row 3
|Row 4 title = Title row 4
|Row 4 info = Info row 4
|Row 5 title = Title row 5
|Row 5 info = Info row 5
|Row 6 title = Title row 6
|Row 6 info = Info row 6
|Row 7 title = Title row 7
|Row 7 info = Info row 7
|Row 8 title = Title row 8
|Row 8 info = Info row 8
|Row 9 title = Title row 9
|Row 9 info = Info row 9
|Row 10 title = Title row 10
|Row 10 info = Info row 10
}}


Info Title

Family)

Info row 1

Title row 2

Info row 2

Title row 3

Info row 3

Infobox Image omitted and displaying only 3 rows of information:
{{Infobox
|Box title = Info Title
|Row 1 title = Title row 1
|Row 1 info = Info row 1
|Row 2 title = Title row 2
|Row 2 info = Info row 2
|Row 3 title = Title row 3
|Row 3 info = Info row 3
}}


Info Title

Family)

Info row 1

Title row 2

Info row 2

Title row 3

Info row 3

Infobox Image and title row 4 omited:
Result: Row 4, 5, and 6 will not be displayed.
{{Infobox
|Box title = Info Title
|Row 1 title = Title row 1
|Row 1 info = Info row 1
|Row 2 title = Title row 2
|Row 2 info = Info row 2
|Row 3 title = Title row 3
|Row 3 info = Info row 3
|Row 4 info = Info row 4
|Row 5 title = Title row 5
|Row 5 info = Info row 5
|Row 6 title = Title row 6
|Row 6 info = Info row 6
}}
ja:テンプレート:Infobox/doc