Help:Tables

From FamilySearch Wiki

(Difference between revisions)
Line 16: Line 16:
 
|}
 
|}
  
== <br>NOTE: ==
+
<br>NOTE: This article includes details on how to create tables with Wikitext or HTML. This is possible by turning off the FCK editor, or Wiki editing tool. '''Detailed instructions for beginning users are not included in this article. '''Special instructions are available for [[Copy Spreadsheets into the Wiki|copying spreadsheets or Excel documents into the Wiki]]. Beginners should first read [[Help:Adding basic tables to an article|basic table instructions for beginners]]. Advanced instructions for users who do not want to create tables using Wikitext or HTML are available online at [http://docs.fckeditor.net/FCKeditor_2.x/Users_Guide/Common_Tasks/Tables the FCK editor website]. Learn more about the [[Help:FCK Editor|FCK editor/editing tool]], and [[Help:FCK Editor#Turning the editor tool off and on|how to turn&nbsp;it off and on]].  
 
+
This article includes details on how to create tables with Wikitext or HTML. This is possible by turning off the FCK editor, or Wiki editing tool. '''Detailed instructions for beginning users are not included in this article. '''Special instructions are available for [[Copy Spreadsheets into the Wiki|copying spreadsheets or Excel documents into the Wiki]]. Beginners should first read [[Help:Adding basic tables to an article|basic table instructions for beginners]]. Advanced instructions for users who do not want to create tables using Wikitext or HTML are available online at [http://docs.fckeditor.net/FCKeditor_2.x/Users_Guide/Common_Tasks/Tables the FCK editor website]. Learn more about the [[Help:FCK Editor|FCK editor/editing tool]], and [[Help:FCK Editor#Turning the editor tool off and on|how to turn&nbsp;it off and on]].  
+
  
 
== What you should know before creating a table  ==
 
== What you should know before creating a table  ==

Revision as of 22:19, 18 February 2009

Quick Reference:

{| start table
|- table row
| table data cell or column
|} end table


NOTE: This article includes details on how to create tables with Wikitext or HTML. This is possible by turning off the FCK editor, or Wiki editing tool. Detailed instructions for beginning users are not included in this article. Special instructions are available for copying spreadsheets or Excel documents into the Wiki. Beginners should first read basic table instructions for beginners. Advanced instructions for users who do not want to create tables using Wikitext or HTML are available online at the FCK editor website. Learn more about the FCK editor/editing tool, and how to turn it off and on.

Contents

What you should know before creating a table

1. Tables that were created in other programs can be imported into the Wiki, however, the process for doing so is time intensive. It may take less time to re-create a table than import an existing table into the Wiki.

3. Tables may be authored in wiki pages using either HTML table elements directly, or using wikicode formatting to define the table. HTML table elements and their use are well described on various web pages and will not be discussed here. The benefit of wikicode 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.

A good general rule of thumb is to use a tables only when necessary. Table markup may complicate page editing.

Wiki 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.
  • XHTML attributes. Each mark, except table end, optionally accepts one or more XHTML 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. So 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 XHTML 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 Tables

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 Tables

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 affect the actual table rendering.

HTML attributes can be added to 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
|}

Tables 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 
|}

Attributes on cells

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
|}

Attributes on rows

You can put attributes on individual rows, too.

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 
|}

Note: This cellpadding example is not currently working properly on mediawiki.org It is supposed to look like this


Tables 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 
|}

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 
|}

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 
|}

Sorting

Tables can be made sortable by adding class="sortable"; for details see Help:Sorting. Since this can be very useful, it is wise to keep the possibilities and limitations of this feature in mind when designing a table. For example:

  • Do not divide a table into sections by subheaders spanning several rows. Instead, an extra column can be made showing the content of these headers on each row, in a short form.
  • Do not have elements spanning several columns; instead, again, repeat the content on each row, in a short form.
  • In a column of numbers, do not put text such as "ca." in front of a number—it will sort like zero. Do not put text after the number, and do not put a range of numbers (it does not affect the sorting position for numeric sorting mode, and in the case of a range, the first number determines the position, but if, possibly after sorting this or another column, the element is at the top, it will induce alphabetic sorting mode). Instead, put these texts in a separate column. Alternatively, for the greatest flexibility, alphabetic sorting mode with hidden sortkeys can be used.

A long form of abbreviated content can be put as legend outside the table.

Wiki markup

{| class="sortable" border="1"
|+ '''Sortable table'''
|-
! Alphabetic !! Numeric !! Date !! class="unsortable" | Unsortable
|-
| d || 2 || 2008-11-24 || This
|-
| b || 8 || 2004-03-01 || column
|-
| a || 6 || 1979-07-23 || cannot
|-
| c || 4 || 1492-12-08 || be
|-
| e || 0 || 1601-08-13 || sorted.
|}

What it looks like in your browser

Sortable table
Alphabetic Numeric Date Unsortable
d 2 2008-11-24 This
b 8 2004-03-01 column
a 6 1979-07-23 cannot
c 4 1492-12-08 be
e 0 1601-08-13 sorted.

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.

Keep the heading hierarchy consistent with the rest of the page so that the table of contents at page top works correctly.

Yummiest

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

Tips

A good way of formatting a table would be something of the form:

{| width="x%" border="1" cellspacing="0" style="margin: 1em auto;"

but you could also add:

cellpadding="4"

if you wanted more white space around the text within each cell.

Remember that you don't always have to set the width to 100%. This can be an irritation when the table just contains small amounts of data but is forced to stretch to fit the full screen:

left header right header
one two
three four

but

left header right header
Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

You can of course leave the width out and let the system decide, but this can result in tables being too narrow!

The best solution is 'trial-and-error'. Keep using the Show preview button and see what it looks like?

Caveat

Negative numbers

Negative value minus sign can break your table (it may display missing some values) if you start a cell on a new line with a negative number or a parameter that evaluates to a negative number (|-6) because that is the wiki markup for table row, not table cell. To avoid this, insert a space before the value (| -6) or use in-line cell markup (||-6).