Help:Editing/Tables

From SRB2 Wiki
Jump to: navigation, search
  Help [view]
Editing Help Main PageImagesTablesTemplatesList of templates
Manual of Style Main PageModifications
Troubleshooting Main Page

Tables are an effective way of organizing information about a certain subject.

Tables may be authored in wiki pages using either HTML table elements directly, or using wiki markup to define the table. HTML table elements and their use are well described on various web pages and will not be discussed here. It may be easier to use HTML table elements if you have experience with HTML, but we advise against using HTML to construct tables, as it makes tables harder to edit for other users.

Tables may instead be constructed by using wiki markup. The benefit of wiki markup is that the table is constructed of character symbols which tend to make it easier to perceive the table structure in the article editing view compared to HTML table elements.

Table markup summary

{| Start table
|+ Table caption, optional; only one per table and between table start and first row
|- Table row, optional on first row – wiki engine assumes the first row
! Table header cell, optional. Consecutive table headers may be added on same line separated by double marks (!!) or start on new lines, each with its own single mark (!).
| Table data cell, required! Consecutive table data cells may be added on same line separated by double marks (||) or start on new lines, each with its own single mark (|).
|} End table
  • The above marks must start on a new line except the double || and !! for optionally adding consecutive cells to a line.
  • HTML attributes. Each mark, except table end, optionally accepts one or more HTML attributes. Attributes must be on the same line as the mark. Separate attributes from each other with a single space.
    • Cells and caption (| or ||, ! or !!, and |+) hold content. Separate any attributes from content with a single pipe (|). Cell content may follow on same line or on following lines.
    • Table and row marks ({| and |-) do not directly hold content. Do not add pipe (|) after their optional attributes. If you erroneously add a pipe after attributes for the table mark or row mark the parser will delete it and your final attribute if it was touching the erroneous pipe!
  • Content may (a) follow its cell mark on the same line after any optional HTML attributes or (b) on lines below the cell mark. Content that uses wiki markup that itself needs to start on a new line, such as lists, headers, or nested tables, must of course be on its own new line.

Simple table

Plain

The following table lacks borders and good spacing but shows the simplest wiki markup table structure.

Orange Apple
Bread Pie
Butter Ice cream
{|
|-
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

Alternative

For more table-ish looking wiki markup cells can be listed on one line separated by ||. This does not scale well for longer cell content such as paragraphs. It works well for short bits of content however, such as our example table.

Extra spaces within cells in the wiki markup can be added, as I have done in the wiki markup below, to make the wiki markup itself look better but they do not effect the actual table rendering.

HTML attributes can be added to this table following the examples in other tables on this page but have been left out of the following example for simplicity.

Orange Apple more
Bread Pie more
Butter Ice cream and more
{|
|   Orange   ||   Apple   ||   more
|-
|   Bread    ||   Pie     ||   more
|-
|   Butter   || Ice cream || and more
|}

With HTML attributes

You can add HTML attributes to make your table look better.

border="1"

Orange Apple
Bread Pie
Butter Ice cream
{| border="1"
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

align="center" border="1"

Orange Apple
Bread Pie
Butter Ice cream
{| align="center" border="1"
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

align="right" border="1"

You can put attributes on individual cells. Numbers for example may look better aligned right.

Orange Apple 12,333.00
Bread Pie 500.00
Butter Ice cream 1.00
{| border="1"
| Orange
| Apple
| align="right"| 12,333.00
|-
| Bread
| Pie
| align="right" | 500.00
|-
| Butter
| Ice cream
| align="right" | 1.00
|}

You can put attributes on individual rows, as well.

Orange Apple 12,333.00
Bread Pie 500.00
Butter Ice cream 1.00
{| border="1"
| Orange
| Apple
| align="right" | 12,333.00
|-
| Bread
| Pie
| align="right" | 500.00
|- style="font-style:italic;color:green;"
| Butter
| Ice cream
| align="right" | 1.00
|}

cellspacing="0" border="1"

Orange Apple
Bread Pie
Butter Ice cream
{| cellspacing="0" border="1"
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

cellpadding="20" cellspacing="0" border="1"

Orange Apple
Bread Pie
Butter Ice cream
{| cellpadding="20" cellspacing="0" border="1"
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

With HTML attributes and CSS styles

CSS style attributes can be added with or without other HTML attributes.

style="color:green;background-color:#ffffcc;" cellpadding="20" cellspacing="0" border="1"

Orange Apple
Bread Pie
Butter Ice cream
{| style="color:green;background-color:#ffffcc;" cellpadding="20" cellspacing="0" border="1"
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

Style classes

One may also apply style classes that are specified in the site's stylesheet by affixing class to the beginning table tag. This works only for styles that are specified in the site's stylesheet.

Currently, the only table style specified is the wikitable class. Note that in almost all cases, especially for informational tables, it's highly recommended to use the "wikitable" style for tables. Do this by affixing class="wikitable" to the beginning table tag (e.g. {| class="wikitable".)

Orange Apple
Bread Pie
Butter Ice cream
{| class="wikitable"
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

Table with TH headings

TH (HTML table headings) can be created by using ! instead of |. Headings usually show up bold and centered by default.

Top headings

Each column

Yummy Yummier
Orange Apple
Bread Pie
Butter Ice cream
{| border="1" cellpadding="20" cellspacing="0"
! Yummy
! Yummier
|-
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

Colspan="2"

Yummies
Orange Apple
Bread Pie
Butter Ice cream
{| border="1" cellpadding="20" cellspacing="0"
! colspan="2" | Yummies
|-
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

Side headings

Default

Fruit Orange Apple
Dish Bread Pie
Complement Butter Ice cream
{| border="1" cellpadding="20" cellspacing="0"
! Fruit
| Orange
| Apple
|-
! Dish
| Bread
| Pie
|-
! Complement
| Butter
| Ice cream 
|}

Right justify

Right justified side headings can be done as follows

Fruit Orange Apple
Dish Bread Pie
Complement Butter Ice cream
{| border="1" cellpadding="20" cellspacing="0"
! align="right" | Fruit
| Orange
| Apple
|-
! align="right" | Dish
| Bread
| Pie
|-
! align="right" | Complement
| Butter
| Ice cream 
|}

On the "wikitable" class

The "wikitable" class has its own definitions for table header cells as compared to regular cells. A header cell is darker and the text bolded and centered.

When using the wikitable class with side headers, it's recommended to align the text to the left. The default behavior is to align the text to the center, which is acceptable for top headers, but looks subpar for side headers. Also note the use of the CSS way of aligning text. Since the wikitable class is a CSS style, its text-align:left; definition takes precedence over a regular table's align="left". To override the wikitable class definition, use style="text-align:left;".

Fruit Orange Apple
Dish Bread Pie
Complement Butter Ice cream
{| class="wikitable"
! style="text-align:left;" | Fruit
| Orange
| Apple
|-
! style="text-align:left;" | Dish
| Bread
| Pie
|-
! style="text-align:left;" | Complement
| Butter
| Ice cream 
|}

Caption

A table caption can be added to the top of any table as follows

Food complements
Orange Apple
Bread Pie
Butter Ice cream
{| border="1" cellpadding="20" cellspacing="0"
|+ Food complements
|-
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

Attributes can be added to the caption as follows

Food complements
Orange Apple
Bread Pie
Butter Ice cream
{| border="1" cellpadding="20" cellspacing="0"
|+ align="bottom" style="color:#e76700;" | ''Food complements''
|-
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

Table with H1, H2, H3 etc. headings

HTML H1, H2, H3, H4 etc. headings can be created the standard wiki markup way with ==equal== signs and must be on a line all by themselves to work.

Preview the whole table. If you click on an edit tab for a heading within a table, edit, and preview, the parent table will display erroneously broken because part of it will be missing.

In most cases, it's not recommended to use headings in tables, as this affects the table of contents of the page; this especially applies when the header hierarchy is disrupted (e.g. placing an H2 in a table in the middle of an H3 section.) If headings are needed, though, keep the header levels (or hierarchy) consistent with the rest of the page so that the table of contents at the top of the page works correctly.

Yummiest

Orange Apple
Bread Pie
Butter Ice cream
{| border="1" cellpadding="20" cellspacing="0"
| colspan="2" |
===Yummiest===
|-
| Orange
| Apple
|-
| Bread
| Pie
|-
| Butter
| Ice cream 
|}

Table recommendations

  • In almost all cases, especially for informational tables, it's highly recommended to use the "wikitable" style for tables. Do this by affixing class="wikitable" to the beginning tag (e.g. {| class="wikitable".)
  Help [view]
Editing Help Main PageImagesTablesTemplatesList of templates
Manual of Style Main PageModifications
Troubleshooting Main Page