Difference between revisions of "PageLayout"

Jump to: navigation, search
(Rwrite of this page)
Line 1: Line 1:
<languages />
+
This page lays out the sections that we would like to see in an ideal page.  
<translate>
+
You should aim to get as many of the sections into your page as is practicable.  
<!--T:1-->
+
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.
+
  
<!--T:2-->
+
==Available Tools==
'''You should use the [[Toolbox|Toolbox]] page in conjunction with this.'''
+
  
<!--T:3-->
+
* [[Toolbox|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.
  
<!--T:4-->
+
==Sections==
:{|class="vertical-centered"
+
|<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>
+
|}
+
  
<!--T:5-->
 
 
{|
 
{|
|A two-cell table containing a header, laid out as
+
! 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
 
|-
 
|-
{|class="wikitable"
+
! Image header
|An image chosen as representing the application||A brief description of the application's role
+
| A two-cell table containing a header, laid out with {{Input|1=<nowiki>{|class="tablecenter vertical-centered"  
|}
+
|[[Image:Image.png|300px]]  
|}
+
|Short description
 
+
|}</nowiki>}}
<!--T:6-->
+
| important
{|Image:Im-status-message-edit.png]]||'''Note'''||Please don't add formatting statements to tables - mostly they will not work.  Use ''Class=tablecenter''when the table is required to be horizontally centered.
+
|}
+
:* A brief feature list, under a heading, and consisting of bullet points
+
 
+
<!--T:7-->
+
:* One or more heading giving more in-depth information about using the application
+
 
+
<!--T:8-->
+
:* Screenshots to illustrate the above, whenever feasible.  These will usually be thumbnails, clickable for enlargement.
+
 
+
<!--T:9-->
+
:{|style="border:2px dotted #BCBCBC; background:#EEEEEE;"
+
|Optional sections - sometimes easier added later
+
 
|-
 
|-
 +
! Features
 +
| A brief feature list, under a heading, and consisting of bullet points.  These are indented by default - no need to specify indentation.
 +
| important
 
|-
 
|-
|* A Hints and Tips section - short tips to increase productivity
+
! 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
 
|-
 
|-
|* ''Either'' A short Troubleshooting section ''or'' a link to another page for Troubleshooting
+
! Hints and Tips
 +
| Short tips to increase productivity
 +
| optional
 +
|-
 +
! Troubleshooting
 +
| List them here or in a subpage
 +
| optional
 +
|-
 +
! Weblinks
 +
| Links to  
 +
* an external project site
 +
* the application manual on docs.kde.org
 +
* other useful internal or external pages
 +
| important<br />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 <nowiki>[[Category:Office]]</nowiki>.
 +
| important
 
|}
 
|}
  
<!--T:10-->
 
:* A sentence including a link to any external Project Page
 
 
<!--T:11-->
 
:* Links to any other useful internal or externals pages.
 
 
<!--T:12-->
 
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-->
 
 
{{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.}}
 
{{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.}}
 
<!--T:14-->
 
 
{{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.}}
 
{{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.}}
 
<!--T:15-->
 
 
{{Warning|Avoid using text smilies as they cause problems for translation applications.  Instead use <nowiki>[[Image:Face-smile.png]]</nowiki>  [[Image:Face-smile.png]]  Other smilies can be found on [[http://commons.wikimedia.org/w/index.php?title=Special:Search&search=smilies&fulltext=1 Commons Wikimedia]] and the file-name is sufficient to get the image included}}
 
{{Warning|Avoid using text smilies as they cause problems for translation applications.  Instead use <nowiki>[[Image:Face-smile.png]]</nowiki>  [[Image:Face-smile.png]]  Other smilies can be found on [[http://commons.wikimedia.org/w/index.php?title=Special:Search&search=smilies&fulltext=1 Commons Wikimedia]] and the file-name is sufficient to get the image included}}
 
<!--T:16-->
 
 
[[Category:Contributing]]
 
[[Category:Contributing]]
</translate>
 

Revision as of 09:39, 25 September 2010

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
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
Weblinks 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
Note-box-icon.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.


Note-box-icon.png
 
Note
If you are making frequent edits to your page, please use either {{Construction}} or {{Being_Edited}} so that translators know to wait until you are finished.


Warning.png
 
Warning
Avoid using text smilies as they cause problems for translation applications. Instead use [[Image:Face-smile.png]] Face-smile.png Other smilies can be found on [Commons Wikimedia] and the file-name is sufficient to get the image included

Content is available under Creative Commons License SA 4.0 unless otherwise noted.