Wikipedia:Manual of Style/Infoboxes: Difference between revisions
Content deleted Content added
tweak a couple of section titles |
→Design principles: add subsection headings; add guidance relating to purpose of an infobox |
||
| Line 7: | Line 7: | ||
These boxes are designed to be placed into main articles related to the topic area, and are usually associated with on-going [[Wikipedia:WikiProject|WikiProjects]]. They have parameters; to work properly, the parameter values have to be specified when the template is inserted in the page. This allows each infobox to show information relevant to the article subject, while requiring only a minimal amount of coding within each article. |
These boxes are designed to be placed into main articles related to the topic area, and are usually associated with on-going [[Wikipedia:WikiProject|WikiProjects]]. They have parameters; to work properly, the parameter values have to be specified when the template is inserted in the page. This allows each infobox to show information relevant to the article subject, while requiring only a minimal amount of coding within each article. |
||
== Design |
== Design principles == |
||
===Purpose of an infobox=== |
|||
When considering any aspect of infobox design, keep in mind the purpose of an infobox: to summarize key facts about the article in which it appears. The less information it contains, the more effectively it serves that purpose, allowing readers to identify key facts at a glance. Of necessity, some infoboxes contain more than just a few fields; however, wherever possible, present information in short form, and exclude any unnecessary content. Do not include links to sections within the article; the table of contents provides that function. |
|||
===Overall approach=== |
|||
The recommended process for creating an infobox template is to simply begin, and gather as many requirements as possible. Test the base format for a new template as a static table first, then once consensus is reached, migrate it into template format. The template should be reviewed before being used extensively in articles in case the template or defined parameters need modification to minimize re-works. If new fields and parameters are added, articles must be updated to reflect the new requirements. If parameters are renamed or removed, many articles will likely be unaffected, since extraneous parameters are ignored. |
The recommended process for creating an infobox template is to simply begin, and gather as many requirements as possible. Test the base format for a new template as a static table first, then once consensus is reached, migrate it into template format. The template should be reviewed before being used extensively in articles in case the template or defined parameters need modification to minimize re-works. If new fields and parameters are added, articles must be updated to reflect the new requirements. If parameters are renamed or removed, many articles will likely be unaffected, since extraneous parameters are ignored. |
||
===Consistency between infoboxes=== |
|||
For consistency the following guidelines apply: |
For consistency the following guidelines apply: |
||
* Standard suggested width of 300 pixels or 25 ems (<code>300px</code> or <code>25em</code> in [[Cascading Style Sheets|CSS]]). |
* Standard suggested width of 300 pixels or 25 ems (<code>300px</code> or <code>25em</code> in [[Cascading Style Sheets|CSS]]). |
||