Jump to content

Template:Infobox/doc: Difference between revisions

From WikiJournal
VisualWikitext
Created page with "{{Documentation subpage}} <!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE. --> <includeonly>{{Intricate template}}</includeonly> ==Usage== This template is intended as..."
 
mNo edit summary
Tag: 2017 source edit
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Documentation subpage}}
The '''Infobox template''' is a universal base template designed for creating information boxes in wiki articles. It serves as the foundation for specialized infoboxes (e.g., for [[Template:Gorge|gorges]], cities, rivers, etc.), ensuring a standardized appearance and structure.
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE. -->
<includeonly>{{Intricate template}}</includeonly>
==Usage==


This template is intended as a meta-template, that is, a template that's used when constructing other templates. It's not meant for use directly in an article. See [[Help:Infobox]] for information on how to craft infoboxes in general.
=== Using Infobox in specialized templates ===
 
To create a new infobox for a specific type of object, you need to use the Infobox template within your own template, passing the appropriate parameters.
Usage is similar to {{tl|navbox}}, but with an additional distinction. Each row on the table can either be a "header", or it can have a label/data pair, or it can just be a data cell. These are mutually exclusive states so if you define a row to be both a header and a label/data pair, the label/data pair is overridden.
* <code><nowiki>{{Infobox ... }}</nowiki></code> — includes the base infobox.
 
* title, image, description, header color — are passed directly to Infobox.
Note that if you want to insert an image elsewhere other than the top of the infobox, or insert other "freeform" data, using a row with just a "data" field allows for that sort of thing.
* parameters — contains a list of fields that will be displayed if provided in the template (e.g., country, region).
 
===Parameters===
 
Mandatory:
;name : The template page name that the "view/discuss/edit" links should point to. You can use <nowiki>{{subst:PAGENAME}}</nowiki>.
;title : A title to put in the titlebar at the top.
If no name or title are given, the pagename is used.
Optional content:
 
; image : An image to display at the top of the template. Use full image syntax, for example <nowiki>[[Image:example.png|200px]]</nowiki>. Image is centered by default.
;caption : Text to put underneath the image.
;header(n) : Text to use as a header in row n.
;label(n): Text to use as a label in row n.
;data(n): Text to display as data in row n.
;below: Text to put in the bottom cell. The bottom cell is intended for footnotes, see-also, and other such information.
 
 
Optional CSS styling:
 
;bodystyle : Applies to the infobox table as a whole
;titlestyle : Applies only to the title cell
;imagestyle : Applies to the cell the image is in (including the caption)
;captionstyle : Applies to the text of the caption
;headerstyle : Applies to all header cells
;labelstyle : Applies to all label cells
;datastyle : Applies to all data cells
;belowstyle : Applies only to the below cell
 
===Making fields optional===
 
A row with a label but no data is not displayed. This allows for optional infobox contents. To make a field optional, use a parameter that defaults to an empty string, like so:


=== Creating a new infobox based on Infobox ===
To create a new infobox (for example, for a city), follow the structure below and adjust the list of parameters for the desired object. Example structure for a city infobox:
<pre>
<pre>
|data5={{{population|}}}
<includeonly>
</pre>
 
For more complex fields with preformatted contents that would still be present if a parameter was unset, you can wrap it all in a simple "if" statement to make the whole thing vanish when not used. Example:
 
<pre>
|data5= {{#if: {{{mass|}}} | {{{mass}}} kg}}
</pre>
 
===Examples===
{{Infobox
|name        = Infobox/doc
|bodystyle    =
|title        = Test Infobox
|titlestyle  =
 
|image        = [[File:example.png|200px|alt=Example alt text]]
|imagestyle  =
|caption      = Caption for example.png
|captionstyle =
|headerstyle  = background:#ccf;
|labelstyle  = background:#ddf;
|datastyle    =
 
|header1 = Header defined alone
|label1  =
|data1  =
|header2 =
|label2  = Label defined alone does not display (needs data, or is suppressed)
|data2  =
|header3 =
|label3  =
|data3  = Data defined alone
|header4 = All three defined (header, label, data, all with same number)
|label4  = does not display (same number as a header)
|data4  = does not display (same number as a header)
|header5 =
|label5  = Label and data defined (label)
|data5  = Label and data defined (data)
 
|belowstyle = background:#ddf;
|below = Below text
}}
 
<pre style="overflow:auto">{{Infobox
|name        = Infobox/doc
|bodystyle    =
|title        = Test Infobox
|titlestyle  =
 
|image        = [[File:example.png|200px|alt=Example alt text]]
|imagestyle  =
|caption      = Caption for example.png
|captionstyle =
|headerstyle  = background:#ccf;
|labelstyle  = background:#ddf;
|datastyle    =
 
|header1 = Header defined alone
|label1  =
|data1  =
|header2 =
|label2  = Label defined alone does not display (needs data, or is suppressed)
|data2  =
|header3 =
|label3  =
|data3  = Data defined alone
|header4 = All three defined (header, label, data, all with same number)
|label4  = does not display (same number as a header)
|data4  = does not display (same number as a header)
|header5 =
|label5  = Label and data defined (label)
|data5  = Label and data defined (data)
 
|belowstyle = background:#ddf;
|below = Below text
}}</pre>
 
Notice how when a label is defined without an accompanying data cell the row doesn't appear in the displayed infobox, and when a header is defined on the same row as a data cell all of them are displayed.
 
{{clear}}
For this example, {{nowrap|bodystyle &#0061; width:20em;}} and {{nowrap|labelstyle &#0061; width:33%;}}
 
{{Infobox
|bodystyle  = width:20em;
|name        = Infobox/doc
|title      = Test Infobox
|titlestyle  =
|headerstyle =
|labelstyle  = width:33%
|datastyle  =
 
|header1 =
|label1  = Label 1
|data1  = Data 1
|header2 =
|label2  = Label 2
|data2  = Data 2
|header3 =
|label3  = Label 3
|data3  = Data 3
|header4 = Header 4
|label4  =
|data4  =
|header5 =
|label5  = Label 5
|data5  = Data 5: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 
|belowstyle =
|below = Below text
}}
<pre style="overflow: auto">
{{Infobox
{{Infobox
|bodystyle  = width:20em;
| title = {{{city name|}}}
|name       = Infobox/doc
| image = {{{photo|}}}
|title      = Test Infobox
  | description = {{{description|}}}
|titlestyle  =  
  | header color = #87CEEB
|headerstyle =
  | parameters =  
|labelstyle = width:33%
    {{#if:{{{country|}}} | <div class="infobox-row">
|datastyle  =  
        <div class="infobox-label">Country:</div>
 
        <div class="infobox-value">[[{{{country}}}]]</div>
|header1 =
    </div> }}
|label1 = Label 1
    {{#if:{{{population|}}} | <div class="infobox-row">
|data1  = Data 1
        <div class="infobox-label">Population:</div>
|header2 =
        <div class="infobox-value">{{{population}}}</div>
|label2 = Label 2
    </div> }}
|data2  = Data 2
|header3 =
|label3  = Label 3
|data3  = Data 3
|header4 = Header 4
|label4  =
|data4  =
|header5 =  
|label5  = Label 5
|data5  = Data 5: Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua.
 
|belowstyle =  
|below = Below text
}}
}}
</includeonly>
</pre>
</pre>
{{clear}}


===Embedding===
=== Additional parameters ===
One infobox template can be embedded into another using the {{para|child}} parameter.  This feature can be used to create a modular infobox, or to create more well defined logical sections.
When creating templates based on <code><nowiki>{{Infobox}}</nowiki></code>, you can add additional parameters for inserting maps, links to thematic portals and other sections at your discretion:
{{Infobox
<pre>
| title = Top level title
{{#if:{{{map|}}} | <div class="infobox-map">{{{map}}}</div> }}
| data1 = {{Infobox
   
  | child = yes
{{#if:{{{portal|}}} |
  | title = First subsection
    <div class="infobox-section" style="background:#ffe2b8;">Thematic Portals</div>
  | label1= Label 1.1
    <div class="infobox-portal">{{{portal}}}</div>
  | data1 = Data 1.1
}}
| data2 = {{Infobox
  | child = yes
  | title = Second subsection
  | label1= Label 2.1
  | data1 = Data 2.1
}}
|belowstyle =
|below = Below text
}}
<pre style="overflow:auto">
{{Infobox
| title = Top level title
| data1 = {{Infobox
  | child = yes
  | title = First subsection
  | label1= Label 1.1
  | data1 = Data 1.1
}}
| data2 = {{Infobox
  | child = yes
  | title = Second subsection
  | label1= Label 2.1
  | data1 = Data 2.1
}}
|belowstyle =
|below = Below text
}}
}}
</pre>
</pre>
Note, in the examples above, the child infobox is placed in a <code>data</code> field, not a <code>header</code> field.  The title will be enclosed in {{tag|b}} bold tags, which can create a "double bolding effect" in some browsers if the child infobox is placed in a <code>header</code> field.  To place the child infobox in a header field and avoid the double bolding effect, use
Now this template can be used in city articles as follows:
{{Infobox
<pre>
| title = Top level title
{{City
| header1 = First subsection
| city name = Paris
  {{Infobox
| photo = Paris.jpg
  | child = yes
| description = View of the Eiffel Tower
  | label1= Label 1.1
| country = France
  | data1 = Data 1.1
| population = 2,165,423
}}
| header2 = Second subsection
  {{Infobox
  | child = yes
  | label1= Label 2.1
  | data1 = Data 2.1
}}
|belowstyle =
|below = Below text
}}
<pre style="overflow:auto">
{{Infobox
| title = Top level title
| header1 = First subsection
  {{Infobox
  | child = yes
  | label1= Label 1.1
  | data1 = Data 1.1
}}
| header2 = Second subsection
  {{Infobox
  | child = yes
  | label1= Label 2.1
  | data1 = Data 2.1
}}
|belowstyle =
|below = Below text
}}
}}
</pre>
</pre>


==Full blank declaration==
=== How to customize Infobox for your needs? ===
(Note: the template currently handles up to 99 rows; only 20 are given below since infoboxes larger than that will be relatively rare. Just extend the numbering as needed. The microformat "class" parameters are also omitted as they are not commonly used.)
# Choose the type of object for which you need an infobox (city, river, nature reserve, etc.).
 
# Create a new template that uses Infobox as its base.
<pre style="overflow:auto;">
# Add the necessary parameters by passing them to the parameters section.
{{Infobox
# Customize the infobox by changing the header color, adding new fields, and adjusting styles.
|name        = {{subst:PAGENAME}}
|bodystyle    =
|title        =
|titlestyle  =
|above        =
|abovestyle  =
 
|imagestyle  =
|captionstyle =
 
|image        =
|caption      =
|image2      =
|caption2    =
 
|headerstyle  =
|labelstyle  =
|datastyle    =
 
|header1  =
|label1  =
|data1    =
|header2  =
|label2  =
|data2    =
|header3  =
|label3  =
|data3    =
|header4  =
|label4  =
|data4    =
|header5  =
|label5  =
|data5    =
|header6  =
|label6  =
|data6    =
|header7  =
|label7  =
|data7    =
|header8  =
|label8  =
|data8    =
|header9  =
|label9  =
|data9    =
|header10 =
|label10  =
|data10  =
|header11 =
|label11  =
|data11  =
|header12 =
|label12  =
|data12  =
|header13 =
|label13  =
|data13  =
|header14 =
|label14  =
|data14  =
|header15 =
|label15  =
|data15  =
|header16 =
|label16  =
|data16  =
|header17 =
|label17  =
|data17  =
|header18 =
|label18  =
|data18  =
|header19 =
|label19  =
|data19  =
|header20 =
|label20  =
|data20  =
 
|belowstyle =
|below =
}}</pre>
 
==See also==
* {{tl|start infobox page}}
* {{tl|infobox3cols}}


<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox||
__NOINDEX__
[[Category:Infobox templates| ]]
<noinclude>[[Category:Template documentation]]</noinclude>
[[Category:Wikipedia metatemplates|{{PAGENAME}}]]
[[Category:Templates using ParserFunctions|{{PAGENAME}}]]
}}</includeonly>

Latest revision as of 12:33, 17 February 2025

The Infobox template is a universal base template designed for creating information boxes in wiki articles. It serves as the foundation for specialized infoboxes (e.g., for gorges, cities, rivers, etc.), ensuring a standardized appearance and structure.

Using Infobox in specialized templates

To create a new infobox for a specific type of object, you need to use the Infobox template within your own template, passing the appropriate parameters.

  • {{Infobox ... }} — includes the base infobox.
  • title, image, description, header color — are passed directly to Infobox.
  • parameters — contains a list of fields that will be displayed if provided in the template (e.g., country, region).

Creating a new infobox based on Infobox

To create a new infobox (for example, for a city), follow the structure below and adjust the list of parameters for the desired object. Example structure for a city infobox: 

<includeonly>
{{Infobox
 | title = {{{city name|}}}
 | image = {{{photo|}}}
 | description = {{{description|}}}
 | header color = #87CEEB
 | parameters = 
    {{#if:{{{country|}}} | <div class="infobox-row">
        <div class="infobox-label">Country:</div> 
        <div class="infobox-value">[[{{{country}}}]]</div>
    </div> }}
    {{#if:{{{population|}}} | <div class="infobox-row">
        <div class="infobox-label">Population:</div> 
        <div class="infobox-value">{{{population}}}</div>
    </div> }}
}}
</includeonly>

Additional parameters

When creating templates based on {{Infobox}}, you can add additional parameters for inserting maps, links to thematic portals and other sections at your discretion: 

{{#if:{{{map|}}} | <div class="infobox-map">{{{map}}}</div> }}
    
{{#if:{{{portal|}}} | 
    <div class="infobox-section" style="background:#ffe2b8;">Thematic Portals</div>
    <div class="infobox-portal">{{{portal}}}</div>
}}

Now this template can be used in city articles as follows: 

{{City
 | city name = Paris
 | photo = Paris.jpg
 | description = View of the Eiffel Tower
 | country = France
 | population = 2,165,423
}}

How to customize Infobox for your needs?

  1. Choose the type of object for which you need an infobox (city, river, nature reserve, etc.).
  2. Create a new template that uses Infobox as its base.
  3. Add the necessary parameters by passing them to the parameters section.
  4. Customize the infobox by changing the header color, adding new fields, and adjusting styles.
Retrieved from "https://en.wikijournal.org/w-wiki/index.php?title=Template:Infobox/doc&oldid=1870"