Difference between revisions of "Template:Float/doc"

From blackwiki
Jump to navigation Jump to search
imported>Jmarchn
m (Detele interwiki -> wikidata)
imported>Sardanaphalus
(update (primarily to introduce {{float|left|...}}))
Line 1: Line 1:
{{documentation subpage}}
+
{{Documentation subpage}}
 
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
 
<!---PLEASE ADD METADATA TO THE <includeonly> SECTION AT THE BOTTOM OF THIS PAGE--->
{{notice|Take care when using this template in navboxes to ensure that whatever it is used to float (e.g. an image) does not float over other elements or text if{{\}}when the navbox is resized. To align centered lists in a navbox with an image, see the [[#Alternatives for navigational boxes|alternatives for navigational boxes]] section below.  For aligning text in general, see {{tl|align}}.  For floating images, boxes, and other elements, see {{tl|stack}}.}}
+
{{Notice |Take care when using this template in navboxes to ensure that whatever it is used to float (e.g. an image) does not float over other elements or text if{{\}}when the navbox is resized. To align centered lists in a navbox with an image, see the [[#Alternatives for navigational boxes|alternatives for navigational boxes]] section below.  For aligning text in general, see {{tl|align}}.  For floating images, boxes, and other elements, see {{tl|stack}}.}}
  
Use <code><nowiki>{{float}}</nowiki></code> to position items such as images so they do not affect the alignment or formatting of other items (e.g. text) nearby.
+
Use {{tl|float}} to "float" items{{spaced ndash}}i.e. position them{{spaced ndash}}so they do not affect the alignment or formatting of other items (such as text) nearby.
  
: <code><nowiki>{{</nowiki>'''float'''|''top''= |''right''= |''bottom''= |''left''= |'''''item'''''}}</code>, where ''top'' and ''right'' default to zero.
+
* <code><nowiki>{{float|</nowiki>{{bigger|{{smallcaps|item}}}}}}</code> floats {{smallcaps|item}} on the righthand edge of a page/area.
: <code><nowiki>{{</nowiki>'''float'''|'''''item'''''}}</code> with default positioning ''top'':0, ''right'':0 (i.e. ''item'' floats on righthand side).
+
* <code><nowiki>{{float|left|</nowiki>{{bigger|{{smallcaps|item}}}}}}</code> floats {{smallcaps|item}} on the lefthand edge of a page/area.
 +
* <code><nowiki>{{float |top= |right= |bottom= |left= |width= |</nowiki>{{bigger|{{smallcaps|item}}}}}}</code>
  
''item'' is the only required parameter. The optional parameters ''top'', ''right'', ''bottom'', ''left'' indicate how far from their respective positions the ''item'' is to be positioned. The ''width'' of the item may also be specified. Any units may be used so long as they are specified{{spaced ndash}}e.g. <code><nowiki>{{</nowiki>float|top=2em|left=2em|width=10em|"Blah"}}</code>. Note that if any values other than zero for ''top'' and ''right'' are required, they need to be specified.
+
{{para||{{bigger|{{smallcaps|item}}}}}} is the only required parameter. The optional parameters ''top'', ''right'', ''bottom'' and ''left'' indicate how far from their respective positions the ''item'' is to be positioned. The ''width'' of the item may also be specified. Any established HTML/CSS units may be used so long as they are specified (for example, <code><nowiki>{{float |top=2.0em |left=2px |width=10em |Blah}}</nowiki></code>). <!--Unnecessary?: Note that if any values other than zero for ''top'' and ''right'' are required, they need to be specified.-->
  
 
===Examples===
 
===Examples===
Note how the links in the second two examples are centered relative to the whole template, unlike in the first example.
+
Note how the links in the second two examples are centered relative to the whole template, unlike those in the first example.
  
 
; Example 1
 
; Example 1
 
One-line [[Template:Navbox|navbox]] using its image parameter:
 
One-line [[Template:Navbox|navbox]] using its image parameter:
 
{{Navbox
 
{{Navbox
| name = Float/doc
+
| name = Float/doc
 
| state = uncollapsed
 
| state = uncollapsed
 
| title = [[Imperial Japanese Navy]]
 
| title = [[Imperial Japanese Navy]]
Line 28: Line 29:
 
* [[List of weapons of the Japanese Navy|Weapons]]
 
* [[List of weapons of the Japanese Navy|Weapons]]
 
}}
 
}}
{{hidden begin|title=Code for Example 1|toggle = left}}
+
{{Hidden begin |showhide=left |title=Code for Example 1}}
 
<pre>
 
<pre>
 
{{Navbox
 
{{Navbox
| name = Float/doc
+
| name = Float/doc
 
| state = uncollapsed
 
| state = uncollapsed
 
| title = [[Imperial Japanese Navy]]
 
| title = [[Imperial Japanese Navy]]
Line 44: Line 45:
 
}}
 
}}
 
</pre>
 
</pre>
{{hidden end}}
+
{{Hidden end}}
  
 
; Example 2
 
; Example 2
Same navbox using <code><nowiki>{{float}}</nowiki></code> instead of the image parameter:
+
Same navbox using {{tlf|float}} instead of the image parameter:
 
{{Navbox
 
{{Navbox
| name = Float/doc
+
| name = Float/doc
 
| state = uncollapsed
 
| state = uncollapsed
 
| title = [[Imperial Japanese Navy]]
 
| title = [[Imperial Japanese Navy]]
Line 60: Line 61:
 
* [[List of weapons of the Japanese Navy|Weapons]]
 
* [[List of weapons of the Japanese Navy|Weapons]]
 
}}
 
}}
{{hidden begin|title=Code for Example 2|toggle = left}}
+
{{Hidden begin |showhide=left |title=Code for Example 2}}
 
<pre>
 
<pre>
 
{{Navbox
 
{{Navbox
| name = Float/doc
+
| name = Float/doc
 
| state = uncollapsed
 
| state = uncollapsed
 
| title = [[Imperial Japanese Navy]]
 
| title = [[Imperial Japanese Navy]]
Line 75: Line 76:
 
}}
 
}}
 
</pre>
 
</pre>
{{hidden end}}
+
{{Hidden end}}
  
 
== Alternatives for navigational boxes ==
 
== Alternatives for navigational boxes ==
Line 93: Line 94:
 
* [[List of weapons of the Japanese Navy|Weapons]]
 
* [[List of weapons of the Japanese Navy|Weapons]]
 
}}
 
}}
{{hidden begin|title=Code for Example|toggle = left}}
+
{{Hidden begin |showhide=left |title=Code}}
 
<pre>
 
<pre>
 
{{Navbox
 
{{Navbox
Line 110: Line 111:
 
}}
 
}}
 
</pre>
 
</pre>
{{hidden end}}
+
{{Hidden end}}
  
 
<includeonly>
 
<includeonly>
 
[[Category:Wikipedia formatting and function templates]]
 
[[Category:Wikipedia formatting and function templates]]
 
</includeonly>
 
</includeonly>

Revision as of 18:05, 10 July 2014

Use {{float}} to "float" itemsTemplate:Spaced ndashi.e. position themTemplate:Spaced ndashso they do not affect the alignment or formatting of other items (such as text) nearby.

|Template:Smallcaps is the only required parameter. The optional parameters top, right, bottom and left indicate how far from their respective positions the item is to be positioned. The width of the item may also be specified. Any established HTML/CSS units may be used so long as they are specified (for example, {{float |top=2.0em |left=2px |width=10em |Blah}}).

Examples

Note how the links in the second two examples are centered relative to the whole template, unlike those in the first example.

Example 1

One-line navbox using its image parameter:

Code for Example 1
{{Navbox
| name = Float/doc
| state = uncollapsed
| title = [[Imperial Japanese Navy]]
| listclass = hlist
| image = [[File:Naval Ensign of Japan.svg|24px|border|Naval Ensign of Japan]]
| list1 =
* [[Imperial Japanese Navy admirals|Admirals]]
* [[Battles of the Imperial Japanese Navy|Battles]]
* [[List of ships of the Japanese Navy|Ships]]
* [[List of aircraft of the Japanese Navy|Aircraft]]
* [[List of weapons of the Japanese Navy|Weapons]]
}}
Example 2

Same navbox using {{float}} instead of the image parameter:

Code for Example 2
{{Navbox
| name = Float/doc
| state = uncollapsed
| title = [[Imperial Japanese Navy]]
| listclass = hlist
| list1 = {{float|top=-0.1em|[[File:Naval Ensign of Japan.svg|24px|border|Naval Ensign of Japan]]}}
* [[Imperial Japanese Navy admirals|Admirals]]
* [[Battles of the Imperial Japanese Navy|Battles]]
* [[List of ships of the Japanese Navy|Ships]]
* [[List of aircraft of the Japanese Navy|Aircraft]]
* [[List of weapons of the Japanese Navy|Weapons]]
}}

Alternatives for navigational boxes

Same navbox using its image parameter and liststyle with padding-left set to the image width:

Code
{{Navbox
| name      = Float/doc
| state     = uncollapsed
| title     = [[Imperial Japanese Navy]]
| listclass = hlist
| image     = [[File:Naval Ensign of Japan.svg|24px|border|Naval Ensign of Japan]]
| liststyle = padding-left: 24px
| list1     =
* [[Imperial Japanese Navy admirals|Admirals]]
* [[Battles of the Imperial Japanese Navy|Battles]]
* [[List of ships of the Japanese Navy|Ships]]
* [[List of aircraft of the Japanese Navy|Aircraft]]
* [[List of weapons of the Japanese Navy|Weapons]]
}}