Template:Needs Improvement/Documentation: Difference between revisions

Help

Revision as of 20:15, 19 November 2023

Template:Needs Improvement adds boilerplate Template:Redbox to the top of a page, indicating that it is incomplete and does not represent it's final form.

Usage

It accepts two optional parameters

1 (default: This page is incomplete) controls the text displayed.
date if set to false hides the last-edited date. If excluded, the template from leverage the article's assorted {{REVISION*}} magic words to generate a date.

Return

{{Needs Improvement}} returns:

Needs Improvement

This page is incomplete.

This article was last edited Sunday, November 19, 2023 by Mr. Johnson.

{{Needs Improvement|date=false}} returns:

Needs Improvement

This page is incomplete.

This article was last edited Sunday, November 19, 2023 by Mr. Johnson.

{{Needs Improvement|Wibbley-Wobbley.}} returns:

Needs Improvement

Wibbley-Wobbley.

This article was last edited Sunday, November 19, 2023 by Mr. Johnson.

@@ Line 1: / Line 1: @@
 <noinclude>[[Category:Categorization Template]]</noinclude>
-{{Template|Needs Improvement}} adds boilerplate text to the top of a page, indicating that it is incomplete and does not represent it's final form.
+{{Template|Needs Improvement}} adds boilerplate {{Template|Redbox}} to the top of a page, indicating that it is incomplete and does not represent it's final form.
 ==Usage==
-It accepts one {{Parameter|optional|string}}, text to replace the default "This page is incomplete."
+It accepts two {{Parameter|optional}}s
+* {{Code|1}} (default: {{Code|This page is incomplete}}) controls the text displayed.
-It leverages the article's assorted {{Code|<nowiki>{{REVISION*}}</nowiki>}} magic words to populate a pre-configured {{Template|Redbox}}.
+* {{Code|date}} if set to {{Code|false}} hides the last-edited date. If excluded, the template from leverage the article's assorted {{Code|<nowiki>{{REVISION*}}</nowiki>}} magic words to generate a date.
 ==Return==
 {{Code|<nowiki>{{Needs Improvement}}</nowiki>}} returns: {{Return|{{Needs Improvement}}}}
-{{Code|<nowiki>{{Needs Improvement|Wibbley-Wobble.y}}</nowiki>}} returns: {{Return|{{Needs Improvement|Wibbley-Wobbley.}}}}
+{{Code|<nowiki>{{Needs Improvement|date=false}}</nowiki>}} returns: {{Return|{{Needs Improvement}}}}
+{{Code|<nowiki>{{Needs Improvement|Wibbley-Wobbley.}}</nowiki>}} returns: {{Return|{{Needs Improvement|Wibbley-Wobbley.}}}}