Template:TutorialBrowser: Difference between revisions

From KDE Community Wiki
m (Further naming.)
(+Recommended usage info)
Line 20: Line 20:
[[Category:Tutorial]]<noinclude>
[[Category:Tutorial]]<noinclude>


==Recommended Usage==
To keep some sort of consistency to our wiki: if you're going to use this template, put it at the very top of the page, above any ==headers== (that will also place it above the page contents section) so readers can find the relevant info as quickly as possible.
Also note that this template will automatically add the page to the [[:Category:Tutorial|tutorial category]] so there's no need to do that yourself.


==Parameters==
==Parameters==
Line 33: Line 37:
| '''pre''' || Any prerequisites for this tutorial (try to order them sensibly and make sure they're links!).
| '''pre''' || Any prerequisites for this tutorial (try to order them sensibly and make sure they're links!).
|-
|-
| '''next''' || A tutorial or two which logically follow on from this (in the same series). Or a tutorial or two which make sense logically to move onto next.
| '''next''' || A tutorial or two which logically follow on from this (in the same series). Or a tutorial or two which make sense to move onto next.
|-
|-
| '''reading''' || Further reading about the subject matter covered in the tutorial
| '''reading''' || Further reading about the subject matter covered in the tutorial

Revision as of 00:04, 6 January 2007

Tutorial Series: {{{series}}}
{{{name}}}
Prerequisites {{{pre}}}
What's Next {{{next}}}
Further Reading {{{reading}}}

Recommended Usage

To keep some sort of consistency to our wiki: if you're going to use this template, put it at the very top of the page, above any ==headers== (that will also place it above the page contents section) so readers can find the relevant info as quickly as possible.

Also note that this template will automatically add the page to the tutorial category so there's no need to do that yourself.

Parameters

Parameter Function
series The name of the tutorial series this belongs to.
name Verbose(ish) name of this tutorial. Kind of a super short abstract.
pre Any prerequisites for this tutorial (try to order them sensibly and make sure they're links!).
next A tutorial or two which logically follow on from this (in the same series). Or a tutorial or two which make sense to move onto next.
reading Further reading about the subject matter covered in the tutorial