Editing Template:Navibox/doc

This template is the base template for every [[:Category:Navibox Templates |navibox]].

Example of use of this template: [[Template:The Undersiders Navibox]]
{{The Undersiders Navibox}}

==How to Use It==
The template is composed of 2 different parts:
*the "title" parts which are coloured and centered (Organizations/Teams)
*the "class" parts which contain the informative articles (Anime only, Locations...)

===Title Parts===
The "title" parts have 2 parameters:
*'''title''' (or '''title1''', '''title2'''...): contents of the title bar, which can be a link.
*'''colorscheme''' (or '''colorscheme1''', '''colorscheme2'''...): [[:Category:Color Schemes|color scheme]] of the title bar.

The non-numbered '''title''' and '''colorscheme''' parameters refer to the main title of the navibox (the one that's seen when the navibox is collapsed).
The others are numbered from 1 to 5. The number is associated to the title position in the final template.

If one of the subtitles have no associated color scheme, the main color scheme is used. If there exists no color scheme corresponding to the color you want, you can use the '''backcolor''' and/or '''textcolor''' optional parameters (also declined in main/numbered versions). Those arguments override the specified color scheme, if any.


;Examples

*The title ''Undersiders'' which is the main title and link to [[Undersiders]] is coded like this:
<pre>
 |title=[[Undersiders]]
 |colorscheme=BorderColors
</pre>
*The title ''Related Articles'' which is the second subtitle and and doesn't link to any page is coded like this:
<pre>
 |title2=Related Articles
</pre>
:::(note that we don't have to specify '''colorcheme2''' since we want it to be the same as the main color scheme

*Suppose that, for some reason, we want to use different colors for this last title, for which no color scheme exists:
<pre>
 |title2=Related Articles
 |backcolor2=123456
 |textcolor2=ABCDEF
</pre>
:::(note that the # is omitted in the color hex-code)


===Class Parts===
The class parts have 2 parameters:
*'''class''': contents of the class written in bold black in the left part of the table, which can be a link.
*'''info''' : the class' list of articles.

Each parameter is associated with 2 numbers in the form <code>x.y</code>. <code>x</code> refers to the title number (0 for the main classes), <code>y</code> refers to the position of the class in the table (there can be 5 subtitle sections (not including the main one) which can have up to 10 classes each).

;Examples

*The class ''Trigger'' which is the first class of the Third subsection (x=1, y=1) and links to [[Trigger]] is coded like this:
<pre>
 |class2.1=[[Trigger]]
 |info2.1={{Navibox/info
            | [[Trigger/White Trigger|Ray-gust]] 
            | [[Replica]]
          }}
</pre>
:::(note the use of [[Template:Navibox/info]] for the list to be displayed properly.)

*The class ''Individuals'' which is the First class of the second subsection (x=2,  y=4) and doesn't link to any page is coded like this:
<pre>
 |class1.1=Individuals
 |info1.1={{Navibox/info
            | [[Jun Arashiyama]]
            | [[Ai Kitora]]
          }}
</pre>

;Notes
*Beware of the position of the x and y numbers in the parameters (x can be between 0 and 5, y can be between 1 and 10)
*Classes are optional, i.e. a title can have no associated class section. This is used mainly for the main classes (numbered 0), see [[Template:Trigger Navibox]].
*Class names and info are optional too. In a subsection, only the title is mandatory.
*Use [[Template:Navibox/info]] in the info parameters, for the list to be displayed properly.

===Organisation===
A typical organisation for this template would be something like this :
<pre>
{{Navibox
  |template={{subst:PAGENAME}}
  |title=[[Osamu Mikumo|yyyy]]
  |colorscheme=BorderCorlors

  |class0.1=[[World Trigger|tata]]
  |info0.1={{Navibox/info
             | [[Daisuke Ashihara|Gabba Gabba]]
             | [[Jin Yūichi|Hey]]
           }}
  |class0.2=[[Masamune Kido|tete]]
  |info0.2={{Navibox/info
             | [[Takumi Rindō|Whoopee]]
             | [[Chika Amatori|Yee-ha]]
           }}
  
  |title1=yyy
  |class1.1=[[Replica|toto]] 
  |info1.1={{Navibox/info
             | [[Shūji Miwa|abc]]
             | [[Netsuki|def]]
           }}
  |class1.2=tata
  |info1.2={{Navibox/info
             | [[Yūgo Kuga|aaaaa]]
             | [[Jun Arashiyama|zzzzzzzz]]
           }}
}}
</pre>
This would output:
{{Navibox
  |template=Navibox/doc
  |title=[[Osamu Mikumo|yyyy]]
  |colorscheme=BorderCorlors

  |class0.1=[[World Trigger|tata]]
  |info0.1={{Navibox/info
             | [[Daisuke Ashihara|Gabba Gabba]]
             | [[Jin Yūichi|Hey]]
           }}
  |class0.2=[[Masamune Kido|tete]]
  |info0.2={{Navibox/info
             | [[Takumi Rindō|Whoopee]]
             | [[Chika Amatori|Yee-ha]]
           }}
  
  |title1=yyy
  |class1.1=[[Replica|toto]] 
  |info1.1={{Navibox/info
             | [[Shūji Miwa|abc]]
             | [[Netsuki|def]]
           }}
  |class1.2=tata
  |info1.2={{Navibox/info
             | [[Yūgo Kuga|aaaaa]]
             | [[Jun Arashiyama|zzzzzzzz]]
           }}
}}

==Most Common Mistakes==
This paragraph describes the most common errors that one can make when using this template, please read them carefully as they contain useful information. 

===There Are Some Abnormal Signs===
If something like {{{title}}} appears, it probably means that you forgot to set a parameter.
Cf above for the good use of parameters.

===Some Parts Are Missing or in a Bad Place===
The maximum number for subtitles is 5 (+ the main title), the maximum number of classes is 10, if you have parameter like title6 or class3.11, they are not displayed.

Beware of the classes number not referring to the good title section. Something like this won't work, since the second class is badly numbered:
<pre>
 |title1
 |class1.1
 |class2.1
</pre>




<includeonly>[[Category:Navibox Templates| ]]</includeonly>

<!-- DO NOT EDIT THE FOLLOWING CODE -->
<noinclude>[[Category:Template Documentation|{{PAGENAME}}]]
</noinclude>