PageLayout

From KDE UserBase Wiki
Revision as of 15:20, 7 July 2019 by FuzzyBot (talk | contribs) (Importing a new version from external source)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

This page lays out the sections that we would like to see in an ideal page. You should aim to get as many of the sections into your page as is practicable.

Available Tools

  • Tool Box shows you wiki markup for the effect you need
  • Typographical Guidelines standardises markup for use in translation, either to official manuals (DocBook) or to other languages.

Sections

Section Description Relevance
Image header A two-cell table containing a header, laid out with
{|class="tablecenter vertical-centered" 
|[[Image:Image.png|300px]] 
|Short description
|}
important
History A brief history of the application including for example the first release date and others major events. It's recommended to add references. optional
Features A brief feature list, under a heading, and consisting of bullet points. These are indented by default - no need to specify indentation. important
Details One or more heading giving more in-depth information about using the application optional
Screenshots Screenshots to illustrate the above, whenever feasible. These will usually be thumbnails, clickable for enlargement. The size will usually be in the range of 300px to 500px. important
Hints and Tips Short tips to increase productivity optional
Troubleshooting List them here or in a subpage optional
More Information Links to
  • an external project site
  • the application manual on docs.kde.org
  • other useful internal or external pages
important
if existing
Category The category will normally be the name of the applications list that points to your page, e.g. applications listed under Applications/Office would show the statement [[Category:Office]]. important

Please make regular checks of the pages relevant to your work (linked from Tasks and Tools) and also Typographical Guidelines as these are updated whenever new issues are noted.