Toolbox: Difference between revisions
No edit summary |
(Removed from translation system) |
||
Line 1: | Line 1: | ||
{{Info|This page offers examples of formatting code for common tasks}} | |||
==Do not add an i18n language bar== | |||
{|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> | ||
|} | |} | ||
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== | ||
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 | ||
<pre style="background:lemonchiffon"> | <pre style="background:lemonchiffon"> | ||
{|class="tablecenter vertical-centered" | {|class="tablecenter vertical-centered" | ||
Line 28: | Line 21: | ||
</pre> | </pre> | ||
==Format your text== | ==Format your text== | ||
===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''=== | ||
Blips are used to specify bold and italic words. | Blips are used to specify bold and italic words. | ||
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''. | ||
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=== | ||
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}} | ||
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}} | ||
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. | ||
Beware, that in templates, the pipe character (|) is used to separate arguments - even when the template only takes one! If Your code snippet contains pipe characters, they have to be entered as a character code or You can use [[Template:!]] like this: <nowiki> | Beware, that in templates, the pipe character (|) is used to separate arguments - even when the template only takes one! If Your code snippet contains pipe characters, they have to be entered as a character code or You can use [[Template:!]] like this: <nowiki> | ||
{{Input|1=some code {{!}} more code}}</nowiki> displays | {{Input|1=some code {{!}} more code}}</nowiki> displays | ||
Line 66: | Line 51: | ||
You can also combine input/output areas with [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi syntaxhiglighting]. An input area like this | You can also combine input/output areas with [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi GeSHi syntaxhiglighting]. An input area like this | ||
{{Input|1=<nowiki>{{Input|<syntaxhighlight lang="php" line> | {{Input|1=<nowiki>{{Input|<syntaxhighlight lang="php" line> | ||
# Initialise common code | # Initialise common code | ||
Line 77: | Line 60: | ||
}} | }} | ||
will result in | will result in | ||
{{Input|<syntaxhighlight lang="php" line> | {{Input|<syntaxhighlight lang="php" line> | ||
Line 85: | Line 67: | ||
</syntaxhighlight>}} | </syntaxhighlight>}} | ||
===Add indents=== | ===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. | :"''':'''" 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=== | ||
<nowiki>*</nowiki> is the symbol to use for bulletted lists. ** gives a second level:<br /> | |||
** | |||
<nowiki>* </nowiki>One star <br /> | |||
* Third point</nowiki> | <nowiki>* </nowiki>Next point <br /> | ||
<nowiki>**</nowiki> Sub-point <br /> | |||
<nowiki>* </nowiki>Third point</nowiki> | |||
produces | produces | ||
* One star | * One star | ||
* Next point | * Next point | ||
Line 115: | Line 87: | ||
* Third point | * Third point | ||
Numbered lists are produced in the same way, using '#'. | Numbered lists are produced in the same way, using '#'. | ||
<nowiki>#</nowiki> A single hash <br /> | |||
<nowiki>#</nowiki> Second point <br /> | |||
<nowiki>##</nowiki> A sub-point <br /> | |||
<nowiki>#</nowiki> Third point</nowiki> | |||
produces | produces | ||
# A single hash | # A single hash | ||
# Second point | # Second point | ||
Line 141: | Line 101: | ||
# Third point | # Third point | ||
This is less useful than the bulletted list. | This is less useful than the bulletted list. | ||
===Add a link=== | ===Add a link=== | ||
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. | ||
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 | ||
{{Input|1=<nowiki>[[PageLayout|this page]]</nowiki>}} | {{Input|1=<nowiki>[[PageLayout|this page]]</nowiki>}} | ||
which displays | which displays | ||
[[PageLayout|this page]] | [[PageLayout|this page]] | ||
External links are slightly different so | External links are slightly different so | ||
{{Input|1=<nowiki>[http://techbase.kde.org/Schedules our road map]</nowiki>}} | {{Input|1=<nowiki>[http://techbase.kde.org/Schedules our road map]</nowiki>}} | ||
displays | displays | ||
[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. | ||
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== | ||
===Add a single image, centered=== | ===Add a single image, centered=== | ||
{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}} | {{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}} | ||
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=== | ||
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. | ||
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=== | ||
{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;" | {{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;" | ||
|[[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 203: | Line 147: | ||
|}</nowiki>}} | |}</nowiki>}} | ||
displays | displays | ||
{|class="tablecenter" style="border: 1px solid grey;" | {|class="tablecenter" style="border: 1px solid grey;" | ||
|[[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 215: | Line 157: | ||
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== | ||
Where a note or warning is relevant within your text, use these templates: | Where a note or warning is relevant within your text, use these templates: | ||
<nowiki>{{Info|This is general information}}</nowiki> displays | <nowiki>{{Info|This is general information}}</nowiki> displays | ||
{{Info|This is general information}} | {{Info|This is general information}} | ||
<nowiki>{{Note|Some important information at this point}}</nowiki> displays | <nowiki>{{Note|Some important information at this point}}</nowiki> displays | ||
{{Note|Some important information at this point}} | {{Note|Some important information at this point}} | ||
<nowiki>{{Tip|A helpful piece of advice, something to remember}}</nowiki>displays | <nowiki>{{Tip|A helpful piece of advice, something to remember}}</nowiki>displays | ||
{{Tip|A helpful piece of advice, something to remember}} | {{Tip|A helpful piece of advice, something to remember}} | ||
<nowiki>{{Warning|Take care - this is a dangerous thing to do}}</nowiki> displays | <nowiki>{{Warning|Take care - this is a dangerous thing to do}}</nowiki> displays | ||
{{Warning|Take care - this is a dangerous thing to do}} | {{Warning|Take care - this is a dangerous thing to do}} | ||
==KDE3 and KDE SC 4 versions of applications== | ==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, or where only a KDE 3 version exists, 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, or where only a KDE 3 version exists, 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}} | ||
==Other Useful Templates== | ==Other Useful Templates== | ||
===Community Applications=== | ===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 <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> | ||
{{Community-app}} | {{Community-app}} | ||
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: | ||
{{Community-app-footnote}} | {{Community-app-footnote}} | ||
===Making major edits to Existing Pages=== | ===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 <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 | ||
{{Being_Edited}} | {{Being_Edited}} | ||
''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=== | ||
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 | ||
{{Construction}} | {{Construction}} | ||
===Links to Pages in the Neighbourhood=== | ===Links to Pages in the Neighbourhood=== | ||
You can add links to a preceding or a following page using the following templates as described here: | You can add links to a preceding or a following page using the following templates as described here: | ||
{{Input|1=<nowiki>{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}</nowiki>}} | {{Input|1=<nowiki>{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}</nowiki>}} | ||
{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}} | {{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}} | ||
For first pages with no preceeding page or last pages with no following page use this: | For first pages with no preceeding page or last pages with no following page use this: | ||
{{Input|1=<nowiki>{{Next|Following Pagename|This page you should read later}}</nowiki>}} | {{Input|1=<nowiki>{{Next|Following Pagename|This page you should read later}}</nowiki>}} | ||
Line 294: | Line 218: | ||
{{Prev|Previous Pagename|The page before this page}} | {{Prev|Previous Pagename|The page before this page}} | ||
==Adding a List of Sub-Pages== | ==Adding a List of Sub-Pages== | ||
{{Input|1=<nowiki>== Subpages of {{FULLPAGENAME}} == | {{Input|1=<nowiki>== Subpages of {{FULLPAGENAME}} == | ||
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki> | {{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki> | ||
is very useful when you want to list subpages with active links, such as | |||
=== Subpages of {{FULLPAGENAME}}=== | |||
It does, however, also list all "other-language" pages, so use with discretion. | |||
{{Special:PrefixIndex/{{FULLPAGENAME}}/}} | {{Special:PrefixIndex/{{FULLPAGENAME}}/}} | ||
---- | ---- | ||
[[Category:Contributing]] | [[Category:Contributing]] | ||
Revision as of 13:03, 25 September 2010
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
{|class="tablecenter vertical-centered" |[[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.
Beware, that in templates, the pipe character (|) is used to separate arguments - even when the template only takes one! If Your code snippet contains pipe characters, they have to be entered as a character code or You can use Template:! like this: {{Input|1=some code {{!}} more code}} displays
some code | more code
You can also combine input/output areas with GeSHi syntaxhiglighting. An input area like this
{{Input|<syntaxhighlight lang="php" line> # Initialise common code $preIP = dirname( __FILE__ ); require_once( "$preIP/includes/WebStart.php" ); </syntaxhighlight>}}
will result in
# Initialise common code $preIP = dirname( __FILE__ ); require_once( "$preIP/includes/WebStart.php" );
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</nowiki>
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</nowiki>
produces
- A single hash
- Second point
- A sub-point
- 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
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.
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" style="border: 1px solid grey;" |[[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 these templates:
{{Info|This is general information}} displays
{{Note|Some important information at this point}} displays
{{Tip|A helpful piece of advice, something to remember}}displays
{{Warning|Take care - this is a dangerous thing to do}} displays
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, or where only a KDE 3 version exists, 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
Other 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}}
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
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
Links to Pages in the Neighbourhood
You can add links to a preceding or a following page using the following templates as described here:
{{Prevnext|Previous Pagename|Following Pagename|The page before this page|This page you should read later}}
For first pages with no preceeding page or last pages with no following page use this:
{{Next|Following Pagename|This page you should read later}}
{{Prev|Previous Pagename|The page before this page}}
- ← The page before this page
- Toolbox
Adding a List of Sub-Pages
{{Input|1=== Subpages of {{FULLPAGENAME}} == {{Special:PrefixIndex/{{FULLPAGENAME}}/}}
is very useful when you want to list subpages with active links, such as
Subpages of Toolbox
It does, however, also list all "other-language" pages, so use with discretion.