Wikipedia>BrandonXLF: Added {{Uses TemplateStyles}}

2022-03-21T18:47:11Z

Added {{Uses TemplateStyles}}

New page

{{Documentation subpage}}
{{Lua|Module:Timeline}}
{{Uses TemplateStyles|Module:Timeline/styles.css}}
{{For|the <timeline> tag|Help:EasyTimeline syntax}}
This template is used to create navbox in the form of a timeline.

== Usage ==
Please remove the parameters that are left blank.
<pre style="overflow: auto;">{{Timeline
| name = {{subst:PAGENAME}}
| title =
| state = {{{state|}}}
| image =
| above =
| row1 =
| item1 =
| date1 =
| style1 =
| item2 =
| date2 =
| style2 =

| below =
}}</pre>

== Parameters ==
{{for|more detailed explanation|Template:Navbox#Parameter descriptions}}

=== Content parameters ===
These parameters are used to change the content of the timeline portion of the navbox.
* <code>row''n''</code> - Defines a row with a optional label.
* <code>span''n''</code> - Sets how many rows tall the label for row ''n'' should be. Any labels for rows that fall inside the label will be discarded.
* <code>item''n''</code> - Defines an item to show in the navbox. The item is shown in the last defined row. If an item exists without a row of the same number, it is either added to the previous row or a new row is created.
* <code>date''n''</code> - Defines the start and end year for item ''n'' in the format <code>''start''-''end''</code>. If ''end'' is omitted, the current year is omitted, so generally the items at the end of the timeline should use the format <code>''start''-</code>.
* <code>decades</code> - Set to <code>no</code> to remove the decade row and to show the full year.
* <code>footer</code> - Set to <code>yes</code> to show the date rows at the bottom of the timeline as well.
* <code>label</code> - Include to show a label column with the content of the <code>row''n''</code> parameters beneath the value of the <code>label</code> parameter.

=== Navbox parameters ===
These parameters are that are used to change the navbox.
* <code>name</code> - The name of the template.
* <code>title</code> - Text to add to the title bar, for example ''Honda road car timeline''.
* <code>above</code> - Text to add above the "content" of the navbox.
* <code>below</code> - Text to add below the "content" of the navbox.
* <code>state</code> - Weather the navbar is expanded, collapsed, or not collapsible.
* <code>navbar</code> - Set to <code>plain</code> or <code>off</code> to remove the V • T • E links on the left side of the title of the navbar, it is recommended you don't do this to maintain consistency between navboxes.
* <code>border</code> or <code>1</code> - Set to <code>child</code> or <code>subgroup</code> to use this navbox as a borderless navbox that can fit snugly in another navbox. Set to <code>none</code> to remove the border and the <code>navbox</code> class.
* <code>image</code> - An image to be displayed in a cell below the title and to the right of the body.
* <code>imageleft</code> - An image to be displayed in a cell below the title and to the left of the body.

=== Time parameters ===
These parameters adjust the length of the timeline
* <code>startoffset</code> - Set to a number to extend the start of the timeline that number of years back
* <code>startyear</code> - Set to a year to set the start of the timeline to that year if the content of the navbox doesn't go beyond that year
* <code>endoffset</code> - Set to a number to extend the end of the timeline that number of years forward
* <code>endyear</code> - Set to a year to set the end of the timeline to that year if the content of the navbox doesn't go beyond that year

=== Content style parameters ===
These parameters apply style to the "content" of the navbox.
* <code>style''n''</code> - CSS to apply to the cell of item ''n''.
* <code>labelstyle''n''</code> - CSS to apply to the label of row ''n''.
* <code>itemstyle</code> - CSS to apply to item cells.
* <code>blankstyle</code> - CSS to apply to blank cells.
* <code>labelstyle</code> - CSS to apply to label cells.
* <code>datestyle</code> - CSS to apply to ''year'' and ''decade'' cells.
* <code>decadestyle</code> - CSS to apply to ''decade'' cells.
* <code>yearstyle</code> - CSS to apply to ''year'' cells.

=== Navbox style parameters ===
These parameters apply style to the parts of the navbox outside of the "content" of the navbox.
* <code>style</code> or <code>bodystyle</code> - CSS to apply to the body of the navbox.
* <code>basestyle</code> - CSS to apply to the ''title'', ''above'', and ''below''.
* <code>titlestyle</code> - CSS to apply to the ''title''.
* <code>abovestyle</code> - CSS to apply to the ''above''.
* <code>belowstyle</code> - CSS to apply to the ''below''.
* <code>imagestyle</code> - CSS to apply to the cell containing <code>image</code>
* <code>imageleftstyle</code> - CSS to apply to the cell containing <code>imageleft</code>

=== Class parameters ===
These parameters add classes to parts of the navbox.
* <code>titleclass</code> - Classes to add to the ''title'' of the navbox.
* <code>aboveclass</code> - Classes to add to the ''above'' of the navbox.
* <code>bodyclass</code> - Classes to add to the body of the navbox.
* <code>belowclass</code> - Classes to add to the ''below'' of the navbox.
* <code>imageclass</code> - Classes to add to both the right and left images of the navbox.

== Examples ==
=== Basic ===
This is a basic example of this template.

{{hidden|Source code|<pre style="overflow: auto;">{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}</pre>|headerstyle = background: #eee; border:1px solid #a2a9b1;|style = padding: 0;}}

{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}

=== label ===
When you specify the {{para|label}} parameter, the contents of the {{para|row''n''}} parameters are shown on the left underneath the {{para|label}} parameter.

{{hidden|Source code|<pre style="overflow: auto;">{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| label = Type
| row1 = A
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 = B
| span3 = 2
| item3 = Baz
| date3 = 1995-2020
| row4 =
| item4 = Qux
| date4 = 2005-2015
}}</pre>|headerstyle = background: #eee; border:1px solid #a2a9b1;|style = padding: 0;}}

{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| label = Type
| row1 = A
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 = B
| span3 = 2
| item3 = Baz
| date3 = 1995-2020
| row4 =
| item4 = Qux
| date4 = 2005-2030
}}

=== decades ===
When {{para|decades|no}} is set, the decade row is removed and the year row contains the full years.

{{hidden|Source code|<pre style="overflow: auto;">{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| label = Type
| decades = no
| row1 = A
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 = B
| item3 = Baz
| date3 = 1995-2020
}}</pre>|headerstyle = background: #eee; border:1px solid #a2a9b1;|style = padding: 0;}}

{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| label = Type
| decades = no
| row1 = A
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 = B
| item3 = Baz
| date3 = 1995-2020
}}

=== footer ===
When {{para|footer|yes}} is set, the decade and year rows at the top of the template are shown again at the bottom. This is useful for very large timelines.

{{hidden|Source code|<pre style="overflow: auto;">{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| footer = yes
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}</pre>|headerstyle = background: #eee; border:1px solid #a2a9b1;|style = padding: 0;}}

{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| footer = yes
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}

=== Item and label styles ===
The {{para|style''n''}} parameters can be used to style items and the {{para|labelstyle''n''}} can be used to style rows.

{{hidden|Source code|<pre style="overflow: auto;">{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| label = Type
| row1 = A
| labelstyle1 = background: #e459e4;
| item1 = Foo
| date1 = 1985-2014
| style1 = background-color: #ff7c7c;
| item2 = Bar
| date2 = 2019-2035
| style2 = background-color: #e6cd38;
| row3 = B
| labelstyle3 = background: #50aeff;
| item3 = Baz
| date3 = 1995-2020
| style3 = background-color: #72d272;
}}</pre>|headerstyle = background: #eee; border:1px solid #a2a9b1;|style = padding: 0;}}

{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| label = Type
| row1 = A
| labelstyle1 = background: #e459e4;
| item1 = Foo
| date1 = 1985-2014
| style1 = background-color: #ff7c7c;
| item2 = Bar
| date2 = 2019-2035
| style2 = background-color: #e6cd38;
| row3 = B
| labelstyle3 = background: #50aeff;
| item3 = Baz
| date3 = 1995-2020
| style3 = background-color: #72d272;
}}

=== above and below ===
{{hidden|Source code|<pre style="overflow: auto;">{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| above = Above
| below = Below
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}</pre>|headerstyle = background: #eee; border:1px solid #a2a9b1;|style = padding: 0;}}

{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| above = Above
| below = Below
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}

=== start and end ===
{{para|startoffset}} and {{para|endoffset}} can be used to extend the start and end of the timeline.

{{hidden|Source code|<pre style="overflow: auto;">{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| startoffset = 5
| endoffset = 5
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}</pre>|headerstyle = background: #eee; border:1px solid #a2a9b1;|style = padding: 0;}}

{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| startoffset = 5
| endoffset = 5
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}

Alternatively, {{para|startyear}} and {{para|endyear}} can be used to extends the start and end of the timeline to those years of the content of the timeline doesn't go beyond those years.

{{hidden|Source code|<pre style="overflow: auto;">{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| startyear = 1975
| endyear = 2046
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}</pre>|headerstyle = background: #eee; border:1px solid #a2a9b1;|style = padding: 0;}}

{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| startyear = 1975
| endyear = 2046
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}

=== Inside another navbox ===
This template can be used to inside another navbox by calling it using {{tlc|Timeline|child|...}}.

{{hidden|Source code|<pre style="overflow: auto;">{{Navbox
| title = Example timeline
| group1 = Timeline
| state = uncollapse
| list1 = {{Timeline|child
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}
}}</pre>|headerstyle = background: #eee; border:1px solid #a2a9b1;|style = padding: 0;}}

{{Navbox
| title = Example timeline
| group1 = Timeline
| state = uncollapse
| list1 = {{Timeline|child
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}
}}

=== image and imageleft ===
The {{para|image}} and {{para|imageleft}} can be used to add content (preferably images) to the right and left of the navbox respectively.

{{hidden|Source code|<pre style="overflow: auto;">{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| image = [[File:Flag of the United States.svg|100px]]
| imageleft = [[File:Flag of Canada.svg|100px]]
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}</pre>|headerstyle = background: #eee; border:1px solid #a2a9b1;|style = padding: 0;}}

{{Timeline
| name = {{FULLPAGENAME}}
| state = uncollapsed
| title = Example timeline
| image = [[File:Flag of the United States.svg|100px]]
| imageleft = [[File:Flag of Canada.svg|100px]]
| row1 =
| item1 = Foo
| date1 = 1985-2014
| item2 = Bar
| date2 = 2019-2035
| row3 =
| item3 = Baz
| date3 = 1995-2020
}}<includeonly>{{sandbox other||

[[Category:Timeline templates|*]]
}}</includeonly>

Template:Timeline/doc - Revision history

Wikipedia>BrandonXLF: Added {{Uses TemplateStyles}}