Template:Eyecatch3/doc: Difference between revisions

From AniDB
Jump to navigation Jump to search
No edit summary
mNo edit summary
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{TOCright}}
{{TOCright}}


==1111==
This template creates three different category marker boxes informing the user when a category is exclusively ecchi, hentai, or both.
{{eyecatch3|test|n1}}
{{eyecatch|1|Features|Choose between the three <nowiki><type></nowiki>s, and optionally <nowiki><align></nowiki> them.}}
{{eyecatch3|test|n2}}
{{eyecatch3|test|n3}}


{{eyecatch3|test|n4}}
==Syntax==
{{eyecatch3|test|n5}}
The template can have '''1''' or '''2 parameters''':
{{eyecatch3|test|n6}}
#{{m|CatExclusive|<type>}} - Default mode, no alignment!
#{{m|CatExclusive|<type>|<align>}} - Define alignment via <align> parameter.
    '''<type>''' =  Define the type category marker box you require:
                  '''e'''
                  '''E'''
              '''ecchi'''  =  Ecchi only!
                  '''h'''
                  '''H'''
              '''hentai'''  =  Hentai only!
                '''e&h'''
                '''E&H'''
        '''ecchi&hentai'''  =  Ecchi & hentai only!
    '''<align>''' =  Should the marker box be aligned? By default it is not a "float".
                '''left'''  =  Aligns the box to the left of the text.
              '''right'''  =  Aligns the box to the right of the text.
              '''1''' to '''6'''  =  No alignment, instead defines level of indentation!
                '''none'''  =  No  entry, or any other entry will *not* align the info box.


{{eyecatch3|test|n7}}
{{eyecatch3|test|n8}}


{{eyecatch3|test|n9}}
==Example Category Markers==
===The three <type>s of marker boxes===
<nowiki>{{eyecatch3|h}}</nowiki>
{{eyecatch3|h}}


==2222==
<nowiki>{{eyecatch3|H}}</nowiki>
{{eyecatch3|0|test|:0}}
{{eyecatch3|H}}
{{eyecatch3|1|test|:1}}
{{eyecatch3|2|test|:2}}
{{eyecatch3|3|test|:3}}


{{eyecatch3|3|test|:3}}
<nowiki>{{eyecatch3|hentai}}</nowiki>
{{eyecatch3|3|test|:3}}
{{eyecatch3|hentai}}


==Real-world Examples==
<nowiki>{{eyecatch3|e}}</nowiki>
''Real-world test of the code, issue '''empty line''' before <tt>eycatch</tt>:''
{{eyecatch3|e}}


===Test 1 - Empty line before and after eyecatch3===
<nowiki>{{eyecatch3|E}}</nowiki>
'''<span style="color:red">Spacing below box is OK, space above box shows one "empty line" too much. VERY UGLY!</span>'''<br>
{{eyecatch3|E}}
Indicates whether the file entry in AniDB represents a perfect copy of the original file or not. You may request a change of the CRC Status if its not checked yet.


{{eyecatch3|Note|'''<nowiki>{{eyecatch3|Note|blah}}</nowiki>''' - Not all groups provide CRC checksums for their files. This means that this status has no meaning and will have the value "not checked against official CRC".}}
<nowiki>{{eyecatch3|ecchi}}</nowiki>
{{eyecatch3|ecchi}}


Read more about [http://en.wikipedia.org/wiki/File_verification file verification] if you are unfamiliar with this subject.
<nowiki>{{eyecatch3|e&h}}</nowiki>
{{eyecatch3|e&h}}


===Test 2 - Empty line before and after eyecatch3, indent 1===
<nowiki>{{eyecatch3|E&H}}</nowiki>
'''<span style="color:red">Spacing below box is OK, space above box shows one "empty line" too much. VERY UGLY!</span>'''<br>
{{eyecatch3|e&h}}
Indicates whether the file entry in AniDB represents a perfect copy of the original file or not. You may request a change of the CRC Status if its not checked yet.


{{eyecatch3|1|Note|'''<nowiki>{{eyecatch3|1|Note|blah}}</nowiki>''' - Not all groups provide CRC checksums for their files. This means that this status has no meaning and will have the value "not checked against official CRC".}}
<nowiki>{{eyecatch3|ecchi&hentai}}</nowiki>
{{eyecatch3|ecchi&hentai}}


Read more about [http://en.wikipedia.org/wiki/File_verification file verification] if you are unfamiliar with this subject.


===Test 3 - NO Empty line before and after eyecatch3===
===The <align> used for indentation===
'''<span style="color:red">Spacing above and below the box looks OK.</span>'''<br>
<nowiki>{{eyecatch3|e&h|1}}</nowiki> (indent level 1)
Indicates whether the file entry in AniDB represents a perfect copy of the original file or not. You may request a change of the CRC Status if its not checked yet.
{{eyecatch3|e&h|1}}
{{eyecatch3|Note|'''<nowiki>{{eyecatch3|Note|blah}}</nowiki>''' - Not all groups provide CRC checksums for their files. This means that this status has no meaning and will have the value "not checked against official CRC".}}
Read more about [http://en.wikipedia.org/wiki/File_verification file verification] if you are unfamiliar with this subject.
 
===Test 4 - NO Empty line before and after eyecatch3, indent 1===
'''<span style="color:red">Spacing above and below the box looks OK.</span>'''<br>
Indicates whether the file entry in AniDB represents a perfect copy of the original file or not. You may request a change of the CRC Status if its not checked yet.
{{eyecatch3|1|Note|'''<nowiki>{{eyecatch3|1|Note|blah}}</nowiki>''' - Not all groups provide CRC checksums for their files. This means that this status has no meaning and will have the value "not checked against official CRC".}}
Read more about [http://en.wikipedia.org/wiki/File_verification file verification] if you are unfamiliar with this subject.
 
===Test 5 - Two eyecatch3 blocks, no empty lines===
'''<span style="color:red">Spacing above and below the boxes looks OK. IMO it would be better to have a slight space between the two eyecatch3 boxes for the normal un-indented eyecatch3 usage.</span>'''<br>
AniDB stores the name and short name of the group/person that produced and released a file. The short name is usually found as ''tags'' in file names, for example "[AonE]".
{{eyecatch3|Note|'''<nowiki>{{eyecatch3|Note|blah}}</nowiki>''' - If a file is a joint release, like a file by e.g. ANBU-AonE, that joint group has its own group entry. The file should not be registered under either ANBU or AonE, but to the group that combines them both.}}
{{eyecatch3|Note|'''<nowiki>{{eyecatch3|Note|blah}}</nowiki>''' - Not all RAW groups are credited. See [[which RAW groups to credit]].}}
Please note that not all groups registered in AniDB are listed with the tag they actually use, as AniDB can only have one distinctive tag for each group.
 
===Test 6 - Two eyecatch3 blocks, indent 1, no empty lines===
'''<span style="color:red">The slight space above, below and between the two eyecatch3 boxes looks fine, when NOT using extra empty lines in-text. But only for the indented eyecatch3!</span>'''<br>
AniDB stores the name and short name of the group/person that produced and released a file. The short name is usually found as ''tags'' in file names, for example "[AonE]".
{{eyecatch3|1|Note|'''<nowiki>{{eyecatch3|1|Note|blah}}</nowiki>''' - If a file is a joint release, like a file by e.g. ANBU-AonE, that joint group has its own group entry. The file should not be registered under either ANBU or AonE, but to the group that combines them both.}}
{{eyecatch3|1|Note|'''<nowiki>{{eyecatch3|1|Note|blah}}</nowiki>''' - Not all RAW groups are credited. See [[which RAW groups to credit]].}}
Please note that not all groups registered in AniDB are listed with the tag they actually use, as AniDB can only have one distinctive tag for each group.
 
==Results==
* <nowiki>{{eyecatch3|0|Note|blah}}</nowiki> works exactly the same as <nowiki>{{eyecatch3|Note|blah}}</nowiki>
* Empty or wrong entries (e.g. xyz) in # field, yields default eyecatch3 without an indent.<br>e.g. <nowiki>{{eyecatch3||Note|blah}}</nowiki> or <nowiki>{{eyecatch3|xyz|Note|blah}}</nowiki><br>-> seems to be fool proof.
 
 
==Solution==
Basically the code works better than the original old version, i.e. the spacing above and below the the eyecatch3 boxes *now* looks really nice.
 
'''So, *never* add an empty line above the eyecatch3 box!'''
 
A empty line below the eyecatch3 box is ignored!
 
 
 
----
----
----
 
{{TOCright}}
 
==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.
 
==Alternative names==
* <nowiki>{{eyecatch3|#|info|text}}</nowiki>
* <nowiki>{{Eyecatch3|#|info|text}}</nowiki> alternate spelling of template
 
==Syntax==
;<tt><nowiki>{{eyecatch3|#|info|text}}</nowiki></tt>
    '''#'''  =  Number '''0''' (min) to '''6''' (max), defines indentation level.
'''info'''  =  The info to highlight, i.e. ''Note'' or ''Important''.
'''text'''  =  The descriptive text for the info.
{{eyecatch3|2|Important|Only the # values of 1 to 6 are actually checked, any other values result in '''no''' indentation at all!<br>Also note that there have to be '''3 parameters''', always!}}


==Examples==
<nowiki>{{eyecatch3|0|Note|'''No''' indentation, just like the normal <tt>eyecatch</tt>.}}</nowiki>
{{eyecatch3|0|Note|'''No''' indentation, just like the normal <tt>eyecatch</tt>.}}


  <nowiki>{{eyecatch3|1|Another note|'''One''' indentation, just like <tt>eyecatch2</tt>.}}</nowiki>  
===The <align>ment of the info boxes===
{{eyecatch3|1|Another note|'''One''' indentation, just like <tt>eyecatch2</tt>.}}
  <nowiki>{{eyecatch3|e|right}}</nowiki>
{{eyecatch3|e|right}}


<nowiki>{{eyecatch3|2|Important|Level '''two''' indentation!}}</nowiki>
blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah...
{{eyecatch3|2|Important|Level '''two''' indentation!}}


  <nowiki>{{eyecatch3|6|Very important|Maximum indentation level of '''six'''!}}</nowiki>  
  <nowiki>{{eyecatch3|h|left}}</nowiki>
{{eyecatch3|6|Very important|Maximum indentation level of '''six'''!}}
{{eyecatch3|h|left}}
blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah...

Latest revision as of 12:44, 15 May 2009

This template creates three different category marker boxes informing the user when a category is exclusively ecchi, hentai, or both.

Features Choose between the three <type>s, and optionally <align> them.

Syntax

The template can have 1 or 2 parameters:

  1. {{CatExclusive|<type>}} - Default mode, no alignment!
  2. {{CatExclusive|<type>|<align>}} - Define alignment via <align> parameter.
    <type> =  Define the type category marker box you require:
                  e
                  E
              ecchi  =  Ecchi only!

                  h
                  H
             hentai  =  Hentai only!

                e&h
                E&H
       ecchi&hentai  =  Ecchi & hentai only!

   <align> =  Should the marker box be aligned? By default it is not a "float".
               left  =  Aligns the box to the left of the text.
              right  =  Aligns the box to the right of the text.
             1 to 6  =  No alignment, instead defines level of indentation!
               none  =  No  entry, or any other entry will *not* align the info box.


Example Category Markers

The three <type>s of marker boxes

{{eyecatch3|h}}
Category Hentai only! 
{{eyecatch3|H}}
Category Hentai only! 
{{eyecatch3|hentai}}
Category Hentai only! 
{{eyecatch3|e}}
Category Ecchi only! 
{{eyecatch3|E}}
Category Ecchi only! 
{{eyecatch3|ecchi}}
Category Ecchi only! 
{{eyecatch3|e&h}}
Category Ecchi & hentai only! 
{{eyecatch3|E&H}}
Category Ecchi & hentai only! 
{{eyecatch3|ecchi&hentai}}
Category Ecchi & hentai only!


The <align> used for indentation

{{eyecatch3|e&h|1}} (indent level 1)
Category Ecchi & hentai only!


The <align>ment of the info boxes

{{eyecatch3|e|right}}
Category Ecchi only!

blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah... 

{{eyecatch3|h|left}}
Category Hentai only!

blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah blah...

Retrieved from "https://wiki.anidb.net/index.php?title=Template:Eyecatch3/doc&oldid=13872"