Help:Contents: Difference between revisions
m (→Syntaxe Wiki) |
ChristianW (talk | contribs) (Typo: The color colde parameter) |
||
| (10 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<languages /> | |||
<translate> | |||
<!--T:1--> | |||
Before you start to add or change content, please read: | Before you start to add or change content, please read: | ||
* [[Help:Contribute|Contributing to TechBase]] | * [[Help:Contribute|Contributing to TechBase]] | ||
| Line 8: | Line 10: | ||
* [[KDE_TechBase:Contributors|List of active contributors]], also contact points | * [[KDE_TechBase:Contributors|List of active contributors]], also contact points | ||
== | == Wiki Syntax == <!--T:2--> | ||
* [http:// | <!--T:3--> | ||
To get started with the MediaWiki syntax, read: | |||
* [http://en.wikipedia.org/wiki/Help:Editing Help on Editing] | |||
* [http://meta.wikimedia.org/wiki/Help:Table Wikitables] | * [http://meta.wikimedia.org/wiki/Help:Table Wikitables] | ||
<!--T:4--> | |||
* [http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax Syntax for displaying images] | * [http://en.wikipedia.org/wiki/Wikipedia:Extended_image_syntax Syntax for displaying images] | ||
* [http://en.wikipedia.org/wiki/Help:Magic_words Magic words] | * [http://en.wikipedia.org/wiki/Help:Magic_words Magic words] | ||
<!--T:5--> | |||
* [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet The most important commands] | * [http://en.wikipedia.org/wiki/Wikipedia:Cheatsheet The most important commands] | ||
* How to [[KDE TechBase:Migrate content|Migrate content]] | * How to [[KDE TechBase:Migrate content|Migrate content]] | ||
== Tips == | == Tips == <!--T:6--> | ||
<!--T:7--> | |||
; Syntax highlighting | ; Syntax highlighting | ||
: Wrap your C++ Qt/KDE code snippets in <tt><syntaxhighlight lang="cpp"></tt>, <tt><syntaxhighlight lang="cpp" line=""></tt>, <tt><syntaxhighlight lang="cpp-qt"></tt> and <tt></syntaxhighlight></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. | : Wrap your C++ Qt/KDE code snippets in <tt><syntaxhighlight lang="cpp"></tt>, <tt><syntaxhighlight lang="cpp" line=""></tt>, <tt><syntaxhighlight lang="cpp-qt"></tt> and <tt></syntaxhighlight></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. | ||
== New Templates == | == New Templates == <!--T:8--> | ||
<!--T:9--> | |||
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. | 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. | ||
<!--T:10--> | |||
; [[Template:movepage|<nowiki>{{movepage|url}}</nowiki>]] | ; [[Template:movepage|<nowiki>{{movepage|url}}</nowiki>]] | ||
: Use this template to mark a page as not finished. | : Use this template to mark a page as not finished. | ||
<!--T:11--> | |||
; [[Template:Improve|<nowiki>{{improve|explanation}}</nowiki>]] | ; [[Template:Improve|<nowiki>{{improve|explanation}}</nowiki>]] | ||
: Pages which need cleanups or contain empty sections and/or todos are marked with this template. Add an explanation if you want (optional) | : Pages which need cleanups or contain empty sections and/or todos are marked with this template. Add an explanation if you want (optional) | ||
<!--T:12--> | |||
; [[Template:tip|<nowiki>{{tip|text}}</nowiki>]] | ; [[Template:tip|<nowiki>{{tip|text}}</nowiki>]] | ||
: Use this template to add a tip for the reader. | : Use this template to add a tip for the reader. | ||
<!--T:13--> | |||
; [[Template:note|<nowiki>{{note|text}}</nowiki>]] | ; [[Template:note|<nowiki>{{note|text}}</nowiki>]] | ||
: Use this template to add an explanatory note. | : Use this template to add an explanatory note. | ||
<!--T:14--> | |||
; [[Template:warning|<nowiki>{{warning|text}}</nowiki>]] | ; [[Template:warning|<nowiki>{{warning|text}}</nowiki>]] | ||
: Use this template to add a warning. | : Use this template to add a warning. | ||
<!--T:15--> | |||
; [[Template:qt|<nowiki>{{qt|class-name}}</nowiki>]] and [[Template:qt3|<nowiki>{{qt3|class-name}}</nowiki>]] | ; [[Template:qt|<nowiki>{{qt|class-name}}</nowiki>]] and [[Template:qt3|<nowiki>{{qt3|class-name}}</nowiki>]] | ||
: Use this template to generate a link to a Qt class, e.g. QWidget. For Qt3 classes use <nowiki>{{qt3|class-name}}</nowiki> | : Use this template to generate a link to a Qt class, e.g. QWidget. For Qt3 classes use <nowiki>{{qt3|class-name}}</nowiki> | ||
<!--T:16--> | |||
; [[Template:class|<nowiki>{{class|class-name}}</nowiki>]] | ; [[Template:class|<nowiki>{{class|class-name}}</nowiki>]] | ||
: Use this template to generate a link to a KDE class, e.g. KDialog. | : Use this template to generate a link to a KDE class, e.g. KDialog. | ||
<!--T:17--> | |||
; [[Template:path|<nowiki>{{path|path-or-filename}}</nowiki>]] | ; [[Template:path|<nowiki>{{path|path-or-filename}}</nowiki>]] | ||
: Use this template for paths and filenames, this way all of them have a consistent style. | : Use this template for paths and filenames, this way all of them have a consistent style. | ||
<!--T:18--> | |||
; [[Template:bug|<nowiki>{{bug|123456}}</nowiki>]] | ; [[Template:bug|<nowiki>{{bug|123456}}</nowiki>]] | ||
: Use this template to automatically create a link to KDE's bugzilla. | : Use this template to automatically create a link to KDE's bugzilla. | ||
<!--T:19--> | |||
; [[Template:KDE3|<nowiki>{{KDE3}}</nowiki>]] | ; [[Template:KDE3|<nowiki>{{KDE3}}</nowiki>]] | ||
: 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>. | : 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>. | ||
<!--T:20--> | |||
; [[Template:TutorialBrowser|<nowiki>{{TutorialBrowser|series|name|pre|next|reading}}</nowiki>]] | ; [[Template:TutorialBrowser|<nowiki>{{TutorialBrowser|series|name|pre|next|reading}}</nowiki>]] | ||
: A template for tutorial navigation | : A template for tutorial navigation | ||
; [[Template:Box|<nowiki>{{Box|caption|text|width|float}}</nowiki>]] | <!--T:21--> | ||
; [[Template:Box|<nowiki>{{Box|caption|text|width|float}}</nowiki>]] - Deprecated, please use Box1 | |||
: 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. | : 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. | ||
<!--T:22--> | |||
; [[Template:Box1|<nowiki>{{Box1|text|caption|icon image|color code}}</nowiki>]] | |||
: Use this template to create a box with a caption and a text. The color code 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. | |||
</translate> | |||
Latest revision as of 09:17, 19 May 2019
Before you start to add or change content, please read:
- Contributing to TechBase
- Wiki Structure
- Translation into other Languages
- Migrating Content
- List of active contributors, also contact points
Wiki Syntax
To get started with the MediaWiki syntax, read:
Tips
- Syntax highlighting
- Wrap your C++ Qt/KDE code snippets in <syntaxhighlight lang="cpp">, <syntaxhighlight lang="cpp" line="">, <syntaxhighlight lang="cpp-qt"> and </syntaxhighlight> to get syntax highlighting (cpp for C++, cpp-qt for Qt) and numbered lines (line=""). Replace cpp with the language used, e.g. ruby for Ruby and python for Python (soon). Use ini for .desktop files, xml for XML files.
New Templates
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.
- {{movepage|url}}
- Use this template to mark a page as not finished.
- {{improve|explanation}}
- Pages which need cleanups or contain empty sections and/or todos are marked with this template. Add an explanation if you want (optional)
- {{tip|text}}
- Use this template to add a tip for the reader.
- {{note|text}}
- Use this template to add an explanatory note.
- {{warning|text}}
- Use this template to add a warning.
- {{qt|class-name}} and {{qt3|class-name}}
- Use this template to generate a link to a Qt class, e.g. QWidget. For Qt3 classes use {{qt3|class-name}}
- {{class|class-name}}
- Use this template to generate a link to a KDE class, e.g. KDialog.
- {{path|path-or-filename}}
- Use this template for paths and filenames, this way all of them have a consistent style.
- {{bug|123456}}
- Use this template to automatically create a link to KDE's bugzilla.
- {{KDE3}}
- 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 [[Category:KDE4]].
- {{TutorialBrowser|series|name|pre|next|reading}}
- A template for tutorial navigation
- {{Box|caption|text|width|float}} - Deprecated, please use Box1
- 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.
- {{Box1|text|caption|icon image|color code}}
- Use this template to create a box with a caption and a text. The color code 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.