Wiki Editing Hints/de

This article may require cleanup to meet the Qt Wiki's quality standards. Reason: Auto-imported from ExpressionEngine.
Please improve this article if you can. Remove the {{cleanup}} tag and add this page to Updated pages list after it's clean.

Die ersten Schritte

Dieses Wiki ist der richtige Ort um Wissen über Qt zu teilen. Aber die Artikel sollten auf Themen beschränkt werden, die mit Qt zu tun haben.
Wenn eine neue Seite erstellt werden soll, ist es wichtig zuerst zu überprüfen, ob sie nicht bereits existiert. Das Suchfeld rechts oben auf dieser Seite ist für diesen Zweck gedacht. Wenn es schon eine Seite zum gesuchten Thema gibt, wird sie in den Suchergebnissen erscheinen.
Da diese Webseite ein Wiki ist, kann der Inhalt auf fast allen Seiten bearbeitet werden.
Wenn keine Seite zu einem Thema existiert, kann sie erstellt werden, indem man auf den Link Create the page "Suchbegriff" on this wiki! in den Suchergebnissen klickt.
Um ein "Vermüllen" der Versionsgeschichte einer Seite durch Tests zu verhindern, sollte die Sandbox stattdessen für Tests genutzt werden.

Wie man eine Seite bearbeitet

Das Qt Wiki basiert auf MediaWiki, der Wiki-Engine, die von Wikipedia und vielen anderen Wikis genutzt wird.

Wenn eine Seite bearbeitet wird, wird eine Werkzeugleiste angezeigt, die es erlaubt die meist genutzten Syntax-Elemente einzufügen. Die Wikicode-Syntax ist unkompliziert und man kann Wikicode direkt schreiben ohne die Werkzeugleiste zu nutzen. Ein Blick auf die MediaWiki Bearbeitungshilfe bietet einen schnellen Überblick.

Es soll bitte immer die "Preview"-Option genutzt werden, um die Änderungen an der Seite vor dem Abspeichern zu überprüfen. So wird verhindert, dass die Versionsgeschichte mit überflüssigen Einträgen vermüllt wird, wenn man die zuvor gemachten Eingabefehler behebt.

Wie man eine gute Seite erstellt

Ein paar einfache Richtlinien sollten eingehalten werden um anderen Entwicklern zu helfen, die Information zu finden nach der sie suchen:

So schreiben wie man programmiert

Gute Wikis sind wie guter Code: einfach zu überblicken und einfach zu warten. Jeder Artikel sollte sich mit einem Thema beschäftigen (sehr ähnlich zu einer Klasse). Jeder Absatz sollte sich mit einem Aspekt des Themas beschäftigen (wie eine Funktion).

Use headers for scannability

Long articles are easier to read if you add some informative headers. Please use the MediaWiki heading level (==) for your introduction and then === and ==== levels to outline your discussion. (The editor includes buttons for them.) Try to write your headers so they outline what you have to say all by themselves, because you can then:

Add a table of Contents

When readers find your article, they will scan the first page to figure out if it's what they're looking for. If your article is not much longer than one page, all you need to do is write it. If it's much longer than that, use a table of content to show the reader what's to come. Your opening paragraph plus table of content should be all the reader needs to know whether to click down or click away.

A table of contents is added automatically as soon as you included three headings, regardless of their depth. Sometimes you don't want to have a table of contents generated (e.g. because the page you create is a table of contents) you can put the magic word __NOTOC__ at the beginning of you page.

Add categories

Add category tags to insert a link to your article in the appropriate summary pages. By adding your article to existing categories you help readers find your content.

If you want to create a new category and summary page, just tag your article to a category that does not yet exist like so: [[Category:Wiki Help]]

Collaboration

Wikis are meant for collaborative editing. To make it as easy as possible for everybody please follow some basic rules:

Discuss your pages on the Talk subpage that can be reached via the top toolbar
Write in an understandable, informative, but not too formal language.
Structure your pages with subheadings and a healthy amount of paragraphs for easier understanding and better reading.
Explain acronyms, at least at first use.
Use meaningful but straight to the point page names.
Don't mindlessly throw away other people's work.
Use [[Category:...]] to group pages by topic.

Category pages

Whenever you create a new category for your page the wiki software will create a landing page for it. This page is editable just like any other page. Just click on the link displayed on your page and edit away. All pages within the respective category will be displayed on this page. Why not start it with an introduction to the topic?

Templates

One can make use of the MediaWiki Templates. This page summarizes the current state of available Templates:

Template Name

You type

You get

Template:DocLink creates a link to the doc.qt.io reference documentation

{{DocLink|QWidget}}
{{DocLink|QWidget|properties}}
{{DocLink|QWidget|size-prop|size()}}
{{DocLink|QtWidgets-Index||Qt Widgets}}

QWidget
properties
size()
Qt Widgets (note the empty anchor parameter)

Template:LangLinks creates a list of predefined language links so that you can easily see what languages are available for the page specified

bg de el es fr it ja ko pt ru zh

Template:LangSwitch does the same as LangLinks but for the same page the template is inserted. It checks all available language subpages and inserts a link. For this template you don't need to specify any parameters.

Template:Ambox inserts a notification box

Some notification text

Template:WarningBox inserts a warning box

Some warning text

Template:Cleanup inserts a notice that the article needs improvement, and puts the article in Category:Articles needing cleanup. You can specify the reason for the tag.

This article may require cleanup to meet the Qt Wiki's quality standards. Reason: The text is too repetitive.
Please improve this article if you can. Remove the {{cleanup}} tag and add this page to Updated pages list after it's clean.

Template:Delete inserts a notice that the article is nominated for deletion, and puts the article in Category:Delete. You can specify the reason for the tag.

This article is nominated for deletion. Reason: This page is empty.
Please raise your support/opposition to this nomination in the article's Discussion page.

Multi-language articles

When creating new articles the first language should always be English (reference language). When translating an article you just append the ISO-639-1 language code separated by a slash to the URL and hit Enter. The Wiki now tells you that the page can be created.

Example:

Tables

The Mediawiki help page on Tables is useful reading to anyone who edits tables.

Code highlighting

The wiki uses the standard GeSHi syntax highlighter.

The only customisation made, has been to add the <code> tag to the highlighted list handled by GeSHi. The default language is set to C++/Qt toolkit. You can change the language with the lang="" attribute.

For example, you can use these settings:

Javascript/QML : <code lang="javascript">
Qt .pro : <code lang="make">
Command Lines : <code lang="bash">
XML : <code lang="xml">

Zusammenarbeit

Wikis wurden zur gemeinschaftlichen Arbeit an Inhalten entworfen. Um das so einfach wie möglich zu gestalten, orientiere dich bitte an den folgenden grundlegenden Regeln:

Nutze eine verständliche, informative, aber nicht zu gestelzte Sprache
Gliedere deine Seiten mittels Überschriften und einer angemessenen Zahl von Absätzen, um Verständlichkeit und Lesefluss zu fördern
Erkläre Abkürzungen — spätestens bei ihrer ersten Benutzung
Nutze griffige Seitennamen
Verwirf nicht leichtfertig anderer Menschen Arbeit
Nutze Tags um Seiten zu gruppieren