There may be other unforeseen breakage primarily in the handbook portion of the wiki.
The Table Of Contents section of each "PC-BSD® Users Handbook" page may be the best workaround.
Difference between revisions of "Good stub"
|Line 21:||Line 21:|
It to the [] of , and the . </nowiki>
<nowiki>*[www..com\.htm Detailed description and ]</nowiki>
Revision as of 21:03, 7 June 2011
Template:Guideline This is a description of a PC-BSD wiki standard.
A good initial page stub is very easy to write. It consists of:
- A first paragraph saying what the head term means. The head term should be in bold type. One sentence is quite adequate.
- A second paragraph saying why the subject is important enough to document on a PC-BSD wiki page. Again one sentence is adequate.
- Optionally, a third paragraph giving relevant applicable external links as a bulleted list. This should have a heading of External link(s).
- A standard stub warning.
That's all! If you can write such a stub, this is an alternative to removing a sub-standard page, and can be very useful in the process of creating or revising the PC-BSD Handbook. Also, it is a way to handle suspected copyright violations. In particular, if the text exists on the web already, make that an external link which also helps to feed back into the community by increasing interconnectedness.
If you can write a better stub, or even a handbook page, that's all the better. Always remember that stubs are only useful if someone makes them into an article. See also PC-BSD wiki:Perfect page stub.
Suppose that a detailed page from a (mythological and fabricated for this example) site www.alter-microsquish-vacs.com.py has been posted with no explanation, and is a probable copyright violation. It describes the (also fantastical for this example) device Max'O'slydePad 9000, which is the page name. The following stub, which would take only a quick moment to compose, would be appropriate:
'''Max'O'slydePad 9000''' is a device made to compete with the [[banana tote caress]] by Electric Plantain.
It is the most recent product by to the [[microsquish|alter microsquish vacs corporation]] of Pearl Island, and incorporates the latest Supra-Glide technology.
*[www.alter-microsquish-vacs.com\mosp9k.htm Detailed description and retail outlet]