Difference between revisions of "Template:Bu/doc"

From MidrangeWiki
Jump to: navigation, search
m (cleanup of template doc)
m (Examples: add a blank column for readability)
 
(5 intermediate revisions by the same user not shown)
Line 2: Line 2:
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
=Documentation=
 
=Documentation=
<big>{{tl|bu}}</big> is a shorthand notation to make the passed parameter text emphasized with both <big>big</big> and <u>underlined</u>.  It is most useful when defining an acronym.
+
<big>{{tl|bu}}</big> is a shorthand notation to make the required first parameter text emphasized with both <big>big</big> and <u>underlined</u>.  It is most useful when defining an acronym
 +
 
 +
An optional second parameter text can be included for non-emphasized text, which can make text entry simpler.
 
:'''{{PAGENAME}}''' stands for {{bu|B}}ig {{bu|U}}nderlined.
 
:'''{{PAGENAME}}''' stands for {{bu|B}}ig {{bu|U}}nderlined.
 
   
 
   
 
== Usage ==
 
== Usage ==
 
<pre>
 
<pre>
{{bu|letter(s) to emphasize}}
+
{{ bu | letter(s) to emphasize }} optional letter(s) to not emphasize
 
</pre>
 
</pre>
== Example ==
+
<pre>
 +
{{ bu | letter(s) to emphasize | optional letter(s) to not emphasize }}
 +
</pre>
 +
:''Note that case is preserved and not automatically converted to uppercase.''
 +
 
 +
== Examples ==
 
{|  
 
{|  
 
! Code
 
! Code
 +
!
 
! Result
 
! Result
 
|-
 
|-
| <code>{&#123;bu&#124;D&#125;}edicated {&#123;bu&#124;S&#125;}ervice {&#123;bu&#124;T&#125;}ools </code>  
+
| Single parameter, single letter
 +
|-
 +
| <pre>{{bu|D}}edicated {{bu|S}}ervice {{bu|T}}ools</pre>
 +
|
 
| {{bu|D}}edicated {{bu|S}}ervice {{bu|T}}ools
 
| {{bu|D}}edicated {{bu|S}}ervice {{bu|T}}ools
 +
|-
 +
| Single parameter, multiple letters
 +
|-
 +
| <pre>{{bu|QuI}}ck {{bu|BrO}}wn {{bu|F}}ox.</pre>
 +
|
 +
| {{bu|QuI}}ck {{bu|BrO}}wn {{bu|F}}ox.
 +
|-
 +
| Optional second parameter, multiple letters
 +
|-
 +
| <pre>{{bu|QuI|ck}} {{bu|BrO|wn}} {{bu|F|ox}}.</pre>
 +
|
 +
| {{bu|QuI|ck}} {{bu|BrO|wn}} {{bu|F|ox}}.
 
|}
 
|}
 
----
 
----
Line 22: Line 45:
 
<includeonly>
 
<includeonly>
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
 
<!-- ADD CATEGORIES BELOW THIS LINE -->
[[Category:Internal link templates|{{PAGENAME}}]]
+
[[Category:Internal formatting templates|{{PAGENAME}}]]
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
<!-- ADD INTERWIKIS BELOW THIS LINE -->
 
</includeonly>
 
</includeonly>

Latest revision as of 15:48, 30 January 2009

48px This is the template documentation page for {{Bu}}.
It is not intended to be viewed directly. If it uses variables, some links may appear broken. Do not replace these variables with hardcoded page names or URLs.

Documentation

{{bu}} is a shorthand notation to make the required first parameter text emphasized with both big and underlined. It is most useful when defining an acronym.

An optional second parameter text can be included for non-emphasized text, which can make text entry simpler.

Bu/doc stands for Big Underlined.

Usage

{{ bu | letter(s) to emphasize }} optional letter(s) to not emphasize
{{ bu | letter(s) to emphasize | optional letter(s) to not emphasize }}
Note that case is preserved and not automatically converted to uppercase.

Examples

Code Result
Single parameter, single letter
{{bu|D}}edicated {{bu|S}}ervice {{bu|T}}ools
Dedicated Service Tools
Single parameter, multiple letters
{{bu|QuI}}ck {{bu|BrO}}wn {{bu|F}}ox.
QuIck BrOwn Fox.
Optional second parameter, multiple letters
{{bu|QuI|ck}} {{bu|BrO|wn}} {{bu|F|ox}}.
QuIck BrOwn Fox.