Editing Template:Block right/doc

{{documentation subpage}}
{{div-based-template}}
{{uses TemplateStyles|Template:Block right/styles.css}}

==Usage==
This template places a block of text in the right of the page, without affecting the text alignment within that block.

;Comparison of <nowiki>{{Block right}}</nowiki> and <nowiki>{{right}}</nowiki>
This template retains the current text alignment (usually left), but moves the entire block of text into the right. To change to right text alignment, use {{tl|right}} instead.

:;Block right
{{block right|Lorem ipsum dolor sit amet, consectetuer adipiscing elit.<br/>
Aenean commodo ligula eget dolor.

Aenean massa.}}

:;Right:
{{right|Lorem ipsum dolor sit amet, consectetuer adipiscing elit.<br/>
Aenean commodo ligula eget dolor. 

Aenean massa.}}


===Parameters===

All parameters are optional. 

* {{parameter|width}} set the width of the block
* {{parameter|offset}} set the distance ("indent") from the right margin
* {{parameter|gutter}}  set the gap between the normal content and the block
* {{parameter|align}} set the internal alignment of the block
* {{parameter|collapse}} remove gaps between paragraphs inside the block
* {{parameter|style}} add other kinds of style

==== Width ====
Where there is a requirement to fix the width of the block, an optional {{parameter|width}} parameter can be used. Avoid ''px'' units and prefer a text-relative unit such as ''em'' when the content is textual<ref>See [[H:PXWIDTH]] for further details.</ref>.

{{doc example|content=
<pre>{{block right|width=25em|Lorem ipsum dolor sit amet, consectetuer adipiscing elit.<br/>
Aenean commodo ligula eget dolor.

Aenean massa.}}</pre>


{{block right|width=25em|Lorem ipsum dolor sit amet, consectetuer adipiscing elit.<br/>
Aenean commodo ligula eget dolor.

Aenean massa.}}
}}

==== Offset ====

To offset the entire block back from the right margin, an optional {{parameter|offset}} parameter may be used:

{{doc example|content=
<pre>{{block right|offset=4em|Lorem ipsum dolor sit amet, consectetuer adipiscing elit.<br/>
Aenean commodo ligula eget dolor.

Aenean massa.}}</pre>

{{block right|offset=4em|Lorem ipsum dolor sit amet, consectetuer adipiscing elit.<br/>
Aenean commodo ligula eget dolor.

Aenean massa.}}
}}

==== Gutter ====

To specify the gap between normal content and the right-floated content, use the {{parameter|gutter}} parameter:

{{doc example|content=
<pre>
{{block right
 | width=50%
 | gutter=10em
 | align=center
 | [[File:Traffic-signs-manual-chapter-3-diagram 622-2 (2008).svg]]
}} {{lorem ipsum}}
</pre>
{{block right
 | width=50%
 | gutter=10em
 | align=center
 |[[File:Traffic-signs-manual-chapter-3-diagram 622-2 (2008).svg]]
}} {{lorem ipsum}}
{{-}}
}}

==== Align ====
To align the ''content'' of the right-aligned block within the block, an optional {{parameter|align}} parameter may be used:

{{doc example|content=
<pre>{{block right|align=center|Lorem ipsum dolor sit amet, consectetuer adipiscing elit.<br/>
Aenean commodo ligula eget dolor.

Aenean massa.}}</pre>


{{block right|align=center|Lorem ipsum dolor sit amet, consectetuer adipiscing elit.<br/>
Aenean commodo ligula eget dolor.

Aenean massa.}}
}}

==== Collapse ====

To remove vertical spacing between paragraphs inside the block (for example, when you want a centered line, and the right-aligned line<ref>Common in some signature blocks</ref>), the {{parameter|collapse}} parameter may be used:

{{doc example|content=
<pre>
{{lorem ipsum}}
{{block right|collapse=y|width=20em|
{{center|Centered text goes here}}
Left-aligned text goes here
{{right|Right-aligned text goes here}}
}}</pre>

{{lorem ipsum}}
{{block right|collapse=y|width=20em|
{{center|Centered text goes here}}
Left-aligned text goes here
{{right|Right-aligned text goes here}}
}}
}}
{{rule}}
{{reflist}}

<!-- template categories and interwiki links -->
<includeonly>
[[Category:Formatting templates]]

</includeonly>