Revision as of 18:27, 6 August 2006

Documentation

Use a single block of succession boxes per article. Begin each succession box block with {{start box}} and end it with {{end box}}. In between, you may place as many instances of {{succession box}} as is necessary.

Usage

{{succession box
  | before=
  | title=
  | after=
  | fullspolier=
  | beforespolier=
  | afterspolier=
}}

Example

{{start box}}
{{succession box
  | before= [[Jackson Spencer|Jackson "Ripper" Spencer]]
  | title= Commander, Air Group of the [[Galactica type battlestar|battlestar]] ''[[Galactica (RDM)|Galactica]]''
  | after= [[George Birch|George "Catman" Birch]]
}}
{{succession box
  | before= [[George Birch|George "Catman" Birch]]
  | title= Commander, Air Group of the [[Galactica type battlestar|battlestar]] ''[[Galactica (RDM)|Galactica]]''
  | after= [[Kara Thrace|Kara "Starbuck" Thrace]]
}}
{{succession box
  | before= ''(unknown, eventually [[Jack Fisk]])''
  | title= Executive Officer of the [[Mercury class battlestar|battlestar]] ''[[Pegasus (RDM)|Pegasus]]''
  | after= ''(unknown, eventually [[Anastasia Dualla]])
}}
{{succession box
  | before= [[Barry Garner]]
  | title= Commanding Officer of the [[Mercury class battlestar|battlestar]] ''[[Pegasus (RDM)|Pegasus]]''
  | after= Incumbent
}}
{{end box}}

Required parameters

before: Can be wikilined or non-wikilinked. Any formating allowed.
title : Can be wikilined or non-wikilinked. Any formating allowed.
after : Can be wikilined or non-wikilinked. Any formating allowed.
- Note: The {{spoiltext}} template will not work within succession boxes. Instead, three other templates are available which may be used in place of {{succession box}}.

Optional parameter

fullspolier: If true, it will hide the entire section behind a spolier tag.
OR: beforespolier: If true, it will hide the before section behind a spolier tag.
OR: afterspolier: If true, it will hide the after section behind a spolier tag.

@@ Line 1: / Line 1: @@
 <includeonly>
-|-
+{{#switch:{{#if:{{{fullspolier|}}}|1}}{{#if:{{{beforespolier|}}}|2}}{{#if:{{{afterspolier|}}}|3}}
+| 1= ! colspan="3" {{spoilerplate}}
+{{!}}-
+{{!}} class="spoiltext_box" {{s-bef|before={{{before}}}}}
+{{!}} class="spoiltext_box" {{s-ttl|title={{{title}}}}}
+{{!}} class="spoiltext_box" {{s-aft|after={{{after}}}}}
+{{!}}-
+| 2= ! colspan="3" {{spoilerplate}}
+{{!}}-
+{{!}} class="spoiltext_box" {{s-bef|before={{{before}}}}}
+{{!}} {{s-ttl|title={{{title}}}}}
+{{!}} {{s-aft|after={{{after}}}}}
+{{!}}-
+| 3= ! colspan="3" {{spoilerplate}}
+{{!}}-
+{{!}} {{s-bef|before={{{before}}}}}
+{{!}} {{s-ttl|title={{{title}}}}}
+{{!}} class="spoiltext_box" {{s-aft|after={{{after}}}}}
+{{!}}-
+| #default= {{!}}-
 | {{s-bef|before={{{before}}}}}
 | {{s-ttl|title={{{title}}}}}
 | {{s-aft|after={{{after}}}}}
-|-
+{{!}}-
-</includeonly>
+}}
+</includeonly><noinclude>
 = Documentation =
-''Insert what this template is about.''
+Use a single block of succession boxes per article. Begin each succession box block with {{tl|start box}} and end it with {{tl|end box}}. In between, you may place as many instances of <code><nowiki>{{succession box}}</nowiki></code> as is necessary.
 == Usage ==
 <pre>
-''Insert full usage here.''
+{{succession box
+  | before=
+  | title=
+  | after=
+  | fullspolier=
+  | beforespolier=
+  | afterspolier=
+}}
 </pre>
-=== Required parameters ===
+=== Example ===
-''Insert Required parameters''
-=== Optional parameters ===
-''Insert Optional parameters''
-<noinclude>
-==Usage instructions==
-Use a single block of succession boxes per article. Begin each succession box block with <nowiki>{{start box}}</nowiki> and end it with <nowiki>{{end box}}</nowiki>. In between, you may place as many instances of <nowiki>{{succession box}}</nowiki> as is necessary. Use the following syntax:
-<nowiki>{{succession box|before=PREDECESSOR|title=TITLE|after=SUCCESSOR}}</nowiki>, replacing "PREDECESSOR", "TITLE" and "SUCCESSOR" as appropriate. For example, this is [[Lee Adama]]'s succession box, which includes two non-contiguous stints as ''Galactica'''s CAG, and two subsequent positions.
 <pre><nowiki>
 {{start box}}
-{{succession box|before=[[Jackson Spencer|Jackson "Ripper" Spencer]]|title=Commander, Air Group of the [[Galactica type battlestar|battlestar]] ''[[Galactica (RDM)|Galactica]]''|after=[[George Birch|George "Catman" Birch]]}}
+{{succession box
-{{succession box|before=[[George Birch|George "Catman" Birch]]|title=Commander, Air Group of the [[Galactica type battlestar|battlestar]] ''[[Galactica (RDM)|Galactica]]''|after=[[Kara Thrace|Kara "Starbuck" Thrace]]}}
+  | before= [[Jackson Spencer|Jackson "Ripper" Spencer]]
-{{succession box|before=''(unknown, eventually [[Jack Fisk]])''|title=Executive Officer of the [[Mercury class battlestar|battlestar]] ''[[Pegasus (RDM)|Pegasus]]''|after=''(unknown, eventually [[Anastasia Dualla]])}}
+  | title= Commander, Air Group of the [[Galactica type battlestar|battlestar]] ''[[Galactica (RDM)|Galactica]]''
-{{succession box|before=[[Barry Garner]]|title=Commanding Officer of the [[Mercury class battlestar|battlestar]] ''[[Pegasus (RDM)|Pegasus]]''|after=Incumbent}}
+  | after= [[George Birch|George "Catman" Birch]]
+}}
+{{succession box
+  | before= [[George Birch|George "Catman" Birch]]
+  | title= Commander, Air Group of the [[Galactica type battlestar|battlestar]] ''[[Galactica (RDM)|Galactica]]''
+  | after= [[Kara Thrace|Kara "Starbuck" Thrace]]
+}}
+{{succession box
+  | before= ''(unknown, eventually [[Jack Fisk]])''
+  | title= Executive Officer of the [[Mercury class battlestar|battlestar]] ''[[Pegasus (RDM)|Pegasus]]''
+  | after= ''(unknown, eventually [[Anastasia Dualla]])
+}}
+{{succession box
+  | before= [[Barry Garner]]
+  | title= Commanding Officer of the [[Mercury class battlestar|battlestar]] ''[[Pegasus (RDM)|Pegasus]]''
+  | after= Incumbent
+}}
 {{end box}}</nowiki></pre>
-The <nowiki>{{spoiltext}}</nowiki> template will not work within succession boxes. Instead, three other templates are available which may be used in place of <nowiki>{{succession box}}</nowiki>. These are:
+=== Required parameters ===
+* '''before''': Can be wikilined or non-wikilinked. Any formating allowed.
+* '''title ''': Can be wikilined or non-wikilinked. Any formating allowed.
+* '''after ''': Can be wikilined or non-wikilinked. Any formating allowed.
+**'''Note''': The {{tl|spoiltext}} template will not work within succession boxes. Instead, three other templates are available which may be used in place of {{tl|succession box}}.
-*<nowiki>{{succession box (spoiler)}}</nowiki> hides the entire section behind a spoiler tag.
+=== Optional parameter ===
-*<nowiki>{{succession box (spoiler-bef)}}</nowiki> hides the predecessor.
+* '''fullspolier''': If true, it will hide the entire section behind a spolier tag.
-*<nowiki>{{succession box (spoiler-aft)}}</nowiki> hides the successor.
+* ''OR:'' '''beforespolier''': If true, it will hide the ''before'' section behind a spolier tag.
+* ''OR:'' '''afterspolier''': If true, it will hide the ''after'' section behind a spolier tag.
-The syntax for these is identical to the standard <nowiki>{{succession box}}</nowiki> template.</noinclude>
+</noinclude>