Difference between revisions of Template:Divbox/doc

(3 intermediate revisions by the same user not shown)

Line 110:

== Using subst: with this template ==

~~{{Update|inaccurate=yes|date=May 2020|reason='''substing the current version leaves behind if statements, category checks, and other undesirable code'''}}~~

The <code>subst:</code> atom may be used with {{tl|divbox}}. ''This may be highly desirable.'' Note that <code>subst:</code> does not take effect in preview, but only after saving a page. The template's inclusion is replaced by the code of the template itself, which will continue to write the box as before, but without an additional server call.

Line 117:

Line 116:

Just paste in your content and, when you're finished, be sure to close the template call with <code><nowiki>}}</nowiki></code>.

Since the contents are given in the form of two parameter values, for the content you may place within {{tl|divbox}}, the ~~[[m:Help:Template#Restrictions_on_parameter_values|~~restrictions on parameter values]] apply. For example, if you put content that includes template calls, {{tl|divbox}} cannot tell where its last parameter ends.

Since the contents are given in the form of two parameter values, for the content you may place within {{tl|divbox}}, the restrictions on parameter values apply. For example, if you put content that includes template calls, {{tl|divbox}} cannot tell where its last parameter ends.

If the contents do not satisfy the restrictions, insert this code in your page first:

Line 125:

Line 124:

That is, choose your style and title as usual (or omit the title with two pipes), but instead of actual content, write "DUMMYCONTENT". Then, save the page and reopen it for editing. You'll see the box code in all its gory detail, and the placeholder DUMMYCONTENT, followed by the HTML division closing tag. Now, you may simply '''replace''' DUMMYCONTENT with '''your content''', save, and move on. Since almost anything may be placed within division tags, this should not break no matter what you do.

~~== Making new divbox styles ==~~

I'd rather hope you were able to find joy within the existing set of styles, but if not, you can create new ones. Follow these instructions to be sure your new style will "play nice" with {{[[template:divbox|divbox]]}}. Note that this requires some understanding of [[Cascading Style Sheets|CSS]].

# Experiment in a drawing program, such as [[GraphicConverter]] or [[Adobe Photoshop]], and decide what colors you want for your new box style. You need to find out the HTML color codes for each color.

~~# Open an existing box style template, such as {{[[template:divbox/style/red|divbox/style/red]]}}. Copy out the code.~~

~~# Create a new box style template page. It '''must''' be located in main Template namespace and '''must''' be named <code>Template:divbox/style/XXXXX</code>, where "XXXXX" is your new style name.~~

~~# Paste in the "borrowed" code and replace the color codes with your new, chosen colors. Save the new template.~~

~~# Return to ''this'' Talk page and add your new style to ''this'' documentation. Remember, a job's not over until the paperwork is done!~~

Note that you ''may'' even change the division box margins and paddings. '''This is not recommended.''' There are a couple of good reasons for specifying these values, and in these units. Most users who "roll their own" make choices with unintended consequences; {divbox} is meant to help you avoid these pitfalls.

~~== See also ==~~

* {{tl|divhide}}

~~{{Mbox templates see also}}~~

<includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |

[[Category:Box templates]]

~~[[simple:Template:Box]]~~

~~[[ru:Шаблон:Divbox]]~~

}}</includeonly>

@@ Line 110: / Line 110: @@
 == Using subst: with this template ==
-{{Update|inaccurate=yes|date=May 2020|reason='''substing the current version leaves behind if statements, category checks, and other undesirable code'''}}
 The <code>subst:</code> atom may be used with {{tl|divbox}}. ''This may be highly desirable.'' Note that <code>subst:</code> does not take effect in preview, but only after saving a page. The template's inclusion is replaced by the code of the template itself, which will continue to write the box as before, but without an additional server call.
@@ Line 117: / Line 116: @@
 Just paste in your content and, when you're finished, be sure to close the template call with <code><nowiki>}}</nowiki></code>.
-Since the contents are given in the form of two parameter values, for the content you may place within {{tl|divbox}}, the [[m:Help:Template#Restrictions_on_parameter_values|restrictions on parameter values]] apply. For example, if you put content that includes template calls, {{tl|divbox}} cannot tell where its last parameter ends.
+Since the contents are given in the form of two parameter values, for the content you may place within {{tl|divbox}}, the restrictions on parameter values apply. For example, if you put content that includes template calls, {{tl|divbox}} cannot tell where its last parameter ends.
 If the contents do not satisfy the restrictions, insert this code in your page first:
@@ Line 125: / Line 124: @@
 That is, choose your style and title as usual (or omit the title with two pipes), but instead of actual content, write "DUMMYCONTENT". Then, save the page and reopen it for editing. You'll see the box code in all its gory detail, and the placeholder DUMMYCONTENT, followed by the HTML division closing tag. Now, you may simply '''replace''' DUMMYCONTENT with '''your content''', save, and move on. Since almost anything may be placed within division tags, this should not break no matter what you do.
-== Making new divbox styles ==
-I'd rather hope you were able to find joy within the existing set of styles, but if not, you can create new ones. Follow these instructions to be sure your new style will "play nice" with &#123;&#123;[[template:divbox|divbox]]&#125;&#125;. Note that this requires some understanding of [[Cascading Style Sheets|CSS]].
-# Experiment in a drawing program, such as [[GraphicConverter]] or [[Adobe Photoshop]], and decide what colors you want for your new box style. You need to find out the HTML color codes for each color.
-# Open an existing box style template, such as &#123;&#123;[[template:divbox/style/red|divbox/style/red]]&#125;&#125;. Copy out the code.
-# Create a new box style template page. It '''must''' be located in main Template namespace and '''must''' be named <code>Template:divbox/style/XXXXX</code>, where "XXXXX" is your new style name.
-# Paste in the "borrowed" code and replace the color codes with your new, chosen colors. Save the new template.
-# Return to ''this'' Talk page and add your new style to ''this'' documentation. Remember, a job's not over until the paperwork is done!
-Note that you ''may'' even change the division box margins and paddings. '''This is not recommended.''' There are a couple of good reasons for specifying these values, and in these units. Most users who "roll their own" make choices with unintended consequences; {divbox} is meant to help you avoid these pitfalls.
-== See also ==
-* {{tl|divhide}}
-{{Mbox templates see also}}
 <includeonly>{{#ifeq:{{SUBPAGENAME}}|sandbox | |
 [[Category:Box templates]]
-[[simple:Template:Box]]
-[[ru:Шаблон:Divbox]]
 }}</includeonly>