Template:Section cleanup/doc: Difference between revisions

From Tardis Wiki, the free Doctor Who reference
No edit summary
No edit summary
Line 5: Line 5:
If you type <nowiki>{{section cleanup}}</nowiki> then you'll get:
If you type <nowiki>{{section cleanup}}</nowiki> then you'll get:
{{section cleanup}}
{{section cleanup}}


If, however, you want to define what's wrong with the section, you can use this format:<nowiki>{{section cleanup|reason}}</nowiki>
If, however, you want to define what's wrong with the section, you can use this format:<nowiki>{{section cleanup|reason}}</nowiki>
{{section cleanup|This section just has '''ugly''' grammar throughout.}}
{{section cleanup|This section just has '''ugly''' grammar throughout.}}
==Caveats==
==Caveats==
This template should always be placed ''directly'' underneath a section header.  It will look ''ugly'' if placed within the body of a section, because it only has margins specified for the right and bottom of the box.
This template should always be placed ''directly'' underneath a section header.  It will look ''ugly'' if placed within the body of a section, because it only has margins specified for the right and bottom of the box.  Note that this box intentionally does ''not'' [[wikipedia:template:clear|clear]] in any direction.  That's why you're seeing what appears to be odd positioning, above.  We ''want'' this template to have text flowing around it.  You will ''never'' have two of these boxes in close proximity to each other in real use, so the effect you see, above — where headers are to the ''right'' of this template — will never occur on regular pages.  Instead what you should actually get is something that looks like the following section.
==What it looks like when properly placed==
{{section cleanup}}Balk dflkj sdklj ldsk ei w eoio  woooo owei owio pj  s dslkj dlj fdjl sd;lfj d fd f. Balk dflkj sdklj ldsk ei w eoio  woooo owei owio pj  s dslkj dlj fdjl sd;lfj d fd f.Balk dflkj sdklj ldsk ei w eoio  woooo owei owio pj  s dslkj dlj fdjl sd;lfj d fd f.Balk dflkj sdklj ldsk ei w eoio  woooo owei owio pj  s dslkj dlj fdjl sd;lfj d fd f.Balk dflkj sdklj ldsk ei w eoio  woooo owei owio pj  s dslkj dlj fdjl sd;lfj d fd f. Balk dflkj sdklj ldsk ei w eoio  woooo owei owio pj  s dslkj dlj fdjl sd;lfj d fd f. Balk dflkj sdklj ldsk ei w eoio  woooo owei owio pj  s dslkj dlj fdjl sd;lfj d fd f.

Revision as of 14:08, 9 April 2011

{{Section cleanup/doc}} produces a small, in-line flag which marks a section as something that needs cleanup, allowing greater specificity than {{cleanup}}.

Usage

The template can be used with either an automatically-generated message, or one that you add yourself.

If you type {{section cleanup}} then you'll get:

This section needs a cleanup.

It contains several grammatical or factual errors, or otherwise offends our our Manual of Style.


If, however, you want to define what's wrong with the section, you can use this format:{{section cleanup|reason}}

This section needs a cleanup.

This section just has ugly grammar throughout.

Caveats

This template should always be placed directly underneath a section header. It will look ugly if placed within the body of a section, because it only has margins specified for the right and bottom of the box. Note that this box intentionally does not clear in any direction. That's why you're seeing what appears to be odd positioning, above. We want this template to have text flowing around it. You will never have two of these boxes in close proximity to each other in real use, so the effect you see, above — where headers are to the right of this template — will never occur on regular pages. Instead what you should actually get is something that looks like the following section.

What it looks like when properly placed

This section needs a cleanup.

It contains several grammatical or factual errors, or otherwise offends our our Manual of Style.

Balk dflkj sdklj ldsk ei w eoio woooo owei owio pj s dslkj dlj fdjl sd;lfj d fd f. Balk dflkj sdklj ldsk ei w eoio woooo owei owio pj s dslkj dlj fdjl sd;lfj d fd f.Balk dflkj sdklj ldsk ei w eoio woooo owei owio pj s dslkj dlj fdjl sd;lfj d fd f.Balk dflkj sdklj ldsk ei w eoio woooo owei owio pj s dslkj dlj fdjl sd;lfj d fd f.Balk dflkj sdklj ldsk ei w eoio woooo owei owio pj s dslkj dlj fdjl sd;lfj d fd f. Balk dflkj sdklj ldsk ei w eoio woooo owei owio pj s dslkj dlj fdjl sd;lfj d fd f. Balk dflkj sdklj ldsk ei w eoio woooo owei owio pj s dslkj dlj fdjl sd;lfj d fd f.