https://techbase.kde.org/api.php?action=feedcontributions&user=Claus+chr&feedformat=atomKDE TechBase - User contributions [en]2024-03-19T08:15:52ZUser contributionsMediaWiki 1.40.2https://techbase.kde.org/index.php?title=Getting_Started/Using_Project_Neon_to_contribute_to_KDE&diff=80691Getting Started/Using Project Neon to contribute to KDE2013-07-25T08:54:05Z<p>Claus chr: instruction to run apt-get update</p>
<hr />
<div>[https://launchpad.net/project-neon Project Neon] is a nightly build of the latest KDE trunk for Ubuntu. It is an easy way for new contributors to KDE to get started without having to download and build the entire KDE source code tree. Additionally, dependencies are automatically handled and updated. This is suitable for new developers, translators, usability designers, documenters, promoters, bug triagers, etc. This process makes the steps detailed on [[Getting_Started/Build|this page]].<br />
<br />
However, for developers, it may at some point become necessary to build more components from source code as you become more involved in the project. The [[Getting_Started/Build/kdesrc-build|kdesrc-build]] script is an easy way to build all or parts of KDE from its source code repositories.<br />
<br />
== Requirements ==<br />
<br />
Project Neon always requires either the latest stable Kubuntu release or the development release. Previous versions of Kubuntu are not supported. <br />
<br />
== Installing Project Neon ==<br />
<br />
To use Project Neon, add the following PPA (Personal Package Archive) to your <tt>sources.list</tt> using your preferred method:<br />
<br />
<syntaxhighlight lang="bash"><br />
sudo add-apt-repository ppa:neon/ppa<br />
</syntaxhighlight><br />
or<br />
<pre><br />
# Project neon nightly KDE4 build<br />
deb http://ppa.launchpad.net/neon/ppa/ubuntu maverick main<br />
<br />
#above repository is PGP signed, refer to below link for getting PGP key<br />
https://launchpad.net/~neon/+archive/ppa<br />
</pre><br />
<br />
Now you need to synchronize the package index files. Run<br />
<br />
<syntaxhighlight lang="bash"><br />
sudo apt-get update<br />
</syntaxhighlight><br />
<br />
After that, you can simply install the nightly package of whichever modules you want to work on. The packages are named project-neon-<git/svn module name>. The packages are installed in /opt/project-neon/ and won't affect your stable KDE install.<br />
<br />
You can install all of the packages or just the ones you are interested in, depending on what you want to use them for.<br />
<br />
=== Using Project Neon version of KDE Workspace ===<br />
<br />
To use Project Neon version of KDE Workspace, install the <tt>project-neon-base</tt> package. You can then log out, select the "Project Neon" session in KDM session list and log in.<br />
<br />
<syntaxhighlight lang="bash"><br />
sudo apt-get install project-neon-base<br />
</syntaxhighlight><br />
<br />
You can also install other KDE Workspace goodies, such as extra plasmoids, with:<br />
<br />
<syntaxhighlight lang="bash"><br />
sudo apt-get install project-neon-kdeplasma-addons<br />
</syntaxhighlight><br />
<br />
=== Testing individual applications ===<br />
<br />
If you are only interested in application development in another module, you can install just the module package.<br />
<br />
First install <tt>project-neon-utils</tt>. This package contains a number of utilities among which <tt>neon-env</tt>, which is needed to run Project Neon applications:<br />
<br />
<syntaxhighlight lang="bash"><br />
sudo apt-get install project-neon-utils<br />
</syntaxhighlight><br />
<br />
You can then install the package for the module you are interested in. For example to test the latest version of kdepim applications:<br />
<br />
<syntaxhighlight lang="bash"><br />
sudo apt-get install project-neon-kdepim<br />
</syntaxhighlight><br />
<br />
That command will also install the <tt>kdelibs</tt>, <tt>kdepimlibs</tt> and other dependencies too. In your regular (stable) KDE session you can now set up Project Neon environment and run the nightly version of your chosen application.<br />
<br />
<syntaxhighlight lang="bash"><br />
neon-env<br />
kmail<br />
</syntaxhighlight><br />
<br />
<tt>neon-env</tt> will setup the environment and start a subshell from which you can work with your project neon installation.<br />
This will correctly use the nightly version of libraries instead of using the stable versions, so no other changes are necessary to your library path etc.<br />
You'll need to close the terminal session for the settings to be undone.<br />
<br />
Note that settings for applications that you run from project neon do not conflict with your regular application settings and data. <tt>.project-neon-kde/</tt> is used instead of <tt>.kde/</tt><br />
<br />
=== Installing everything ===<br />
<br />
If you want to install all packages that are provided by Project Neon in one go, you can use the <tt>project-neon-all</tt> package which will install all provided packages. To install all debugging symbols (Warning: takes a lot of disk space) <tt>project-neon-all-dbg</tt> can be used.<br />
<br />
== Using Project Neon for development ==<br />
<br />
If you are joining one of the development teams in KDE, you will need a real SVN/GIT checkout in order to contribute your code back to the project and create patches easily. If you only code for KDE every now and then, Project Neon provides some extra tools for this purpose in the package <tt>project-neon-utils</tt>:<br />
<br />
NOTE: both neon-cmake and neonmake require neon-env to be run first!<br />
<br />
* <tt>neon-env</tt> - sets up the necessary environment settings for project neon builds and opens a subshell.<br />
* <tt>neon-cmake</tt> - cmake wrapper with neon environment settings for cmake, same synopsis as cmake and passes arguments to cmake<br />
* <tt>neonmake</tt> - convenience script which will create a build folder, configure the source, build it and install it in /opt/project-neon/ so you can test your changes.<br />
* <tt>neon-clean</tt> - script that resets any changes you made to /opt/project-neon after installing the packages. Since this script reinstalls the packages it might require a working internet connection.<br />
* <tt>neonbuild</tt> - pbuilder/pdebuild wrapper to rebuild a neon package in a chroot. Takes the same options as pbuilder. If no pbuilder action is given pdebuild is run instead.<br />
<br />
=== Options for cmake/make ===<br />
You can change the cmake and make options used by setting these variables in ~/.neonrc:<br />
<br />
* <tt>NEON_CMAKE_OPTS=""</tt> - Here you can add additional cmake options that should be used together with the default neon options.<br />
* <tt>NEON_CMAKE_OVERRIDE=""</tt> - If you set this variable cmake will ignore the default neon options and only use the ones in NEON_CMAKE_OVERRIDE.<br />
* <tt>NEON_MAKE_OVERRIDE=""</tt> - If you set this variable make in neonmake will only use your options. By default make uses '-j CPUs+1'<br />
<br />
=== Debugging symbols ===<br />
The debugging symbols for every package are in its corresponding <code>-dbg</code> package, so to install the debugging symbols for kdelibs you can use<br />
<syntaxhighlight lang="bash"><br />
sudo apt-get install project-neon-kdelibs-dbg<br />
</syntaxhighlight><br />
<br />
If you are already using a nightly package of the module you want to develop for, you should remove that and checkout the development version. For example:<br />
<br />
<pre><br />
# Remove the packaged nightly version<br />
sudo apt-get purge project-neon-kdepim<br />
<br />
# Add below Project Neon source code repository to sources.list if you didn't use add-apt-repository<br />
deb-src http://ppa.launchpad.net/neon/ppa/ubuntu maverick main<br />
<br />
# Get the dependencies for building kdepim<br />
sudo apt-get build-dep project-neon-kdepim<br />
cd ~<br />
# You may choose to do your development in a different folder.<br />
cd Development<br />
# Gets the latest version of the kdepim module.<br />
git clone git://anongit.kde.org/kdepim<br />
cd kdepim<br />
# Set up neon environment<br />
neon-env<br />
# Shortcut provided by Project Neon to make the module<br />
# and install it to the prefix /opt/project-neon/<br />
neonmake<br />
</pre><br />
<br />
Note that you should usually checkout a module from KDE, not an application. Most modules contain libraries shared within the module and which are necessary to build the applications in the module.<br />
<br />
Also note that when using apt-get build-dep it will always get all build-depends, so watch out that it doesn't install a component you want to build yourself as that would overwrite your changes should you install the packages after installing your build. <br />
<br />
<br />
== Using Project Neon for translation ==<br />
<br />
The Project Neon nightly packages include English language strings only. Translated packages are not available. However, if you are translating KDE applications, you can install the translations from KDE SVN in your normal workflow.<br />
<br />
<syntaxhighlight lang="bash"><br />
cd ~<br />
cd Translations<br />
# The -N switch checks out only the top level directory from svn.<br />
svn co -N svn://anonsvn.kde.org/home/kde/trunk/l10n-kde4<br />
cd l10n-kde4<br />
# scripts necessary to build translations.<br />
svn up scripts<br />
# Get the German translations<br />
svn up de<br />
# Generate the build files for the German language pack - if you get a message<br />
# that revpath couldn't be found you need to install the xutils-dev package<br />
./scripts/autogen.sh de<br />
cd de<br />
neon-env<br />
neonmake<br />
</syntaxhighlight><br />
<br />
After building the translations it is possible to either change the language in system settings, or run applications in another language using the environment variable <tt>KDE_LANG</tt>.<br />
<br />
<syntaxhighlight lang="bash"><br />
switchtonightly # or neon-env<br />
KDE_LANG=de kmail<br />
</syntaxhighlight><br />
<br />
Exit the shell to reset the settings.<br />
<br />
== Using Project Neon for documentation ==<br />
<br />
The Project Neon nightly source packages include the official KDE User Documentation in English.<br />
<br />
TODO: How to build user docs from SVN.<br />
<br />
== Using Project Neon for promotion ==<br />
<br />
If you are creating screenshots or screencasts of the latest version of KDE, project Neon is a simple and fast way of getting a default KDE4 session.<br />
<br />
The KDE Promotion team recommends using the default background, theme, icons etc when preparing official promotional materials (unless the feature you are showing is related to configuring KDE artwork). Project Neon uses the default artwork that comes with KDE4, so it is useful for creating promo materials.<br />
<br />
Here is a shortcut to get all available modules from the PPA:<br />
<br />
<syntaxhighlight lang="bash"><br />
sudo apt-get install project-neon-all<br />
</syntaxhighlight><br />
<br />
The application [http://ariya.blogspot.com/2008/06/creating-fancy-screenshots-with.html screenie] is provided since Kubuntu 8.10 as <tt>screenie-qt</tt>.<br />
<br />
<syntaxhighlight lang="bash"><br />
sudo apt-get install screenie-qt<br />
</syntaxhighlight><br />
<br />
== Contact the Team ==<br />
<br />
You can reach the Project Neon team on IRC in <br />
<syntaxhighlight lang="text">#project-neon on irc.freenode.net</syntaxhighlight><br />
by mail at <syntaxhighlight lang="text">neon@lists.launchpad.net</syntaxhighlight><br />
or you can ask a question on [https://answers.launchpad.net/project-neon launchpad]<br />
<br />
If you think there is a bug in our packaging of the provided software you can file a bug on [https://bugs.launchpad.net/project-neon launchpad]<br />
<br />
[https://wiki.kubuntu.org/Kubuntu/ProjectNeon Team page in the Kubuntu Wiki]</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:DBIndexItem&diff=79425Template:DBIndexItem2013-05-25T15:12:02Z<p>Claus chr: First working version</p>
<hr />
<div><noinclude>This template adds an item to the [[Documentation Primer/Manual/DocBook Reference/Index|index of DocBook commands]]. Usage: {{Input|1=<nowiki>{{DBIndexItem|General markup|acronym}}</nowiki>}}<br />
gives {{DBIndexItem|General markup|acronym}}<br />
----<br />
[[Category:Template]]<br />
</noinclude>* [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/{{{1}}}#{{{2}}}{{!}}{{Tag|{{{2}}}}}]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:DBIndexItem&diff=79424Template:DBIndexItem2013-05-25T15:09:11Z<p>Claus chr: </p>
<hr />
<div><noinclude>This template adds an item to the [[Documentation Primer/Manual/DocBook Reference/Index|index of DocBook commands]]. Usage: {{Input|1=<nowiki>{{DBIndexItem|Section|item}}</nowiki>}}<br />
gives {{DBIndexItem|Section|item}}<br />
----<br />
[[Category:Template]]<br />
</noinclude>* [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/{{{1}}}#{{{2}}}{{!}}{{Tag|{{{2}}}}}]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:DBIndexItem&diff=79423Template:DBIndexItem2013-05-25T15:05:40Z<p>Claus chr: </p>
<hr />
<div><noinclude>This template adds an item to the [[Documentation Primer/Manual/DocBook Reference/Index|index of DocBook commands]]. Usage: {{Input|1=<nowiki>{{DBIndexItem|Section|item}}</nowiki>}}<br />
gives {{DBIndexItem|Section|item}}<br />
----<br />
[[Category:Template]]<br />
</noinclude>* [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/{{{1}}}#{{{2}}}{{!}}{{Tag|{{{2}}}]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:DBIndexItem&diff=79422Template:DBIndexItem2013-05-25T15:04:24Z<p>Claus chr: </p>
<hr />
<div><noinclude>This template adds an item to the [[Documentation Primer/Manual/DocBook Reference/Index|index of DocBook commands]]. Usage: {{Input|1=<nowiki>{{DBIndexItem|Section|item}}</nowiki>}}<br />
gives {{DBIndexItem|Section|item}}<br />
----<br />
[[Category:Template]]<br />
</noinclude>* [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/{{{1}}}#{{{2}}}{{!}}{{Tag{{!}}{{{2}}}]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:DBIndexItem&diff=79421Template:DBIndexItem2013-05-25T15:03:42Z<p>Claus chr: </p>
<hr />
<div><noinclude>This template adds an item to the [[Documentation Primer/Manual/DocBook Reference/Index|index of DocBook commands]]. Usage: {{Input|1=<nowiki>{{DBIndexItem|Section|item}}</nowiki>}}<br />
gives {{DBIndexItem|Section|item}}<br />
----<br />
[[Category:Template]]<br />
</noinclude>* [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/{{{1}}}#{{{2}}}{{!}}{{Tag|{{{2}}}]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:DBIndexItem&diff=79420Template:DBIndexItem2013-05-25T15:02:41Z<p>Claus chr: </p>
<hr />
<div><noinclude>This template adds an item to the [[Documentation Primer/Manual/DocBook Reference/Index|index of DocBook commands]]. Usage: {{Input|1=<nowiki>{{DBIndexItem|Section|item}}</nowiki>}}<br />
gives {{DBIndexItem|Section|item}}<br />
----<br />
[[Category:Template]]<br />
</noinclude>* [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/{{{1}}}#{{{2}}}!{{Tag|{{{2}}}]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:DBIndexItem&diff=79419Template:DBIndexItem2013-05-25T15:01:17Z<p>Claus chr: Template for DocBook index</p>
<hr />
<div><noinclude>This template adds an item to the [[Documentation Primer/Manual/DocBook Reference/Index|index of DocBook commands]]. Usage: {{Input|1=<nowiki>{{DBIndexItem|Section|item}}</nowiki>}}<br />
gives {{DBIndexItem|Section|item}}<br />
----<br />
[[Category:Template]]<br />
</noinclude>* [[Special:myLanguage/Documentation Primer/Manual/DocBook Reference/{{{1}}}#{{{2}}}|{{Tag|{{{2}}}]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Transferring&diff=75137Template:Transferring2012-09-01T09:00:40Z<p>Claus chr: </p>
<hr />
<div>{{Info|1=These pages are being transferred from UserBase. Please don't work on them until the transfer is complete, and the old UserBase pages have been removed.}}<br />
<noinclude><br />
[[Category:Template]]<br />
</noinclude></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Transferring&diff=75135Template:Transferring2012-09-01T09:00:04Z<p>Claus chr: Created page with "{{Info|1=These pages are being transferred from UserBase. Please don't work on them until the transfer is complete, and the old UserBase pages have been removed.}}"</p>
<hr />
<div>{{Info|1=These pages are being transferred from UserBase. Please don't work on them until the transfer is complete, and the old UserBase pages have been removed.}}</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Warning&diff=75134Template:Warning2012-09-01T08:47:35Z<p>Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase</p>
<hr />
<div>{{Box1|2={{{2|Warning}}}|3=[[Image:Warning.png|noframe|left|40px]]|1={{{1}}} }}<br />
<noinclude><br />
This template displays an info box in the page. Syntax: <code><nowiki>{{Warning|2=title|1=text}}</nowiki></code><br />
# The body of the box<br />
# (optional) the title of the box - Translators: Consider creating a translated version of this template instead of using this parameter every time.<br />
<br />
Example: {{Input|1=<nowiki>{{Warning|1=This is a warning.}}</nowiki>}}<br />
{{Warning|1=This is a warning.}}<br />
<br />
[[Category:Template]]<br />
</noinclude></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Tip&diff=75132Template:Tip2012-09-01T08:47:35Z<p>Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase</p>
<hr />
<div>{{Box1|2={{{2|Tip}}}|3=[[Image:Ktip.png|left|40px|link=]]|4=alert-success|1={{{1}}} }}<br />
<noinclude><br />
This template displays an info box in the page. Syntax: <code><nowiki>{{Info|2=title|1=text}}</nowiki></code><br />
# The body of the box<br />
# (optional) the title of the box - Translators: Consider creating a translated version of this template instead of using this parameter every time.<br />
<br />
Example: {{Input|1=<nowiki>{{Tip|1=This is a tip.}}</nowiki>}}<br />
{{Tip|1=This is a tip.}}<br />
<br />
[[Category:Template]]<br />
</noinclude></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Output&diff=75130Template:Output2012-09-01T08:47:35Z<p>Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase</p>
<hr />
<div><noinclude><br />
This template should be used whenever you are indicating terminal output.<br />
<br />
==Usage==<br />
<br />
<nowiki>{{Output|1=output code, single line or block}}</nowiki><br />
<br />
which displays<br />
{{Output|1=output code, single line or block}}<br />
<br />
==See also==<br />
<br />
* [[Template:Input]] - similar box for inputs<br />
[[Category:Template]]<br />
----<br />
</noinclude><pr<includeonly></includeonly>e style="margin-left: 0em; background-color:gainsboro; border:2px dotted #BCBCBC;">{{{1}}}</pre></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:TagPair&diff=75128Template:TagPair2012-09-01T08:47:35Z<p>Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase</p>
<hr />
<div><noinclude>Dispaly a tag endtag pair with an item in between it the typewriter font: Example<br />
<br />
{{Input|1=<nowiki>{{TagPair|tag|content}}</nowiki>}}<br />
<br />
displays<br />
<br />
{{Output|1={{TagPair|tag|content}}}}<br />
----<br />
[[Category:Template]]<br />
</noinclude><tt>&lt;{{{1}}}&gt;{{{2}}}&lt;/{{{1}}}&gt;</tt></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Tag&diff=75126Template:Tag2012-09-01T08:47:35Z<p>Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase</p>
<hr />
<div><noinclude>This template displays a HTML/XML tag like &lt;span&gt; in a typewriter font. Usage: {{Input|1=<nowiki>{{Tag|span}}</nowiki>}}<br />
gives {{Tag|span}}<br />
----<br />
[[Category:Template]]<br />
</noinclude><tt>&lt;{{{1}}}&gt;</tt></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Note&diff=75124Template:Note2012-09-01T08:47:35Z<p>Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase</p>
<hr />
<div>{{Box1|2={{{2|Note}}}|3=[[Image:Note-box-icon.png|noframe|left|40px]]|4=alert-success|1={{{1}}} }}<br />
<noinclude><br />
This template displays an info box in the page. Syntax: <code><nowiki>{{Note|2=title|1=text}}</nowiki></code><br />
# The body of the box<br />
# (optional) the title of the box - Translators: Consider creating a translated version of this template instead of using this parameter every time.<br />
<br />
Example: {{Input|1=<nowiki>{{Note|1=Take note of this.}}</nowiki>}}<br />
{{Note|1=Take note of this.}}<br />
<br />
[[Category:Template]]<br />
</noinclude></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Entity&diff=75122Template:Entity2012-09-01T08:47:35Z<p>Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase</p>
<hr />
<div><noinclude>This template is used to display an HTML/XML entity like &amp;lt; in the typewriter font. Usage:{{Input|1=<nowiki>{{Entity|lt}}</nowiki>}} <br />
displays<br />
{{Entity|lt}}<br />
----<br />
[[Category:Template]]<br />
</noinclude><tt>&amp;{{{1}}};</tt></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Box&diff=75120Template:Box2012-09-01T08:47:35Z<p>Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase</p>
<hr />
<div><div class="alert {{{4}}}"><br />
<div style="float:left; valign:top">{{{3}}}</div><br />
<div style="width:10px; float:left">&nbsp;</div><br />
<table><tr><th>{{{2}}}</th></tr><tr><td>{{{1}}}</td></tr></table><br />
<div class="clearfix"></div><br />
</div><br />
<noinclude><br />
----<br />
Use this template for content that needs to be specially emphasized. Syntax: {{Input|1=<nowiki>{{Box1|2=Title|3=Image|4=color|1=text}}</nowiki>}}<br />
<br />
The template takes four arguments:<br />
# The text of the main body of the box<br />
# The title of the box<br />
# An image file to be displayed in the top left of the box - the image size should be 40 x 40<br />
# The background color (optional): possible values<br />
#* default is yellow<br />
#* ''alert-info'' gives blue - use with care; it doesn't work well with links<br />
#* ''alert-success'' gives green<br />
#* ''alert-error'' gives red<br />
<br />
Example: {{Input|1=<nowiki>{{Box1|2=Example|3=[[Image:Dialog-information.png|left|40px|link=]]|1=This is an example box}}</nowiki>}}<br />
{{Box1|2=Example|3=[[Image:Dialog-information.png|left|40px|link=]]|1=This is an example box}}<br />
<br />
Please avoid using this template directly in pages. If you need something that doesn't already exist, consider making a new template based on this template. That way it will be much easier to maintain TechBase, and the risk of introducing unintended effects on your page is reduced considerably.<br />
<br />
Existing templates based on this template: [[Template:Info]], [[Template:Note]], [[Template:Tip]], [[Template:Warning]], [[Template:Remember]].<br />
<br />
[[Category:Template]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Prevnext2&diff=75118Template:Prevnext22012-09-01T08:47:35Z<p>Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase</p>
<hr />
<div><includeonly><ul class="pager"><br />
<li>{{#if: {{{prevpage|}}} | [[{{{prevpage}}}|&larr; {{{prevtext|{{{prevpage}}}}}}]] | }}</li><br />
<li>'''{{#if: {{{index|}}} | [[{{{index}}}|&uarr; {{{indextext|{{PAGENAME}}}}} &uarr;]] | {{{indextext|{{PAGENAME}}}}}}}'''</li><br />
<li>{{#if: {{{nextpage|}}} | [[{{{nextpage}}}|{{{nexttext|{{{nextpage}}}}}} &rarr;]] | }}</li><br />
</ul></includeonly><noinclude><br />
<br />
The old code was<br />
{{Input|1=<nowiki><br />
<includeonly><table align=center id=toc style="width: 95%" class="noprint"><tr><br />
<td style="text-align: left; width: 33%">{{#if: {{{prevpage|}}} | [[{{{prevpage}}}|&larr; {{{prevtext|{{{prevpage}}}}}}]] | }}</td><br />
<td style="text-align: center; width: 33%">'''{{#if: {{{index|}}} | [[{{{index}}}|&uarr; {{{indextext|{{PAGENAME}}}}} &uarr;]] | {{{indextext|{{PAGENAME}}}}}}}'''</td><br />
<td style="text-align: right; width: 33%">{{#if: {{{nextpage|}}} | [[{{{nextpage}}}|{{{nexttext|{{{nextpage}}}}}} &rarr;]] | }}</td><br />
</tr></table></includeonly><noinclude></nowiki>}}<br />
<br />
{{Info|This template is a work-in-progress and will probably be re-named to something less obtuse quite soon, so avoid using it just at the moment.}}<br />
<br />
Use this template when you want to provide links to the previous and the next sections of the article so the user isn't forced to go back to the index to navigate.<br />
<br />
<br />
== Arguments ==<br />
<br />
<tt><nowiki>{{Prevnext2</nowiki><br><nowiki><br />
| prevpage = The path of the previous article.</nowiki><br><nowiki><br />
| prevtext = The link name for prevpage.*</nowiki><br><nowiki><br />
| nextpage = The path to the next article.*</nowiki><br><nowiki><br />
| nexttext = The link name for nextpage.*</nowiki><br><nowiki><br />
| index = The path to the manual index.*</nowiki><br><nowiki><br />
| indextext = The link name for index.*</nowiki><br><nowiki><br />
}}</nowiki></tt><br />
<br />
<br />
(* - Optional arguments.)<br />
<br />
== Example usage ==<br />
Writing this:<br />
<br />
<br><tt><nowiki>{{Prevnext2</nowiki><br><nowiki><br />
| prevpage=path/to/article | nextpage=path/to/article</nowiki><br><nowiki><br />
| prevtext=previous section| nexttext=The next section</nowiki><br><nowiki><br />
}}</nowiki></tt><br><br />
<br />
Gets you this:<br />
----<br />
{{Prevnext2<br />
| prevpage=path/to/article | nextpage=path/to/article<br />
| prevtext=previous section| nexttext=The next section<br />
}}<br />
----<br />
<br />
== Example usage: omitting arguments ==<br />
<br />
Writing this:<br />
<br />
<tt><nowiki>{{Prevnext2</nowiki><br><nowiki><br />
| nextpage=path/to/article</nowiki><br><nowiki><br />
| nexttext=The next section</nowiki><br><nowiki><br />
}}</nowiki></tt><br />
<br />
Gets you this:<br />
----<br />
{{Prevnext2<br />
| nextpage=path/to/article<br />
| nexttext=The next section<br />
}}<br />
----<br />
<br />
Writing this:<br />
<br />
<tt><nowiki>{{Prevnext2</nowiki><br><nowiki><br />
| prevpage=path/to/article</nowiki><br><nowiki><br />
| prevtext=previous section</nowiki><br><nowiki><br />
}}</nowiki></tt><br />
<br />
Gets you this:<br />
----<br />
{{Prevnext2<br />
| prevpage=path/to/article<br />
| prevtext=previous section<br />
}}<br />
----<br />
<br />
== Example usage: the least amount of typing ==<br />
Writing this:<br />
<br />
<tt><nowiki>{{Prevnext2</nowiki><br><nowiki><br />
| nextpage=path/to/article</nowiki><br><nowiki><br />
| prevpage=path/to/lastsection</nowiki><br><nowiki><br />
}}</nowiki></tt><br />
<br />
Gets you this:<br />
----<br />
{{Prevnext2<br />
| nextpage=path/to/article<br />
| prevpage=path/to/lastsection<br />
}}<br />
----<br />
<br />
== Example usage: including every argument ==<br />
<br />
Writing this:<br />
<br />
<tt><nowiki>{{Prevnext2</nowiki><br><nowiki><br />
| prevpage=path/to/article | nextpage=path/to/article</nowiki><br><nowiki><br />
| prevtext=previous section | nexttext=The next section</nowiki><br><nowiki><br />
| index= {{PAGENAME}}/Manual | indextext=Contents page</nowiki><br><nowiki><br />
}}</nowiki></tt><br />
<br />
Gets you this:<br />
----<br />
{{Prevnext2<br />
| prevpage=path/to/article | nextpage=path/to/article<br />
| prevtext=previous section | nexttext=The next section<br />
| index={{PAGENAME}}/Manual | indextext=Contents page<br />
}}<br />
----<br />
<br />
Writing this:<br />
<br />
<tt><nowiki>{{Prevnext2</nowiki><br><nowiki><br />
| nextpage=path/to/article</nowiki><br><nowiki><br />
| nexttext=The next section</nowiki><br><nowiki><br />
| indextext=Contents section</nowiki><br><nowiki><br />
}}</nowiki></tt><br />
<br />
Gets you this:<br />
----<br />
{{Prevnext2<br />
| nextpage=path/to/article<br />
| nexttext=The next section<br />
| indextext=Contents section<br />
}}<br />
----<br />
<br />
[[Category:Template]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Input&diff=75116Template:Input2012-09-01T08:47:35Z<p>Claus chr: 1 revision: Moving Docbook Primer from UserBase to TechBase</p>
<hr />
<div><noinclude><br />
This template should be used whenever you are indicating input commands.<br />
<br />
==Usage==<br />
<br />
<nowiki>{{Input|1=your code, single line or block}}</nowiki><br />
<br />
which displays<br />
{{Input|1=your code, single line or block}}<br />
<br />
== See also ==<br />
<br />
* [[Template:Output]] - similar box for outlining some output<br />
[[Category:Template]]<br />
----<br />
</noinclude><pr<includeonly></includeonly>e style="margin-left: 0em; background-color:lemonchiffon; border:2px dotted #BCBCBC;">{{{1}}}</pre></div>Claus chrhttps://techbase.kde.org/index.php?title=Schedules/KDE4/4.2_Upstream_Issues&diff=75048Schedules/KDE4/4.2 Upstream Issues2012-08-27T19:36:48Z<p>Claus chr: Box template should not be used anymore</p>
<hr />
<div>{{Info|2=Upstream Issues HotList|Listed below are various upstream issues that are considered release critical problems. This is not a bug tracker or meant to supplant one, but to keep a running tally of open upstream issues we need to address for the KDE4.2 release.}}<br />
<br />
== Qt4 ==<br />
* '''Problem''': Random crashes in painting code<br />
** Affects: KMail<br />
** Solution: Apply qt-copy patch 0256:fix-recursive-backingstore-sync-crash.diff<br />
** Status: Reported to upstream (N227209, but no task ID yet). KDE Bug [http://bugs.kde.org/show_bug.cgi?id=174065 174065].<br />
<br />
* '''Problem''': <br />
** Affects: <br />
** Solution: <br />
** Status:<br />
<br />
== Opensync ==<br />
* '''Problem''': kdepim's kitchensync and Akonadi opensync plugin require Opensync 0.40, which hasn't been released yet.<br />
** Affects: kdepim's kitchensync and Akonadi opensync plugin, which will need to be disabled otherwise.<br />
** Solution: Opensync 0.40 must be released<br />
** Status: Opensync developers have been contacted. They are in testing.</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:OBS&diff=75047Template:OBS2012-08-27T19:35:34Z<p>Claus chr: Modifications to make template work well with neverland</p>
<hr />
<div>{{Box1|2=OBS:|3=[[Image:Action_pen.svg|noframe|left|40px]]|1={{{1}}} }}<br />
<noinclude><br />
[[Category:Template]]<br />
</noinclude></div>Claus chrhttps://techbase.kde.org/index.php?title=Schedules/Is_KDE_4.1_for_you%3F&diff=75046Schedules/Is KDE 4.1 for you?2012-08-27T19:34:19Z<p>Claus chr: Box template should not be used anymore</p>
<hr />
<div>KDE 4.1 was released at the end of July 2008. This is a significant milestone for the KDE 4 series and for KDE in general, but as an early <br />
release in the KDE 4 cycle, it does have some known issues which will not be fixed in KDE 4.1. Huge progress has been made in KDE 4.1 which is listed in the [[Schedules/KDE4/4.1_Feature_Plan|KDE 4.1 Feature Plan]].<br />
<br />
Some of the more obvious issues are listed below. If these issues are important to you, you should stay with KDE 3.5 (KDE 3.5.10 was released in [[Schedules/KDE_3.5_Release_Schedule#August_2008:_Expected_release_date_of_KDE_3.5.10|August 2008]]) until KDE 4.2 is released (scheduled for release in [[Schedules/KDE4/4.2_Release_Schedule|January 2009]]) when most of these issues are scheduled to be resolved.<br />
<br />
It is possible that distributions will work around some of these issues before distributing to users.<br />
<br />
== Graphics Performance ==<br />
<br />
Users of NVidia cards with the binary driver provided by NVidia might suffer from performance problems in window switching and resizing. A fixed NVidia driver has been [http://www.nvidia.com/object/unix.html released.]<br />
<br />
== The Desktop ==<br />
<br />
The desktop in KDE 4.1 will mark the start of some significant user interface changes. This is a step away from the way the KDE 3 desktop was<br />
designed, but everything possible on your KDE 3.5.9 desktop will also be possible on your KDE 4 desktop. For KDE 4.1, however, some features <br />
are not yet complete, but should be ready for KDE 4.2.<br />
<br />
=== FolderView ===<br />
<br />
{{Box1|2=Under Construction|3=[[Image:Action_configure.svg|noframe|left|40px]]|1=<br />
'''This page is under construction'''. This section could really do with some screenshots on the page. You can help by [{{fullurl:{{PAGENAME}}|action=edit}} editing this page]. }}<br />
<br />
FolderView is a new technology on the KDE 4 desktop which allows more than one collection of icons on your "desktop". However, it can still be configured to behave much like KDE 3 did. See [http://blog.lydiapintscher.de/2008/06/14/folderview-is-the-awesome/ this blog entry by Lydia Pintscher] for some more information on FolderView.<br />
<br />
The following issues are known and are scheduled to be resolved in KDE 4.2:<br />
* Icons do not need to be in a grid: you can drag them to any point within the FolderView. However, the location you leave them in is not saved, so they will be in a grid again the next time you start the desktop.<br />
* You can have a full screen "desktop with icons", but if you do, you can not have a desktop background. See also: http://www.youtube.com/watch?v=RhYinDOKbE8<br />
* You can have a desktop background, but then you must use the FolderView in regular, not entire screen mode (as shown in Lydia's blog above).<br />
<br />
=== Panels and workspaces ===<br />
<br />
Some panel issues can be resolved before KDE 4.2. Because of the modular design of Plasma, a new panel could be quite easily written with autohide functionality. This would likely be written by a distribution team or a developer on kde-apps.org.<br />
<br />
* Autohiding of panels is not yet configurable.<br />
* It is not possible to set different desktop wallpapers for different virtual desktops.<br />
* The Mac-style menu bar is not available.<br />
<br />
=== Session management ===<br />
<br />
Session management is not fully implemented yet, at least not as you're used to from KDE 3.5. Some of these features might get implemented in a 4.1.x release.<br />
<br />
* Even though the System Settings module offers you an option to start your day with a Manually Saved Session, there's no option yet in the menu to actually save one. The functionality is available via D-Bus though and some distributions already include patches to fix this. See [http://bugs.kde.org/show_bug.cgi?id=155341 bug 155341] for details.<br />
* For a number of applications, e.g. Konsole, sessions do not get restored.<br />
<br />
== Applications ==<br />
<br />
=== New and missing applications ===<br />
Some KDE 3 applications have not yet been ported to KDE 4. Most distributions still package KDE 3 versions of these applications with their KDE 4 desktop. Some notable applications which will not be included in KDE 4.1 are listed below:<br />
<br />
'''Projects with a different release schedule than KDE4.'''<br />
<br />
Project (Current Version - Final Release Date)<br />
* [http://www.digikam.org/ digiKam] ([http://www.digikam.org/drupal/node/416 Beta 7] - Early 2009)<br />
[http://www.digikam.org/drupal/about/releaseplan Digikam 0.10.0 Release Plan]<br />
<br />
* [http://www.krusader.org Krusader 2.0] ([http://www.krusader.org/text.php?t=krusader-2.0.0-beta2.notes Beta 2] - Unknown)<br />
Krusader is an advanced twin panel (commander style) file manager.<br />
<br />
* [http://www.koffice.org/ KOffice 2.0] ([http://www.koffice.org/news.php#itemKOffice20beta4released Beta 4] - Spring 2009)<br />
Binaries are available for all three major platforms. The developers are looking for volunteers to help put together screenshots for [http://www.kdedevelopers.org/node/3545 visual changelogs].<br />
<br />
* [http://amarok.kde.org/ Amarok 2.0] ([http://amarok.kde.org/de/node/595 2.0 Released - December 2008])<br />
Amarok 2.0 was released on 10 December 2008.<br />
<br />
* [http://k3b.plainblack.com/ k3b 1.1] (Pre-Alpha - Unknown)<br />
An alpha release of 1.1 (the KDE 4 port) is forthcoming, but not yet released.<br />
<br />
* [http://kaffeine.kde.org/ Kaffeine] (Pre-Alpha - Unknown) <br />
The KDE4 port is under way but requires major rewriting to support Phonon and other new features. No releases scheduled at this time.<br />
<br />
* [http://kplayer.sourceforge.net/ KPlayer 0.7] (Released January 11 2008) <br />
KPlayer 0.7 is the KDE4 port of KPlayer that was released on the same day as KDE 4.0. KPlayer 0.7.1 is planned for fall 2008 and will include a KDE4 port of its multimedia library which still used KDE3 compatibility layer in version 0.7.0.<br />
<br />
* [http://basket.kde.org/ Basket] (1.0.3.1 (KDE3) - Released June 30 2008)<br />
The KDE4 port of Basket is currently in a pre-alpha state.<br />
<br />
* [http://konversation.kde.org/ Konversation 2.0] (Pre-Alpha - Unknown)<br />
The KDE4 port will not be released to sometime after version 1.1, which will be the last KDE3 release.<br />
<br />
*There are also several [http://games.kde.org/ KDE games] that do not have a KDE 4 port yet. Among these are kasteroids, kfouleggs.<br />
<br />
* [http://www.kdevelop.org/ KDevelop 4.0] (Pre-Alpha - Unknown)<br />
An alpha release of 4.0 (a rewritten from scratch version) [http://www.kdevelop.org/mediawiki/index.php/KDevelop_4/KDev3_KDev4_comparison_table is forthcoming], but not yet released. Normal users should continue to use the [http://www.kdevelop.org/index.html?filename=3.5/download.html stable KDevelop 3.5.2] version for the time being.<br />
<br />
<!-- Got more info on this? A bug number? A mailing list thread? Will this not be added before KDE 4.2 or is it KDE 4.1 material? <br />
Removing for now. Login to techbase and use the talk page for more information<br />
--><br />
<!--<br />
== Misc. Features ==<br />
<br />
* HTTP proxy support hasn't been ported yet. SOCKS proxies should work fine, however. <br />
--></div>Claus chrhttps://techbase.kde.org/index.php?title=Projects/Utils/kwallet/FeaturePlan42&diff=75045Projects/Utils/kwallet/FeaturePlan422012-08-27T19:31:50Z<p>Claus chr: Box template should not be used anymore</p>
<hr />
<div><br />
<br />
== General ideas ==<br />
<br />
=== Single signon ===<br />
<br />
The user shouldn't have to enter his password twice (once for logging in, once for opening the default wallet). The main problem is that the wallet will still have to be password protected, so we need a way to transmit the password to the daemon.<br />
<br />
Gnome keyring provide a [http://live.gnome.org/GnomeKeyring/Pam hack] (is it?) for this:<br />
{{Info|2=How it works|<br />
Upon authenticating the user, or logging into the session, the PAM module checks for the GNOME_KEYRING_SOCKET environment variable. If not present it assumes that gnome-keyring-daemon is not running for that session.<br />
*If the auto_start argument is present in in the PAM config, it then starts it as a daemon. <br />
*The gnome-session process does the same checks, which prevents it from starting twice. <br />
Upon authenticating the user, the PAM module tries to unlock the 'login' keyring with the password entered by the user. <br />
*If the 'login' keyring does not exist it is created with the user's password. <br />
*If the 'login' is the first and only keyring it will become the default keyring.|500px|center}}<br />
<br />
We could basically do something quite similar to this for kwallet:<br />
* Extract the kwalletd to run standalone.<br />
* Adapt/rewrite the gnome mini-pam module to start kwalletd and pipe the password to it using some sort of socket.<br />
* This would probably have to be optional (default policy might be to NOT enable it and let the user choose the level of security he wants).<br />
* It's important to consider security implications.<br />
<br />
Sascha Peilicke will look into this matters and come up with a plan. This is a core issue so we'll have to discuss it on kcd.<br />
<br />
<br />
=== Inter-desktop integration ===<br />
<br />
Sascha proposed making kwallet/keyring cross-desktop so the user would need only a single authentication backend running. For this to work we'd either need a single API and multiple implementations or a common backend implementation - probably something for freedesktop.org. Coordinating that would take a hell lot of time so this is more or less a long-term goal. In the process we have to consider binary API compatibility.<br />
<br />
It would also be nice to have software not tied to a desktop use this (ie. Firefox).<br />
<br />
<br />
=== Make sure passwords are saved ===<br />
<br />
<s>This relates to Bug {{Bug|105752}}. We should come up with a way to store passwords before a session crashes. Of course shouldn't disturb the user (which is why I ([[User:Lemma|Lemma]]) don't like the timed solution proposed by a comment in this report). Complete rewrites of the kwl file should happen at points in time when the user is used to waiting (ie. opening the wallet after a crash, saving the session).<br />
<br />
General idea: On adding new passwords, append the encrypted password entries to the kwl file without rewriting it completely. If the session crashes the passwords are still here. The kwl file could be cleaned up upon reopening the wallet. As far as I know this might work. We'll see.</s><br />
<br />
This is already fixed and will be in 4.1. Benchmarking showed that syncing the wallet on every change (with a very small timer) is feasible.<br />
<br />
=== Use QCA ===<br />
<br />
Currently kwallet uses its own implementations of MD5, SHA-1 and Blowfish to encrypt the wallet. While SHA-1 is probably still safe enough it might not be in the future. Therefore switching to an external library to handle encryption will not only simplify the code but also provide more choices for hashing/encryption algorithms.<br />
<br />
=== Save more information ===<br />
<br />
This hasn't been talked about yet, but I'd like to additionally store the date of creation and the date of modification for a wallet entry. No API changes are needed for that as all the work could be done by the backend transparently. One thing that would require an API change is commenting on the entries. This could be used to make obscure entries (like the ones by kmail) more transparent to the user.<br />
<br />
=== Overhaul the interface ===<br />
<br />
The interface will have to be reworked. We were talking about:<br />
* Overall goal:<br />
** Make the manager a little shinier and a breeze to use<br />
** Make it a program that eases managing personal account data rather than an editor for account data stored by various programs (yes, I know it already is, but the emphasis is on EASES :-)).<br />
* Using model/view classes<br />
* Improving usability (have a look at various bugreports concerning that)<br />
* The current gui only provides basic undo support (you can only undo changes to a password/map that hasn't been saved yet). I think we could improve on that - it has to be "secure enough" though as I don't like the idea of having passwords stick around everywhere in memory.<br />
* Maybe choose a one-window solution instead of the current two-window solution<br />
* No need to reinvent the wheel, learn from what others have done, eg:<br />
** [http://en.wikipedia.org/wiki/Image:Keychainaccess.png Apple Keychain]<br />
<br />
<br />
=== Access Granularity Management ===<br />
KWallet provides all or nothing access to the password store. This is a security problem, because it enables application A in principle to access keys of application b. <br />
<br />
Possible solutions: <br />
* Ownership model (application can only read values it has created). Here the problem of how to identify applications arises. <br />
* If application wants to access data it has not created, the user is presented with the precise keys the application wants to read and can make an informed decision.<br />
* Possibly rights management for keys is required. (For example, to allow the user to configure that subversion and subclipse both can read/write the SVN password).</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Attention&diff=75044Template:Attention2012-08-27T19:27:47Z<p>Claus chr: Modifications to make template work well with neverland</p>
<hr />
<div>{{Box1|2={{{2|Attention}}}|3=[[Image:Warning.png|left|40px|link=]]|1={{{1}}} }}<br />
<noinclude><br />
[[Category:Template]]<br />
</noinclude></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Todo&diff=75043Template:Todo2012-08-27T19:26:32Z<p>Claus chr: Modifications to make template work well with neverland</p>
<hr />
<div>{{Box1|2={{{2|'''TODO'''}}}|3=[[Image:Action_stop.png|noframe|left|40px]]|1={{{1}}} }}<br />
<noinclude><br />
<br />
[[Category:Template]]<br />
</noinclude></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:BeingEdited&diff=75042Template:BeingEdited2012-08-27T19:25:07Z<p>Claus chr: Modifications to make template work well with neverland</p>
<hr />
<div>{{Box1|2={{{2|Currently Being Edited}}}|3=[[Image:Being_edited.png|left|40px|link=]]|1='''This page is currently being edited.'''<br />If this notice persists for an unreasonable time, please either notify irc.freenode.org #kde-www or report on [[User_talk:Annew|Annewilson's Talk page]]. }}<br />
<noinclude><br />
To use, add <nowiki>{{Being_Edited}}</nowiki> where it is to be displayed.<br />
[[Category:Template]]<br />
</noinclude></div>Claus chrhttps://techbase.kde.org/index.php?title=Schedules/KDE4/4.0_Upstream_Issues&diff=75040Schedules/KDE4/4.0 Upstream Issues2012-08-27T18:35:05Z<p>Claus chr: Box template should not be used anymore</p>
<hr />
<div>{{Info|2=Upstream Issues HotList|Listed below are various upstream issues that are considered release critical problems. This is not a bug tracker or meant to supplant one, but to keep a running tally of open upstream issues we need to address for KDE4 releases.}}<br />
<br />
== Qt4 ==<br />
* '''Problem''': CSS currently resets fonts in widgets when used, making it very difficult to use with widgets where fonts are set programmatically as done throughout KDE.<br />
** Affects: All widgets using CSS, such as the Konqueror location bar when using CSS to set an offset for the clear button.<br />
** Solution: Pending; perhaps a CSS value (font: QWidget?) that prevents the style sheet from resetting fonts outside of what the widget is doing. Can be done currently on a case-by-case basis by overriding changeEvent, intercepting font changes and updating CSS strings containing the font desired; this is error prone (easy to trigger infinite loops) and seems sub-optimal.<br />
** Status: Fixed for Qt4.4, CSS will only touch the font values explicitly mentioned in the style sheet and leave other values alone<br />
<br />
* '''Problem''': Designer converts WhatsThis text to richtext blocks<br />
** Affects: translators who get opaque blocks of html code<br />
** Solution: None yet<br />
** Status: Fixed for Qt4.4, patch being reviewed for qt-copy<br />
** [http://trolltech.com/developer/task-tracker/index_html?id=187205&method=entry Upstream tracker link]<br />
<br />
== Xine ==<br />
* '''Problem''': short Oggs are not played properly<br />
** Affects: Phonon playing short sounds, therefore all audio notification in KDE<br />
** Solution: Patch being worked on by Matthias Kretz, needs to be upstreamed to libxine<br />
** Status: Patch sent, fixed in xine-lib 1.1.9</div>Claus chrhttps://techbase.kde.org/index.php?title=Projects/Contributor_Paths&diff=75037Projects/Contributor Paths2012-08-27T17:47:39Z<p>Claus chr: Box template should not be used anymore</p>
<hr />
<div>This is a temporary page to hold information about creating techbase pages for contributor paths. The idea is to reorganize the tutorials already present on techbase into categories to teach new people to contribute. The focus is on lowering the barrier to entry, and identifying gaps in the techbase tutorials.<br />
<br />
The original thread is here:<br />
http://thread.gmane.org/gmane.comp.kde.devel.core/55248<br />
<br />
What I'm looking for is <br />
* '''Consensus''' - Is this a good idea and something we want?<br />
* '''Correctness''' - As I know nothing about artists work, I don't know if creating icons is harder than creating themes, and I don't know if the steps in the path are correct. Similar for the others (docs, translation, etc)<br />
* '''Collaboration''' - Will you help fill the gaps in the techbase documentation?<br />
<br />
== Followups here ==<br />
* [http://thread.gmane.org/gmane.comp.kde.devel.general/56132 Developer]<br />
* [http://thread.gmane.org/gmane.comp.kde.artists/5582 Artist]<br />
* [http://thread.gmane.org/gmane.comp.kde.devel.internationalization-and-documentation/15942 Documenter]<br />
* [http://thread.gmane.org/gmane.comp.kde.devel.internationalization-and-documentation/15941 Translator]<br />
* Bugsquad - [ link]<br />
* [http://lists.kde.org/?l=kde-usability&m=123056383919172&w=2 Usability Team]<br />
* [http://lists.kde.org/?l=kde-promo&m=123056251917223&w=2 Promotion Team]<br />
* [http://thread.gmane.org/gmane.comp.kde.www/355 Websites Team]<br />
<br />
<br />
== Draft of 'root' page ==<br />
Box is a bad template to use for this stuff. We can do a lot better, but you get the idea<br />
<br />
***********<br />
<br />
This page is a starting point for people who want to become KDE contributors. <br />
<br />
{{Info|2=Become a KDE Developer|<br />
Start on the [[Paths/Developer|Developer path]] <br />
}}<br />
<br />
{{Info|2=Become a KDE Artist|<br />
Start on the [[Paths/Artist|Artist path]] <br />
}}<br />
<br />
{{Info|2=Become a KDE Documenter|<br />
Start on the [[Paths/Documenter|Documenter path]] <br />
}}<br />
<br />
{{Info|2=Become a KDE Translator|<br />
Start on the [[Paths/Translator|Translator path]] <br />
}}<br />
<br />
{{Info|2=Join the KDE Bugsquad|<br />
Start on the [[Paths/Bugsquad|Bugsquad path]] <br />
}}<br />
<br />
{{Info|2=Join the KDE Usability Team|<br />
Start on the [[Paths/Usability|Usability path]] <br />
}}<br />
<br />
{{Info|2=Join the KDE Promotion Team|<br />
Start on the [[Paths/Promotion|Promotion path]] <br />
}}<br />
<br />
{{Info|2=Join the KDE Websites Team|<br />
Start on the [[Paths/Websites|Websites path]] <br />
}}</div>Claus chrhttps://techbase.kde.org/index.php?title=Template:TODO&diff=75036Template:TODO2012-08-27T17:41:56Z<p>Claus chr: Modifications to make template work well with neverland</p>
<hr />
<div><noinclude><br />
{{Template}}<br />
<br />
Included content begins<br />
----<br />
</noinclude><br />
{{Box1|2=TODO|3=[[Image:Action_todo.svg|noframe|left|40px]]|1={{{1}}} }}<br />
<noinclude><br />
----<br />
Included content ends<br />
[[Category:Template]]<br />
</noinclude></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Under_Construction&diff=75035Template:Under Construction2012-08-27T17:38:58Z<p>Claus chr: Modifications to make template work well with neverland</p>
<hr />
<div><noinclude><br />
{{Template}}<br />
<br />
Included content begins<br />
----<br />
</noinclude><br />
{{Box1|2=Under Construction|3=[[Image:Action_configure.svg|noframe|left|40px]]<br />
|1='''This page is under construction'''. This page is actively being developed and updated with new information, and may be incomplete. You can help by [{{fullurl:{{PAGENAME}}|action=edit}} editing this page]<br />
}}<br />
<noinclude><br />
----<br />
Included content ends<br />
[[Category:Template]]<br />
</noinclude></div>Claus chrhttps://techbase.kde.org/index.php?title=Schedules/KOffice_1.6_Release_Schedule&diff=75034Schedules/KOffice 1.6 Release Schedule2012-08-27T17:21:10Z<p>Claus chr: Box template should not be used anymore</p>
<hr />
<div>All dates given here are subject to revision, but we will try our best to stick to them if possible.<br /><br /><br />
[mailto:cyb@lepi.org Cyrille Berger] is acting as release coordinator for the KOffice 1.6 release.<br /><br /><br />
KOffice 1.6 will be released independently from KDE. But new development will only happens for a few applications (mostly Krita, Kexi and KChart), other applications are developed for the version 2.0 of koffice.<br />
<br />
==The genesis of the 1.6 version==<br />
===Beginning of April, 2006===<br />
The development for the 1.6 branch is started only for Krita, Kexi, KChart and KPlato, other parts of koffice are closed for now.<br />
<br />
==KOffice 1.6 Alpha 1==<br />
===July 10, 2006===<br />
The 1.5 branch is officially close for bug fixes, except critical ones, all bug fixes must be applied to the 1.6 branch.<br />
<br />
===August 1, 2006===<br />
An alpha version of KOffice 1.6 is released.<br />
<br />
==KOffice 1.6 Beta 1==<br />
===August 15, 2006===<br />
From that date, developers are asked to be carefull about the modification they make, no big changes, even if, adding small new features is still allowed. This is needed if we want to shorten the release cycle and still be sure to deliver a high quality new version. <br />
<br />
===September 1, 2006===<br />
The 1.6 branch of KOffice is frozen: no new features, bugfixes commits only, no commit that modifies an application's behaviour, and message freeze. <br />
<br />
===September 1, 2006===<br />
KOffice is tagged KOFFICE_1_6_BETA1. Tarballs are made out of KOffice, for <br />
<br />
==KOffice 1.6 Beta 1==<br />
They are made public immediately, and given to packagers for creation of binary packages. <br />
<br />
===September 9, 2006===<br />
Announce KOffice 1.6 Beta 1. <br />
===September 13, 2006===<br />
And documentation is frozen. <br />
<br />
==KOffice 1.6 RC1==<br />
===September 18, 2006===<br />
Tag l10n for 1.6 rc1. <br />
<br />
===September 19, 2006===<br />
Tag KOffice 1.6 rc1 (tags/koffice/1.6-rc1). Test the tarballs. <br /><br />
This week is for packagers to create binary packages. <br />
<br />
===September 26, 2006===<br />
Announce KOffice 1.6 RC 1 <br />
<br />
==KOffice 1.6 Final==<br />
===October 6, 2006===<br />
Tag KOffice 1.6 final version (tags/koffice/1.6.0). Test the tarballs. <br /><br />
This week is for packagers to create binary packages. <br />
<br />
===October 14, 2006===<br />
The source and binary packages are uploaded to ftp.kde.org to give some time for the mirrors to get them. <br />
<br />
===October 15, 2006===<br />
Announce KOffice 1.6 <br />
<br />
==KOffice 1.6.1==<br />
===From October 16, 2006 to October 22, 2006===<br />
String freeze lift for kexi. <br />
<br />
===November 6, 2006===<br />
Tag 1.6.1 (tags/koffice/1.6.1). <br />
<br />
===November 29, 2006===<br />
Release 1.6.1. <br />
<br />
==KOffice 1.6.2==<br />
===From November 30, 2006 to December 7, 2006===<br />
String freeze lift for kexi. <br />
<br />
===February 7, 2007===<br />
Tag 1.6.2 (tags/koffice/1.6.2). <br />
<br />
===February 14, 2007===<br />
Release 1.6.2. <br />
<br />
==KOffice 1.6.3==<br />
===May 30, 2007===<br />
Tag 1.6.3 (tags/koffice/1.6.3).<br />
<br />
===June 6, 2007===<br />
Release 1.6.3.<br />
<br />
<br /><br /><br />
{{Note| 1.6.3 will be the last revision of the 1.6 serie.}}<br />
<br /><br /><br />
<br />
==Frequently Asked Questions==<br />
;Which version of Qt is required?<br />
Qt 3.3 or later, but not Qt 4.X <br />
;Which version of kdelibs is required?<br />
kdelibs 3.3 or later, but not kdelibs 4.X</div>Claus chrhttps://techbase.kde.org/index.php?title=Development/Tutorials/API_Documentation&diff=75033Development/Tutorials/API Documentation2012-08-27T17:19:46Z<p>Claus chr: Box template should not be used anymore</p>
<hr />
<div><br />
__TOC__<br />
{{Info|2=Definition|<br />
'''API (''Application Programming Interface'') documentation''' is documentation that applies to ''a program'' and its interfaces. It is documentation that explains to a developer who is going to work with the program, or a developer who is going to work on a program, how things work and what methods are there to call.<br />
<br />
API documentation is sometimes called an API reference manual. It needn't ''just'' be a reference manual, though, there can be extensive additional material, like tutorials, histories, etc. In this page, we will refer to all the material that documents and explains the API of a piece of code as "apidox."<br />
<br />
Good apidox take some effort to write -- but I would say less than good ''user'' documentation, since you as a developer are writing for another developer, and explaining how code works and what it is supposed to do. So your audience is clear to start with. The benefits of apidox come when someone else (or maybe even you several months later) needs to (re)use the code, or extend it. Good apidox means that someone new can show up, understand your code, and produce meaningful patches (that is, ''help'') all the more quickly. Especially for libraries, good apidox make the library usable as a black box (and that's how they should be) because all the needed documentation is available in the apidox and not hidden in the (perhaps inaccessible) C code.}}<br />
<br />
== Preamble ==<br />
<br />
APIDOX are what make a program accessible to other contributors. They are not essential, but they certainly help a great deal for new people who want to work on your code, or better yet, re-use it elsewhere with a minimum of modification.<br />
<br />
Look at the [http://doc.trolltech.com/latest/ Qt documentation] to get a feeling of what good apidox look like. There is a consistency of style, a thoroughness which permeates all the documentation. It is possible to learn a lot about Qt just from reading the documentation. You do not necessarily need to run the tutorial programs or read the source code of the library to find out what a parameter flags does in some method of the library. It is all spelled out for you. <br />
<br />
Writing apidox is a two-part process. One part is technical: you need to understand the code you are documenting -- or at least know what it is supposed to do and how it is meant to be used. The other part is plain discipline: apidox are most useful when they are exhaustive.<br />
<br />
This document is going to try to prevent the apidox process from becoming exhausting, by giving straightforward tips about how to write apidox. There are also the [[Policies/Library Documentation Policy|library apidox policies]], which are much stricter, which provide measurable properties that apidox must adhere to. It does not hurt to glance at them now.<br />
<br />
== APIDOX Basics ==<br />
<br />
APIDOX are processed by the [http://www.doxygen.org Doxygen] documentation tool. This tool reads source code for your application (or library) and produces nicely formatted documentation from it. There is a good [http://www.stack.nl/~dimitri/doxygen/manual.html reference manual] available -- but let's hope to make it unnecessary to read, for basic use anyway.<br />
<br />
{{Tip|You don't even need to have Doxygen installed to work on apidox for your application. Every few hours, the [http://www.englishbreakfastnetwork.org/ EnglishBreakfastNetwork] compiles apidox for all of the KDE modules we know about. Logfiles are kept and you can see your apidox on the site, or read the error messages and fix those. ...it might not be the fastest way to write and fix apidox, but it gets the job done, and if you spend just an hour at the end of the day writing some apidox, it's sufficiently useful.}}<br />
<br />
{{Tip|If you do have Doxygen installed and want to build the apidox, use the method described in [[Development/Tools/apidox|apidox]].}}<br />
<br />
Basic apidox are fun and simple: you write comments in your code explaining what things are supposed to be for. These comments are nearly indistinguishable from stuff you would be writing in the headers of your code ''anyway'', so that's not hard to do.<br />
<br />
APIDOX are written in special comments. These comments start with /** (slash, star, star) -- that's what makes them special. The rest of the content of the comment is just plain text describing a part of your program. The plain text is interpreted by the Doxygen processor, so that you can write accurate descriptions of parameters, return types, and do some basic text markup. But documentation can be very straighforward: just write down what a method does, surrounded by /** and */, like this:<br />
<br />
<syntaxhighlight lang="cpp-qt"><br />
/** This method increases the sexyness of Kontact and should as<br />
* such be called whenever possible (i.e. instead of having idle<br />
* time, you might think of calling this method and helping<br />
* Kontact gain even more popularity). You might even insert it<br />
* into your own event loop to ensure it is called as often as<br />
* possible. If these calls decrease the number of new features,<br />
* it's still no problem to call it. <br />
*/<br />
void incSexyness(KInstance *instance);<br />
</syntaxhighlight><br />
<br />
For proper apidox, you need to document every "thing" in your program. "Things" here are directories, files, namespaces, classes, methods, enums, and member variables. You can actually leave out files and directories, and concentrate on the latter. Complete apidox looks something like this:<br />
<br />
<syntaxhighlight lang="cpp-qt"><br />
/** Namespace for KDE network-related classes */<br />
namespace KDENetwork {<br />
/** Wrapper for a TCP/IP socket */<br />
class Socket {<br />
public:<br />
/** Constructor. Calls listen() on some random high port. */<br />
Socket();<br />
private:<br />
int fd;<br />
};<br />
}<br />
</syntaxhighlight><br />
<br />
You can see here that each nesting level of "things" is documented with a comment -- the namespace, the class and the method. Things that are private do not need apidox, but things that are protected do.<br />
<br />
It is important to document each level of nesting, because if you leave one level out, Doxygen will ignore the documentation in inner nesting levels, and you will be left wondering where it has gone. For instance, if we leave out the class documentation, then the method documentation for Socket() will vanish as well. This is one of the common pitfalls to writing apidox.<br />
<br />
If you just do this -- write an explanation for every part of your program -- then you're already a long way on the road to having complete apidox. Writing all those explanations makes your program more accessible to other developers -- and often shows you where the design or choice of names is sub-optimal. So it's a win for you both ways.<br />
<br />
You can consult the list of supported tags for examples of more fancy apidox -- explaining parameters, for instance, and annotating the apidox with credits and examples. It's also worthwhile to take a look at the section on enabling apidox, but it's also fine to divide the work: you write the apidox themselves, and ask me (mailto:groot@kde.org) to enable apidox generation for your module. And I will.<br />
<br />
== Writing APIDOX in New Code ==<br />
<br />
If you are writing new code and want to write apidox, use KDevelop. Really. Properly configured, it can automatically set up all the skeletons for apidox that you need, and what you do is write the descriptions. No messing with apidox commands.<br />
<br />
If you're not in that fortunate position, the following little checklist should get you through the worst of writing apidox. <br />
<br />
'''1. Write apidox as you code'''<br />
<br />
The discipline it takes to write down the apidox for function foo() now as you are thinking of foo() and what it needs to do more than compensates the effort later where you have to remember what foo() was supposed to do, anyway.<br />
<br />
This isn't to say you have to do it this way, but it is convenient. The apidox also document design decisions. They also document what you want a particular piece of code to do, regardless of what it actually does. That makes it possible to independently check that the code does what it's supposed to: because it's written down. <br />
<br />
'''2. Document your headers completely'''<br />
<br />
The headers are what's most visible to users (in this context, users are developers who are re-using) of your code, and they should be complete. Document each structural bit of the headers as you go along. This means:<br />
<br />
*Every file should have a file-level comment. This is suggested in the KDE guidelines anyway -- near the top of your file, write down what the file is for, vaguely what it defines. Wrap this up in a /** @file */ comment and you are set.<br />
*Every namespace should have a comment. A given namespace only needs a comment once in your source tree (or within one bunch of files that generate apidox together), but it can't hurt to repeat the description on each occasion -- just make it brief. These comments are just plain apidox comments wrapped up in /** */ ; there are no special markups needed like the @file for file comments.<br />Do make sure the comment is just before the namespace and doesn't get distanced from the namespace it documents. The following is fine:<br />
<syntaxhighlight lang="cpp-qt">/** The Ungulate namespace collects classes and methods<br />
pertaining to hooved animals. */<br />
<br />
namespace Ungulate {<br />
</syntaxhighlight><br />
:In the next example, someone has snuck in some extra stuff between the apidox comment and the namespace it is documenting. This may cause Doxygen errors (so then it is easy to spot) or it may cause the namespace documentation to attach to something wildly different (and then it's hard to spot).<br />
<syntaxhighlight lang="cpp-qt"><br />
/** The Ungulate namespace collects classes and methods<br />
pertaining to hooved animals. */<br />
class Mammal;<br />
namespace Ungulate {<br />
</syntaxhighlight><br />
:There is not much you can do about this except to be watching when you insert code -- don't separate apidox from the thing they are documenting.<br />
*Every class should have a comment. Classes are the important building blocks of your application or library, so this is one place where writing lots helps. Write down why the class exists. Write down what it is supposed to do. Give an example of how to use it. Explain how not to use it, or what prerequisites it has (for instance, lots of classes need a KInstance object, but don't document that explicitly).<br />The same caveats apply as with namespace apidox: make sure the class follows its apidox immediately.<br />
*Every method should have a comment explaining what it does and what the parameters are for. Method parameters should be documented using @param. Don't rely on the name of the method or the parameters to be fully self-documenting. Besides, writing these things down properly will trigger Doxygen errors if you change them in an incompatible way later -- and that is going to save you lots of time in finding source and binary incompatibilities and explaining to users why their code suddenly doesn't do what they expect (assuming it compiles at all). So good method apidox is an additional insurance against making bad changes. Same caveats apply.<br />
*Every enumeration type should have a comment explaining what the enumeration is for, even if it's just /** Various constants */.<br />
*Every enumeration value should have a comment too, to explain what it represents. Don't rely on the name of the enumeration value being sufficiently expressive.<br />For the purposes of readability, I suggest that you document enumeration values after the value, as opposed to the documentation format for namespaces, classes and methods where you write the documentation in front of the thing you are documenting. The format of the documentation is slightly different. Instead of writing /** Documentation */ in front, you write /**< Documentation afterards */, where the < denotes that the documentation applies to the thing just past.<br />It looks like this:<br />
<syntaxhighlight lang="cpp-qt"><br />
enum State {<br />
none, /**< No bracket seen */<br />
bracket, /**< Found a ( for grouping */<br />
squote, /**< Found a single quote */<br />
dquote /**< Found double quotes */<br />
};<br />
</syntaxhighlight><br />
<br />
'''3. Watch this space!'''<br />
<br />
Watch the [http://www.englishbreakfastnetwork.org/ English Breakfast Network] for the [http://www.englishbreakfastnetwork.org/apidocs/ results] of your apidox work. Check the log files for errors -- Doxygen can complain quite loudly. <br />
<br />
'''4. Write a main page for your application.'''<br />
<br />
This is usually done in a separate file {{path|Mainpage.dox}} in the top-level of a library or application. The file's content is just a single apidox comment that starts with /** @mainpage title ; the rest of the file is just a long comment about what the library or application is for.<br />
<br />
== Fixing APIDOX in Old Code ==<br />
<br />
Writing apidox in old code is a lot like writing the same apidox in new code, except that there is more cruft in the way. The number 1 tip to follow is: watch the logs on English Breakfast Network. Those will show you what errors there are in the apidox. However, Doxygen can't catch everything that is wrong with the documentation on its own, so you will have to do some reading yourself. The other tips for new apidox apply equally here: you want to document everything, in a consistent style. If methods show up on the generated apidox pages with no documentation, you know that you have more apidox to write. (Doxygen may provide an error message, but doesn't do that everywhere in the current setup because there would just be too many.)<br />
<br />
In old apidox, you are more likely to suffer from the following symptoms:<br />
<br />
*Missing parameter documentation (because parameters were renamed, or added, or removed, or something).<br />
*Missing method documentation.<br />
*Missing class documentation.<br />
*Documentation that has wandered off on its own and is attached to the wrong thing now.<br />
<br />
The first of these can be fixed by correcting the parameter documentation. See the examples section. The next two -- missing documentation that you can see is there in the source files but that does not show up in the generated HTML pages, is usually a matter of missing documentation on surrounding blocks. See the common pitfalls section, and make sure that the surrounding classes, namespaces and files all have documentation.<br />
<br />
The last problem can best be fixed by moving the offending documentation back to where it belongs (really, it's not the documentation that is at fault, it's whatever has squeezed in -- the home-breaker -- between the documentation and the thing it was originally attached to). You could use some Doxygen special tags to avoid moving stuff around like that, but it does not help the understandability of the source much.<br />
<br />
== Example APIDOX ==<br />
<br />
So what does documentation look like in the headers? How do you write a method documenation that describes the parameters as well? This section contains boilerplate for most common situations. Doxygen does not require a strict style -- it will ignore whitespace and asterisks at the beginning of a line, so you can make the documentation ASCII-pretty.<br />
<br />
'''Documentation for a file:''' The newline after @file is significant! The text after @author is listed in a special Authors section of the apidox; you can list multiple authors.<br />
<br />
<syntaxhighlight lang="cpp-qt"><br />
/** @file<br />
* This file is part of AnApplication and defines<br />
* classes Ungulate and Moose.<br />
*<br />
* @author Mostly by me<br />
*/<br />
</syntaxhighlight><br />
<br />
'''Documentation for a namespace:'''<br />
<br />
<syntaxhighlight lang="cpp-qt"><br />
/**<br />
* This namespace collects functions related to<br />
* counting and enumeration of mammals and their limbs.<br />
*/<br />
</syntaxhighlight><br />
<br />
'''Documentation for a class:''' Some Doxygen special commands are used here to provide additional information. @author (as with files) identifies authors of the code; these are collected in a special ''Authors:'' section of the apidox. You can list more than one author. The @since tag tells users since when the class has existed. It is usual to put a KDE release number here.<br />
<br />
<syntaxhighlight lang="cpp-qt"><br />
/**<br />
* This class represents a Moose in the woodland<br />
* simulator. A single Moose object can be created,<br />
* but it is more useful to instantiate Moose::Factory<br />
* by calling Moose::factory(), and then calling spawn()<br />
* for each new Moose, since that maintains the ecological<br />
* balance far better.<br />
*<br />
* @author Adriaan de Groot <degroot@kde.org><br />
* @since 3.5<br />
*/<br />
</syntaxhighlight><br />
<br />
'''Method documentation:''' We can use @author and @since just like we do for classes. In addition, there are the parameters of the method that can be described. @p is used to refer to them in running text, and @param is used to construct a list of parameter descriptions that is specially formatted. Finally, @return entries describe the values that may be returned by the method. <br />
<br />
<syntaxhighlight lang="cpp-qt"><br />
/**<br />
* This method names a particular Moose and as a side effect<br />
* sets whether or not the Moose is treated as a Reindeer.<br />
* When @p santa is @c true, the name of the moose is set to<br />
* the next of the available Reindeer (if possible).<br />
*<br />
* @param name name to assign to the Moose, which is only<br />
* relevant if the moose is not a Reindeer.<br />
* @param santa is this Moose assigned to Santa? if so, the<br />
* name is irrelevant.<br />
*<br />
* @return @c true if naming the Moose succeeded<br />
* @return @c false if naming the Moose failed. This only<br />
* happens if the Moose is assigned to Santa duty<br />
* but there are already eight named Reindeer.<br />
*/<br />
bool name(const QString &name, bool santa = false);<br />
</syntaxhighlight><br />
<br />
Enum documentation is described in the section on writing new apidox. The same kind of documentation as for classes applies, with the addition of the documentation for each enumerated value which belongs inline.<br />
<br />
== Common Pitfalls ==<br />
<br />
This section lists common pitfalls in writing apidox. Typically, they are easily<br />
overlooked mistakes that produce weird error messages, but I will also include<br />
some stylistic pitfalls that should be avoided.<br />
<br />
'''Missing APIDOX''': You ''know'' you wrote dox for class Moose, but after<br />
generation they are not visible. You ''know'' that the file-scope function int<br />
foo() is documented, but it's not there either! What is going on?<br />
<br />
The most common pitfall, the one that leads to "missing" apidox, is forgetting<br />
to document surrounding structure. The "structure" in the source comes from<br />
files, namespaces, classes and methods. In order to document a class you must<br />
document the namespace it is in (if there is one) and the file that it is in.<br />
In order to document a method, you must document the class it is in (and thus<br />
the namespace and file). So the easiest rule of thumb is to<br />
document ''everything''.<br />
{{note|This hard-and-fast rule is not quite accurate:<br />
classes do not need the file to be documented,<br />
so you can leave out the /** @file */ comment for<br />
source files containing only classes (and namespaces).<br />
Note that classes in a namespace require the namespace<br />
to be documented, but classes in the :: namespace<br />
don't need extra documentation.<br />
I'm not sure about anonymous namespaces.<br />
<br />
For file-scoped functions &mdash; that is, functions<br />
that are defined in a file, not in a namespace<br />
and not in a class &mdash;<br />
you ''must'' document the file<br />
they are in. This applies mostly<br />
to files which collect a bunch of non-method utility functions.<br />
}}<br />
<br />
'''Broken parameter documentation:''' Documenting parameters to methods can be done two ways: you can document <em>none</em> of them, or you can document<br />
''all'' of them for a given method. There is no middle ground (that doesn't<br />
generate gobs of errors that you should fix).<br />
<br />
If you document ''all'' of your parameters (which is a good thing to do,<br />
and generates things in a nicely formatted fashion), then your method<br />
apidox consists first of a general description of the method and then a<br />
bunch of @param tags which describe each individual parameter. The @param<br />
tag is followed by the name of the parameter -- watch out for spelling<br />
and case-sensitivity! -- and then the description. The description can<br />
span multiple lines.<br />
<syntaxhighlight lang="cpp-qt"><br />
/** Calculate the root-mean-square distance from the<br />
* origin to the given integral coordinate.<br />
*<br />
* @param y y-coordinate, which is on an axis perpendicular to the<br />
* x-axis, yet still in the same plane.<br />
* @param x x-coordinate<br />
*/<br />
</syntaxhighlight><br />
<br />
When you document all the parameters like this, Doxygen will complain if<br />
you misspell parameter names, or forget some, or mention parameters that<br />
are not there. This will force you to update the documentation if you<br />
change the method signature. And that's a good thing.<br />
<br />
Additional pitfalls are putting the type of the parameter in the list,<br />
like @param int x, which makes "int" the name of the parameter. Another<br />
pitfall is that @param should come <em>after</em> the general description.<br />
Once the @param list starts, nothing can stop it except for other<br />
list-style Doxygen tags like @since, @author or @return. So write @param<br />
after the story and before, say, @return.<br />
<br />
If you document ''none'' of the parameters, you do not use the @param tag<br />
at all. You can talk about your parameters by writing @p before the name<br />
of a parameter (or anything else, really, but it only makes sense in front<br />
of a name of a parameter). Like this:<br />
<syntaxhighlight lang="cpp-qt"><br />
/** Calculate the root-mean-square distance from the origin to<br />
* the given integral coordinate which is given as a pair @p x,<br />
* @p y. If @p nonFree is true, use ESR instead of RMS in the<br />
* computation.<br />
*/<br />
double distance(int x, int y, bool nonFree=false);<br />
</syntaxhighlight><br />
<br />
'''Misuse of tags in running text:''' This boils down to the warning<br />
above about where to put @param: not every Doxygen tag can go anywhere.<br />
Some start lists or basically end the general description part of a<br />
description, so you need to avoid using them in running text.<br />
<br />
'''Chosing between Doxygen errors and compiler warnings:''' If you are<br />
going to document your parameters, you need to name them. If you are<br />
defining a stub method, this can lead to compiler warnings.<br />
<br />
'''Accidental tags:''' It can be easy to accidentally use Doxygen tags<br />
in running text -- email addresses, backslash escapes, those are the<br />
easy ones. Watch the Doxygen logs and escape that at sign with a backslash<br />
when needed (i.e.&nbsp;write \@ to get an at sign). It's probably a good<br />
idea to avoid the backslash style of apidox entirely; at the same time, if<br />
you happen to write \moose, Doxygen will complain that that is an invalid<br />
tag.<br />
<br />
'''Accidental HTML:''' If you use &lt; and &gt; in your apidox, these may<br />
confuse Doxygen -- especially if you write things like &lt;service&gt;<br />
which look like HTML tags. This is a common way of writing some kind of<br />
element that may be replaced in a method call or string or something, so<br />
it crops up all the time. You know, you write some thing like this:<br />
<syntaxhighlight lang="cpp-qt"><br />
/** This method connects to a database. The connection string is<br />
* composed of a username, password, host and database name as<br />
* follows:<br />
* <username>:<password>@<host>//<database><br />
*<br />
* @return true if the connection succeeded.<br />
*/<br />
</syntaxhighlight><br />
<br />
This bit of dox is terribly broken, because the whole sample connection<br />
string will be interpreted as (bad) HTML and ignored. There are two<br />
solutions:<br />
<ol><br />
*Write \&lt; instead of just &lt; to escape the &lt; and make Doxygen output it normally. Doxygen is smart enough to turn this into &amp;lt; in HTML output. This has only a minimal impact on readability of the dox in the header files themselves.<br />
*Use the HTML formatting that Doxygen makes available, and write &lt;i&gt;''foo''&lt;/i&gt; instead of &lt;<i>foo</i>&gt;. This produces nicer output with italics instead of plain text, so it is easier to spot what is the replaceable part of the text. The downside is that it has a larger visible impact on the apidox in the headers.<br />
</ol><br />
<br />
;Superfluous @ref<br />
:It can be tempting -- certainly if you've written dox for other projects -- to use #method or @ref method to force a reference to another method somewhere. Relax, it's not needed and usually causes Doxygen warnings to boot. Just name the method normally, make apidox and watch the references appear naturally.<br />
<br />
== KDE Specific Tags ==<br />
'''@bc''': This tag indicated binary compatibility, much like ''@since'' does. The argument after ''@bc'' is the scope of binary compatibility (for instance, KDE4). Classes that are not marked with ''@bc'' may, in some modules, be flagged as incompatible so that they can be avoided.<br />
<br />
Example:<br />
<syntaxhighlight lang="cpp"><br />
/**<br />
* This class emulates a Moose.<br />
* @bc KDE4.2 Compatibility is expected to break <br />
* with next-generation mooses.<br />
*/<br />
</syntaxhighlight><br />
<br />
'''@libs''': Use this tag to indicate what libraries should be linked in for the given class. Although this is usually the name of the directory the class lives in, this is not always the case.<br />
<br />
Example:<br />
<syntaxhighlight lang="cpp"><br />
/**<br />
* This class emulates a Moose.<br />
* @libs<br />
* @a -lkdeui or use \$(LIB_KDEUI) in the KDE build framework.<br />
*/<br />
</syntaxhighlight><br />
<br />
== Code Examples in APIDOX ==<br />
<br />
It can be useful to put example code in the APIDOX for a class.<br />
Very useful, in fact, for the reader who is wondering<br />
how exactly to use the class in a straightforward way.<br />
Most classes in {{path|kdelibs/kdecore}} have example code.<br />
<br />
One way to write example code is to use @code and @endcode around<br />
blocks of example code in the Doxygen comments themselves, like this:<br />
<syntaxhighlight lang="cpp-qt"><br />
/**<br />
* This class represents a Moose.<br />
* The correct way of generating Meese is to use the factory:<br />
*<br />
* @code<br />
* Moose::Factory outlet = Moose::factory();<br />
* Moose *m = outlet.spawn();<br />
* @endcode<br />
*/<br />
</syntaxhighlight><br />
<br />
This is how most of the examples in {{path|kdelibs}}<br />
are done, actually. It works reasonably well, you can pare the<br />
example down to something really minimal and leave out all the<br />
boilerplate.<br />
<br />
An important drawback of this approach to writing example code is that<br />
the code is never checked to see if it actually works.<br />
The code is also ''so'' terse, usually, that it's hard<br />
to expand into a complete example that actually compiles and runs.<br />
<br />
To solve this problem, you can write ''real code'' that<br />
actually compiles (as part of the test suite for the code<br />
that you have anyway) and that illustrates exactly <br />
how to use the class under consideration in an actual program.<br />
Better yet, you do not need to include ''all'' the code<br />
in the APIDOX, just the interesting bits.<br />
The way to do this is to put the code in a file in the<br />
<tt>tests/</tt> subdirectory of your code.<br />
Then use Doxygen's @include tag to include the<br />
code from that file into the API documentation.<br />
<br />
{{warning|Do not use @example! It does something totally different<br />
from what you might expect (it doesn't insert example code, for one thing).}}<br />
<br />
== Links ==<br />
<br />
[[Development/Tools/apidox|How to build apidox]]<br />
<br />
[http://www.stack.nl/~dimitri/doxygen/commands.html List of supported doxygen tags]<br />
:This is a list of all available documentation tags of doxygen, from the official site. Note that the list uses a backslash in front of a tag, while this page always used the at sign. Both are allowed, but for KDE you should use the at sign to stay consistent within KDE.<br />
<br />
[[Category:Documentation]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Help:Contents&diff=75030Help:Contents2012-08-27T17:13:25Z<p>Claus chr: added entry about Box1 template</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
Before you start to add or change content, please read:<br />
* [[Help:Contribute|Contributing to TechBase]]<br />
* [[Help:Wiki Structure|Wiki Structure]]<br />
* [[Help:Wiki Translation|Translation into other Languages]]<br />
* [[KDE_TechBase:Migrate_content|Migrating Content]]<br />
* [[KDE_TechBase:Contributors|List of active contributors]], also contact points<br />
<br />
== Wiki Syntax == <!--T:2--><br />
<br />
<!--T:3--><br />
To get started with the MediaWiki syntax, read:<br />
* [http://en.wikipedia.org/wiki/Help:Editing Help on Editing]<br />
* [http://meta.wikimedia.org/wiki/Help:Table Wikitables]<br />
<br />
<!--T:4--><br />
* [http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax Syntax for displaying images]<br />
* [http://en.wikipedia.org/wiki/Help:Magic_words Magic words]<br />
<br />
<!--T:5--><br />
* [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet The most important commands]<br />
* How to [[KDE TechBase:Migrate content|Migrate content]]<br />
<br />
== Tips == <!--T:6--><br />
<br />
<!--T:7--><br />
; Syntax highlighting<br />
: Wrap your C++ Qt/KDE code snippets in <tt>&lt;syntaxhighlight lang="cpp"&gt;</tt>, <tt>&lt;syntaxhighlight lang="cpp" line=""&gt;</tt>, <tt>&lt;syntaxhighlight lang="cpp-qt"&gt;</tt> and <tt>&lt;/syntaxhighlight&gt;</tt> to get syntax highlighting (<tt>cpp</tt> for C++, <tt>cpp-qt</tt> for Qt) and numbered lines (<tt>line=""</tt>). Replace <tt>cpp</tt> with [http://www.mediawiki.org/wiki/Extension:SyntaxHighlight_GeSHi#Supported_languages the language used], e.g. <tt>ruby</tt> for Ruby and <tt>python</tt> for Python (soon). Use <tt>ini</tt> for {{path|.desktop}} files, <tt>xml</tt> for XML files.<br />
<br />
== New Templates == <!--T:8--><br />
<br />
<!--T:9--><br />
To get a list of pages using a template, go to corresponding template page (e.g. [[Template:movepage]]) and click "''What links here''" in the toolbox.<br />
<br />
<!--T:10--><br />
; [[Template:movepage|<nowiki>{{movepage|url}}</nowiki>]]<br />
: Use this template to mark a page as not finished.<br />
<br />
<!--T:11--><br />
; [[Template:Improve|<nowiki>{{improve|explanation}}</nowiki>]]<br />
: Pages which need cleanups or contain empty sections and/or todos are marked with this template. Add an explanation if you want (optional)<br />
<br />
<!--T:12--><br />
; [[Template:tip|<nowiki>{{tip|text}}</nowiki>]]<br />
: Use this template to add a tip for the reader.<br />
<br />
<!--T:13--><br />
; [[Template:note|<nowiki>{{note|text}}</nowiki>]]<br />
: Use this template to add an explanatory note.<br />
<br />
<!--T:14--><br />
; [[Template:warning|<nowiki>{{warning|text}}</nowiki>]]<br />
: Use this template to add a warning.<br />
<br />
<!--T:15--><br />
; [[Template:qt|<nowiki>{{qt|class-name}}</nowiki>]] and [[Template:qt3|<nowiki>{{qt3|class-name}}</nowiki>]]<br />
: Use this template to generate a link to a Qt class, e.g. QWidget. For Qt3 classes use <nowiki>{{qt3|class-name}}</nowiki><br />
<br />
<!--T:16--><br />
; [[Template:class|<nowiki>{{class|class-name}}</nowiki>]]<br />
: Use this template to generate a link to a KDE class, e.g. KDialog.<br />
<br />
<!--T:17--><br />
; [[Template:path|<nowiki>{{path|path-or-filename}}</nowiki>]]<br />
: Use this template for paths and filenames, this way all of them have a consistent style.<br />
<br />
<!--T:18--><br />
; [[Template:bug|<nowiki>{{bug|123456}}</nowiki>]]<br />
: Use this template to automatically create a link to KDE's bugzilla.<br />
<br />
<!--T:19--><br />
; [[Template:KDE3|<nowiki>{{KDE3}}</nowiki>]]<br />
: Use this template to mark the content of a page as applicable for either KDE 3. Don't tag technology agnostic pages. For KDE4 content, use <nowiki>[[Category:KDE4]]</nowiki>.<br />
<br />
<!--T:20--><br />
; [[Template:TutorialBrowser|<nowiki>{{TutorialBrowser|series|name|pre|next|reading}}</nowiki>]]<br />
: A template for tutorial navigation<br />
<br />
<!--T:21--><br />
; [[Template:Box|<nowiki>{{Box|caption|text|width|float}}</nowiki>]] - Deprecated, please use Box1<br />
: Use this template to create a box with a caption and a text. The width parameter is optional and can be specified absolute (400px) or relative (50%). The last parameter is the float value, which is also optional and defaults to center.<br />
<br />
; [[Template:Box1|<nowiki>{{Box1|text|caption|icon image|color code}}</nowiki>]]<br />
: Use this template to create a box with a caption and a text. The color colde parameter is optional. Normally you would use one of the partial instantiations of Box1, such as [[Template:Info]], [[Template:Note]], [[Template:Tip]], [[Template:Warning]], or [[Template:Remember]]; each of these take a title as an optional second argument.<br />
</translate></div>Claus chrhttps://techbase.kde.org/index.php?title=Template:Box&diff=75119Template:Box2012-08-27T16:49:57Z<p>Claus chr: </p>
<hr />
<div><div class="alert {{{4}}}"><br />
<div style="float:left; valign:top">{{{3}}}</div><br />
<div style="width:10px; float:left">&nbsp;</div><br />
<table><tr><th>{{{2}}}</th></tr><tr><td>{{{1}}}</td></tr></table><br />
<div class="clearfix"></div><br />
</div><br />
<noinclude><br />
----<br />
Use this template for content that needs to be specially emphasized. Syntax: {{Input|1=<nowiki>{{Box1|2=Title|3=Image|4=color|1=text}}</nowiki>}}<br />
<br />
The template takes four arguments:<br />
# The text of the main body of the box<br />
# The title of the box<br />
# An image file to be displayed in the top left of the box - the image size should be 40 x 40<br />
# The background color (optional): possible values<br />
#* default is yellow<br />
#* ''alert-info'' gives blue - use with care; it doesn't work well with links<br />
#* ''alert-success'' gives green<br />
#* ''alert-error'' gives red<br />
<br />
Example: {{Input|1=<nowiki>{{Box1|2=Example|3=[[Image:Dialog-information.png|left|40px|link=]]|1=This is an example box}}</nowiki>}}<br />
{{Box1|2=Example|3=[[Image:Dialog-information.png|left|40px|link=]]|1=This is an example box}}<br />
<br />
Please avoid using this template directly in pages. If you need something that doesn't already exist, consider making a new template based on this template. That way it will be much easier to maintain TechBase, and the risk of introducing unintended effects on your page is reduced considerably.<br />
<br />
Existing templates based on this template: [[Template:Info]], [[Template:Note]], [[Template:Tip]], [[Template:Warning]], [[Template:Remember]].<br />
<br />
[[Category:Template]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Toolbox/fi&diff=75025Toolbox/fi2012-08-27T16:47:04Z<p>Claus chr: </p>
<hr />
<div><languages /><br />
<br />
{{Info|2=Tiedot|Tämä sivu tarjoaa esimerkkejä tavallisten tehtävien muotoilukoodeista}}<br />
<br />
== Muotoile tekstiäsi == <br />
<br />
=== Käytä otsakkeita === <br />
<br />
Otsakkeet muokkaavat automaattisesti osan taulukkosisällöistäsi, joten niiden on oltava rakenteisia. Niiden paikkaa puussa hallitaan useilla '=' -merkeillä otsakkeen molemmissa päissä. Vältä yksittäisen '=' -merkin käyttämistä - se osoittaa sivuotsaketta ja pitäisi käyttää automaattista sivuotsaketta. Pääotsakkeesi käyttävät '== teksti menee tähän ==', seuraavalla tasolla, '=== lisää tekstiä ===' ja niin edelleen.<br />
<br />
=== Käytä '''lihavoitu''' ja ''kursivoitu'' === <br />
<br />
Yhden merkin lainausmerkkejä käytetään määrittämään lihavoituja ja kursivoituja sanoja.<br />
<br />
Käytä <nowiki>'''lihavoitu teksti'''</nowiki> määrittämään '''lihavoidun tekstin''' ja<br />
<nowiki>''kursivoitu teksti''</nowiki> määrittämään ''kursivoidun tekstin''.<br />
<br />
Sen takaamiseksi, että saamme helppoja ja tarkkoja kotoistamisia noudata ''[[Special:myLanguage/Typographical_Guidelines|typograafisia ohjeita]].''<br />
<br />
=== Lisää koodipätkä === <br />
<br />
Meillä on mallinteita avustamaan koodipätkien näyttämisessä oikein. Käytön esimerkit eri tilanteissa ovat käytettävissä kohteessa [[Special:myLanguage/Typographical_Guidelines|typograafinen ohjesivu]]. Koodi eri laatikkomallinteisiin voidaan ottaa kohteesta [[User:Annewilson/Boxes|tämä sivu]].<br />
<br />
Jos sinulla on vaikeuksia putkimerkkien näyttämisessä koodipätkässäsi, katso selitys ja yksityiskohtainen merkintäkieli kohteessa [[Special:myLanguage/Typographical_Guidelines|Typograafisia ohjeita]]<br />
<br />
=== Lisää sisennykset === <br />
<br />
:"''':'''" käytetään sisennyksenä, ja sitä käytettiin useita kertoja joillakin vanhoilla sivuilla. Tämä on vanhentunut, ja aiheuttaa joitakin pulmia, joten monikerrat tulee poistaa löydettäessä. Yksittäinen "''':'''"-merkki sisentää neljällä merkillä.<br />
<br />
=== Muotoile päivämäärät === <br />
<br />
Päivämäärät ovat puhtaasti numeerinen muoto, joka aiheuttaa hämmennystä johtuen maantieteellisten vyöhykkeiden odotusten erosta. Muotoile päivämäärät {{Input|3=Syöte|<nowiki>18. maaliskuuta 2011</nowiki>}} kuukaudella joko kokonaan kirjoitettuna tai lyhennetyssä muodossa ja vuosi neljänumeroisessa muodossa. Päivä voi olla yksinumeroinen tai kaksinumeroinen.<span id="Bulleted Lists"></span><br />
=== Luettelomerkkiluettelot === <br />
<br />
<nowiki>*</nowiki> on luettelomerkkiluetteloissa käytetty symboli. ** antaa toisen tason:<br /><br />
<br />
<!--}}-->{{Input|3=Syöte|<nowiki><br />
* Mantelit<br />
<br />
* Pähkinät<br />
** Munuaispuun pähkinät<br />
<br />
* Rusinat<br />
</nowiki>}}<!--{{--><br />
tuottavat<br />
<br />
* Manteleita<br />
<br />
* Pähkinät<br />
** Munuaispuun pähkinät<br />
<br />
* Rusinat<br />
<br />
=== Luettelotyypit === <br />
<br />
Luettelotyypit tuotetaan samalla tavalla käyttäen merkkiä '#'.<br />
<br />
{{Input|3=Syöte|<nowiki><br />
# Siivilöi<br />
# Sekoita<br />
## Sekoita perusteellisesti<br />
# Leivo<br />
</nowiki>}}<br />
<br />
tuottaa<br />
<br />
# Siivilöi<br />
# Sekoita<br />
## Sekoita perusteellisesti<br />
# Leivo<br />
<br />
=== Luettelomerkkiluetteloiden ja luettelotyyppien yhdistäminen === <br />
<br />
Sinulla voi olla luettelotyyppialiluettelo luettelomerkillisessä luettelossa ja päinvastoin, kuten tässä:<br />
<br />
{{Input|3=Syöte|<nowiki><br />
* Pähkinät<br />
*# Munuaispuun pähkinät<br />
*# Hullu<br />
* Muita asioita<br />
</nowiki>}}<br />
<br />
tuottaa<br />
<br />
* Pähkinät<br />
*# Munuaispuun pähkinät<br />
*# Hullu<br />
* Muita asioita<br />
<br />
samalla kun<br />
<br />
{{Input|3=Syöte|<nowiki><br />
# Pähkinät<br />
#* Munuaispuun pähkinät<br />
#* Hullu<br />
# Muita asioita<br />
</nowiki>}}<br />
<br />
tuottaa<br />
<br />
# Pähkinät<br />
#* Munuaispuun pähkinät<br />
#* Hullu<br />
# Muita asioita<br />
<br />
{{Note|2=Huomaa|Luettelotyypeissä ei pitäisi koskaan olla tyhjiä riviä niiden sisällä: se rikkoo sarjan ja numerointi alkaa taas alusta. Samalla tavalla ei pitäisi olla tyhjiä rivejä ennen aliluetteloalkiota oli se luettelotyyppiä tai luettelomerkillinen: se luo kaksi alkioiden merkitsemistasoa (luettelomerkit tai numerot)}}<br />
<br />
{{Note|2=Huomaa|Muista, että pitkät luettelot ovat pulmallisia kotoistajille. Yksitasoisissa luettelomerkillisissä luetteloissa sijoita jokainen luettelomerkki omaan kappaleeseen, toisin sanoen tee tyhjä rivi luettelomerkkien väliin. Kaksitasoisissa luettelomerkeissä alialkiot on pidettävä samassa kappaleessa kuin niiden ylemmän tason luettelomerkit; jos sinun on käytettävä aliluettelomerkkejä, pidä aliluettelo lyhyenä! Kun käytetään luettelotyyppejä, kaikki on pidettävä yhdessä yksikössä. Yritä välttää luettelotyyppejä, ja milloin niitä pitää käyttää, yritä pitää ne lyhyinä.}}<br />
<br />
=== Alkiointi === <br />
<br />
Alkioinnit tuotetaan käyttämällä vaihtoehtoisesti ''';'''- ja ''':'''-merkkejä. Ne soveltuvat parhaiten antamaan lyhyen kuvauksen sukulaisobjektien ryhmästä.<br />
<br />
<br />
<!--}}-->{{Input|3=Syöte|<nowiki><br />
;Eläimet<br />
: Ne liikkuvat ympäriinsä ja ahmivat muita luontokappaleita.<br />
<br />
;Kasvit<br />
: Niillä on juuret ja pohjavesi ja aurinko ruokkivat niitä.<br />
</nowiki>}}<!--{{--><br />
tuottaa<br />
<br />
;Eläimet<br />
: Ne liikkuvat ympäriinsä ja ahmivat muita luontokappaleita.<br />
<br />
;Kasvit<br />
: Niillä on juuret ja pohjavesi ja aurinko ruokkivat niitä.<br />
<br />
{{Note|2=Huomaa|Kuten aina, pidä jokainen alkio omassa lohkossaan; se auttaa kotoistajaa paljon.}}<br />
<br />
===Lisää linkki=== <br />
<br />
Opittavana on kahdentyyppisiä linkkejä, sisäisiä, muille TechBase-sivuille johtavia, ja ulkoisia verkko-osoitelinkkejä.<br />
<br />
Sisäisiä linkkejä varten toimii muoto on <nowiki>[[Typographical_Guidelines]]</nowiki>, milloin haluat näyttää sivun nimen, mutta se ei ole optimaalinen, erityisesti kotoistettaessa docbook-muotoon ja paikallistamisessa. On parempi käyttää muotoa <nowiki>[[Special:myLanguage/Typographical_Guidelines|Typograafiset ohjeet]]</nowiki>, koska se sallii kotoistajan linkittää oikein jopa sellaisen sivun kautta, jonka nimi on kotoistettu. Tulos on, että se ohjaa oikein kotoistetulle sivulle, jos sellainen on olemassa. Linkki on usein sisällytettävä lauseeseen, joten siinä tapauksessa voi käyttää <br />
<br />
{{Input|3=Syöte|<nowiki>[[Special:myLanguage/Typographical_Guidelines|tämä sivu]]</nowiki>}} joka näyttää [[Special:myLanguage/Typographical_Guidelines|tämän sivun]]<br />
<br />
Ulkoiset linkit ovat hiukan erilaisia, joten<br />
<br />
{{Input|3=Syöte|<nowiki>[http://techbase.kde.org/Schedules tiekarttamme]</nowiki>}} näyttää <br />
[http://techbase.kde.org/Schedules tiekarttamme], mikä ohjaisi sinut suoraan techbase-sivulle.<br />
<br />
Viimeinen asia huomattavaksi - kun esikatselet sivujasi, kaikki linkit ovat eläviä. Tämä tarjoaa kaksi etua. Voit tarkistaa (pitämällä hiiren kohdistinta linkin päällä) että linkkisi on asetettu niin kuin olet otaksunut, ja voit käyttää punaista linkkiä luomaan uuden sivun.<br />
<br />
== Kuvita tekstisi == <br />
<br />
=== Lisää yksittäinen keskitetty kuva === <br />
<br />
<br />
{{Input|3=Syöte|<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}<br />
<br />
Huomaa, että voit vaihtaa kuvan sijainnin, mutta oletus on vasen. Kuvan koko riippuu oloista, mutta näyttökaappauksille suosittelen suurempaa tai yhtäsuurta kuin 250 px ja ei suurempaa kuin 500 px.<br />
<br />
=== Tee kuvasta napsautettava, ja lisää kuvateksti === <br />
<br />
Milloin on näytettävä enemmän yksityiskohtia, luo kohtuullisen kokoinen kuva, tee siitä napsautettava, niin että täysikokoinen kuva voidaan nähdä. Lisää vain '|tumb' kuvan kaarisulkumerkkien sisälle.<br />
<br />
Kuvateksti voidaa myös lisätä parametrina, mutta se näkyy vain jos '|tumb' on käytössä.<br />
<br />
=== Käytä taulukkoja useiden kuvien tarkkaan sijoittamiseen === <br />
<br />
{{Input|3=Syöte|<nowiki>{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}</nowiki>}}<br />
<br />
näyttää<br />
<br />
{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}<br />
<br />
<br />
<br />
Huomaa, että yhden kuvan kaikki parametrit ovat tagien <nowiki>[[...]]</nowiki> sisällä, ja solut erotellaan merkeillä '||'. Uuden rivin aloittamiseksi, lisää '|-' muutoin tyhjälle riville, sitten '|' seuraavan rivin alkuun.<br />
<br />
== Lisää huomautuksia ja varoituksia ==<br />
<br />
Siellä missä huomautukset tai varoitukset ovat oleellisia tekstisi sisällä, käytä näitä mallinteita:<br />
<br />
<nowiki>{{Info|2=Tiedot|Tämä on yleisiä tietoja}}</nowiki> näyttää<br />
{{Info|2=Tiedot|Tämä on yleisiä tietoja}}<br />
<br />
<nowiki>{{Note|2=Huomaa|Jotain tärkeää tietoa tässä vaiheessa}}</nowiki> näyttää<br />
{{Note|2=Huom|Jotain tärkeää tietoa tässä vaiheessa}}<br />
<br />
<nowiki>{{Tip|2=Vihje|Hyödyllinen neuvo, jotain muistettavaa}}</nowiki> näyttää<br />
{{Tip|2=Vihje|Hyödyllinen neuvo, jotain muistettavaa}}<br />
<br />
<nowiki>{{Warning|2=Varoitus|Varo - tämä on vaarallinen asia tehtäväksi}}</nowiki> näyttää<br />
{{Warning|2=Varoitus|Varo - tämä on vaarallinen asia tehtäväksi}}<br />
<br />
Siellä missä tarvitaan vahvin mahdollinen varoitus, voidaan käyttää Muista-laatikkoa, mutta käytä sitä säästeliäästi.<br />
<nowiki>{{Remember|2=Muista|Tämä on asia, jota ei saa ehdottomasti unohtaa}}</nowiki> näyttää <br />
{{Remember|2=Muista|Tämä on asia, jota ei saa ehdottomasti unohtaa}}<br />
<br />
Voit myös vaihtaa otsaketta:<br />
<br />
{{Remember|2=Älä unohda tätä!|1=Voit käyttää parametriä numero 2 asettamaan yksilöllisen laatikko-otsakkeen:<br />
{{Input|3=Syöte|<nowiki>{{Remember|2=Älä unohda tätä!|1=Voit käyttää...}}</nowiki>}}}}<br />
<br />
== Muita hyödyllisiä mallinteita == <br />
<br />
=== Käyttöliittymäkuvakkeiden lisääminen === <br />
<br />
Paras tapa viitata kuvakkeisiin graafisessa käyttöliittymässä on näyttää ne tekstissä. Tämä voidaan tehdä mallinteessa kuten tämä: <code><nowiki>{{Icon|list-add}}</nowiki></code>. Tämä näyttää {{Icon|list-add}}-kuvakkeen.<br />
<br />
Jotta tämä toimisi, kuvakekuvatiedosto on oltava ladattu wikiin. Katso [[Special:myLanguage/Update_an_Image|Päivitä kuvaa]] selitykseksi, kuinka kopioidaan kuvia palvelimelle. Tyypin .png tyyppiset kuvat löydetään tavallisesti täältä: <tt>usr/share/icons/oxygen</tt>. On mahdollista käyttää 16x16 -kuvaketta. Kuvatiedostolla pitäisi olla <tt>Icon-</tt>-etuliite kuten tiedostossa <tt>Icon-list-add.png</tt> &mdash; sen lisäksi, että etuliitteen tulisi täsmälleen täsmätä tavalliseen nimeen. Huomaa, että kun käytetään mallinnetta, ei pitäisi kirjoittaa <tt>Icon-</tt>-etuliitettä eikä <tt>.png</tt>-tiedostotarkenninta.<br />
<br />
Kuvake {{Plus}} voidaan myös kirjoittaa <code><nowiki>{{Plus}}</nowiki></code>, ja kuvake {{Minus}} koodina <code><nowiki>{{Minus}}</nowiki></code>. Voit myös käyttää <code><nowiki>{{Configure}}</nowiki></code> kuvakkeen {{Configure}} saamiseksi, ja koodia <code><nowiki>{{Exit}}</nowiki></code> saamaan {{Exit}}-kuvake.<br />
<br />
=== Suurten muokkausten tekeminen olemassaoleviin sivuihin === <br />
<br />
Jos on todennäköistä, että sivua avataan joku kerta muokkausta varten, on olemassa vaara ristiriitoihin - joku muu saattaa muokata samanaikaisesti, ja sinun muutosten tallentaminen peruu heidän muutokset, ja päinvastoin. Yksi tapa välttää se on käyttää tilapäistä merkkiä, suoraan kielipalkin alla. Käyttämällä <nowiki>{{Being_Edited}}</nowiki> näytetään<br />
<br />
{{Being_Edited}}<br />
<br />
''Älä unohda poistaa sitä, kun lopetat!''<br />
<br />
=== Lisätään uusi mutkikas sivu === <br />
<br />
Jos sinun on kyettävä työskentelemään sivulla aika pitkän ajan, esimerkiksi useita päiviä, saatat haluta käyttää Construction-mallinnetta - <nowiki>{{Construction}}</nowiki>, joka näyttää<br />
<br />
{{Construction}}<br />
<br />
== Luetteloiden lisääminen alisivuille == <br />
<br />
{{Input|3=Syöte|<nowiki>== {{FULLPAGENAME}}-alisivu ==<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}<br />
<br />
on hyvin hyödyllinen, kun haluat luetteloida alisivut aktiiveilla linkeillä, kuten <br />
<br />
=== {{FULLPAGENAME}}-alisivu === <br />
<br />
Se kuitenkin luetteloi myös kaikki ''muu-kieliset'' sivut, joten käytä sitä harkitsevasti.<br />
<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}<br />
<br />
<br />
----<br />
<br />
<br />
<br />
[[Category:Translator_Help]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Translations:Toolbox/73/fi&diff=75024Translations:Toolbox/73/fi2012-08-27T16:47:04Z<p>Claus chr: </p>
<hr />
<div>{{Remember|2=Älä unohda tätä!|1=Voit käyttää parametriä numero 2 asettamaan yksilöllisen laatikko-otsakkeen:<br />
{{Input|3=Syöte|<nowiki>{{Remember|2=Älä unohda tätä!|1=Voit käyttää...}}</nowiki>}}}}</div>Claus chrhttps://techbase.kde.org/index.php?title=Toolbox/pt-br&diff=75023Toolbox/pt-br2012-08-27T16:39:41Z<p>Claus chr: </p>
<hr />
<div><languages /><br />
<br />
{{Info|Essa página oferece exemplos de formatação de código para tarefas comuns}}<br />
<br />
== Formatar seu texto == <br />
<br />
=== Usar cabeçalhos === <br />
<br />
Cabeçalhos automaticamente fazem parte de sua Tabela de Conteúdos, então precisam ser estruturados. Seus lugares na árvore é regido por vários '=' caracteres no final do cabeçalho. Evite usar um único - que indica um cabeçalho de página e o cabeçalho de página automático deve ser usado. Seus cabeçalhos principais usarão '== texto vai aqui ==', o próximo nível, '=== mais texto ===' e assim por diante.<br />
<br />
=== Usar '''negrito''' e ''itálico'' === <br />
<br />
Aspas são usadas para especificar palavras em negrito e itálico.<br />
<br />
Use <nowiki>'''bold text'''</nowiki> para especificar '''texto em negrito''' e<br />
<nowiki>''italic text''</nowiki> para especificar ''texto em itálico''.<br />
<br />
Para que possamos garantir traduções fáceis e precisas, por favor, respeitem o ''[[Special:myLanguage/Typographical_Guidelines|guia tipográfico]].''<br />
<br />
=== Adicionar um trecho de código === <br />
<br />
Nós temos modelos para auxiliar na correta exibição de trechos de código. Exemplos de uso em várias situações estão disponíveis na página do [[Special:myLanguage/Typographical_Guidelines|guia tipográfico]]. Código para os vários modelos de caixa podem ser encontrados [[User:Annewilson/Boxes|nessa página]].<br />
<br />
Se você tem problemas com exibição de caracteres pipe no seu trecho de código, por favor, veja a explicação e marcação detalhada no [[Special:myLanguage/Typographical_Guidelines|Guia Tipográfico]]<br />
<br />
=== Adicionar recuos === <br />
<br />
:"''':'''" é usado para um recuo e foi usado em múltiplos em várias páginas antigas. Isso está obsoleto e causa alguns problemas, por isso os múltiplos serão removidos a medida que forem encontrados. Um simples "''':'''" recua por quatro caracteres.<br />
<br />
=== Formatar datas === <br />
<br />
Datas em um formato puramente numérico causam confusão, devido às diferenças nas expectativas das zonas geográficas. Por favor, formate as datas como {{Input|1=<nowiki>18 Mar 2011</nowiki>}} com o nome completo do mês ou na forma abreviada, e o ano no formato de 4 digitos. O dia pode ser com um único digito ou com dois.<span id="Bulleted Lists"></span><br />
=== Listas com marcadores === <br />
<br />
<nowiki>*</nowiki> é o símbolo para usar em listas com marcadores. ** fornece um segundo nível:<br /><br />
<br />
<!--}}-->{{Input|1=<nowiki><br />
* Almonds<br />
<br />
* Nuts<br />
** Cashews<br />
<br />
* Raisins<br />
</nowiki>}}<!--{{--><br />
produz<br />
<br />
* Almonds<br />
<br />
* Nuts<br />
** Cashews<br />
<br />
* Raisins<br />
<br />
=== Enumerações === <br />
<br />
Enumerações são produzidas da mesma forma, usando '#'.<br />
<br />
{{Input|1=<nowiki><br />
# Sift<br />
# Mix<br />
## Stir thoroughly<br />
# Bake<br />
</nowiki>}}<br />
<br />
produz<br />
<br />
# Sift<br />
# Mix<br />
## Stir thoroughly<br />
# Bake<br />
<br />
=== Combinando listas com marcadores e enumerações === <br />
<br />
Você pode ter uma sublista enumerada em uma lista com marcadores e vice e versa, como essa:<br />
<br />
{{Input|1=<nowiki><br />
* Nuts<br />
*# Cashew<br />
*# Crazy<br />
* Other things<br />
</nowiki>}}<br />
<br />
produz<br />
<br />
* Nuts<br />
*# Cashew<br />
*# Crazy<br />
* Other things<br />
<br />
enquanto<br />
<br />
{{Input|1=<nowiki><br />
# Nuts<br />
#* Cashew<br />
#* Crazy<br />
# Other things<br />
</nowiki>}}<br />
<br />
produz<br />
<br />
# Nuts<br />
#* Cashew<br />
#* Crazy<br />
# Other things<br />
<br />
{{Note (pt_BR)|1=Enumerações nunca devem ter linhas em branco nelas: isso quebra a sequência e a numeração inicia em um novamente. Da mesma forma, nunca deve haver linhas em branco antes de um item de sublist se enumerador ou com marcadores: isso cria dois níveis de marcas de item (marcadores ou números)}}<br />
<br />
{{Note (pt_BR)|1=Por favor, lembre que listas grandes são um problema para tradutores. Com listas com marcadores de nível simples, coloque cada marcador em uma seção própria, por exemplo, colocar uma linha em branco entre os marcadores. Com dois níveis de marcadores os subitens devem ser mantidos na mesma seção como seus marcadores de nível superior; se você usa submarcadores, por favor, mantenha as sublistas curtas! Com enumerações envolvidas, você deve manter tudo em uma unidade. Por favor, tente evitar enumerações e se você encontrar isso você deve usá-las tentando mantê-las curtas.}}<br />
<br />
=== Itemizações === <br />
<br />
Itemizações são produzidas usando ''';''' e ''':''' alternativamente. Elas são melhores para dar descrições curtas para um grupo de objetos relacionados.<br />
<br />
<br />
<!--}}-->{{Input|1=<nowiki><br />
;Animals<br />
: They move around and devour other creatures.<br />
<br />
;Plants<br />
: They have roots and feed upon ground water and sun.<br />
</nowiki>}}<!--{{--><br />
produz<br />
<br />
;Animals<br />
: They move around and devour other creatures.<br />
<br />
;Plants<br />
: They have roots and feed upon ground water and sun.<br />
<br />
{{Note (pt_BR)|1=Como sempre, por favor, mantenha cada item em uma seção própria; isso ajuda muito os tradutores.}}<br />
<br />
===Adicionar um link=== <br />
<br />
Há dois tipos de links para aprender, no plano interno, para outra página do TechBase e links externos.<br />
<br />
Para um link interno o formato <nowiki>[[Typographical_Guidelines]]</nowiki>, onde você deseja mostrar o nome da página, funciona, mas não é o ideal, particularmente para tradução de docbook e para localização. É melhor usar a forma <nowiki>[[Special:myLanguage/Typographical_Guidelines|Typographical Guidelines]]</nowiki>, porque isso permite aos tradutores linkar corretamente mesmo quando o nome da página está localizado.O resultado é que direciona corretamente a página traduzida, se existir uma. Você muitas vezes vai precisar incluir o link em uma sentença, então nesse caso você usaria <br />
<br />
{{Input|1=<nowiki>[[Special:myLanguage/Typographical_Guidelines|essa página]]</nowiki>}} que mostra <br />
[[Special:myLanguage/Typographical_Guidelines|essa página]]<br />
<br />
Links externos são ligeiramente diferentes assim<br />
<br />
{{Input|1=<nowiki>[http://techbase.kde.org/Schedules nosso roteiro]</nowiki>}} mostra <br />
[http://techbase.kde.org/Schedules nosso roteiro], que iria levá-lo direto para a página do techbase.<br />
<br />
Uma última coisa a notar - quando você visualizar sua página, todos os links estão funcionando. Isto te dá dois benefícios. Você pode verificar (ao passar com o mouse em cima deles) que seus links estão configurados como você esperava, e você pode usar um link vermelho para criar uma nova página.<br />
<br />
== Ilustrar seu texto == <br />
<br />
=== Adicionar uma única imagem, centralizada === <br />
<br />
<br />
{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}<br />
<br />
Note que você pode mudar a posição da imagem, mas o padrão é à esquerda. O tamanho da imagem depende das circunstâncias, mas para screenshots recomendo não menos do que 250px e não mais do que 500 pixels.<br />
<br />
=== Criar imagem clicável e adicionar uma legenda === <br />
<br />
Quando você precisar mostrar mais detalhes, crie uma imagem de tamanho moderado, clicável, para que o tamanho completo possa ser visto. Basta adicionar o parâmetro '|thumb' dentro dos parênteses imagem.<br />
<br />
Uma legenda também pode ser adicionada como um parâmetro, mas somente mostrará se '|thumb' está presente.<br />
<br />
=== Use tabelas para localizar precisamente múltiplas imagens === <br />
<br />
{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}</nowiki>}}<br />
<br />
mostra<br />
<br />
{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}<br />
<br />
<br />
<br />
Note que todos esses parâmetros para cada imagem estão dentro de <nowiki>[[...]]</nowiki> e as células são separadas por '||'. Para começar uma nova linha, insira '|-' em uma linha vazia, então '|' no começo da próxima.<br />
<br />
==Adicionar Notas e Avisos==<br />
<br />
Quando houver uma nota ou aviso relevante dentro do seu texto, use esses exemplos:<br />
<br />
<nowiki>{{Info|This is general information}}</nowiki> displays<br />
{{Info|Essa é a informação geral}}<br />
<br />
<nowiki>{{Note|Some important information at this point}}</nowiki> displays<br />
{{Note|Alguma informação importante nesse ponto}}<br />
<br />
<nowiki>{{Tip|A helpful piece of advice, something to remember}}</nowiki>displays<br />
{{Tip|Um conselho útil, alguma coisa para lembrar}}<br />
<br />
<nowiki>{{Warning|Take care - this is a dangerous thing to do}}</nowiki> displays<br />
{{Warning|Tomar cuidado - isso é uma coisa perigosa para fazer}}<br />
<br />
Onde for necessário um aviso mais reforçado, essa caixa de lembrete pode ser usada, mas, por favor, use moderadamente.<br />
<nowiki>{{Remember|1=This is for things that definitely must not be forgotten}}</nowiki><br />
{{Remember|1=Isso é para coisas que definitivamente não devem ser esquecidas}}<br />
<br />
Você também pode alterar o cabeçalho:<br />
<br />
{{Remember|2=Don't Forget This!|1=Você pode usar o parâmetro número 2 para configurar um cabçalho de caixa individual:<br />
{{Input|1=<nowiki>{{Remember|2=Não esqueça isso!|1=Você pode usar...}}</nowiki>}}}}<br />
<br />
== Outros modelos úteis == <br />
<br />
=== Inserindo ícones GUI === <br />
<br />
A melhor forma para se referir a ícones GUI é exibi-los no texto. Isso pode ser feito com um modelo como esse: <code><nowiki>{{Icon|list-add}}</nowiki></code>. Isso irá exibir o ícone {{Icon|list-add}}.<br />
<br />
Para que isso funcione, a imagem do ícone deve ter sido carregada na wiki. Veja [[Special:myLanguage/Update_an_Image|Update an Image]] para uma explicação sobre como carregar imagens. Os arquivos .png podem geralmente ser encontrados aqui: <tt>usr/share/icons/oxygen</tt>. Se possível use o ícone 16x16. O nome do arquivo deve ter um prefixo <tt>Icon-</tt> como em <tt>Icon-list-add.png</tt> &mdash; além do prefixo o nome do arquivo deve corresponder exatamente a um nome comum. Note, que quando usar o modelo você não deve escrever nem o prefixo <tt>Icon-</tt> e nem o tipo de extensão do arquivo <tt>.png</tt>.<br />
<br />
O ícone {{Plus}} também pode ser escrito como <code><nowiki>{{Plus}}</nowiki></code> e o ícone {{Minus}} como <code><nowiki>{{Minus}}</nowiki></code>. Você também pode usar <code><nowiki>{{Configure}}</nowiki></code> para obter o ícone {{Configure}} e <code><nowiki>{{Exit}}</nowiki></code> para obter o ícone {{Exit}}.<br />
<br />
=== Fazendo grandes edições em páginas existentes === <br />
<br />
Se uma página é passível de ser editada há o perigo de conflitos - alguém mais pode editá-la ao mesmo tempo que você e se você salvar sua edição isso cancelará a dele, ou vice versa. O jeito de evitar isso é fazer um registro temporário, diretamente na barra de idioma, usando <nowiki>{{Being_Edited}}</nowiki> que mostrará<br />
<br />
{{Being_Edited}}<br />
<br />
''Não esqueça de removê-la quando você terminar!''<br />
<br />
=== Adicionando uma nova página complexa === <br />
<br />
Se você precisa trabalhar em uma página por um bom tempo, durante vários dias, por exemplo, você pode gostar de usar um modelo de contrução - <nowiki>{{Construction}}</nowiki>, que mostra<br />
<br />
{{Construction}}<br />
<br />
== Adicionando uma lista de subpáginas == <br />
<br />
{{Input|1=<nowiki>== Subpages of {{FULLPAGENAME}} ==<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}<br />
<br />
é muito útil quando você quer listar subpáginas com links ativos, tais como <br />
<br />
=== Subpáginas de {{FULLPAGENAME}}=== <br />
<br />
Isso, no entanto, também lista todas as páginas de "outras línguas", então use com critério<br />
<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}<br />
<br />
<br />
----<br />
<br />
<br />
<br />
[[Category:Translator_Help]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Translations:Toolbox/73/pt-br&diff=75022Translations:Toolbox/73/pt-br2012-08-27T16:39:41Z<p>Claus chr: </p>
<hr />
<div>{{Remember|2=Don't Forget This!|1=Você pode usar o parâmetro número 2 para configurar um cabçalho de caixa individual:<br />
{{Input|1=<nowiki>{{Remember|2=Não esqueça isso!|1=Você pode usar...}}</nowiki>}}}}</div>Claus chrhttps://techbase.kde.org/index.php?title=Toolbox&diff=75021Toolbox2012-08-27T16:39:03Z<p>Claus chr: Adjust to modified template</p>
<hr />
<div><languages /><br />
<translate><br />
<br />
<!--T:1--><br />
{{Info|This page offers examples of formatting code for common tasks}}<br />
<br />
== Format Your Text == <!--T:2--> <br />
<br />
=== Use Headings === <!--T:3--> <br />
<br />
<!--T:4--><br />
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.<br />
<br />
=== Use '''bold''' and ''italic'' === <!--T:5--> <br />
<br />
<!--T:6--><br />
Blips are used to specify bold and italic words.<br />
<br />
<!--T:7--><br />
Use <nowiki>'''bold text'''</nowiki> to specify '''bold text''' and<br />
<nowiki>''italic text''</nowiki> to specify ''italic text''.<br />
<br />
<!--T:8--><br />
In order to ensure we get easy and accurate translations, please adhere to the ''[[Special:myLanguage/Typographical_Guidelines|typographical guidelines]].''<br />
<br />
=== Add a Code Snippet === <!--T:9--> <br />
<br />
<!--T:10--><br />
We have templates to assist in correctly displaying code snippets. Examples of use in various situations are available on [[Special:myLanguage/Typographical_Guidelines|the typographical guideline page]]. Code for the various box templates can be taken from [[User:Annewilson/Boxes|this page]].<br />
<br />
<!--T:11--><br />
If you have problems displaying pipe characters in your code snippet, please see the explanation and markup detailed on [[Special:myLanguage/Typographical_Guidelines|Typographical Guidelines]<br />
<br />
=== Add Indents === <!--T:12--> <br />
<br />
<!--T:13--><br />
:"''':'''" 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.<br />
<br />
=== Format Dates === <!--T:14--> <br />
<br />
<!--T:15--><br />
Dates in a purely numerical format cause confusion, due to differences in expectations of geographical zones. Please format dates as {{Input|1=<nowiki>18 Mar 2011</nowiki>}} with the month either spelled out completely or in abbreviated form, and the year in 4-digit format. The day may be single or double-digit.<br />
</translate><span id="Bulleted Lists"></span><translate><br />
<br />
=== Bulleted Lists === <!--T:16--> <br />
<br />
<!--T:17--><br />
<nowiki>*</nowiki> is the symbol to use for bulletted lists. ** gives a second level:<br /><br />
<br />
<!--T:18--><br />
<!--}}-->{{Input|1=<nowiki><br />
* Almonds<br />
<br />
<!--T:19--><br />
* Nuts<br />
** Cashews<br />
<br />
<!--T:20--><br />
* Raisins<br />
</nowiki>}}<!--{{--><br />
produces<br />
<br />
<!--T:21--><br />
* Almonds<br />
<br />
<!--T:22--><br />
* Nuts<br />
** Cashews<br />
<br />
<!--T:23--><br />
* Raisins<br />
<br />
=== Enumerations === <!--T:24--> <br />
<br />
<!--T:25--><br />
Enumerations are produced in the same way, using '#'.<br />
<br />
<!--T:26--><br />
{{Input|1=<nowiki><br />
# Sift<br />
# Mix<br />
## Stir thoroughly<br />
# Bake<br />
</nowiki>}}<br />
<br />
<!--T:27--><br />
produces<br />
<br />
<!--T:28--><br />
# Sift<br />
# Mix<br />
## Stir thoroughly<br />
# Bake<br />
<br />
=== Combining Bulleted Lists and Enumerations === <!--T:29--> <br />
<br />
<!--T:30--><br />
You can have an enumerated sublist in a bulleted list and vice versa, like this:<br />
<br />
<!--T:31--><br />
{{Input|1=<nowiki><br />
* Nuts<br />
*# Cashew<br />
*# Crazy<br />
* Other things<br />
</nowiki>}}<br />
<br />
<!--T:32--><br />
produces<br />
<br />
<!--T:33--><br />
* Nuts<br />
*# Cashew<br />
*# Crazy<br />
* Other things<br />
<br />
<!--T:34--><br />
while<br />
<br />
<!--T:35--><br />
{{Input|1=<nowiki><br />
# Nuts<br />
#* Cashew<br />
#* Crazy<br />
# Other things<br />
</nowiki>}}<br />
<br />
<!--T:36--><br />
produces<br />
<br />
<!--T:37--><br />
# Nuts<br />
#* Cashew<br />
#* Crazy<br />
# Other things<br />
<br />
<!--T:38--><br />
{{Note|1=Enumerations should never have blank lines in them: it breaks the sequence and numbering starts at one again. Similarly, there should never be blank lines before a sublist item whether enumerated or bulleted: it creates two levels of item markings (bullets or numbers)}}<br />
<br />
<!--T:39--><br />
{{Note|1=Please remember, that long lists are a problem for translators. With single level bulleted lists, place each bullet in a section of its own, i.e. make a blank line between bullets. With two levels of bullets the subitems must be kept in the same section as their top level bullet; if you have to use subbullets, please keep the sublists short! With enumerations involved, you must keep everything in one unit. Please try to avoid enumerations, and if you find that you must use them try to keep them short.}}<br />
<br />
=== Itemizations === <!--T:40--> <br />
<br />
<!--T:41--><br />
Itemizations are produced using ''';''' and ''':''' alternately. They are best for giving short descriptions for a group of related objects.<br />
<br />
<br />
<!--T:42--><br />
<!--}}-->{{Input|1=<nowiki><br />
;Animals<br />
: They move around and devour other creatures.<br />
<br />
<!--T:43--><br />
;Plants<br />
: They have roots and feed upon ground water and sun.<br />
</nowiki>}}<!--{{--><br />
produces<br />
<br />
<!--T:44--><br />
;Animals<br />
: They move around and devour other creatures.<br />
<br />
<!--T:45--><br />
;Plants<br />
: They have roots and feed upon ground water and sun.<br />
<br />
<!--T:46--><br />
{{Note|1=As allways, please keep each item in a section of its own; it helps translators a lot.}}<br />
<br />
===Add a Link=== <!--T:47--> <br />
<br />
<!--T:48--><br />
There are two kinds of links to learn, internal ones, to another TechBase page, and external URL links.<br />
<br />
<!--T:49--><br />
For an internal link the format <nowiki>[[Typographical_Guidelines]]</nowiki>, where you want to display the name of the page, does work, but it is not ideal, particularly for translation to docbook and for localisation. It is better to use the form <nowiki>[[Special:myLanguage/Typographical_Guidelines|Typographical Guidelines]]</nowiki>, because that allows translators to link correctly even though the page name is localised. The result is that it directs to the correctly translated page, if one exists. You often need to include the link in a sentence, so in that case you would use <br />
<br />
<!--T:50--><br />
{{Input|1=<nowiki>[[Special:myLanguage/Typographical_Guidelines|this page]]</nowiki>}} which displays <br />
[[Special:myLanguage/Typographical_Guidelines|this page]]<br />
<br />
<!--T:51--><br />
External links are slightly different so<br />
<br />
<!--T:52--><br />
{{Input|1=<nowiki>[http://techbase.kde.org/Schedules our road map]</nowiki>}} displays <br />
[http://techbase.kde.org/Schedules our road map], which would take you straight to the techbase page.<br />
<br />
<!--T:53--><br />
One last thing to note - when you preview your page, all 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.<br />
<br />
== Illustrate Your Text == <!--T:54--> <br />
<br />
=== Add a single image, centered === <!--T:55--> <br />
<br />
<br />
<!--T:56--><br />
{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}<br />
<br />
<!--T:57--><br />
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.<br />
<br />
=== Make the Image Clickable, and Add a Caption === <!--T:58--> <br />
<br />
<!--T:59--><br />
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.<br />
<br />
<!--T:60--><br />
A caption can also be added as a parameter, but will only show if '|thumb' is present.<br />
<br />
=== Use Tables to Precisely Place Multiple Images === <!--T:61--> <br />
<br />
<!--T:62--><br />
{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}</nowiki>}}<br />
<br />
<!--T:63--><br />
displays<br />
<br />
<!--T:64--><br />
{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}<br />
<br />
<br />
<br />
<!--T:65--><br />
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.<br />
<br />
==Add Notes and Warnings== <!--T:94--><br />
<br />
<!--T:66--><br />
Where a note or warning is relevant within your text, use these templates:<br />
<br />
<!--T:67--><br />
<nowiki>{{Info|This is general information}}</nowiki> displays<br />
{{Info|This is general information}}<br />
<br />
<!--T:68--><br />
<nowiki>{{Note|Some important information at this point}}</nowiki> displays<br />
{{Note|Some important information at this point}}<br />
<br />
<!--T:95--><br />
<nowiki>{{Tip|A helpful piece of advice, something to remember}}</nowiki>displays<br />
{{Tip|A helpful piece of advice, something to remember}}<br />
<br />
<!--T:70--><br />
<nowiki>{{Warning|Take care - this is a dangerous thing to do}}</nowiki> displays<br />
{{Warning|Take care - this is a dangerous thing to do}}<br />
<br />
<!--T:71--><br />
Where the strongest possible warning is needed, the Remember box can be used, but please use sparingly.<br />
<nowiki>{{Remember|1=This is for things that definitely must not be forgotten}}</nowiki><br />
{{Remember|1=This is for things that definitely must not be forgotten}}<br />
<br />
<!--T:72--><br />
You can also change the heading:<br />
<br />
<!--T:73--><br />
{{Remember|2=Don't Forget This!|1=You can use parameter number 2 to set an individual box heading:<br />
{{Input|1=<nowiki>{{Remember|2=Don't Forget This!|1=You can use...}}</nowiki>}}}}<br />
<br />
== Other Useful Templates == <!--T:74--> <br />
<br />
=== Inserting GUI Icons === <!--T:75--> <br />
<br />
<!--T:76--><br />
The best way to refer to icons in the GUI is to display it in the text. This can be done with a template like this: <code><nowiki>{{Icon|list-add}}</nowiki></code>. This will display the {{Icon|list-add}} icon.<br />
<br />
<!--T:77--><br />
For this to work, the icon image must have been uploaded to the wiki. See [[Special:myLanguage/Update_an_Image|Update an Image]] for an explanation on how to upload images. The .png files can usually be found here: <tt>usr/share/icons/oxygen</tt>. If possible use the 16x16 icon. The file name should have an <tt>Icon-</tt> prefix as in <tt>Icon-list-add.png</tt> &mdash; apart from the prefix the filename should exactly match the usual name. Note, that when using the template you should neither write the <tt>Icon-</tt> prefix nor the <tt>.png</tt> file type extension.<br />
<br />
<!--T:78--><br />
The {{Plus}} icon can also be written as <code><nowiki>{{Plus}}</nowiki></code>, and the {{Minus}} icon as <code><nowiki>{{Minus}}</nowiki></code>. You can also use <code><nowiki>{{Configure}}</nowiki></code> to get the {{Configure}} icon, and <code><nowiki>{{Exit}}</nowiki></code> gets you the {{Exit}} icon.<br />
<br />
=== Making Major Edits to Existing Pages === <!--T:79--> <br />
<br />
<!--T:80--><br />
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<br />
<br />
<!--T:81--><br />
{{Being_Edited}}<br />
<br />
<!--T:82--><br />
''Don't forget to remove it when you have finished!''<br />
<br />
=== Adding a New Complex Page === <!--T:83--> <br />
<br />
<!--T:84--><br />
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<br />
<br />
<!--T:85--><br />
{{Construction}}<br />
<br />
== Adding a List of Sub-Pages == <!--T:86--> <br />
<br />
<!--T:87--><br />
{{Input|1=<nowiki>== Subpages of {{FULLPAGENAME}} ==<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}<br />
<br />
<!--T:88--><br />
is very useful when you want to list subpages with active links, such as <br />
<br />
=== Subpages of {{FULLPAGENAME}}=== <!--T:89--> <br />
<br />
<!--T:90--><br />
It does, however, also list all "other-language" pages, so use with discretion.<br />
<br />
<!--T:91--><br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}<br />
<br />
<br />
<!--T:92--><br />
----<br />
<br />
<br />
<br />
<!--T:93--><br />
[[Category:Translator_Help]]<br />
</translate></div>Claus chrhttps://techbase.kde.org/index.php?title=Toolbox/it&diff=75020Toolbox/it2012-08-27T16:38:14Z<p>Claus chr: </p>
<hr />
<div><languages /><br />
<br />
{{Info/it|Questa pagina offre esempi di formattazione per compiti comuni}}<br />
<br />
==Formattare il testo== <br />
<br />
===Utilizzare i titoli delle sezioni=== <br />
<br />
I titoli delle sezioni fanno automaticamente parte dell'Indice, devono quindi essere strutturati. La loro posizione nella struttura ad albero è regolata dai caratteri '=' alla fine di ogni titolo. Evita di utilizzarne uno da solo perché indica il titolo di una pagina che dovrebbe essere semmai indicato tramite il titolo automatico della pagina. I titoli delle sezioni principali utilizzeranno '==qui il testo==', il livello successivo '===altro testo===' e così via.<br />
<br />
===Utilizzare il '''grassetto''' e il ''corsivo''=== <br />
<br />
Le virgolette singole sono utilizzate per specificare le parole in grassetto e in corsivo.<br />
<br />
Utilizza <nowiki>'''grassetto'''</nowiki> per specificare il '''testo in grassetto''' e <nowiki>''corsivo''</nowiki> per specificare il ''testo corsivo''.<br />
<br />
Per arrivare ad ottenere traduzioni semplici ed accurate, segui le linee ''[[Special:myLanguage/Typographical_Guidelines|Linee guida tipografiche]].''<br />
<br />
===Aggiungere un frammento di codice=== <br />
<br />
Abbiamo dei modelli per aiutare nella corretta visualizzazione dei frammenti di codice. Esempi d'uso nelle varie situazioni sono disponibili nella pagina [[Special:myLanguage/Typographical_Guidelines|Linee guida tipografiche]]. Codice per vari modelli di riquadri possono essere presi da [[User:Annewilson/Boxes|questa pagina]].<br />
<br />
Se hai problemi a visualizzare i caratteri pipe nel tuo frammento di codice, consulta la spiegazione e il marcatore in dettaglio su [[Special:myLanguage/Typographical_Guidelines|Linee guida tipografiche]].<br />
<br />
===Aggiungere rientri=== <br />
<br />
:"''':'''" è utilizzato per ottenere un rientro. È stato utilizzato ripetuto più volte in alcune vecchie pagine. È una pratica deprecata che causa alcuni problemi, di conseguenza i rientri multipli verranno rimossi non appena trovati. Un singolo "''':'''" inserisce un rientro di quattro caratteri.<br />
<br />
=== Formato delle date === <br />
<br />
Le date in un formato puramente numerico causano confusione a causa delle differenti interpretazioni a seconda della zona geografica. Formatta le date così {{Input|1=<nowiki>18 Mar 2011</nowiki>}} con il mese completo o in forma abbreviata e l'anno nel formato a 4 cifre. Il giorno può essere a singola o doppia cifra.<span id="Bulleted Lists"></span><br />
=== Elenchi puntati === <br />
<br />
<nowiki>*</nowiki> è il simbolo da utilizzare per gli elenchi puntati. ** crea un secondo livello:<br /><br />
<br />
{{<!--}}-->Input|1=<nowiki><br />
* Mandorle<br />
<br />
* Noci<br />
** Anacardi<br />
<br />
* Uvetta<br />
</nowiki>}}<!--{{--><br />
produce<br />
<br />
* Mandorle<br />
<br />
* Noci<br />
** Anacardi<br />
<br />
* Uvetta<br />
<br />
=== Elenchi numerati === <br />
<br />
Gli elenchi numerati sono create nello stesso modo, ma utilizzando '#'.<br />
<br />
{{Input|1=<nowiki><br />
# Setacciare<br />
# Mescolare<br />
## Mescolare accuratamente<br />
# Infornare<br />
</nowiki>}}<br />
<br />
produce<br />
<br />
# Setacciare<br />
# Mescolare<br />
## Mescolare accuratamente<br />
# Infornare<br />
<br />
=== Combinare elenchi puntati e numerati === <br />
<br />
Puoi avere un sotto-elenco numerato in un elenco puntato e viceversa, come questo:<br />
<br />
{{Input|1=<nowiki><br />
* Noci<br />
*# Anacardi<br />
*# Matti<br />
* Altre cose<br />
</nowiki>}}<br />
<br />
produce<br />
<br />
* Noci<br />
*# Anacardi<br />
*# Matti<br />
* Altre cose<br />
<br />
mentre<br />
<br />
{{Input|1=<nowiki><br />
# Noci<br />
#* Anacardi<br />
#* Matti<br />
# Altre cose<br />
</nowiki>}}<br />
<br />
produce<br />
<br />
# Noci<br />
#* Anacardi<br />
#* Matti<br />
# Altre cose<br />
<br />
{{Note/it|1=Gli elenchi numerati non dovrebbero mai contenere righe vuote: spezzano la sequenza e la numerazione riparte da uno. Allo stesso modo non dovrebbero mai esserci righe vuote prima di un elemento di un sotto-elenco numerato o puntato: si creano due livelli di marcature di elementi (puntati o numerati).}}<br />
<br />
{{Note/it|1=Ricordati che i lunghi elenchi sono un problema per i traduttori. Con elenchi puntati a singolo livello posiziona ogni punto in una sezione a sé, cioè inserisci una riga vuota tra i punti. Con elenchi puntati a due livelli, i sotto-elementi devono essere tenuti nella stessa sezione del loro punto di primo livello di riferimento; se devi utilizzare i sotto-punti, per favore fai in modo che i sotto-elenchi siano corti! Per quanto riguarda gli elenchi numerati devi tenere tutto in una sola unità. Per favore cerca di evitare gli elenchi numerati e se proprio devi utilizzarli cerca di farli brevi.}}<br />
<br />
=== Suddivisione in punti === <br />
<br />
Le suddivisioni in punti sono create utilizzando ''';''' e ''':''' alternativamente. Sono perfetti per descrivere brevemente un gruppo di oggetti correlati.<br />
<br />
<br />
<!--}}-->{{Input|1=<nowiki><br />
;Animali<br />
: Si spostano in giro e divorano altre creature.<br />
<br />
;Piante<br />
: Hanno radici e si nutrono di acqua dal terreno e di sole.<br />
</nowiki>}}<!--{{--><br />
produce<br />
<br />
;Animali<br />
: Si spostano in giro e divorano altre creature.<br />
<br />
;Piante<br />
: Hanno radici e si nutrono di acqua dal terreno e di sole.<br />
<br />
{{Note/it|1=Come sempre tieni ogni elemento in una propria sezione, aiuta molto i traduttori.}}<br />
<br />
===Aggiungere un collegamento=== <br />
<br />
Ci sono due tipi di collegamenti da conoscere: quelli interni per altre pagine di TechBase e quelli a URL esterni.<br />
<br />
Per un collegamento interno il formato <nowiki>[[Typographical_Guidelines]]</nowiki>, nel punto in cui vuoi visualizzare il nome della pagina, funziona, ma non è l'ideale, in particolare per traduzioni in docbook e per la localizzazione. È meglio utilizzare la forma <nowiki>[[Special:myLanguage/Typographical_Guidelines|Struttura della pagina]]</nowiki> perché questa permette ai traduttori di collegare correttamente le pagine anche se i nomi sono tradotti. Il risultato è che l'utente verrà portato nella pagina correttamente tradotta, se ne esiste una. Spesso avrai bisogno di includere il collegamento in una frase, in questo caso utilizza <br />
<br />
{{Input|1=<nowiki>[[Special:myLanguage/Typographical_Guidelines|questa pagina]]</nowiki>}} che visualizza <br />
[[Special:myLanguage/Typographical_Guidelines|questa pagina]]<br />
<br />
I collegamenti esterni sono abbastanza differenti<br />
<br />
{{Input|1=<nowiki>[http://techbase.kde.org/Schedules il nostro piano di lavoro]</nowiki>}} visualizza <br />
[http://techbase.kde.org/Schedules il nostro piano di lavoro] che ti porta direttamente nella pagina di techbase.<br />
<br />
Un'ultima cosa da notare: quando visualizzi in anteprima la tua pagina, tutti i collegamenti sono attivi. Questo ti offre due vantaggi: puoi controllare (passandoci sopra con il mouse) che tutti i collegamenti siano impostati correttamente e puoi utilizzare un collegamento rosso per creare una nuova pagina.<br />
<br />
==Illustrare il testo== <br />
<br />
===Aggiungere una singola immagine centrata=== <br />
<br />
<br />
{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}<br />
<br />
Nota che puoi modificare la posizione dell'immagine, ma quella predefinita è a sinistra. La dimensione dell'immagine dipende dalle circostanze, ma per le schermate ti raccomando non meno di 250px e non più di 500px.<br />
<br />
===Fare in modo che si possa fare clic sull'immagine e aggiungere una didascalia=== <br />
<br />
Quando hai bisogno di mostrare più dettagli, crea un'immagine un'immagine non troppo grande su cui si possa fare clic per visualizzare quella a dimensioni complete. Aggiungi semplicemente il parametro '|thumb' all'interno delle parentesi dell'immagine.<br />
<br />
Una didascalia può anche essere aggiunta come parametro, ma verrà mostrata solo se è presente '|thumb'.<br />
<br />
===Utilizzare le tabelle per posizionare precisamente più immagini=== <br />
<br />
{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}</nowiki>}}<br />
<br />
visualizza<br />
<br />
{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}<br />
<br />
<br />
<br />
Nota che tutti i parametri per un'immagine sono contenuti all'interno di <nowiki>[[...]]</nowiki> e che le celle sono separate da '||'. Per iniziare una nuova riga inserisci '|-' in una riga altrimenti vuota e poi '|' all'inizio della successiva.<br />
<br />
==Aggiungere note ed avvertimenti==<br />
<br />
Quando serve inserire una nota o un avvertimento nel testo, utilizza questi modelli:<br />
<br />
<nowiki>{{Info|Questa è un'informazione generale}}</nowiki> visualizza<br />
{{Info|Questa è un'informazione generale}}<br />
<br />
<nowiki>{{Note|Alcune informazioni importanti a questo punto}}</nowiki> visualizza<br />
{{Note|Alcune informazioni importanti a questo punto}}<br />
<br />
<nowiki>{{Tip|Un consiglio utile, qualcosa da ricordare}}</nowiki>visualizza<br />
{{Tip|Un consiglio utile, qualcosa da ricordare}}<br />
<br />
<nowiki>{{Warning|Stai attento, è una cosa pericolosa da fare}}</nowiki> visualizza<br />
{{Warning|Stai attento, è una cosa pericolosa da fare}}<br />
<br />
Quando è necessario un avvertimento particolarmente forte si può utilizzare il riquadro Remember, ma utilizzalo con parsimonia.<br />
<nowiki>{{Remember|1=Per cose che non devono assolutamente essere dimenticate}}</nowiki><br />
{{Remember|1=Per cose che non devono assolutamente essere dimenticate}}<br />
<br />
Puoi anche modificare l'intestazione:<br />
<br />
{{Remember|2=Da non dimenticare!|1=Puoi utilizzare il parametro numero 2 per impostare l'intestazione di un singolo riquadro:<br />
{{Input|1=<nowiki>{{Remember|2=Da non dimenticare!|1=Puoi utilizzare...}}</nowiki>}}}}<br />
<br />
==Altri modelli utili== <br />
<br />
=== Inserire icone dell'interfaccia === <br />
<br />
Il modo migliore per fare riferimento alle icone nell'interfaccia è visualizzarle nel testo. Puoi farlo con un modello come questo: <code><nowiki>{{Icon|list-add}}</nowiki></code>. Verrà visualizzata l'icona {{Icon|list-add}}.<br />
<br />
Perché questo funzioni l'immagine dell'icona deve essere stata caricata nel wiki. Vedi [[Special:myLanguage/Update_an_Image|Aggiornare un'immagine]] per una spiegazione su come caricare immagini. I file .png si possono di solito trovare qui: <tt>/usr/share/icons/oxygen</tt>. Se possibile utilizza l'icona 16x16. Il nome del file dovrebbe contenere un prefisso <tt>Icon-</tt> come in <tt>Icon-list-add.png</tt> &mdash; mentre il resto dovrebbe corrispondere esattamente al nome consueto dell'icona. Nota che quando utilizzi il modello non devi scrivere il prefisso <tt>Icon-</tt> e nemmeno l'estensione del tipo di file <tt>.png</tt>.<br />
<br />
L'icona {{Plus}} può essere scritta anche come <code><nowiki>{{Plus}}</nowiki></code> e l'icona {{Minus}} come <code><nowiki>{{Minus}}</nowiki></code>. Puoi anche utilizzare <code><nowiki>{{Configure}}</nowiki></code> per ottenere l'icona {{Configure}} e <code><nowiki>{{Exit}}</nowiki></code> per ottenere {{Exit}}.<br />
<br />
===Fare modifiche importanti alle pagine esistenti=== <br />
<br />
Se una pagina rimane aperta per modifiche per un po' di tempo, c'è un rischio di conflitto: qualcun altro potrebbe modificarla nello stesso momento e salvare le tue modifiche comporterà l'annullamento delle sue e viceversa. Il modo per evitarlo è inserire una voce momentanea direttamente sotto la barra delle lingue utilizzando <nowiki>{{Being_Edited}}</nowiki> che visualizzerà<br />
<br />
{{Being_Edited}}<br />
<br />
''Non dimenticare di rimuoverla quando hai finito!''<br />
<br />
===Aggiungere una nuova pagina complessa=== <br />
<br />
Se hai bisogno di poter lavorare su una pagina per un po' di tempo, per più giorni per esempio, potrebbe piacerti utilizzare il modello Construction: <nowiki>{{Construction}}</nowiki> che visualizza<br />
<br />
{{Construction}}<br />
<br />
==Aggiungere un elenco di sotto-pagine== <br />
<br />
{{Input|1=<nowiki>== Sotto-pagine di {{FULLPAGENAME}} ==<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}<br />
<br />
è molto utile se vuoi elencare le sotto-pagine con collegamenti attivi come <br />
<br />
=== Sotto-pagine di {{FULLPAGENAME}}=== <br />
<br />
Tuttavia elenca anche tutte le pagine di "altre lingue", utilizzalo quindi con prudenza.<br />
<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}<br />
<br />
<br />
----<br />
<br />
<br />
<br />
[[Category:Translator_Help]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Translations:Toolbox/73/it&diff=75019Translations:Toolbox/73/it2012-08-27T16:38:13Z<p>Claus chr: </p>
<hr />
<div>{{Remember|2=Da non dimenticare!|1=Puoi utilizzare il parametro numero 2 per impostare l'intestazione di un singolo riquadro:<br />
{{Input|1=<nowiki>{{Remember|2=Da non dimenticare!|1=Puoi utilizzare...}}</nowiki>}}}}</div>Claus chrhttps://techbase.kde.org/index.php?title=Toolbox/it&diff=75018Toolbox/it2012-08-27T16:37:52Z<p>Claus chr: </p>
<hr />
<div><languages /><br />
<br />
{{Info/it|Questa pagina offre esempi di formattazione per compiti comuni}}<br />
<br />
==Formattare il testo== <br />
<br />
===Utilizzare i titoli delle sezioni=== <br />
<br />
I titoli delle sezioni fanno automaticamente parte dell'Indice, devono quindi essere strutturati. La loro posizione nella struttura ad albero è regolata dai caratteri '=' alla fine di ogni titolo. Evita di utilizzarne uno da solo perché indica il titolo di una pagina che dovrebbe essere semmai indicato tramite il titolo automatico della pagina. I titoli delle sezioni principali utilizzeranno '==qui il testo==', il livello successivo '===altro testo===' e così via.<br />
<br />
===Utilizzare il '''grassetto''' e il ''corsivo''=== <br />
<br />
Le virgolette singole sono utilizzate per specificare le parole in grassetto e in corsivo.<br />
<br />
Utilizza <nowiki>'''grassetto'''</nowiki> per specificare il '''testo in grassetto''' e <nowiki>''corsivo''</nowiki> per specificare il ''testo corsivo''.<br />
<br />
Per arrivare ad ottenere traduzioni semplici ed accurate, segui le linee ''[[Special:myLanguage/Typographical_Guidelines|Linee guida tipografiche]].''<br />
<br />
===Aggiungere un frammento di codice=== <br />
<br />
Abbiamo dei modelli per aiutare nella corretta visualizzazione dei frammenti di codice. Esempi d'uso nelle varie situazioni sono disponibili nella pagina [[Special:myLanguage/Typographical_Guidelines|Linee guida tipografiche]]. Codice per vari modelli di riquadri possono essere presi da [[User:Annewilson/Boxes|questa pagina]].<br />
<br />
Se hai problemi a visualizzare i caratteri pipe nel tuo frammento di codice, consulta la spiegazione e il marcatore in dettaglio su [[Special:myLanguage/Typographical_Guidelines|Linee guida tipografiche]].<br />
<br />
===Aggiungere rientri=== <br />
<br />
:"''':'''" è utilizzato per ottenere un rientro. È stato utilizzato ripetuto più volte in alcune vecchie pagine. È una pratica deprecata che causa alcuni problemi, di conseguenza i rientri multipli verranno rimossi non appena trovati. Un singolo "''':'''" inserisce un rientro di quattro caratteri.<br />
<br />
=== Formato delle date === <br />
<br />
Le date in un formato puramente numerico causano confusione a causa delle differenti interpretazioni a seconda della zona geografica. Formatta le date così {{Input|1=<nowiki>18 Mar 2011</nowiki>}} con il mese completo o in forma abbreviata e l'anno nel formato a 4 cifre. Il giorno può essere a singola o doppia cifra.<span id="Bulleted Lists"></span><br />
=== Elenchi puntati === <br />
<br />
<nowiki>*</nowiki> è il simbolo da utilizzare per gli elenchi puntati. ** crea un secondo livello:<br /><br />
<br />
{{<!--}}-->Input|1=<nowiki><br />
* Mandorle<br />
<br />
* Noci<br />
** Anacardi<br />
<br />
* Uvetta<br />
</nowiki>}}<!--{{--><br />
produce<br />
<br />
* Mandorle<br />
<br />
* Noci<br />
** Anacardi<br />
<br />
* Uvetta<br />
<br />
=== Elenchi numerati === <br />
<br />
Gli elenchi numerati sono create nello stesso modo, ma utilizzando '#'.<br />
<br />
{{Input|1=<nowiki><br />
# Setacciare<br />
# Mescolare<br />
## Mescolare accuratamente<br />
# Infornare<br />
</nowiki>}}<br />
<br />
produce<br />
<br />
# Setacciare<br />
# Mescolare<br />
## Mescolare accuratamente<br />
# Infornare<br />
<br />
=== Combinare elenchi puntati e numerati === <br />
<br />
Puoi avere un sotto-elenco numerato in un elenco puntato e viceversa, come questo:<br />
<br />
{{Input|1=<nowiki><br />
* Noci<br />
*# Anacardi<br />
*# Matti<br />
* Altre cose<br />
</nowiki>}}<br />
<br />
produce<br />
<br />
* Noci<br />
*# Anacardi<br />
*# Matti<br />
* Altre cose<br />
<br />
mentre<br />
<br />
{{Input|1=<nowiki><br />
# Noci<br />
#* Anacardi<br />
#* Matti<br />
# Altre cose<br />
</nowiki>}}<br />
<br />
produce<br />
<br />
# Noci<br />
#* Anacardi<br />
#* Matti<br />
# Altre cose<br />
<br />
{{Note/it|1=Gli elenchi numerati non dovrebbero mai contenere righe vuote: spezzano la sequenza e la numerazione riparte da uno. Allo stesso modo non dovrebbero mai esserci righe vuote prima di un elemento di un sotto-elenco numerato o puntato: si creano due livelli di marcature di elementi (puntati o numerati).}}<br />
<br />
{{Note/it|1=Ricordati che i lunghi elenchi sono un problema per i traduttori. Con elenchi puntati a singolo livello posiziona ogni punto in una sezione a sé, cioè inserisci una riga vuota tra i punti. Con elenchi puntati a due livelli, i sotto-elementi devono essere tenuti nella stessa sezione del loro punto di primo livello di riferimento; se devi utilizzare i sotto-punti, per favore fai in modo che i sotto-elenchi siano corti! Per quanto riguarda gli elenchi numerati devi tenere tutto in una sola unità. Per favore cerca di evitare gli elenchi numerati e se proprio devi utilizzarli cerca di farli brevi.}}<br />
<br />
=== Suddivisione in punti === <br />
<br />
Le suddivisioni in punti sono create utilizzando ''';''' e ''':''' alternativamente. Sono perfetti per descrivere brevemente un gruppo di oggetti correlati.<br />
<br />
<br />
<!--}}-->{{Input|1=<nowiki><br />
;Animali<br />
: Si spostano in giro e divorano altre creature.<br />
<br />
;Piante<br />
: Hanno radici e si nutrono di acqua dal terreno e di sole.<br />
</nowiki>}}<!--{{--><br />
produce<br />
<br />
;Animali<br />
: Si spostano in giro e divorano altre creature.<br />
<br />
;Piante<br />
: Hanno radici e si nutrono di acqua dal terreno e di sole.<br />
<br />
{{Note/it|1=Come sempre tieni ogni elemento in una propria sezione, aiuta molto i traduttori.}}<br />
<br />
===Aggiungere un collegamento=== <br />
<br />
Ci sono due tipi di collegamenti da conoscere: quelli interni per altre pagine di TechBase e quelli a URL esterni.<br />
<br />
Per un collegamento interno il formato <nowiki>[[Typographical_Guidelines]]</nowiki>, nel punto in cui vuoi visualizzare il nome della pagina, funziona, ma non è l'ideale, in particolare per traduzioni in docbook e per la localizzazione. È meglio utilizzare la forma <nowiki>[[Special:myLanguage/Typographical_Guidelines|Struttura della pagina]]</nowiki> perché questa permette ai traduttori di collegare correttamente le pagine anche se i nomi sono tradotti. Il risultato è che l'utente verrà portato nella pagina correttamente tradotta, se ne esiste una. Spesso avrai bisogno di includere il collegamento in una frase, in questo caso utilizza <br />
<br />
{{Input|1=<nowiki>[[Special:myLanguage/Typographical_Guidelines|questa pagina]]</nowiki>}} che visualizza <br />
[[Special:myLanguage/Typographical_Guidelines|questa pagina]]<br />
<br />
I collegamenti esterni sono abbastanza differenti<br />
<br />
{{Input|1=<nowiki>[http://techbase.kde.org/Schedules il nostro piano di lavoro]</nowiki>}} visualizza <br />
[http://techbase.kde.org/Schedules il nostro piano di lavoro] che ti porta direttamente nella pagina di techbase.<br />
<br />
Un'ultima cosa da notare: quando visualizzi in anteprima la tua pagina, tutti i collegamenti sono attivi. Questo ti offre due vantaggi: puoi controllare (passandoci sopra con il mouse) che tutti i collegamenti siano impostati correttamente e puoi utilizzare un collegamento rosso per creare una nuova pagina.<br />
<br />
==Illustrare il testo== <br />
<br />
===Aggiungere una singola immagine centrata=== <br />
<br />
<br />
{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}<br />
<br />
Nota che puoi modificare la posizione dell'immagine, ma quella predefinita è a sinistra. La dimensione dell'immagine dipende dalle circostanze, ma per le schermate ti raccomando non meno di 250px e non più di 500px.<br />
<br />
===Fare in modo che si possa fare clic sull'immagine e aggiungere una didascalia=== <br />
<br />
Quando hai bisogno di mostrare più dettagli, crea un'immagine un'immagine non troppo grande su cui si possa fare clic per visualizzare quella a dimensioni complete. Aggiungi semplicemente il parametro '|thumb' all'interno delle parentesi dell'immagine.<br />
<br />
Una didascalia può anche essere aggiunta come parametro, ma verrà mostrata solo se è presente '|thumb'.<br />
<br />
===Utilizzare le tabelle per posizionare precisamente più immagini=== <br />
<br />
{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}</nowiki>}}<br />
<br />
visualizza<br />
<br />
{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}<br />
<br />
<br />
<br />
Nota che tutti i parametri per un'immagine sono contenuti all'interno di <nowiki>[[...]]</nowiki> e che le celle sono separate da '||'. Per iniziare una nuova riga inserisci '|-' in una riga altrimenti vuota e poi '|' all'inizio della successiva.<br />
<br />
==Aggiungere note ed avvertimenti==<br />
<br />
Quando serve inserire una nota o un avvertimento nel testo, utilizza questi modelli:<br />
<br />
<nowiki>{{Info|Questa è un'informazione generale}}</nowiki> visualizza<br />
{{Info|Questa è un'informazione generale}}<br />
<br />
<nowiki>{{Note|Alcune informazioni importanti a questo punto}}</nowiki> visualizza<br />
{{Note|Alcune informazioni importanti a questo punto}}<br />
<br />
<nowiki>{{Tip|Un consiglio utile, qualcosa da ricordare}}</nowiki>visualizza<br />
{{Tip|Un consiglio utile, qualcosa da ricordare}}<br />
<br />
<nowiki>{{Warning|Stai attento, è una cosa pericolosa da fare}}</nowiki> visualizza<br />
{{Warning|Stai attento, è una cosa pericolosa da fare}}<br />
<br />
Quando è necessario un avvertimento particolarmente forte si può utilizzare il riquadro Remember, ma utilizzalo con parsimonia.<br />
<nowiki>{{Remember|1=Per cose che non devono assolutamente essere dimenticate}}</nowiki><br />
{{Remember|1=Per cose che non devono assolutamente essere dimenticate}}<br />
<br />
Puoi anche modificare l'intestazione:<br />
<br />
{{Remember|2=Da non dimenticare!|1=Puoi utilizzare il parametro numero 3 per impostare l'intestazione di un singolo riquadro:<br />
{{Input|1=<nowiki>{{Remember|2=Da non dimenticare!|1=Puoi utilizzare...}}</nowiki>}}}}<br />
<br />
==Altri modelli utili== <br />
<br />
=== Inserire icone dell'interfaccia === <br />
<br />
Il modo migliore per fare riferimento alle icone nell'interfaccia è visualizzarle nel testo. Puoi farlo con un modello come questo: <code><nowiki>{{Icon|list-add}}</nowiki></code>. Verrà visualizzata l'icona {{Icon|list-add}}.<br />
<br />
Perché questo funzioni l'immagine dell'icona deve essere stata caricata nel wiki. Vedi [[Special:myLanguage/Update_an_Image|Aggiornare un'immagine]] per una spiegazione su come caricare immagini. I file .png si possono di solito trovare qui: <tt>/usr/share/icons/oxygen</tt>. Se possibile utilizza l'icona 16x16. Il nome del file dovrebbe contenere un prefisso <tt>Icon-</tt> come in <tt>Icon-list-add.png</tt> &mdash; mentre il resto dovrebbe corrispondere esattamente al nome consueto dell'icona. Nota che quando utilizzi il modello non devi scrivere il prefisso <tt>Icon-</tt> e nemmeno l'estensione del tipo di file <tt>.png</tt>.<br />
<br />
L'icona {{Plus}} può essere scritta anche come <code><nowiki>{{Plus}}</nowiki></code> e l'icona {{Minus}} come <code><nowiki>{{Minus}}</nowiki></code>. Puoi anche utilizzare <code><nowiki>{{Configure}}</nowiki></code> per ottenere l'icona {{Configure}} e <code><nowiki>{{Exit}}</nowiki></code> per ottenere {{Exit}}.<br />
<br />
===Fare modifiche importanti alle pagine esistenti=== <br />
<br />
Se una pagina rimane aperta per modifiche per un po' di tempo, c'è un rischio di conflitto: qualcun altro potrebbe modificarla nello stesso momento e salvare le tue modifiche comporterà l'annullamento delle sue e viceversa. Il modo per evitarlo è inserire una voce momentanea direttamente sotto la barra delle lingue utilizzando <nowiki>{{Being_Edited}}</nowiki> che visualizzerà<br />
<br />
{{Being_Edited}}<br />
<br />
''Non dimenticare di rimuoverla quando hai finito!''<br />
<br />
===Aggiungere una nuova pagina complessa=== <br />
<br />
Se hai bisogno di poter lavorare su una pagina per un po' di tempo, per più giorni per esempio, potrebbe piacerti utilizzare il modello Construction: <nowiki>{{Construction}}</nowiki> che visualizza<br />
<br />
{{Construction}}<br />
<br />
==Aggiungere un elenco di sotto-pagine== <br />
<br />
{{Input|1=<nowiki>== Sotto-pagine di {{FULLPAGENAME}} ==<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}<br />
<br />
è molto utile se vuoi elencare le sotto-pagine con collegamenti attivi come <br />
<br />
=== Sotto-pagine di {{FULLPAGENAME}}=== <br />
<br />
Tuttavia elenca anche tutte le pagine di "altre lingue", utilizzalo quindi con prudenza.<br />
<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}<br />
<br />
<br />
----<br />
<br />
<br />
<br />
[[Category:Translator_Help]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Translations:Toolbox/73/it&diff=75017Translations:Toolbox/73/it2012-08-27T16:37:52Z<p>Claus chr: </p>
<hr />
<div>{{Remember|2=Da non dimenticare!|1=Puoi utilizzare il parametro numero 3 per impostare l'intestazione di un singolo riquadro:<br />
{{Input|1=<nowiki>{{Remember|2=Da non dimenticare!|1=Puoi utilizzare...}}</nowiki>}}}}</div>Claus chrhttps://techbase.kde.org/index.php?title=Toolbox/it&diff=75016Toolbox/it2012-08-27T16:37:32Z<p>Claus chr: </p>
<hr />
<div><languages /><br />
<br />
{{Info/it|Questa pagina offre esempi di formattazione per compiti comuni}}<br />
<br />
==Formattare il testo== <br />
<br />
===Utilizzare i titoli delle sezioni=== <br />
<br />
I titoli delle sezioni fanno automaticamente parte dell'Indice, devono quindi essere strutturati. La loro posizione nella struttura ad albero è regolata dai caratteri '=' alla fine di ogni titolo. Evita di utilizzarne uno da solo perché indica il titolo di una pagina che dovrebbe essere semmai indicato tramite il titolo automatico della pagina. I titoli delle sezioni principali utilizzeranno '==qui il testo==', il livello successivo '===altro testo===' e così via.<br />
<br />
===Utilizzare il '''grassetto''' e il ''corsivo''=== <br />
<br />
Le virgolette singole sono utilizzate per specificare le parole in grassetto e in corsivo.<br />
<br />
Utilizza <nowiki>'''grassetto'''</nowiki> per specificare il '''testo in grassetto''' e <nowiki>''corsivo''</nowiki> per specificare il ''testo corsivo''.<br />
<br />
Per arrivare ad ottenere traduzioni semplici ed accurate, segui le linee ''[[Special:myLanguage/Typographical_Guidelines|Linee guida tipografiche]].''<br />
<br />
===Aggiungere un frammento di codice=== <br />
<br />
Abbiamo dei modelli per aiutare nella corretta visualizzazione dei frammenti di codice. Esempi d'uso nelle varie situazioni sono disponibili nella pagina [[Special:myLanguage/Typographical_Guidelines|Linee guida tipografiche]]. Codice per vari modelli di riquadri possono essere presi da [[User:Annewilson/Boxes|questa pagina]].<br />
<br />
Se hai problemi a visualizzare i caratteri pipe nel tuo frammento di codice, consulta la spiegazione e il marcatore in dettaglio su [[Special:myLanguage/Typographical_Guidelines|Linee guida tipografiche]].<br />
<br />
===Aggiungere rientri=== <br />
<br />
:"''':'''" è utilizzato per ottenere un rientro. È stato utilizzato ripetuto più volte in alcune vecchie pagine. È una pratica deprecata che causa alcuni problemi, di conseguenza i rientri multipli verranno rimossi non appena trovati. Un singolo "''':'''" inserisce un rientro di quattro caratteri.<br />
<br />
=== Formato delle date === <br />
<br />
Le date in un formato puramente numerico causano confusione a causa delle differenti interpretazioni a seconda della zona geografica. Formatta le date così {{Input|1=<nowiki>18 Mar 2011</nowiki>}} con il mese completo o in forma abbreviata e l'anno nel formato a 4 cifre. Il giorno può essere a singola o doppia cifra.<span id="Bulleted Lists"></span><br />
=== Elenchi puntati === <br />
<br />
<nowiki>*</nowiki> è il simbolo da utilizzare per gli elenchi puntati. ** crea un secondo livello:<br /><br />
<br />
{{<!--}}-->Input|1=<nowiki><br />
* Mandorle<br />
<br />
* Noci<br />
** Anacardi<br />
<br />
* Uvetta<br />
</nowiki>}}<!--{{--><br />
produce<br />
<br />
* Mandorle<br />
<br />
* Noci<br />
** Anacardi<br />
<br />
* Uvetta<br />
<br />
=== Elenchi numerati === <br />
<br />
Gli elenchi numerati sono create nello stesso modo, ma utilizzando '#'.<br />
<br />
{{Input|1=<nowiki><br />
# Setacciare<br />
# Mescolare<br />
## Mescolare accuratamente<br />
# Infornare<br />
</nowiki>}}<br />
<br />
produce<br />
<br />
# Setacciare<br />
# Mescolare<br />
## Mescolare accuratamente<br />
# Infornare<br />
<br />
=== Combinare elenchi puntati e numerati === <br />
<br />
Puoi avere un sotto-elenco numerato in un elenco puntato e viceversa, come questo:<br />
<br />
{{Input|1=<nowiki><br />
* Noci<br />
*# Anacardi<br />
*# Matti<br />
* Altre cose<br />
</nowiki>}}<br />
<br />
produce<br />
<br />
* Noci<br />
*# Anacardi<br />
*# Matti<br />
* Altre cose<br />
<br />
mentre<br />
<br />
{{Input|1=<nowiki><br />
# Noci<br />
#* Anacardi<br />
#* Matti<br />
# Altre cose<br />
</nowiki>}}<br />
<br />
produce<br />
<br />
# Noci<br />
#* Anacardi<br />
#* Matti<br />
# Altre cose<br />
<br />
{{Note/it|1=Gli elenchi numerati non dovrebbero mai contenere righe vuote: spezzano la sequenza e la numerazione riparte da uno. Allo stesso modo non dovrebbero mai esserci righe vuote prima di un elemento di un sotto-elenco numerato o puntato: si creano due livelli di marcature di elementi (puntati o numerati).}}<br />
<br />
{{Note/it|1=Ricordati che i lunghi elenchi sono un problema per i traduttori. Con elenchi puntati a singolo livello posiziona ogni punto in una sezione a sé, cioè inserisci una riga vuota tra i punti. Con elenchi puntati a due livelli, i sotto-elementi devono essere tenuti nella stessa sezione del loro punto di primo livello di riferimento; se devi utilizzare i sotto-punti, per favore fai in modo che i sotto-elenchi siano corti! Per quanto riguarda gli elenchi numerati devi tenere tutto in una sola unità. Per favore cerca di evitare gli elenchi numerati e se proprio devi utilizzarli cerca di farli brevi.}}<br />
<br />
=== Suddivisione in punti === <br />
<br />
Le suddivisioni in punti sono create utilizzando ''';''' e ''':''' alternativamente. Sono perfetti per descrivere brevemente un gruppo di oggetti correlati.<br />
<br />
<br />
<!--}}-->{{Input|1=<nowiki><br />
;Animali<br />
: Si spostano in giro e divorano altre creature.<br />
<br />
;Piante<br />
: Hanno radici e si nutrono di acqua dal terreno e di sole.<br />
</nowiki>}}<!--{{--><br />
produce<br />
<br />
;Animali<br />
: Si spostano in giro e divorano altre creature.<br />
<br />
;Piante<br />
: Hanno radici e si nutrono di acqua dal terreno e di sole.<br />
<br />
{{Note/it|1=Come sempre tieni ogni elemento in una propria sezione, aiuta molto i traduttori.}}<br />
<br />
===Aggiungere un collegamento=== <br />
<br />
Ci sono due tipi di collegamenti da conoscere: quelli interni per altre pagine di TechBase e quelli a URL esterni.<br />
<br />
Per un collegamento interno il formato <nowiki>[[Typographical_Guidelines]]</nowiki>, nel punto in cui vuoi visualizzare il nome della pagina, funziona, ma non è l'ideale, in particolare per traduzioni in docbook e per la localizzazione. È meglio utilizzare la forma <nowiki>[[Special:myLanguage/Typographical_Guidelines|Struttura della pagina]]</nowiki> perché questa permette ai traduttori di collegare correttamente le pagine anche se i nomi sono tradotti. Il risultato è che l'utente verrà portato nella pagina correttamente tradotta, se ne esiste una. Spesso avrai bisogno di includere il collegamento in una frase, in questo caso utilizza <br />
<br />
{{Input|1=<nowiki>[[Special:myLanguage/Typographical_Guidelines|questa pagina]]</nowiki>}} che visualizza <br />
[[Special:myLanguage/Typographical_Guidelines|questa pagina]]<br />
<br />
I collegamenti esterni sono abbastanza differenti<br />
<br />
{{Input|1=<nowiki>[http://techbase.kde.org/Schedules il nostro piano di lavoro]</nowiki>}} visualizza <br />
[http://techbase.kde.org/Schedules il nostro piano di lavoro] che ti porta direttamente nella pagina di techbase.<br />
<br />
Un'ultima cosa da notare: quando visualizzi in anteprima la tua pagina, tutti i collegamenti sono attivi. Questo ti offre due vantaggi: puoi controllare (passandoci sopra con il mouse) che tutti i collegamenti siano impostati correttamente e puoi utilizzare un collegamento rosso per creare una nuova pagina.<br />
<br />
==Illustrare il testo== <br />
<br />
===Aggiungere una singola immagine centrata=== <br />
<br />
<br />
{{Input|1=<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}<br />
<br />
Nota che puoi modificare la posizione dell'immagine, ma quella predefinita è a sinistra. La dimensione dell'immagine dipende dalle circostanze, ma per le schermate ti raccomando non meno di 250px e non più di 500px.<br />
<br />
===Fare in modo che si possa fare clic sull'immagine e aggiungere una didascalia=== <br />
<br />
Quando hai bisogno di mostrare più dettagli, crea un'immagine un'immagine non troppo grande su cui si possa fare clic per visualizzare quella a dimensioni complete. Aggiungi semplicemente il parametro '|thumb' all'interno delle parentesi dell'immagine.<br />
<br />
Una didascalia può anche essere aggiunta come parametro, ma verrà mostrata solo se è presente '|thumb'.<br />
<br />
===Utilizzare le tabelle per posizionare precisamente più immagini=== <br />
<br />
{{Input|1=<nowiki>{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}</nowiki>}}<br />
<br />
visualizza<br />
<br />
{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}<br />
<br />
<br />
<br />
Nota che tutti i parametri per un'immagine sono contenuti all'interno di <nowiki>[[...]]</nowiki> e che le celle sono separate da '||'. Per iniziare una nuova riga inserisci '|-' in una riga altrimenti vuota e poi '|' all'inizio della successiva.<br />
<br />
==Aggiungere note ed avvertimenti==<br />
<br />
Quando serve inserire una nota o un avvertimento nel testo, utilizza questi modelli:<br />
<br />
<nowiki>{{Info|Questa è un'informazione generale}}</nowiki> visualizza<br />
{{Info|Questa è un'informazione generale}}<br />
<br />
<nowiki>{{Note|Alcune informazioni importanti a questo punto}}</nowiki> visualizza<br />
{{Note|Alcune informazioni importanti a questo punto}}<br />
<br />
<nowiki>{{Tip|Un consiglio utile, qualcosa da ricordare}}</nowiki>visualizza<br />
{{Tip|Un consiglio utile, qualcosa da ricordare}}<br />
<br />
<nowiki>{{Warning|Stai attento, è una cosa pericolosa da fare}}</nowiki> visualizza<br />
{{Warning|Stai attento, è una cosa pericolosa da fare}}<br />
<br />
Quando è necessario un avvertimento particolarmente forte si può utilizzare il riquadro Remember, ma utilizzalo con parsimonia.<br />
<nowiki>{{Remember|1=Per cose che non devono assolutamente essere dimenticate}}</nowiki><br />
{{Remember|1=Per cose che non devono assolutamente essere dimenticate}}<br />
<br />
Puoi anche modificare l'intestazione:<br />
<br />
{{Remember|2=Da non dimenticare!|1=Puoi utilizzare il parametro numero 3 per impostare l'intestazione di un singolo riquadro:<br />
{{Input|1=<nowiki>{{Remember|3=Da non dimenticare!|1=Puoi utilizzare...}}</nowiki>}}}}<br />
<br />
==Altri modelli utili== <br />
<br />
=== Inserire icone dell'interfaccia === <br />
<br />
Il modo migliore per fare riferimento alle icone nell'interfaccia è visualizzarle nel testo. Puoi farlo con un modello come questo: <code><nowiki>{{Icon|list-add}}</nowiki></code>. Verrà visualizzata l'icona {{Icon|list-add}}.<br />
<br />
Perché questo funzioni l'immagine dell'icona deve essere stata caricata nel wiki. Vedi [[Special:myLanguage/Update_an_Image|Aggiornare un'immagine]] per una spiegazione su come caricare immagini. I file .png si possono di solito trovare qui: <tt>/usr/share/icons/oxygen</tt>. Se possibile utilizza l'icona 16x16. Il nome del file dovrebbe contenere un prefisso <tt>Icon-</tt> come in <tt>Icon-list-add.png</tt> &mdash; mentre il resto dovrebbe corrispondere esattamente al nome consueto dell'icona. Nota che quando utilizzi il modello non devi scrivere il prefisso <tt>Icon-</tt> e nemmeno l'estensione del tipo di file <tt>.png</tt>.<br />
<br />
L'icona {{Plus}} può essere scritta anche come <code><nowiki>{{Plus}}</nowiki></code> e l'icona {{Minus}} come <code><nowiki>{{Minus}}</nowiki></code>. Puoi anche utilizzare <code><nowiki>{{Configure}}</nowiki></code> per ottenere l'icona {{Configure}} e <code><nowiki>{{Exit}}</nowiki></code> per ottenere {{Exit}}.<br />
<br />
===Fare modifiche importanti alle pagine esistenti=== <br />
<br />
Se una pagina rimane aperta per modifiche per un po' di tempo, c'è un rischio di conflitto: qualcun altro potrebbe modificarla nello stesso momento e salvare le tue modifiche comporterà l'annullamento delle sue e viceversa. Il modo per evitarlo è inserire una voce momentanea direttamente sotto la barra delle lingue utilizzando <nowiki>{{Being_Edited}}</nowiki> che visualizzerà<br />
<br />
{{Being_Edited}}<br />
<br />
''Non dimenticare di rimuoverla quando hai finito!''<br />
<br />
===Aggiungere una nuova pagina complessa=== <br />
<br />
Se hai bisogno di poter lavorare su una pagina per un po' di tempo, per più giorni per esempio, potrebbe piacerti utilizzare il modello Construction: <nowiki>{{Construction}}</nowiki> che visualizza<br />
<br />
{{Construction}}<br />
<br />
==Aggiungere un elenco di sotto-pagine== <br />
<br />
{{Input|1=<nowiki>== Sotto-pagine di {{FULLPAGENAME}} ==<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}<br />
<br />
è molto utile se vuoi elencare le sotto-pagine con collegamenti attivi come <br />
<br />
=== Sotto-pagine di {{FULLPAGENAME}}=== <br />
<br />
Tuttavia elenca anche tutte le pagine di "altre lingue", utilizzalo quindi con prudenza.<br />
<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}<br />
<br />
<br />
----<br />
<br />
<br />
<br />
[[Category:Translator_Help]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Translations:Toolbox/73/it&diff=75015Translations:Toolbox/73/it2012-08-27T16:37:32Z<p>Claus chr: </p>
<hr />
<div>{{Remember|2=Da non dimenticare!|1=Puoi utilizzare il parametro numero 3 per impostare l'intestazione di un singolo riquadro:<br />
{{Input|1=<nowiki>{{Remember|3=Da non dimenticare!|1=Puoi utilizzare...}}</nowiki>}}}}</div>Claus chrhttps://techbase.kde.org/index.php?title=Toolbox/fi&diff=75014Toolbox/fi2012-08-27T16:36:40Z<p>Claus chr: </p>
<hr />
<div><languages /><br />
<br />
{{Info|2=Tiedot|Tämä sivu tarjoaa esimerkkejä tavallisten tehtävien muotoilukoodeista}}<br />
<br />
== Muotoile tekstiäsi == <br />
<br />
=== Käytä otsakkeita === <br />
<br />
Otsakkeet muokkaavat automaattisesti osan taulukkosisällöistäsi, joten niiden on oltava rakenteisia. Niiden paikkaa puussa hallitaan useilla '=' -merkeillä otsakkeen molemmissa päissä. Vältä yksittäisen '=' -merkin käyttämistä - se osoittaa sivuotsaketta ja pitäisi käyttää automaattista sivuotsaketta. Pääotsakkeesi käyttävät '== teksti menee tähän ==', seuraavalla tasolla, '=== lisää tekstiä ===' ja niin edelleen.<br />
<br />
=== Käytä '''lihavoitu''' ja ''kursivoitu'' === <br />
<br />
Yhden merkin lainausmerkkejä käytetään määrittämään lihavoituja ja kursivoituja sanoja.<br />
<br />
Käytä <nowiki>'''lihavoitu teksti'''</nowiki> määrittämään '''lihavoidun tekstin''' ja<br />
<nowiki>''kursivoitu teksti''</nowiki> määrittämään ''kursivoidun tekstin''.<br />
<br />
Sen takaamiseksi, että saamme helppoja ja tarkkoja kotoistamisia noudata ''[[Special:myLanguage/Typographical_Guidelines|typograafisia ohjeita]].''<br />
<br />
=== Lisää koodipätkä === <br />
<br />
Meillä on mallinteita avustamaan koodipätkien näyttämisessä oikein. Käytön esimerkit eri tilanteissa ovat käytettävissä kohteessa [[Special:myLanguage/Typographical_Guidelines|typograafinen ohjesivu]]. Koodi eri laatikkomallinteisiin voidaan ottaa kohteesta [[User:Annewilson/Boxes|tämä sivu]].<br />
<br />
Jos sinulla on vaikeuksia putkimerkkien näyttämisessä koodipätkässäsi, katso selitys ja yksityiskohtainen merkintäkieli kohteessa [[Special:myLanguage/Typographical_Guidelines|Typograafisia ohjeita]]<br />
<br />
=== Lisää sisennykset === <br />
<br />
:"''':'''" käytetään sisennyksenä, ja sitä käytettiin useita kertoja joillakin vanhoilla sivuilla. Tämä on vanhentunut, ja aiheuttaa joitakin pulmia, joten monikerrat tulee poistaa löydettäessä. Yksittäinen "''':'''"-merkki sisentää neljällä merkillä.<br />
<br />
=== Muotoile päivämäärät === <br />
<br />
Päivämäärät ovat puhtaasti numeerinen muoto, joka aiheuttaa hämmennystä johtuen maantieteellisten vyöhykkeiden odotusten erosta. Muotoile päivämäärät {{Input|3=Syöte|<nowiki>18. maaliskuuta 2011</nowiki>}} kuukaudella joko kokonaan kirjoitettuna tai lyhennetyssä muodossa ja vuosi neljänumeroisessa muodossa. Päivä voi olla yksinumeroinen tai kaksinumeroinen.<span id="Bulleted Lists"></span><br />
=== Luettelomerkkiluettelot === <br />
<br />
<nowiki>*</nowiki> on luettelomerkkiluetteloissa käytetty symboli. ** antaa toisen tason:<br /><br />
<br />
<!--}}-->{{Input|3=Syöte|<nowiki><br />
* Mantelit<br />
<br />
* Pähkinät<br />
** Munuaispuun pähkinät<br />
<br />
* Rusinat<br />
</nowiki>}}<!--{{--><br />
tuottavat<br />
<br />
* Manteleita<br />
<br />
* Pähkinät<br />
** Munuaispuun pähkinät<br />
<br />
* Rusinat<br />
<br />
=== Luettelotyypit === <br />
<br />
Luettelotyypit tuotetaan samalla tavalla käyttäen merkkiä '#'.<br />
<br />
{{Input|3=Syöte|<nowiki><br />
# Siivilöi<br />
# Sekoita<br />
## Sekoita perusteellisesti<br />
# Leivo<br />
</nowiki>}}<br />
<br />
tuottaa<br />
<br />
# Siivilöi<br />
# Sekoita<br />
## Sekoita perusteellisesti<br />
# Leivo<br />
<br />
=== Luettelomerkkiluetteloiden ja luettelotyyppien yhdistäminen === <br />
<br />
Sinulla voi olla luettelotyyppialiluettelo luettelomerkillisessä luettelossa ja päinvastoin, kuten tässä:<br />
<br />
{{Input|3=Syöte|<nowiki><br />
* Pähkinät<br />
*# Munuaispuun pähkinät<br />
*# Hullu<br />
* Muita asioita<br />
</nowiki>}}<br />
<br />
tuottaa<br />
<br />
* Pähkinät<br />
*# Munuaispuun pähkinät<br />
*# Hullu<br />
* Muita asioita<br />
<br />
samalla kun<br />
<br />
{{Input|3=Syöte|<nowiki><br />
# Pähkinät<br />
#* Munuaispuun pähkinät<br />
#* Hullu<br />
# Muita asioita<br />
</nowiki>}}<br />
<br />
tuottaa<br />
<br />
# Pähkinät<br />
#* Munuaispuun pähkinät<br />
#* Hullu<br />
# Muita asioita<br />
<br />
{{Note|2=Huomaa|Luettelotyypeissä ei pitäisi koskaan olla tyhjiä riviä niiden sisällä: se rikkoo sarjan ja numerointi alkaa taas alusta. Samalla tavalla ei pitäisi olla tyhjiä rivejä ennen aliluetteloalkiota oli se luettelotyyppiä tai luettelomerkillinen: se luo kaksi alkioiden merkitsemistasoa (luettelomerkit tai numerot)}}<br />
<br />
{{Note|2=Huomaa|Muista, että pitkät luettelot ovat pulmallisia kotoistajille. Yksitasoisissa luettelomerkillisissä luetteloissa sijoita jokainen luettelomerkki omaan kappaleeseen, toisin sanoen tee tyhjä rivi luettelomerkkien väliin. Kaksitasoisissa luettelomerkeissä alialkiot on pidettävä samassa kappaleessa kuin niiden ylemmän tason luettelomerkit; jos sinun on käytettävä aliluettelomerkkejä, pidä aliluettelo lyhyenä! Kun käytetään luettelotyyppejä, kaikki on pidettävä yhdessä yksikössä. Yritä välttää luettelotyyppejä, ja milloin niitä pitää käyttää, yritä pitää ne lyhyinä.}}<br />
<br />
=== Alkiointi === <br />
<br />
Alkioinnit tuotetaan käyttämällä vaihtoehtoisesti ''';'''- ja ''':'''-merkkejä. Ne soveltuvat parhaiten antamaan lyhyen kuvauksen sukulaisobjektien ryhmästä.<br />
<br />
<br />
<!--}}-->{{Input|3=Syöte|<nowiki><br />
;Eläimet<br />
: Ne liikkuvat ympäriinsä ja ahmivat muita luontokappaleita.<br />
<br />
;Kasvit<br />
: Niillä on juuret ja pohjavesi ja aurinko ruokkivat niitä.<br />
</nowiki>}}<!--{{--><br />
tuottaa<br />
<br />
;Eläimet<br />
: Ne liikkuvat ympäriinsä ja ahmivat muita luontokappaleita.<br />
<br />
;Kasvit<br />
: Niillä on juuret ja pohjavesi ja aurinko ruokkivat niitä.<br />
<br />
{{Note|2=Huomaa|Kuten aina, pidä jokainen alkio omassa lohkossaan; se auttaa kotoistajaa paljon.}}<br />
<br />
===Lisää linkki=== <br />
<br />
Opittavana on kahdentyyppisiä linkkejä, sisäisiä, muille TechBase-sivuille johtavia, ja ulkoisia verkko-osoitelinkkejä.<br />
<br />
Sisäisiä linkkejä varten toimii muoto on <nowiki>[[Typographical_Guidelines]]</nowiki>, milloin haluat näyttää sivun nimen, mutta se ei ole optimaalinen, erityisesti kotoistettaessa docbook-muotoon ja paikallistamisessa. On parempi käyttää muotoa <nowiki>[[Special:myLanguage/Typographical_Guidelines|Typograafiset ohjeet]]</nowiki>, koska se sallii kotoistajan linkittää oikein jopa sellaisen sivun kautta, jonka nimi on kotoistettu. Tulos on, että se ohjaa oikein kotoistetulle sivulle, jos sellainen on olemassa. Linkki on usein sisällytettävä lauseeseen, joten siinä tapauksessa voi käyttää <br />
<br />
{{Input|3=Syöte|<nowiki>[[Special:myLanguage/Typographical_Guidelines|tämä sivu]]</nowiki>}} joka näyttää [[Special:myLanguage/Typographical_Guidelines|tämän sivun]]<br />
<br />
Ulkoiset linkit ovat hiukan erilaisia, joten<br />
<br />
{{Input|3=Syöte|<nowiki>[http://techbase.kde.org/Schedules tiekarttamme]</nowiki>}} näyttää <br />
[http://techbase.kde.org/Schedules tiekarttamme], mikä ohjaisi sinut suoraan techbase-sivulle.<br />
<br />
Viimeinen asia huomattavaksi - kun esikatselet sivujasi, kaikki linkit ovat eläviä. Tämä tarjoaa kaksi etua. Voit tarkistaa (pitämällä hiiren kohdistinta linkin päällä) että linkkisi on asetettu niin kuin olet otaksunut, ja voit käyttää punaista linkkiä luomaan uuden sivun.<br />
<br />
== Kuvita tekstisi == <br />
<br />
=== Lisää yksittäinen keskitetty kuva === <br />
<br />
<br />
{{Input|3=Syöte|<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}<br />
<br />
Huomaa, että voit vaihtaa kuvan sijainnin, mutta oletus on vasen. Kuvan koko riippuu oloista, mutta näyttökaappauksille suosittelen suurempaa tai yhtäsuurta kuin 250 px ja ei suurempaa kuin 500 px.<br />
<br />
=== Tee kuvasta napsautettava, ja lisää kuvateksti === <br />
<br />
Milloin on näytettävä enemmän yksityiskohtia, luo kohtuullisen kokoinen kuva, tee siitä napsautettava, niin että täysikokoinen kuva voidaan nähdä. Lisää vain '|tumb' kuvan kaarisulkumerkkien sisälle.<br />
<br />
Kuvateksti voidaa myös lisätä parametrina, mutta se näkyy vain jos '|tumb' on käytössä.<br />
<br />
=== Käytä taulukkoja useiden kuvien tarkkaan sijoittamiseen === <br />
<br />
{{Input|3=Syöte|<nowiki>{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}</nowiki>}}<br />
<br />
näyttää<br />
<br />
{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}<br />
<br />
<br />
<br />
Huomaa, että yhden kuvan kaikki parametrit ovat tagien <nowiki>[[...]]</nowiki> sisällä, ja solut erotellaan merkeillä '||'. Uuden rivin aloittamiseksi, lisää '|-' muutoin tyhjälle riville, sitten '|' seuraavan rivin alkuun.<br />
<br />
== Lisää huomautuksia ja varoituksia ==<br />
<br />
Siellä missä huomautukset tai varoitukset ovat oleellisia tekstisi sisällä, käytä näitä mallinteita:<br />
<br />
<nowiki>{{Info|2=Tiedot|Tämä on yleisiä tietoja}}</nowiki> näyttää<br />
{{Info|2=Tiedot|Tämä on yleisiä tietoja}}<br />
<br />
<nowiki>{{Note|2=Huomaa|Jotain tärkeää tietoa tässä vaiheessa}}</nowiki> näyttää<br />
{{Note|2=Huom|Jotain tärkeää tietoa tässä vaiheessa}}<br />
<br />
<nowiki>{{Tip|2=Vihje|Hyödyllinen neuvo, jotain muistettavaa}}</nowiki> näyttää<br />
{{Tip|2=Vihje|Hyödyllinen neuvo, jotain muistettavaa}}<br />
<br />
<nowiki>{{Warning|2=Varoitus|Varo - tämä on vaarallinen asia tehtäväksi}}</nowiki> näyttää<br />
{{Warning|2=Varoitus|Varo - tämä on vaarallinen asia tehtäväksi}}<br />
<br />
Siellä missä tarvitaan vahvin mahdollinen varoitus, voidaan käyttää Muista-laatikkoa, mutta käytä sitä säästeliäästi.<br />
<nowiki>{{Remember|2=Muista|Tämä on asia, jota ei saa ehdottomasti unohtaa}}</nowiki> näyttää <br />
{{Remember|2=Muista|Tämä on asia, jota ei saa ehdottomasti unohtaa}}<br />
<br />
Voit myös vaihtaa otsaketta:<br />
<br />
{{Remember|2=Älä unohda tätä!|1=Voit käyttää parametriä numero 3 asettamaan yksilöllisen laatikko-otsakkeen:<br />
{{Input|3=Syöte|<nowiki>{{Remember|2=Älä unohda tätä!|1=Voit käyttää...}}</nowiki>}}}}<br />
<br />
== Muita hyödyllisiä mallinteita == <br />
<br />
=== Käyttöliittymäkuvakkeiden lisääminen === <br />
<br />
Paras tapa viitata kuvakkeisiin graafisessa käyttöliittymässä on näyttää ne tekstissä. Tämä voidaan tehdä mallinteessa kuten tämä: <code><nowiki>{{Icon|list-add}}</nowiki></code>. Tämä näyttää {{Icon|list-add}}-kuvakkeen.<br />
<br />
Jotta tämä toimisi, kuvakekuvatiedosto on oltava ladattu wikiin. Katso [[Special:myLanguage/Update_an_Image|Päivitä kuvaa]] selitykseksi, kuinka kopioidaan kuvia palvelimelle. Tyypin .png tyyppiset kuvat löydetään tavallisesti täältä: <tt>usr/share/icons/oxygen</tt>. On mahdollista käyttää 16x16 -kuvaketta. Kuvatiedostolla pitäisi olla <tt>Icon-</tt>-etuliite kuten tiedostossa <tt>Icon-list-add.png</tt> &mdash; sen lisäksi, että etuliitteen tulisi täsmälleen täsmätä tavalliseen nimeen. Huomaa, että kun käytetään mallinnetta, ei pitäisi kirjoittaa <tt>Icon-</tt>-etuliitettä eikä <tt>.png</tt>-tiedostotarkenninta.<br />
<br />
Kuvake {{Plus}} voidaan myös kirjoittaa <code><nowiki>{{Plus}}</nowiki></code>, ja kuvake {{Minus}} koodina <code><nowiki>{{Minus}}</nowiki></code>. Voit myös käyttää <code><nowiki>{{Configure}}</nowiki></code> kuvakkeen {{Configure}} saamiseksi, ja koodia <code><nowiki>{{Exit}}</nowiki></code> saamaan {{Exit}}-kuvake.<br />
<br />
=== Suurten muokkausten tekeminen olemassaoleviin sivuihin === <br />
<br />
Jos on todennäköistä, että sivua avataan joku kerta muokkausta varten, on olemassa vaara ristiriitoihin - joku muu saattaa muokata samanaikaisesti, ja sinun muutosten tallentaminen peruu heidän muutokset, ja päinvastoin. Yksi tapa välttää se on käyttää tilapäistä merkkiä, suoraan kielipalkin alla. Käyttämällä <nowiki>{{Being_Edited}}</nowiki> näytetään<br />
<br />
{{Being_Edited}}<br />
<br />
''Älä unohda poistaa sitä, kun lopetat!''<br />
<br />
=== Lisätään uusi mutkikas sivu === <br />
<br />
Jos sinun on kyettävä työskentelemään sivulla aika pitkän ajan, esimerkiksi useita päiviä, saatat haluta käyttää Construction-mallinnetta - <nowiki>{{Construction}}</nowiki>, joka näyttää<br />
<br />
{{Construction}}<br />
<br />
== Luetteloiden lisääminen alisivuille == <br />
<br />
{{Input|3=Syöte|<nowiki>== {{FULLPAGENAME}}-alisivu ==<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}<br />
<br />
on hyvin hyödyllinen, kun haluat luetteloida alisivut aktiiveilla linkeillä, kuten <br />
<br />
=== {{FULLPAGENAME}}-alisivu === <br />
<br />
Se kuitenkin luetteloi myös kaikki ''muu-kieliset'' sivut, joten käytä sitä harkitsevasti.<br />
<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}<br />
<br />
<br />
----<br />
<br />
<br />
<br />
[[Category:Translator_Help]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Translations:Toolbox/46/fi&diff=75013Translations:Toolbox/46/fi2012-08-27T16:36:40Z<p>Claus chr: </p>
<hr />
<div>{{Note|2=Huomaa|Kuten aina, pidä jokainen alkio omassa lohkossaan; se auttaa kotoistajaa paljon.}}</div>Claus chrhttps://techbase.kde.org/index.php?title=Toolbox/fi&diff=75012Toolbox/fi2012-08-27T16:35:58Z<p>Claus chr: </p>
<hr />
<div><languages /><br />
<br />
{{Info|2=Tiedot|Tämä sivu tarjoaa esimerkkejä tavallisten tehtävien muotoilukoodeista}}<br />
<br />
== Muotoile tekstiäsi == <br />
<br />
=== Käytä otsakkeita === <br />
<br />
Otsakkeet muokkaavat automaattisesti osan taulukkosisällöistäsi, joten niiden on oltava rakenteisia. Niiden paikkaa puussa hallitaan useilla '=' -merkeillä otsakkeen molemmissa päissä. Vältä yksittäisen '=' -merkin käyttämistä - se osoittaa sivuotsaketta ja pitäisi käyttää automaattista sivuotsaketta. Pääotsakkeesi käyttävät '== teksti menee tähän ==', seuraavalla tasolla, '=== lisää tekstiä ===' ja niin edelleen.<br />
<br />
=== Käytä '''lihavoitu''' ja ''kursivoitu'' === <br />
<br />
Yhden merkin lainausmerkkejä käytetään määrittämään lihavoituja ja kursivoituja sanoja.<br />
<br />
Käytä <nowiki>'''lihavoitu teksti'''</nowiki> määrittämään '''lihavoidun tekstin''' ja<br />
<nowiki>''kursivoitu teksti''</nowiki> määrittämään ''kursivoidun tekstin''.<br />
<br />
Sen takaamiseksi, että saamme helppoja ja tarkkoja kotoistamisia noudata ''[[Special:myLanguage/Typographical_Guidelines|typograafisia ohjeita]].''<br />
<br />
=== Lisää koodipätkä === <br />
<br />
Meillä on mallinteita avustamaan koodipätkien näyttämisessä oikein. Käytön esimerkit eri tilanteissa ovat käytettävissä kohteessa [[Special:myLanguage/Typographical_Guidelines|typograafinen ohjesivu]]. Koodi eri laatikkomallinteisiin voidaan ottaa kohteesta [[User:Annewilson/Boxes|tämä sivu]].<br />
<br />
Jos sinulla on vaikeuksia putkimerkkien näyttämisessä koodipätkässäsi, katso selitys ja yksityiskohtainen merkintäkieli kohteessa [[Special:myLanguage/Typographical_Guidelines|Typograafisia ohjeita]]<br />
<br />
=== Lisää sisennykset === <br />
<br />
:"''':'''" käytetään sisennyksenä, ja sitä käytettiin useita kertoja joillakin vanhoilla sivuilla. Tämä on vanhentunut, ja aiheuttaa joitakin pulmia, joten monikerrat tulee poistaa löydettäessä. Yksittäinen "''':'''"-merkki sisentää neljällä merkillä.<br />
<br />
=== Muotoile päivämäärät === <br />
<br />
Päivämäärät ovat puhtaasti numeerinen muoto, joka aiheuttaa hämmennystä johtuen maantieteellisten vyöhykkeiden odotusten erosta. Muotoile päivämäärät {{Input|3=Syöte|<nowiki>18. maaliskuuta 2011</nowiki>}} kuukaudella joko kokonaan kirjoitettuna tai lyhennetyssä muodossa ja vuosi neljänumeroisessa muodossa. Päivä voi olla yksinumeroinen tai kaksinumeroinen.<span id="Bulleted Lists"></span><br />
=== Luettelomerkkiluettelot === <br />
<br />
<nowiki>*</nowiki> on luettelomerkkiluetteloissa käytetty symboli. ** antaa toisen tason:<br /><br />
<br />
<!--}}-->{{Input|3=Syöte|<nowiki><br />
* Mantelit<br />
<br />
* Pähkinät<br />
** Munuaispuun pähkinät<br />
<br />
* Rusinat<br />
</nowiki>}}<!--{{--><br />
tuottavat<br />
<br />
* Manteleita<br />
<br />
* Pähkinät<br />
** Munuaispuun pähkinät<br />
<br />
* Rusinat<br />
<br />
=== Luettelotyypit === <br />
<br />
Luettelotyypit tuotetaan samalla tavalla käyttäen merkkiä '#'.<br />
<br />
{{Input|3=Syöte|<nowiki><br />
# Siivilöi<br />
# Sekoita<br />
## Sekoita perusteellisesti<br />
# Leivo<br />
</nowiki>}}<br />
<br />
tuottaa<br />
<br />
# Siivilöi<br />
# Sekoita<br />
## Sekoita perusteellisesti<br />
# Leivo<br />
<br />
=== Luettelomerkkiluetteloiden ja luettelotyyppien yhdistäminen === <br />
<br />
Sinulla voi olla luettelotyyppialiluettelo luettelomerkillisessä luettelossa ja päinvastoin, kuten tässä:<br />
<br />
{{Input|3=Syöte|<nowiki><br />
* Pähkinät<br />
*# Munuaispuun pähkinät<br />
*# Hullu<br />
* Muita asioita<br />
</nowiki>}}<br />
<br />
tuottaa<br />
<br />
* Pähkinät<br />
*# Munuaispuun pähkinät<br />
*# Hullu<br />
* Muita asioita<br />
<br />
samalla kun<br />
<br />
{{Input|3=Syöte|<nowiki><br />
# Pähkinät<br />
#* Munuaispuun pähkinät<br />
#* Hullu<br />
# Muita asioita<br />
</nowiki>}}<br />
<br />
tuottaa<br />
<br />
# Pähkinät<br />
#* Munuaispuun pähkinät<br />
#* Hullu<br />
# Muita asioita<br />
<br />
{{Note|2=Huomaa|Luettelotyypeissä ei pitäisi koskaan olla tyhjiä riviä niiden sisällä: se rikkoo sarjan ja numerointi alkaa taas alusta. Samalla tavalla ei pitäisi olla tyhjiä rivejä ennen aliluetteloalkiota oli se luettelotyyppiä tai luettelomerkillinen: se luo kaksi alkioiden merkitsemistasoa (luettelomerkit tai numerot)}}<br />
<br />
{{Note|2=Huomaa|Muista, että pitkät luettelot ovat pulmallisia kotoistajille. Yksitasoisissa luettelomerkillisissä luetteloissa sijoita jokainen luettelomerkki omaan kappaleeseen, toisin sanoen tee tyhjä rivi luettelomerkkien väliin. Kaksitasoisissa luettelomerkeissä alialkiot on pidettävä samassa kappaleessa kuin niiden ylemmän tason luettelomerkit; jos sinun on käytettävä aliluettelomerkkejä, pidä aliluettelo lyhyenä! Kun käytetään luettelotyyppejä, kaikki on pidettävä yhdessä yksikössä. Yritä välttää luettelotyyppejä, ja milloin niitä pitää käyttää, yritä pitää ne lyhyinä.}}<br />
<br />
=== Alkiointi === <br />
<br />
Alkioinnit tuotetaan käyttämällä vaihtoehtoisesti ''';'''- ja ''':'''-merkkejä. Ne soveltuvat parhaiten antamaan lyhyen kuvauksen sukulaisobjektien ryhmästä.<br />
<br />
<br />
<!--}}-->{{Input|3=Syöte|<nowiki><br />
;Eläimet<br />
: Ne liikkuvat ympäriinsä ja ahmivat muita luontokappaleita.<br />
<br />
;Kasvit<br />
: Niillä on juuret ja pohjavesi ja aurinko ruokkivat niitä.<br />
</nowiki>}}<!--{{--><br />
tuottaa<br />
<br />
;Eläimet<br />
: Ne liikkuvat ympäriinsä ja ahmivat muita luontokappaleita.<br />
<br />
;Kasvit<br />
: Niillä on juuret ja pohjavesi ja aurinko ruokkivat niitä.<br />
<br />
{{Note|3=Huomaa|Kuten aina, pidä jokainen alkio omassa lohkossaan; se auttaa kotoistajaa paljon.}}<br />
<br />
===Lisää linkki=== <br />
<br />
Opittavana on kahdentyyppisiä linkkejä, sisäisiä, muille TechBase-sivuille johtavia, ja ulkoisia verkko-osoitelinkkejä.<br />
<br />
Sisäisiä linkkejä varten toimii muoto on <nowiki>[[Typographical_Guidelines]]</nowiki>, milloin haluat näyttää sivun nimen, mutta se ei ole optimaalinen, erityisesti kotoistettaessa docbook-muotoon ja paikallistamisessa. On parempi käyttää muotoa <nowiki>[[Special:myLanguage/Typographical_Guidelines|Typograafiset ohjeet]]</nowiki>, koska se sallii kotoistajan linkittää oikein jopa sellaisen sivun kautta, jonka nimi on kotoistettu. Tulos on, että se ohjaa oikein kotoistetulle sivulle, jos sellainen on olemassa. Linkki on usein sisällytettävä lauseeseen, joten siinä tapauksessa voi käyttää <br />
<br />
{{Input|3=Syöte|<nowiki>[[Special:myLanguage/Typographical_Guidelines|tämä sivu]]</nowiki>}} joka näyttää [[Special:myLanguage/Typographical_Guidelines|tämän sivun]]<br />
<br />
Ulkoiset linkit ovat hiukan erilaisia, joten<br />
<br />
{{Input|3=Syöte|<nowiki>[http://techbase.kde.org/Schedules tiekarttamme]</nowiki>}} näyttää <br />
[http://techbase.kde.org/Schedules tiekarttamme], mikä ohjaisi sinut suoraan techbase-sivulle.<br />
<br />
Viimeinen asia huomattavaksi - kun esikatselet sivujasi, kaikki linkit ovat eläviä. Tämä tarjoaa kaksi etua. Voit tarkistaa (pitämällä hiiren kohdistinta linkin päällä) että linkkisi on asetettu niin kuin olet otaksunut, ja voit käyttää punaista linkkiä luomaan uuden sivun.<br />
<br />
== Kuvita tekstisi == <br />
<br />
=== Lisää yksittäinen keskitetty kuva === <br />
<br />
<br />
{{Input|3=Syöte|<nowiki>[[Image:KMail-kde4.png|250px|center]]</nowiki>}}<br />
<br />
Huomaa, että voit vaihtaa kuvan sijainnin, mutta oletus on vasen. Kuvan koko riippuu oloista, mutta näyttökaappauksille suosittelen suurempaa tai yhtäsuurta kuin 250 px ja ei suurempaa kuin 500 px.<br />
<br />
=== Tee kuvasta napsautettava, ja lisää kuvateksti === <br />
<br />
Milloin on näytettävä enemmän yksityiskohtia, luo kohtuullisen kokoinen kuva, tee siitä napsautettava, niin että täysikokoinen kuva voidaan nähdä. Lisää vain '|tumb' kuvan kaarisulkumerkkien sisälle.<br />
<br />
Kuvateksti voidaa myös lisätä parametrina, mutta se näkyy vain jos '|tumb' on käytössä.<br />
<br />
=== Käytä taulukkoja useiden kuvien tarkkaan sijoittamiseen === <br />
<br />
{{Input|3=Syöte|<nowiki>{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}</nowiki>}}<br />
<br />
näyttää<br />
<br />
{|class="tablecenter" style="border: 1px solid grey;"<br />
|[[Image:Desktop-config-customized.png|230px|center]]||[[Image:Desktop-settings-rightclick.png|230px|center]]<br />
|-<br />
|[[Image:Desktop-theme-details-dialog.png|230px|center]]||[[Image:Plasma-multiple-themes.png|230px|center]]<br />
|}<br />
<br />
<br />
<br />
Huomaa, että yhden kuvan kaikki parametrit ovat tagien <nowiki>[[...]]</nowiki> sisällä, ja solut erotellaan merkeillä '||'. Uuden rivin aloittamiseksi, lisää '|-' muutoin tyhjälle riville, sitten '|' seuraavan rivin alkuun.<br />
<br />
== Lisää huomautuksia ja varoituksia ==<br />
<br />
Siellä missä huomautukset tai varoitukset ovat oleellisia tekstisi sisällä, käytä näitä mallinteita:<br />
<br />
<nowiki>{{Info|2=Tiedot|Tämä on yleisiä tietoja}}</nowiki> näyttää<br />
{{Info|2=Tiedot|Tämä on yleisiä tietoja}}<br />
<br />
<nowiki>{{Note|2=Huomaa|Jotain tärkeää tietoa tässä vaiheessa}}</nowiki> näyttää<br />
{{Note|2=Huom|Jotain tärkeää tietoa tässä vaiheessa}}<br />
<br />
<nowiki>{{Tip|2=Vihje|Hyödyllinen neuvo, jotain muistettavaa}}</nowiki> näyttää<br />
{{Tip|2=Vihje|Hyödyllinen neuvo, jotain muistettavaa}}<br />
<br />
<nowiki>{{Warning|2=Varoitus|Varo - tämä on vaarallinen asia tehtäväksi}}</nowiki> näyttää<br />
{{Warning|2=Varoitus|Varo - tämä on vaarallinen asia tehtäväksi}}<br />
<br />
Siellä missä tarvitaan vahvin mahdollinen varoitus, voidaan käyttää Muista-laatikkoa, mutta käytä sitä säästeliäästi.<br />
<nowiki>{{Remember|2=Muista|Tämä on asia, jota ei saa ehdottomasti unohtaa}}</nowiki> näyttää <br />
{{Remember|2=Muista|Tämä on asia, jota ei saa ehdottomasti unohtaa}}<br />
<br />
Voit myös vaihtaa otsaketta:<br />
<br />
{{Remember|2=Älä unohda tätä!|1=Voit käyttää parametriä numero 3 asettamaan yksilöllisen laatikko-otsakkeen:<br />
{{Input|3=Syöte|<nowiki>{{Remember|2=Älä unohda tätä!|1=Voit käyttää...}}</nowiki>}}}}<br />
<br />
== Muita hyödyllisiä mallinteita == <br />
<br />
=== Käyttöliittymäkuvakkeiden lisääminen === <br />
<br />
Paras tapa viitata kuvakkeisiin graafisessa käyttöliittymässä on näyttää ne tekstissä. Tämä voidaan tehdä mallinteessa kuten tämä: <code><nowiki>{{Icon|list-add}}</nowiki></code>. Tämä näyttää {{Icon|list-add}}-kuvakkeen.<br />
<br />
Jotta tämä toimisi, kuvakekuvatiedosto on oltava ladattu wikiin. Katso [[Special:myLanguage/Update_an_Image|Päivitä kuvaa]] selitykseksi, kuinka kopioidaan kuvia palvelimelle. Tyypin .png tyyppiset kuvat löydetään tavallisesti täältä: <tt>usr/share/icons/oxygen</tt>. On mahdollista käyttää 16x16 -kuvaketta. Kuvatiedostolla pitäisi olla <tt>Icon-</tt>-etuliite kuten tiedostossa <tt>Icon-list-add.png</tt> &mdash; sen lisäksi, että etuliitteen tulisi täsmälleen täsmätä tavalliseen nimeen. Huomaa, että kun käytetään mallinnetta, ei pitäisi kirjoittaa <tt>Icon-</tt>-etuliitettä eikä <tt>.png</tt>-tiedostotarkenninta.<br />
<br />
Kuvake {{Plus}} voidaan myös kirjoittaa <code><nowiki>{{Plus}}</nowiki></code>, ja kuvake {{Minus}} koodina <code><nowiki>{{Minus}}</nowiki></code>. Voit myös käyttää <code><nowiki>{{Configure}}</nowiki></code> kuvakkeen {{Configure}} saamiseksi, ja koodia <code><nowiki>{{Exit}}</nowiki></code> saamaan {{Exit}}-kuvake.<br />
<br />
=== Suurten muokkausten tekeminen olemassaoleviin sivuihin === <br />
<br />
Jos on todennäköistä, että sivua avataan joku kerta muokkausta varten, on olemassa vaara ristiriitoihin - joku muu saattaa muokata samanaikaisesti, ja sinun muutosten tallentaminen peruu heidän muutokset, ja päinvastoin. Yksi tapa välttää se on käyttää tilapäistä merkkiä, suoraan kielipalkin alla. Käyttämällä <nowiki>{{Being_Edited}}</nowiki> näytetään<br />
<br />
{{Being_Edited}}<br />
<br />
''Älä unohda poistaa sitä, kun lopetat!''<br />
<br />
=== Lisätään uusi mutkikas sivu === <br />
<br />
Jos sinun on kyettävä työskentelemään sivulla aika pitkän ajan, esimerkiksi useita päiviä, saatat haluta käyttää Construction-mallinnetta - <nowiki>{{Construction}}</nowiki>, joka näyttää<br />
<br />
{{Construction}}<br />
<br />
== Luetteloiden lisääminen alisivuille == <br />
<br />
{{Input|3=Syöte|<nowiki>== {{FULLPAGENAME}}-alisivu ==<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}</nowiki>}}<br />
<br />
on hyvin hyödyllinen, kun haluat luetteloida alisivut aktiiveilla linkeillä, kuten <br />
<br />
=== {{FULLPAGENAME}}-alisivu === <br />
<br />
Se kuitenkin luetteloi myös kaikki ''muu-kieliset'' sivut, joten käytä sitä harkitsevasti.<br />
<br />
{{Special:PrefixIndex/{{FULLPAGENAME}}/}}<br />
<br />
<br />
----<br />
<br />
<br />
<br />
[[Category:Translator_Help]]</div>Claus chrhttps://techbase.kde.org/index.php?title=Translations:Toolbox/73/fi&diff=75011Translations:Toolbox/73/fi2012-08-27T16:35:58Z<p>Claus chr: </p>
<hr />
<div>{{Remember|2=Älä unohda tätä!|1=Voit käyttää parametriä numero 3 asettamaan yksilöllisen laatikko-otsakkeen:<br />
{{Input|3=Syöte|<nowiki>{{Remember|2=Älä unohda tätä!|1=Voit käyttää...}}</nowiki>}}}}</div>Claus chr