Template:Box/Documentation: Difference between revisions

Latest revision as of 11:29, 10 January 2023

Template:Box is used to create formatted text boxes.

Usage

It accepts one mandatory string parameter and one optional string parameter.

1 is the name of the article and the header for the text box.
2, if supplied, is the contents of the text box. If not supplied, the contents is transcluded from a subpage of the article, using the header as the subpage name. It also uses Template:Edit to adds a link to directly edit the subpage.

It also accepts two optional named parameters:

width accepts Xpx or X%, and controls the width of the box. If undefined, the box has 10% margins left and right.
float accepts left, right, or clear.
- If left or right, the box is floated to the selected side of the screen and the margins and padding are setup coorespondingly.
- If clear, the box is arranged clear of all content, above and below.
color (default: blue) controls the color of the background. The valid options are:

red

green

blue

yellow

purple

cyan

gray

white

Return

{{{Box|color=green|Lorem Ipsum|{{Lorem Ipsum|2}}}} returns:

Lorem Ipsum

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis quis metus nunc. Fusce est libero, interdum vel iaculis et, blandit quis odio. Integer ac magna nunc. In quis libero purus. Praesent mattis eget justo in efficitur. Aenean tempor congue dictum. Mauris hendrerit nunc a auctor dictum.

{{Box|Sample}} returns:

Sample

This page intentionally left blank... or something.

No examples are included for float, as they don't appear correctly inside Template:Return.

@@ Line 1: / Line 1: @@
-<includeonly>[[Category:Template]][[Category:Box Template]]</includeonly>
+<includeonly>[[Category:Box Template]]</includeonly>
-{{Box|color=red|Lorem Ipsum|{{Lorem Ipsum}}}}
+{{Template|Box}} is used to create formatted text boxes.
+==Usage==
+It accepts one {{Parameter|mandatory|string}} and one {{Parameter|optional|string}}.
+* {{Code|1}} is the name of the article and the header for the text box.
+* {{Code|2}}, if supplied, is the contents of the text box. If not supplied, the contents is transcluded from a subpage of the article, using the header as the subpage name. It also uses {{Template|Edit}} to adds a link to directly edit the subpage.
+It also accepts two {{Parameter|optional|named}}s:
+* {{Code|width}} accepts {{Code|Xpx}} or {{Code|X%}}, and controls the width of the box. If undefined, the box has {{Code|10%}} margins left and right.
+* {{Code|float}} accepts {{Code|left}}, {{Code|right}}, or {{code|clear}}.
+** If {{Code|left}} or {{Code|right}}, the box is floated to the selected side of the screen and the margins and padding are setup coorespondingly.
+** If {{code|clear}}, the box is arranged clear of all content, above and below.
+* {{Code|color}} (default: {{Code|blue}}) controls the color of the background. The valid options are: {{Box/Color}}
-{{Box|color=green|Lorem Ipsum|{{Lorem Ipsum}}}}
+==Return==
+{{Code|<nowiki>{{{Box|color=green|Lorem Ipsum|{{Lorem Ipsum|2}}}}</nowiki>}} returns: {{Return| {{Box|color=green|Lorem Ipsum|{{Lorem Ipsum|2}}}}}}
-{{Box|color=blue|Lorem Ipsum|{{Lorem Ipsum}}}}
+{{Code|<nowiki>{{Box|Sample}}</nowiki>}} returns: {{Return|{{Box|Sample}}}}
+No examples are included for {{code|float}}, as they don't appear correctly inside {{Template|Return}}.