Template:CatWeight/doc: Difference between revisions

Revision as of 12:26, 2 May 2009

Documentation for this template

This template creates an eye-catcher bar that can be indented up to 6 times via parameter value, letting the user better customize his "Note"s. The code is backwards compatible, letting the user keep on using the old 2 parameter version as well.

New	Subtle one-pixel border added, padding improved, <weight> is not word-wrapped.

Alternative names

{{catWeight|<weight>|<text>}}
{{CatWeight|<weight>|<text>}} - alternate spelling of template
{{catWeight|<#>|<weight>|<text>}}
{{CatWeight|<#>|<weight>|<text>}} - alternate spelling of template

Syntax

The template can have 2 or 3 parameters:

{{catWeight|<weight>|<text>}} - Default mode, no indentation.
{{catWeight|<#>|<weight>|<text>}} - Define indentation via <#> parameter.

       <#> =  Number 0 (min) to 6 (max), defines indentation level.
  <weight> =  The category weight denominator (not word-wrapped), range 1 (+) to 6 (***).
    <text> =  The descriptive text for that weight level.

Note	Only the <#>* values 1 to 6 are actually checked, any other values (e.g. 0 or abc) yield no indentation at all, and are treated the same as `{{eyecatch\|info\|text}}`!*

Examples

The Weights

Category Weight + Weight + means this and that.

Category Weight * Weight * means this and that.

Category Weight *+ Weight *+ means this and that.

Category Weight ** Weight ** means this and that.

Category Weight **+ Weight **+ means this and that.

Category Weight *** Weight *** means this and that.

Category Weight + to **+ Weight + to **+ means this and that.

Category Weight + to *** Weight + to *** means this and that.

There is an issue when using * as argument in catWeight, using "x" for now.

Indentation

{{catWeight|0|Note|'''No''' indentation, just like the normal <tt>catWeight</tt>.}} 
{{catWeight|abc|Note|'''No''' indentation, just like the normal <tt>catWeight</tt>.}} 
{{catWeight||Note|'''No''' indentation, just like the normal <tt>catWeight</tt>.}}

Category Weight No indentation, just like the normal catWeight.

{{catWeight|1|Another note|'''One''' indentation, just like <tt>catWeight2</tt>.}}

Category Weight One indentation, just like catWeight2.

{{catWeight|2|Important|Level '''two''' indentation!}}

Category Weight Level two indentation!

{{catWeight|6|Very important|Maximum indentation level of '''six'''! "Very important" is ...}}

Category Weight Maximum indentation level of six! "Very important" is not word-wrapped.

Test the Code

Should more code testing be required see the Template:CatWeight/Test Code page.

@@ Line 1: / Line 1: @@
-{{todo}}
 {{TOCright}}
-==Experimental Weight Boxes==
-<!--
-    	     		BG		Frame 		Grey Frame
-			s6 b100		s38 b100	s20 b80
-h240	blue		#efefff		#9F9FFF		#A3A3CC
-h0	light red	#ffefef		#FF9F9F		#CCA3A3
-h60	yellow		#ffffef		#FFFF9E         #CCCCA3
-h120	green		#efffef		#9EFF9E         #A3CCA3
--->
-===Detailed weighing of Category with explicit descriptions===
-:{| style="background:#FAF0FF; border:1px solid #DFC8EC; font-size: 90%;"
-| style="background:black; padding:2px;"    | <span style="color:white; font-weight:bold;">Category&nbsp;Weight</span>
-| style="background:#DFC8EC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&nbsp;&nbsp;&nbsp;</tt></span>
-| style="padding:2px;"                      | ''Level 0 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#DFC8EC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>+&nbsp;&nbsp;</tt></span>
-| style="padding:2px;"                      | ''Level 1 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#DFC8EC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&#42;&nbsp;&nbsp;</tt></span>
-| style="padding:2px;"                      | ''Level 2 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#DFC8EC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&#42;+&nbsp;</tt></span>
-| style="padding:2px;"                      | ''Level 3 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#DFC8EC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&#42;&#42;&nbsp;</tt></span>
-| style="padding:2px;"                      | ''Level 4 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#DFC8EC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&#42;&#42;+</tt></span>
-| style="padding:2px;"                      | ''Level 5 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#DFC8EC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&#42;&#42;&#42;</tt></span>
-| style="padding:2px;"                      | ''Level 6 does this and that.''
-|-
-|}
-:{| style="background:#efefff; border:1px solid #A3A3CC; font-size: 90%;"
-| style="background:black; padding:2px;"    | <span style="color:white; font-weight:bold;">Category&nbsp;Weight</span>
-| style="background:#A3A3CC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&nbsp;&nbsp;&nbsp;</tt></span>
-| style="padding:2px;"                      | ''Level 0 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#A3A3CC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>+&nbsp;&nbsp;</tt></span>
-| style="padding:2px;"                      | ''Level 1 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#A3A3CC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&#42;&nbsp;&nbsp;</tt></span>
-| style="padding:2px;"                      | ''Level 2 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#A3A3CC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&#42;+&nbsp;</tt></span>
-| style="padding:2px;"                      | ''Level 3 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#A3A3CC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&#42;&#42;&nbsp;</tt></span>
-| style="padding:2px;"                      | ''Level 4 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#A3A3CC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&#42;&#42;+</tt></span>
-| style="padding:2px;"                      | ''Level 5 does this and that.''
-|-
-| style=""                                  | &nbsp;
-| style="background:#A3A3CC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&#42;&#42;&#42;</tt></span>
-| style="padding:2px;"                      | ''Level 6 does this and that.''
-|-
-|}
-===Case: on/off only===
-Certain categories will either be set to <tt>***</tt> or not set at all. There are no intermediate weights!
-:{| style="background:#FAF0FF; border:1px solid #DFC8EC; width:300px"
-| style="background:black; padding:2px; text-align:center;"    | <span style="color:white; font-weight:bold;">Category Weight</span>
-| style="background:#DFC8EC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&nbsp;<br>or ***</tt></span>
-| style="padding:2px;"                      | ''If applicable this category should be weighted with '''<tt>***</tt>''' (on). Otherwise do '''not''' set it at all!''
-|}
-Probably better alternative table layout:
-:{| style="background:#ffefef; border:1px solid #CCA3A3; width:300px"
-| style="background:black; padding:2px; text-align:center;"    | <span style="color:white; font-weight:bold;">Category Weight</span>
-| style="background:#CCA3A3; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&nbsp; or ***</tt></span>
-|-
-| style="padding:2px;" colspan="2" | ''If applicable this category should be weighted with '''<tt>***</tt>''' (on). Otherwise do '''not''' set it at all!''
-|}
-:{| style="background:#ffefef; border:1px solid #CCA3A3; width:180px; font-size:90%;"
-| style="background:black; padding:2px; text-align:center;"    | <span style="color:white; font-weight:bold;">Category Weight</span>
-| style="background:#CCA3A3; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>&nbsp; or ***</tt></span>
-|-
-| style="padding:2px; text-align:center;" colspan="2" | ''If applicable this category should be weighted with '''<tt>***</tt>''' (on). Otherwise do '''not''' set it at all!''
-|}
-===Case: + to *** range dependant on occurrence amount===
-Most categories are weighted <tt>+</tt> to <tt>***</tt>. This solely depends on '''how often''' the category occurs in the anime.
-:{| style="background:#FAF0FF; border:1px solid #DFC8EC; width:300px"
-| style="background:black; padding:2px; text-align:center;"    | <span style="color:white; font-weight:bold;">Category Weight</span>
-| style="background:#DFC8EC; padding:2px;"  | <span style="color:black; font-weight:bold;"><tt>+ to ***</tt></span>
-| style="padding:2px;"                      | ''If applicable, choose a weight between '''<tt>+</tt>''' (seldom) to '''<tt>***</tt>''' (abundant) denoting '''how often''' the category occurs in the anime.''
-|}
-Probably better alternative table layout:
-:{| style="background:#efffef; border:1px solid #A3CCA3; width:300px"
-| style="background:black; padding:2px; text-align:center;"    | <span style="color:white; font-weight:bold;">Category Weight</span>
-| style="background:#A3CCA3; padding:2px; text-align:center;"  | <span style="color:black; font-weight:bold;"><tt>+ to ***</tt></span>
-|-
-| style="padding:2px;" colspan="2" | ''If applicable, choose a weight between '''<tt>+</tt>''' (seldom) to '''<tt>***</tt>''' (abundant) denoting '''how often''' the category occurs in the anime.''
-|}
-:{| style="background:#efffef; border:1px solid #A3CCA3; width:180px; font-size:90%;"
-| style="background:black; padding:2px; text-align:center;"    | <span style="color:white; font-weight:bold;">Category Weight</span>
-| style="background:#A3CCA3; padding:2px; text-align:center;"  | <span style="color:black; font-weight:bold;"><tt>+ to ***</tt></span>
-|-
-| style="padding:2px; text-align:center;" colspan="2" | ''If applicable, choose a weight between '''<tt>+</tt>''' (seldom) to '''<tt>***</tt>''' (abundant) denoting '''how often''' the category occurs in the anime.''
-|}
-===Case: + to *** range dependant worst case===
-Some categories like the Content Indicators are weighted not by the occurrence amount, but by the '''worst case''' in the anime, e.g. the most violent scene defined the weight. Range of weights is <tt>+</tt> to <tt>***</tt>.
-:{| style="background:#FAF0FF; border:1px solid #DFC8EC; width:300px"
-| style="background:black; padding:2px; text-align:center;"    | <span style="color:white; font-weight:bold;">Category Weight</span>
-| style="background:#DFC8EC; padding:2px; "  | <span style="color:black; font-weight:bold;"><tt>+ to ***</tt></span>
-| style="padding:2px;"                      | ''If applicable, choose a weight between '''<tt>+</tt>''' (slight) to '''<tt>***</tt>''' (excessive) describing the '''worst case''' of category occurrence in the anime.''
-|}
-Probably better alternative table layout:
-:{| style="background:#ffffef; border:1px solid #CCCCA3; width:300px"
-| style="background:black; padding:2px; text-align:center;"    | <span style="color:white; font-weight:bold;">Category Weight</span>
-| style="background:#CCCCA3; padding:2px; text-align:center;"  | <span style="color:black; font-weight:bold;"><tt>+ to ***</tt></span>
-|-
-| style="padding:2px;" colspan="2"          | ''If applicable, choose a weight between '''<tt>+</tt>''' (slight) to '''<tt>***</tt>''' (excessive) describing the '''worst case''' of category occurrence in the anime.''
-|}
-:{| style="background:#ffffef; border:1px solid #CCCCA3; width:180px; font-size:90%;"
-| style="background:black; padding:2px; text-align:center;"    | <span style="color:white; font-weight:bold;">Category Weight</span>
-| style="background:#CCCCA3; padding:2px; text-align:center;"  | <span style="color:black; font-weight:bold;"><tt>+ to ***</tt></span>
-|-
-| style="padding:2px; text-align:center;" colspan="2"          | ''If applicable, choose a weight between '''<tt>+</tt>''' (slight) to '''<tt>***</tt>''' (exces- sive) describing the '''worst case''' of category occurrence in the anime.''
-|}
 ==Documentation for this template==
@@ Line 175: / Line 20: @@
       '''<text>''' =  The descriptive text for that weight level.
 {{eyecatch|1|Note|Only the '''<#>''' values '''1''' to '''6''' are actually checked, any '''other values''' (e.g. 0 or abc) yield '''no indentation''' at all, and are treated the same as <tt><nowiki>{{eyecatch|info|text}}</nowiki></tt>!}}
 ==Examples==
@@ Line 203: / Line 49: @@
   <nowiki>{{catWeight|6|Very important|Maximum indentation level of '''six'''! "Very important" is ...}}</nowiki>
 {{catWeight|6|Very important|Maximum indentation level of '''six'''! "Very important" is '''not''' word-wrapped.}}
+==Test the Code==
+Should more code testing be required see the [[Template:CatWeight/Test Code]] page.