Template:Examples/doc: Difference between revisions

Content added Content deleted

Inline

Latest revision as of 14:30, 18 April 2024

Description: A header for the examples section for use on trope pages (see the nearly identical {{tropelist}} for use on work pages). This makes a gray box that clearly delineates description from examples listings, and allows use of all of the normal headers for subsections.
Use: Place the template {{examples}} immediately above the examples for a trope. It will automatically include the name of the trope:

Examples of Examples/doc include:

Options
Description: Use the art argument (short for "article") to precede the article name with additional words, namely articles (a, an, the). This is {{examples|art=The}}:

Examples of The Examples/doc include:

Use the pre argument (short for "prefix") to append extra characters to the start of the title. This is {{examples|pre=Prefixed-}}:

Examples of Prefixed-Examples/doc include:

Use the suf argument (short for "suffix") to append extra characters to the end of the title. This is {{examples|suf=ample}}:

Examples of Examples/docample include:

Use the page argument to replace the default trope name. This is {{examples|page=A Completely Different Trope}}:

Examples of A Completely Different Trope include:

To provide entirely alternate text, use an unnamed argument, like {{examples|I can't believe it's not Troper!}}:

I can't believe it's not Troper!

@@ Line 1: / Line 1: @@
+; Description
-'''Description''':An examples header meant for general purpose use on ATT, that doesn't trigger the hide-section functionality like a normal header does.
+: A header for the examples section for use on '''trope pages''' (see the nearly identical {{tl|tropelist}} for use on work pages).  This makes a gray box that clearly delineates description from examples listings, and allows use of all of the normal headers for subsections.
+; Use
+: Place the template {{tl|examples}} immediately above the examples for a trope.  It will automatically include the name of the trope:
+{{examples}}
+; Options
+; Description
+: Use the <code>art</code> argument (short for "article") to precede the article name with additional words, namely articles (a, an, the).  This is <code><nowiki>{{examples|art=The}}</nowiki></code>:
+{{examples|art=The}}
-'''Use''': place <nowiki>{{examples}}</nowiki> template just above rest of examples for an article.  To provide alternate text, provide it as an argument to the template, like <nowiki>{{examples|Examples of this trope are:}}</nowiki>.
+: Use the <code>pre</code> argument (short for "prefix") to append extra characters to the start of the title. This is <code><nowiki>{{examples|pre=Prefixed-}}</nowiki></code>:
+{{examples|pre=Prefixed-}}
+: Use the <code>suf</code> argument (short for "suffix") to append extra characters to the end of the title. This is <code><nowiki>{{examples|suf=ample}}</nowiki></code>:
+{{examples|suf=ample}}
+: Use the <code>page</code> argument to replace the default trope name.  This is <code><nowiki>{{examples|page=A Completely Different Trope}}</nowiki></code>:
+{{examples|page=A Completely Different Trope}}
+: To provide entirely alternate text, use an unnamed argument, like <code><nowiki>{{examples|I can't believe it's not Troper!}}</nowiki></code>:
+{{examples|I can't believe it's not Troper!}}
+<includeonly>[[Category:ATT Templates]]</includeonly>
 <noinclude>[[Category:ATT Template Documentation]]</noinclude>