PageLayout: Difference between revisions

From KDE UserBase Wiki
(Added note re paragraphs causing Translation problems)
(remove info on obsolete language selector)
 
(27 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{Template:I18n/Language Navigation Bar|PageLayout}}
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.


'''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.'''
<languages />
<translate>


'''You should use the '''[[Toolbox]]''' page in conjunction with this.'''
==Available Tools== <!--T:1-->


<!--T:2-->
* [[Special:myLanguage/Toolbox|Tool Box]] shows you wiki markup for the effect you need
* [[Special:myLanguage/Typographical Guidelines|Typographical Guidelines]] standardises markup for use in translation, either to official manuals (DocBook) or to other languages.


----
==Sections== <!--T:3-->


:{|align="center" border="1" cellpadding="2"
<!--T:4-->
|<nowiki>An i18n language bar, using the supplied template</nowiki>
{|
|}
! Section
! Description
! Relevance
|-<!--}-->


<!--T:6-->
! Image header
| A two-cell table containing a header, laid out with {{Input|1=<nowiki>{|class="tablecenter vertical-centered"
|[[Image:Image.png|300px]]
|Short description
|}</nowiki>}}
| important
|-


{|style="width:80%; align="center" cellpadding="5"
<!--T:16-->
|A two-cell table containing a header, laid out as
! 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
|-
|-
<!--T:7-->
! Features
| A brief feature list, under a heading, and consisting of bullet points.  These are indented by default - no need to specify indentation.
| important
|-
|-
{| border="2" align="center" cellpadding="5"
|An image chosen as representing the application||A brief description of the application's role
|}
|}


<!--T:8-->
! Details
| One or more heading giving more in-depth information about using the application
| optional
|-


:* A brief feature list, under a heading, and consisting of bullet points
<!--T:9-->
! 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
|-


:* One or more heading giving more in-depth information about using the application
<!--T:10-->
! Hints and Tips
| Short tips to increase productivity
| optional
|-


:* Screenshots to illustrate the above, whenever feasible.  These will usually be thumbnails, clickable for enlargement.
<!--T:11-->
! Troubleshooting
| List them here or in a subpage
| optional
|-


:::{|style="width:500px; border:2px dotted #BCBCBC; background:#EEEEEE;"
<!--T:12-->
|Optional sections - sometimes easier added later
! More Information
|-
| Links to
|-
* an external project site
|* A Hints and Tips section - short tips to increase productivity
* the application manual on docs.kde.org
|-
* other useful internal or external pages
| important<br />if existing
|-
|-
|* ''Either'' A short Troubleshooting section ''or'' a link to another page for Troubleshooting
|}
:* A sentence including a link to any external Project Page
:* Links to any other useful internal or externals pages.


Finally, as the last item on the page, include a Category statement.  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 <nowiki>[[Category:Office]]</nowiki>
<!--T:13-->
! 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 <nowiki>[[Category:Office]]</nowiki>.
| important
|<!--{-->}


::{|cellpadding="4"
<!--T:14-->
|[[Image:Im-status-message-edit.png]]||'''Note'''||A double-Enter is required to make a new paragraph.  Please do not use this after any heading, as those empty lines denote a new translation unit. Having the heading as one unit creates a lot of work for translators.
Please make regular checks of the pages relevant to your work (linked from [[Special:myLanguage/Tasks and Tools|Tasks and Tools]]) and also [[Special:myLanguage/Typographical Guidelines|Typographical Guidelines]] as these are updated whenever new issues are noted.
|}


[[Category:Getting Started]]
<!--T:15-->
[[Category:Contributing]]
</translate>

Latest revision as of 15:14, 7 July 2019

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.

Other languages:

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.

Retrieved from "https://userbase.kde.org/index.php?title=PageLayout&oldid=432830"