Template:Eyecatch3/doc: Difference between revisions
m (Example testing) |
No edit summary |
||
Line 2: | Line 2: | ||
==1111== | ==1111== | ||
{{ | {{eyecatch3|test|n1}} | ||
{{ | {{eyecatch3|test|n2}} | ||
{{ | {{eyecatch3|test|n3}} | ||
{{ | {{eyecatch3|test|n4}} | ||
{{ | {{eyecatch3|test|n5}} | ||
{{ | {{eyecatch3|test|n6}} | ||
{{ | {{eyecatch3|test|n7}} | ||
{{ | {{eyecatch3|test|n8}} | ||
{{ | {{eyecatch3|test|n9}} | ||
==2222== | ==2222== | ||
{{ | {{eyecatch3|0|test|:0}} | ||
{{ | {{eyecatch3|1|test|:1}} | ||
{{ | {{eyecatch3|2|test|:2}} | ||
{{ | {{eyecatch3|3|test|:3}} | ||
{{ | {{eyecatch3|3|test|:3}} | ||
{{ | {{eyecatch3|3|test|:3}} | ||
==Real-world Examples== | ==Real-world Examples== | ||
''Real-world test of the code, issue '''empty line''' before <tt>eycatch</tt>:'' | ''Real-world test of the code, issue '''empty line''' before <tt>eycatch</tt>:'' | ||
===Test 1 - Empty line before and after | ===Test 1 - Empty line before and after eyecatch3=== | ||
'''<span style="color:red">Spacing below box is OK, space above box shows one "empty line" too much. VERY UGLY!</span>'''<br> | '''<span style="color:red">Spacing below box is OK, space above box shows one "empty line" too much. VERY UGLY!</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. | 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".}} | ||
Read more about [http://en.wikipedia.org/wiki/File_verification file verification] if you are unfamiliar with this subject. | Read more about [http://en.wikipedia.org/wiki/File_verification file verification] if you are unfamiliar with this subject. | ||
===Test 2 - Empty line before and after | ===Test 2 - Empty line before and after eyecatch3, indent 1=== | ||
'''<span style="color:red">Spacing below box is OK, space above box shows one "empty line" too much. VERY UGLY!</span>'''<br> | '''<span style="color:red">Spacing below box is OK, space above box shows one "empty line" too much. VERY UGLY!</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. | 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. | 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 | ===Test 3 - NO Empty line before and after eyecatch3=== | ||
'''<span style="color:red">Spacing above and below the box looks OK.</span>'''<br> | '''<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. | 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".}} | ||
Read more about [http://en.wikipedia.org/wiki/File_verification file verification] if you are unfamiliar with this subject. | 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 | ===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> | '''<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. | 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. | Read more about [http://en.wikipedia.org/wiki/File_verification file verification] if you are unfamiliar with this subject. | ||
===Test 5 - Two | ===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 | '''<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]". | 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. | 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 | ===Test 6 - Two eyecatch3 blocks, indent 1, no empty lines=== | ||
'''<span style="color:red">The slight space above, below and between the two | '''<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]". | 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. | 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== | ==Results== | ||
* <nowiki>{{ | * <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 | * 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== | ==Solution== | ||
Basically the code works better than the original old version, i.e. the spacing above and below the the | 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 | '''So, *never* add an empty line above the eyecatch3 box!''' | ||
A empty line below the | A empty line below the eyecatch3 box is ignored! | ||
Revision as of 11:12, 28 April 2009
1111
|
|
|
|
|
|
|
|
|
2222
|
|
|
|
|
|
Real-world Examples
Real-world test of the code, issue empty line before eycatch:
Test 1 - Empty line before and after eyecatch3
Spacing below box is OK, space above box shows one "empty line" too much. VERY UGLY!
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.
|
Read more about file verification if you are unfamiliar with this subject.
Test 2 - Empty line before and after eyecatch3, indent 1
Spacing below box is OK, space above box shows one "empty line" too much. VERY UGLY!
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.
|
Read more about file verification if you are unfamiliar with this subject.
Test 3 - NO Empty line before and after eyecatch3
Spacing above and below the box looks OK.
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.
|
Read more about file verification if you are unfamiliar with this subject.
Test 4 - NO Empty line before and after eyecatch3, indent 1
Spacing above and below the box looks OK.
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.
|
Read more about file verification if you are unfamiliar with this subject.
Test 5 - Two eyecatch3 blocks, no empty lines
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.
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]".
|
|
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
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!
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]".
|
|
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
- {{eyecatch3|0|Note|blah}} works exactly the same as {{eyecatch3|Note|blah}}
- Empty or wrong entries (e.g. xyz) in # field, yields default eyecatch3 without an indent.
e.g. {{eyecatch3||Note|blah}} or {{eyecatch3|xyz|Note|blah}}
-> 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!
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
- {{eyecatch3|#|info|text}}
- {{Eyecatch3|#|info|text}} alternate spelling of template
Syntax
- {{eyecatch3|#|info|text}}
# = 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.
|
Examples
{{eyecatch3|0|Note|'''No''' indentation, just like the normal <tt>eyecatch</tt>.}}
|
{{eyecatch3|1|Another note|'''One''' indentation, just like <tt>eyecatch2</tt>.}}
|
{{eyecatch3|2|Important|Level '''two''' indentation!}}
|
{{eyecatch3|6|Very important|Maximum indentation level of '''six'''!}}
|