Difference between revisions of "Template:Border/doc"

From blackwiki
Jump to navigation Jump to search
imported>DixonDBot
m (Migrating 20 interwiki links, now provided by Wikidata on d:Q5832664)
imported>Vanisaac
m (→‎See also: clean up per WP:CAT#T and WP:AWBREQ add template:Sandbox other)
 
(12 intermediate revisions by 5 users not shown)
Line 1: Line 1:
 
{{Documentation subpage}}
 
{{Documentation subpage}}
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
 
<!-- EDIT TEMPLATE DOCUMENTATION BELOW THIS LINE -->
To place a border around e.g. an image.
+
This template is used to place a border around text. Note, to add a border to an image use the <code><nowiki>|border</nowiki></code> parameter in <code><nowiki>[[File:...]]</nowiki></code> (see [[Wikipedia:Picture tutorial#Border|Wikipedia:Picture tutorial]]).
 
__NOTOC__
 
__NOTOC__
 +
 
== Syntax ==
 
== Syntax ==
  
 
===Basic===
 
===Basic===
: <code><nowiki>{{border|</nowiki>''element''}}<code>
+
Basic usage is <code><nowiki>{{border|</nowiki>''element''}}</code>, where ''element'' is the image, text, etc around which the border is to appear. The border will be a solid light grey color (#ddd) and 1px (1 pixel) wide (default settings; see below). <!--If applying the template appears to shift the ''element'''s position, try adding the <code>display=noinline</code> parameter described below.-->
: ...where ''element'' is the image, text, etc around which the border is to appear. The border will be a solid light grey color (#ddd) and 1px (1 pixel) wide (default settings; see below). <!--If applying the template appears to shift the ''element'''s position, try adding the <code>display=noinline</code> parameter described below.-->
+
: <code><nowiki>{{border|Abc}}</nowiki></code> &rarr; {{border|Abc}}
 +
 
 +
All options show:
 +
: <code><nowiki>{{border |</nowiki>''element'' |display=''display'' |width=''width'' |style=''style'' |style2=''2nd style'' |color=''color'' |lh=''line height''}}</code>
  
===Full===
+
: <code><nowiki>{{border |Abc|width=2px|style=dotted |color=red}}</nowiki></code> &rarr; {{border |Abc|width=2px|style=dotted |color=red}}
: <code><nowiki>{{border |</nowiki>''element'' <!--|display=''display''--> |width=''width'' |style=''style'' |color=''color}}</code>
 
  
 
====Parameters====
 
====Parameters====
; ''element'' : (required) The element (image, text, etc) around which the border is to appear.
+
; ''element'': (required) The element (image, text, etc) around which the border is to appear.
<!--
+
 
; ''display'' {{nobold|1==noinline}} : The ''element'''s position sometimes seems to be shifted due to the default inline formatting style used by this template. When this occurs, adding the parameter <code>display=noinline</code> may restore the positioning.
+
; ''display'' The ''element'''s display method: ''inline-block'' (default if the parameter is not used), ''block'', ''inline'', ''table'', ''flex'', etc.
-->
+
 
; ''width''   : The width (thickness) of the border (default 1px).
+
; ''width'': The width (thickness) of the border (default is <code>1px</code>).
 +
 
 +
; ''style'' The border's style: ''solid'' (default if the parameter is not used), ''dotted'', ''dashed'', ''double'', ''groove'', ''ridge'', ''inset'' or ''outset''.
 +
 
 +
; ''style2'': Additional CSS properties can be used in this template.
 +
 
 +
; ''color'': The border's color (default #ddd, otherwise recommend a [[Web colors#X11 color names|named color]]).
  
; ''style''   : The border's style: ''solid'' (default if the parameter is not used), ''dotted'', ''dashed'', ''double'', ''groove'', ''ridge'', ''inset'' or ''outset''.
+
=====Inline of element=====
 +
; ''noinline'': Set {{para|noinline|&lt;anytext>}} to replace the default <code>inline-block</code> display style.
 +
:Some text {{border |Abc|width=2px|style=dotted|noinline=indeed}}
 +
:Inline reading {{border |Abc|width=2px|style=dotted}}
  
; ''color''  : The border's color (default #ddd, otherwise recommend a [[Web colors#X11 color names|named color]]).
+
== See also ==
 +
* {{tl|color box}}
 +
* {{tl|legend inline}}
  
; ''noinline'' : Set this to any value to remove the inline style.
+
<includeonly>{{Sandbox other||
<includeonly>
 
 
<!--Categories-->
 
<!--Categories-->
[[Category:Wikipedia formatting and function templates]]
+
[[Category:Text color templates]]
 
+
}}</includeonly>
<!--Other languages-->
 
</includeonly>
 

Latest revision as of 00:13, 24 April 2020

This template is used to place a border around text. Note, to add a border to an image use the |border parameter in [[File:...]] (see Wikipedia:Picture tutorial).


Syntax

Basic

Basic usage is {{border|element}}, where element is the image, text, etc around which the border is to appear. The border will be a solid light grey color (#ddd) and 1px (1 pixel) wide (default settings; see below).

{{border|Abc}}Abc

All options show:

{{border |element |display=display |width=width |style=style |style2=2nd style |color=color |lh=line height}}
{{border |Abc|width=2px|style=dotted |color=red}}Abc

Parameters

element
(required) The element (image, text, etc) around which the border is to appear.
display The element's display method
inline-block (default if the parameter is not used), block, inline, table, flex, etc.
width
The width (thickness) of the border (default is 1px).
style The border's style
solid (default if the parameter is not used), dotted, dashed, double, groove, ridge, inset or outset.
style2
Additional CSS properties can be used in this template.
color
The border's color (default #ddd, otherwise recommend a named color).
Inline of element
noinline
Set |noinline=<anytext> to replace the default inline-block display style.
Some text Abc
Inline reading Abc

See also