PageLayout: Difference between revisions

From KDE UserBase Wiki
(remove definition list around the tables)
(rename section Weblink to More Information)
(16 intermediate revisions by 6 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.


:{|align="center" border="1" cellpadding="2"
==Sections== <!--T:3-->
|<nowiki>The i18n language bar previously used does not work with TranslateWiki.
Please do not use it. A new language bar will be created by the first translation being prepared.</nowiki>
|}


{|style="width:80%; align="center" cellpadding="5"
<!--T:4-->
|A two-cell table containing a header, laid out as
{|
! Section
! Description
! Relevance
|-<!--}-->
 
<!--T:5-->
! Language selector
| The i18n language bar previously used does not work with TranslateWiki. Please do not use it. A new language bar will be created by the first translation being prepared.
| deprecated
|-
|-
<!--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
|-
|-
{| border="2" align="center" cellpadding="5"
|An image chosen as representing the application||A brief description of the application's role
|}
|}


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


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


:* Screenshots to illustrate the above, whenever feasible. These will usually be thumbnails, clickable for enlargement.
<!--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
|-


:::{|style="width:500px; border:2px dotted #BCBCBC; background:#EEEEEE;"
<!--T:10-->
|Optional sections - sometimes easier added later
! Hints and Tips
| Short tips to increase productivity
| optional
|-
|-
<!--T:11-->
! Troubleshooting
| List them here or in a subpage
| optional
|-
|-
|* A Hints and Tips section - short tips to increase productivity
 
<!--T:12-->
! More Information
| Links to
* an external project site
* 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 use this after any heading, as it puts headings in a separate translation unit which is preferred by translators using external tools.
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.
|}


{|cellpadding="4"
<!--T:15-->
|[[Image:Im-status-message-edit.png]]||'''Note'''||If you are making frequent edits to your page, please use either <nowiki>{{Construction}}</nowiki> or <nowiki>{{Being_Edited}}</nowiki> so that translators know to wait until you are finished.
|}
 
{|
|[[Image:dialog-warning.png|32px]]||'''Warning'''||Avoid using text smilies as they cause problems for translation applications.  Instead use <nowiki>:: [[Image:Face-smile.png]]</nowiki> [[Image:Face-smile.png]]
|}
[[Category:Contributing]]
[[Category:Contributing]]
</translate>

Revision as of 20:04, 8 January 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
Language selector The i18n language bar previously used does not work with TranslateWiki. Please do not use it. A new language bar will be created by the first translation being prepared. deprecated
Image header A two-cell table containing a header, laid out with 
{|class="tablecenter vertical-centered" 
|[[Image:Image.png|300px]] 
|Short description
|}
 important
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=409158"