Toolbox: Difference between revisions

From KDE Wiki Sandbox
No edit summary
(Marked this version for translation)
Line 2: Line 2:


<translate>
<translate>
<!--T:1-->
'''This page offers examples of formatting code for common tasks'''
'''This page offers examples of formatting code for common tasks'''


==Deciding where to create your page==
==Deciding where to create your page== <!--T:2-->
Many people choose to draft a page on their own Talk page, then move the result to the desired site.  Sometimes there is a good reason for preferring to do it in the final location.  If that is the case, consider using before your content <nowiki>{{Construction}}</nowiki> which will display  
Many people choose to draft a page on their own Talk page, then move the result to the desired site.  Sometimes there is a good reason for preferring to do it in the final location.  If that is the case, consider using before your content <nowiki>{{Construction}}</nowiki> which will display  
{{Construction}}
{{Construction}}


===Directory Structure===
===Directory Structure=== <!--T:3-->
Try to avoid creating a structure more than three levels deep.  For most purposes,  the following guide will suffice:
Try to avoid creating a structure more than three levels deep.  For most purposes,  the following guide will suffice:


<!--T:4-->
Application <br />
Application <br />
Application/Troubleshooting <br />
Application/Troubleshooting <br />
Line 19: Line 21:
Application/Manual/Section_xxx <br />
Application/Manual/Section_xxx <br />


==Do not add an i18n language bar==
==Do not add an i18n language bar== <!--T:5-->


<!--T:6-->
{|style="width:75%; border:2px dotted #BCBCBC;" align="center"
{|style="width:75%; border:2px dotted #BCBCBC;" align="center"
|<nowiki>{{Template:I18n/Language Navigation Bar|Toolbox}}</nowiki>
|<nowiki>{{Template:I18n/Language Navigation Bar|Toolbox}}</nowiki>
|}
|}


<!--T:7-->
New pages should not have this language bar.  It related to the old style of translation and will not work with page translation extension.  The new style language bar will be added by the software when the first translation is made.
New pages should not have this language bar.  It related to the old style of translation and will not work with page translation extension.  The new style language bar will be added by the software when the first translation is made.


==Add an introductory screenshot and description==
==Add an introductory screenshot and description== <!--T:8-->
Whenever possible we begin an application's top-level page with this.  The code to achieve it is
Whenever possible we begin an application's top-level page with this.  The code to achieve it is


<!--T:9-->
<pre style="background:lemonchiffon">
<pre style="background:lemonchiffon">
{|
{|
Line 37: Line 42:
</pre>
</pre>


==Format your text==
==Format your text== <!--T:10-->
===Use Headings===
===Use Headings===
Headings automatically form part of your Table of Contents, so need to be structured.  Their place in the tree is governed by multiple '=' characters at each end of the heading.  Avoid using a single one - that denotes a page heading, and the automatic page heading should be used.  Your major headings will use '==text goes here==', the next level, '===more text===' and so on.
Headings automatically form part of your Table of Contents, so need to be structured.  Their place in the tree is governed by multiple '=' characters at each end of the heading.  Avoid using a single one - that denotes a page heading, and the automatic page heading should be used.  Your major headings will use '==text goes here==', the next level, '===more text===' and so on.


===Use '''bold''' and ''italic''===
===Use '''bold''' and ''italic''=== <!--T:11-->
Blips are used to specify bold and italic words.
Blips are used to specify bold and italic words.


<!--T:12-->
Use <nowiki>'''bold text'''</nowiki> to specify '''bold text''' and
Use <nowiki>'''bold text'''</nowiki> to specify '''bold text''' and
<nowiki>''italic text''</nowiki> to specify ''italic text''.
<nowiki>''italic text''</nowiki> to specify ''italic text''.


<!--T:13-->
In order to ensure we get easy and accurate translations, please adhere to the ''[[Typographical_Guidelines|typographical guidelines]].''
In order to ensure we get easy and accurate translations, please adhere to the ''[[Typographical_Guidelines|typographical guidelines]].''


===Add a code snippet===
===Add a code snippet=== <!--T:14-->


<!--T:15-->
We distinguish code that the user inputs from terminal output by the use of templates.  <nowiki>{{Input|1=this piece of code is input by the user}}</nowiki> displays
We distinguish code that the user inputs from terminal output by the use of templates.  <nowiki>{{Input|1=this piece of code is input by the user}}</nowiki> displays
{{Input|1=this piece of code is input by the user}}
{{Input|1=this piece of code is input by the user}}


<!--T:16-->
Code output by a terminal is shown similarly, using <nowiki>{{Output|1=the user would read this in konsole}}</nowiki> which displays as
Code output by a terminal is shown similarly, using <nowiki>{{Output|1=the user would read this in konsole}}</nowiki> which displays as
{{Output|1=the user would read this in konsole}}
{{Output|1=the user would read this in konsole}}


<!--T:17-->
Be aware that very long lines can be problematic.  Wherever possible display the code in reasonably short lines.
Be aware that very long lines can be problematic.  Wherever possible display the code in reasonably short lines.


===Add indents===
===Add indents=== <!--T:18-->


<!--T:19-->
:"''':'''" is used for an indent, and was used in multiples in some old pages.  This is deprecated, and causes some problems, so the multiples will be removed as they are found.  A single "''':'''" indents by four characters.
:"''':'''" is used for an indent, and was used in multiples in some old pages.  This is deprecated, and causes some problems, so the multiples will be removed as they are found.  A single "''':'''" indents by four characters.


===Lists, numbered and bulleted===
===Lists, numbered and bulleted=== <!--T:20-->
<nowiki>*</nowiki> is the symbol to use for bulletted lists.  ** gives a second level:
<nowiki>*</nowiki> is the symbol to use for bulletted lists.  ** gives a second level:
  <nowiki>
  <nowiki>
  :* One star
  :* One star


  :* Next point
  <!--T:21-->
:* Next point


  :** Sub-point
  <!--T:22-->
:** Sub-point


  :* Third point</nowiki>
  <!--T:23-->
:* Third point</nowiki>


<!--T:24-->
produces
produces


<!--T:25-->
:* One star
:* One star
:* Next point
:* Next point
Line 81: Line 97:
:* Third point
:* Third point


<!--T:26-->
Numbered lists are produced in the same way, using '#'.
Numbered lists are produced in the same way, using '#'.




  <nowiki>
  <!--T:27-->
<nowiki>
  :# A single hash
  :# A single hash


  :# Second point
  <!--T:28-->
:# Second point


  :## A sub-point
  <!--T:29-->
:## A sub-point


  :# Third point</nowiki>
  <!--T:30-->
:# Third point</nowiki>


<!--T:31-->
produces
produces


<!--T:32-->
:# A single hash
:# A single hash
:# Second point
:# Second point
Line 100: Line 123:
:# Third point
:# Third point


<!--T:33-->
This is less useful than the bulletted list.
This is less useful than the bulletted list.


===Add a link===
===Add a link=== <!--T:34-->


<!--T:35-->
There are two kinds of links to learn, internal ones, to another userbase page, and external URL links.
There are two kinds of links to learn, internal ones, to another userbase page, and external URL links.


<!--T:36-->
For an internal link the format <nowiki>[[PageLayout]]</nowiki>, where you want to display the name of the page, does work, but it is not ideal, particularly for translation to docbook.  It is better to use the form <nowiki>[[PageLayout|Page Layout]]</nowiki>, as it avoids problems at the translator stage.  You often need to include the link in a sentence, so in that case you would use  
For an internal link the format <nowiki>[[PageLayout]]</nowiki>, where you want to display the name of the page, does work, but it is not ideal, particularly for translation to docbook.  It is better to use the form <nowiki>[[PageLayout|Page Layout]]</nowiki>, as it avoids problems at the translator stage.  You often need to include the link in a sentence, so in that case you would use  


<!--T:37-->
:{{Input|1=<nowiki>[[PageLayout|this page]]</nowiki>}}
:{{Input|1=<nowiki>[[PageLayout|this page]]</nowiki>}}


<!--T:38-->
which displays
which displays


<!--T:39-->
[[PageLayout|this page]]
[[PageLayout|this page]]


<!--T:40-->
External links are slightly different so
External links are slightly different so


<!--T:41-->
:{{Input|1=<nowiki>[http://techbase.kde.org/Schedules our road map]</nowiki>}}
:{{Input|1=<nowiki>[http://techbase.kde.org/Schedules our road map]</nowiki>}}


<!--T:42-->
displays
displays


<!--T:43-->
[http://techbase.kde.org/Schedules our road map], which would take you straight to the techbase page.
[http://techbase.kde.org/Schedules our road map], which would take you straight to the techbase page.


<!--T:44-->
One last thing to note - when you preview your page, the links are live.  This gives you two benefits. You can check (by hovering) that your links are set up as you expected, and you can use a red link to create a new page.
One last thing to note - when you preview your page, the links are live.  This gives you two benefits. You can check (by hovering) that your links are set up as you expected, and you can use a red link to create a new page.


==Illustrate your text==
==Illustrate your text== <!--T:45-->
===Add a single image, centered===
===Add a single image, centered===


<!--T:46-->
:{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}
:{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}


<!--T:47-->
Note that you can change the position of the image, but the default is left.  The size of the image depends on the circumstances, but for screenshots I recommend no less than 250px and no more than 500px.
Note that you can change the position of the image, but the default is left.  The size of the image depends on the circumstances, but for screenshots I recommend no less than 250px and no more than 500px.


===Make the image clickable, and add a caption===
===Make the image clickable, and add a caption=== <!--T:48-->


<!--T:49-->
Where you need to show more detail, create a moderately sized image, clickable, so that the full-size can be seen.  Simply add the parameter '|thumb' within the image parentheses.
Where you need to show more detail, create a moderately sized image, clickable, so that the full-size can be seen.  Simply add the parameter '|thumb' within the image parentheses.


<!--T:50-->
A caption can also be added as a parameter, but will only show if '|thumb' is present.
A caption can also be added as a parameter, but will only show if '|thumb' is present.


===Use tables to precisely place multiple images===
===Use tables to precisely place multiple images=== <!--T:51-->
<div style="white-space:pre;">
<div style="white-space:pre;">
:{|style="width:95%; border:2px dotted #BCBCBC; background:lemonchiffon" align="center"
:{|style="width:95%; border:2px dotted #BCBCBC; background:lemonchiffon" align="center"
Line 148: Line 186:
</div>
</div>


<!--T:52-->
displays
displays


<!--T:53-->
:{|class=tablecenter
:{|class=tablecenter
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]
Line 158: Line 198:




<!--T:54-->
Note that all the parameters for one image are contained within <nowiki>[[...]]</nowiki>, and cells are separated by '||'.  To start a new line, insert '|-' on an otherwise-empty line, then '|' at the start of the next one.
Note that all the parameters for one image are contained within <nowiki>[[...]]</nowiki>, and cells are separated by '||'.  To start a new line, insert '|-' on an otherwise-empty line, then '|' at the start of the next one.


==Add Notes and Warnings==
==Add Notes and Warnings== <!--T:55-->


<!--T:56-->
Where a note or warning is relevant within your text, use a table, like these:
Where a note or warning is relevant within your text, use a table, like these:
{|style="width:80%; border:2px dotted #BCBCBC; background:lemonchiffon" align="center"
{|style="width:80%; border:2px dotted #BCBCBC; background:lemonchiffon" align="center"
Line 171: Line 213:
|}
|}


<!--T:57-->
:{|
:{|
|[[Image:Im-status-message-edit.png]]||'''Note'''||Some important information
|[[Image:Im-status-message-edit.png]]||'''Note'''||Some important information
|}
|}


<!--T:58-->
{|style="width:95%; border:2px dotted #BCBCBC; background:lemonchiffon" align="center"
{|style="width:95%; border:2px dotted #BCBCBC; background:lemonchiffon" align="center"
|<nowiki>
|<nowiki>
Line 183: Line 227:
|}
|}


<!--T:59-->
:{|
:{|
|[[Image:help-hint.png]]||'''Tip'''||Something useful to remember
|[[Image:help-hint.png]]||'''Tip'''||Something useful to remember
|}
|}


<!--T:60-->
{|style="width:95%; border:2px dotted #BCBCBC;background:lemonchiffon " align="center"
{|style="width:95%; border:2px dotted #BCBCBC;background:lemonchiffon " align="center"
|<nowiki>:{|
|<nowiki>:{|
Line 194: Line 240:
|}
|}


<!--T:61-->
:{|
:{|
|[[Image:dialog-warning.png|32px]]||'''Warning'''||This is dangerous
|[[Image:dialog-warning.png|32px]]||'''Warning'''||This is dangerous
|}
|}


<!--T:62-->
Where a note or warning is important enough to need to stand out strongly there are two useful templates, Info and Warning.  Use  
Where a note or warning is important enough to need to stand out strongly there are two useful templates, Info and Warning.  Use  


<!--T:63-->
<nowiki>{{info|This is another way to display your information}}</nowiki>
<nowiki>{{info|This is another way to display your information}}</nowiki>


  {{info|This is another way to display your information}}
  <!--T:64-->
{{info|This is another way to display your information}}


<!--T:65-->
or
or


<!--T:66-->
<nowiki>{{warning|This is a very dangerous thing to do}}</nowiki>
<nowiki>{{warning|This is a very dangerous thing to do}}</nowiki>


<!--T:67-->
{{warning|This is a very dangerous thing to do}}
{{warning|This is a very dangerous thing to do}}


==KDE3 and KDE SC 4 versions of applications==
==KDE3 and KDE SC 4 versions of applications== <!--T:68-->


<!--T:69-->
By default, KDE SC 4 is assumed.  If the KDE SC 4 version is not yet ready for release it may be necessary to document the KDE3 version.  In this case you should add an icon  <nowiki>{{KDE3}}</nowiki>  
By default, KDE SC 4 is assumed.  If the KDE SC 4 version is not yet ready for release it may be necessary to document the KDE3 version.  In this case you should add an icon  <nowiki>{{KDE3}}</nowiki>  
which displays {{KDE3}}.  Should you be writing about a KDE3 version and KDE SC 4 version on the same page, use icons for both - <nowiki>{{KDE4}}</nowiki> which displays {{KDE4}}
which displays {{KDE3}}.  Should you be writing about a KDE3 version and KDE SC 4 version on the same page, use icons for both - <nowiki>{{KDE4}}</nowiki> which displays {{KDE4}}


==Useful Templates==
==Useful Templates== <!--T:70-->
===Community Applications===
===Community Applications===


<!--T:71-->
The final consideration concerns those applications which are not distributed as core KDE applications.  These need to be indicated by an icon, placing <nowiki>{{Community-app}}</nowiki>
The final consideration concerns those applications which are not distributed as core KDE applications.  These need to be indicated by an icon, placing <nowiki>{{Community-app}}</nowiki>


<!--T:72-->
{{Community-app}}
{{Community-app}}


<!--T:73-->
at the end of your sentence or line, just as you would to denote a footnote in general writing.  You then need to add <nowiki>{{Community-app-footnote}}</nowiki> which will create a footnote, like this:
at the end of your sentence or line, just as you would to denote a footnote in general writing.  You then need to add <nowiki>{{Community-app-footnote}}</nowiki> which will create a footnote, like this:


<!--T:74-->
{{Community-app-footnote}}
{{Community-app-footnote}}


===Making major edits to Existing Pages===
===Making major edits to Existing Pages=== <!--T:75-->
If a page is likely to be open for editing for some time there is a danger of conflicts - someone else may edit at the same time, and saving your edit will cancel out theirs, or vice versa.  The way to avoid that is to make a temporary entry, directly under the language bar, using <nowiki>{{Being_Edited}}</nowiki> which will display
If a page is likely to be open for editing for some time there is a danger of conflicts - someone else may edit at the same time, and saving your edit will cancel out theirs, or vice versa.  The way to avoid that is to make a temporary entry, directly under the language bar, using <nowiki>{{Being_Edited}}</nowiki> which will display


<!--T:76-->
{{Being_Edited}}
{{Being_Edited}}


<!--T:77-->
''Don't forget to remove it when you have finished!''
''Don't forget to remove it when you have finished!''


===Adding a new complex page===
===Adding a new complex page=== <!--T:78-->
If you need to be able to work on a page for quite some time, over several days, for instance, you may like to use the Construction template - <nowiki>{{Construction}}</nowiki>, which displays
If you need to be able to work on a page for quite some time, over several days, for instance, you may like to use the Construction template - <nowiki>{{Construction}}</nowiki>, which displays


<!--T:79-->
{{Construction}}
{{Construction}}


==Adding a List of Sub-Pages==
==Adding a List of Sub-Pages== <!--T:80-->
<pre style="background:lemonchiffon">
<pre style="background:lemonchiffon">
== Subpages of {{FULLPAGENAME}} ==
== Subpages of {{FULLPAGENAME}} ==
Line 244: Line 305:
</pre>
</pre>


<!--T:81-->
is very useful when you want to list subpages with active links, such as  
is very useful when you want to list subpages with active links, such as  


=== Subpages of {{FULLPAGENAME}}===
=== Subpages of {{FULLPAGENAME}}=== <!--T:82-->
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}


<!--T:83-->
----
----
</translate>
</translate>
[[Category:Contributing]]
[[Category:Contributing]]

Revision as of 19:02, 28 August 2010

This page offers examples of formatting code for common tasks

Deciding where to create your page

Many people choose to draft a page on their own Talk page, then move the result to the desired site. Sometimes there is a good reason for preferring to do it in the final location. If that is the case, consider using before your content {{Construction}} which will display

Under Construction
This is a new page, currently under construction!


Directory Structure

Try to avoid creating a structure more than three levels deep. For most purposes, the following guide will suffice:

Application
Application/Troubleshooting
Application/xxx-How-To
Application/Manual
Application/Manual/Introduction
Application/Manual/Section_1
Application/Manual/Section_xxx

Do not add an i18n language bar

{{Template:I18n/Language Navigation Bar|Toolbox}}

New pages should not have this language bar. It related to the old style of translation and will not work with page translation extension. The new style language bar will be added by the software when the first translation is made.

Add an introductory screenshot and description

Whenever possible we begin an application's top-level page with this. The code to achieve it is

{|
|[[Image:YourScreenshot.png|250px|thumb]]
|Your descriptive text
|}

Format your text

Use Headings

Headings automatically form part of your Table of Contents, so need to be structured. Their place in the tree is governed by multiple '=' characters at each end of the heading. Avoid using a single one - that denotes a page heading, and the automatic page heading should be used. Your major headings will use '==text goes here==', the next level, '===more text===' and so on.

Use bold and italic

Blips are used to specify bold and italic words.

Use '''bold text''' to specify bold text and ''italic text'' to specify italic text.

In order to ensure we get easy and accurate translations, please adhere to the typographical guidelines.

Add a code snippet

We distinguish code that the user inputs from terminal output by the use of templates. {{Input|1=this piece of code is input by the user}} displays

this piece of code is input by the user

Code output by a terminal is shown similarly, using {{Output|1=the user would read this in konsole}} which displays as

the user would read this in konsole

Be aware that very long lines can be problematic. Wherever possible display the code in reasonably short lines.

Add indents

":" is used for an indent, and was used in multiples in some old pages. This is deprecated, and causes some problems, so the multiples will be removed as they are found. A single ":" indents by four characters.

Lists, numbered and bulleted

* is the symbol to use for bulletted lists. ** gives a second level:

 :* One star

 :* Next point

 :** Sub-point

 :* Third point

produces

  • One star
  • Next point
    • Sub-point
  • Third point

Numbered lists are produced in the same way, using '#'.


 :# A single hash

 :# Second point

 :## A sub-point

 :# Third point

produces

  1. A single hash
  2. Second point
    1. A sub-point
  3. Third point

This is less useful than the bulletted list.

Add a link

There are two kinds of links to learn, internal ones, to another userbase page, and external URL links.

For an internal link the format [[PageLayout]], where you want to display the name of the page, does work, but it is not ideal, particularly for translation to docbook. It is better to use the form [[PageLayout|Page Layout]], as it avoids problems at the translator stage. You often need to include the link in a sentence, so in that case you would use

[[PageLayout|this page]]

which displays

this page

External links are slightly different so

[http://techbase.kde.org/Schedules our road map]

displays

our road map, which would take you straight to the techbase page.

One last thing to note - when you preview your page, the links are live. This gives you two benefits. You can check (by hovering) that your links are set up as you expected, and you can use a red link to create a new page.

Illustrate your text

Add a single image, centered

[[Image:KMail-kde4.png|250px|center]]

Note that you can change the position of the image, but the default is left. The size of the image depends on the circumstances, but for screenshots I recommend no less than 250px and no more than 500px.

Make the image clickable, and add a caption

Where you need to show more detail, create a moderately sized image, clickable, so that the full-size can be seen. Simply add the parameter '|thumb' within the image parentheses.

A caption can also be added as a parameter, but will only show if '|thumb' is present.

Use tables to precisely place multiple images

{|class=tablecenter |[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]] |- |[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]] |}

displays


Note that all the parameters for one image are contained within [[...]], and cells are separated by '||'. To start a new line, insert '|-' on an otherwise-empty line, then '|' at the start of the next one.

Add Notes and Warnings

Where a note or warning is relevant within your text, use a table, like these:

:{| |[[Image:Im-status-message-edit.png]]||'''Note'''||Some important information |}
Note Some important information
:{| |[[Image:help-hint.png]]||'''Tip'''||Something useful to remember |}
Tip Something useful to remember
:{| |[[Image:dialog-warning.png|32px]]||'''Warning'''||This is dangerous |}
Warning This is dangerous

Where a note or warning is important enough to need to stand out strongly there are two useful templates, Info and Warning. Use

{{info|This is another way to display your information}}

Information
This is another way to display your information


or

{{warning|This is a very dangerous thing to do}}

Warning
This is a very dangerous thing to do


KDE3 and KDE SC 4 versions of applications

By default, KDE SC 4 is assumed. If the KDE SC 4 version is not yet ready for release it may be necessary to document the KDE3 version. In this case you should add an icon {{KDE3}} which displays . Should you be writing about a KDE3 version and KDE SC 4 version on the same page, use icons for both - {{KDE4}} which displays

Useful Templates

Community Applications

The final consideration concerns those applications which are not distributed as core KDE applications. These need to be indicated by an icon, placing {{Community-app}}


 See footnote


at the end of your sentence or line, just as you would to denote a footnote in general writing. You then need to add {{Community-app-footnote}} which will create a footnote, like this:



Support for this application can be found from the project's home page


Making major edits to Existing Pages

If a page is likely to be open for editing for some time there is a danger of conflicts - someone else may edit at the same time, and saving your edit will cancel out theirs, or vice versa. The way to avoid that is to make a temporary entry, directly under the language bar, using {{Being_Edited}} which will display

Currently Being Edited
This page is currently being edited.
If this notice persists for an unreasonable time, please either notify irc.freenode.org #kde-www or report on Annew's Talk page

Note: Pages should not normally be marked for translation while they are being actively worked on


Don't forget to remove it when you have finished!

Adding a new complex page

If you need to be able to work on a page for quite some time, over several days, for instance, you may like to use the Construction template - {{Construction}}, which displays

Under Construction
This is a new page, currently under construction!


Adding a List of Sub-Pages

== Subpages of {{FULLPAGENAME}} ==
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}

is very useful when you want to list subpages with active links, such as

Subpages of Toolbox