Difference between revisions of "Template:Float/doc"

From blackwiki
Jump to navigation Jump to search
imported>LlywelynII
imported>Milker
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
<!---PLEASE ADD CATEGORIES WHERE INDIACTED AT THE BOTTOM OF THIS PAGE--->
+
<!-- PLEASE ADD CATEGORIES AT THE BOTTOM OF THIS PAGE, and INTERWIKIS IN WIKIDATA -->
 
{{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}}.}}
  
 +
== Description ==
 
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.
 
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.
  
 +
== Usage ==
 
* <code><nowiki>{{float|</nowiki>{{bigger|{{smallcaps|item}}}}}}</code> floats {{smallcaps|item}} on the righthand edge of a page/area.
 
* <code><nowiki>{{float|</nowiki>{{bigger|{{smallcaps|item}}}}}}</code> floats {{smallcaps|item}} on the righthand edge of a page/area.
 
* <code><nowiki>{{float|left|</nowiki>{{bigger|{{smallcaps|item}}}}}}</code> floats {{smallcaps|item}} on the lefthand edge of a page/area.
 
* <code><nowiki>{{float|left|</nowiki>{{bigger|{{smallcaps|item}}}}}}</code> floats {{smallcaps|item}} on the lefthand edge of a page/area.
Line 11: Line 13:
 
{{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.-->
 
{{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 those 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
Line 47: Line 49:
 
{{Hidden end}}
 
{{Hidden end}}
  
; Example 2
+
=== Example 2 ===
 
Same navbox using {{tlf|float}} instead of the image parameter:
 
Same navbox using {{tlf|float}} instead of the image parameter:
 
{{Navbox
 
{{Navbox
Line 78: Line 80:
 
{{Hidden end}}
 
{{Hidden end}}
  
== Alternatives for navigational boxes ==
+
=== Alternatives for navigational boxes ===
 
Same navbox using its image parameter and liststyle with padding-left set to the image width:
 
Same navbox using its image parameter and liststyle with padding-left set to the image width:
 
{{Navbox
 
{{Navbox
Line 94: Line 96:
 
* [[List of weapons of the Japanese Navy|Weapons]]
 
* [[List of weapons of the Japanese Navy|Weapons]]
 
}}
 
}}
{{Hidden begin |showhide=left |title=Code}}
+
{{Hidden begin |showhide=left |title=Code for this alternative navigational box}}
 
<pre>
 
<pre>
 
{{Navbox
 
{{Navbox
Line 119: Line 121:
  
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
 
<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox |
| <!-- CATEGORIES BELOW THIS LINE, PLEASE: -->
+
| <!-- ADD CATEGORIES HERE, and INTERWIKIS IN WIKIDATA -->
 
[[Category:Positioning templates]]
 
[[Category:Positioning templates]]
 
}}</includeonly>
 
}}</includeonly>

Revision as of 15:24, 6 January 2020

Description

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.

Usage

|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 for this alternative navigational box
{{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]]
}}

See also