WikiPages/de

Diese Seite ist eine Erweiterung der Hilfe:Editieren Seite und gibt allgemeine Richtlinien für das Schreiben und Aktualisieren der FreeCAD Wiki Dokumentation. Es fasst mehrere Diskussionen und Ideenfindungssitzungen zusammen

Vor dem Beginn

 * Diese Wiki Dokumentation basiert auf MediaWiki, derselben Software, die auch Wikipedia nutzt. Wenn du bereits Beiträge zu Wikipedia geleistet hast, sollte das Bearbeiten von FreeCAD Wiki Seiten einfach sein.
 * Im Gegensatz zu Wikipedia ist das FreeCAD Wiki schreibgeschützt, um Spam zu vermeiden. Du musst beantragen, dass ein Konto für dich im Forum erstellt wird.
 * Wenn du noch nie Wiki Software verwendet hast, gehe zu Hilfe:Bearbeitung, um dich mit dem Markup vertraut zu machen, das zur Bearbeitung von Seiten verwendet wird.
 * Für fortgeschrittene Anwendung der Wiki Software siehe MediaWiki Hilfe:Übersicht. Nicht alle Funktionen von MediaWiki sind in diesem FreeCAD Wiki verfügbar, aber viele von ihnen sind es.
 * Wir möchten, dass die Dokumentation einfach zu lesen ist, vermeide also die Verwendung komplexer Funktionen. Halte es einfach.
 * Verwende einen Sandkasten, um deinen Code zu testen, z.B. FreeCADDocu:Sandbox oder eine bestimmte Seite mit deinem Namen Sandbox:Yourname. Sandkasten-Seiten müssen in der Sandkasten-Kategorie platziert werden. Dies geschieht durch hinzufügen von  am Ende des Wiki-Codes.
 * Bitte beachte die Übersetzungen. Das FreeCAD Wiki verwendet eine automatische Übersetzungsunterstützung, um Seiten in vielen Sprachen bereitzustellen. Jede Seite kann in mehreren Sprachversionen existieren. Auf vielen Seiten sieht man (Bereichs-) Markierungen wie  und viele einzelne Markierungen wie   . Letztere kennzeichnen sogenannte Übersetzungseinheiten (translation units) und werden durch das Übersetzungssystem erstellt, sie sollten nie manuell erstellt werden. Sie verbinden die Überschriften und Absätze mit ihren übersetzten Versionen. Du solltest sie nicht ändern, denn das würde diese Verweise zerstören. Es wäre trotzdem in Ordnung, Absätze zu verschieben oder den Wortlaut zu ändern, solange die zugehörigen Kennzeichen beibehalten werden. Wenn du eine Überschrift oder einen Absatz löschst, solltest du auch die zugehörigen Kennzeichen löschen. Bitte sei dir bewusst, dass sich das Ändern von existierenden Überschriften und Absätze auch auf bestehende Übersetzungen auswirkt. Das gilt nicht beim Hinzufügen von neuem Material, weil das System nach deinen Änderungen automatisch neue Kennzeichen hinzufügt. Mehr Informationen findest du unter Lokalisierung und den Original-Seiten Mediawiki:Extension:Translate page.

Präzise Beschreibungen
Versuche bei der Beschreibung der FreeCAD Funktionalität prägnant und auf den Punkt zu kommen. Beschreibe, was FreeCAD tut, nicht was FreeCAD nicht tut. Es könnte Ausnahmen geben, um zu rechtfertigen, warum FreeCAD eine bestimmte Funktionalität nicht unterstützt, z.B. zu klären wie sich FreeCAD von anderen CAD Systemen unterscheidet.


 * Schlechte Beschreibung
 * PartDesign Arbeitsbereich: der PartDesign Arbeitsbereich ist ein Arbeitsbereich zur Teilekonstruktion die Werkzeuge für die Modellierung komplexer Volumenkörperteile bereitstellen soll.

PartDesign Arbeitsbereich: zielt darauf ab, Werkzeuge für die Modellierung komplexer Festkörperteile bereitzustellen.
 * Gute Beschreibung

Zentralisierte Informationen
Vermeide es, die gleichen Informationen an verschiedenen Orten zu duplizieren. Füge die Informationen in eine neue Seite ein und verknüpfe diese Seite von anderen Seiten aus, die diese Informationen benötigen.

Verwende keine Transklusion von Seiten (Hilfe:Bearbeiten#Vorlagen und Transklusion von Seiten), da dies die Übersetzung des Wikis erschwert. Verwende nur die unten unter #Vorlagen beschriebenen Vorlagen.

Formgestaltung
Vorlagen werden zum Gestalten der Hilfeseiten verwendet. Sie geben der Dokumentation ein einheitliches Aussehen und Gefühl. Es gibt eine Vorlage für Menübefehle, wie, eine Vorlage zum Gestalten von zu drückenden Tasten, wie , eine weitere Vorlage zum Anzeigen eines booleschen Wertes  usw. Bitte mache dich mit dem Abschnitt #Templates vertraut, vor dem Schreiben von Hilfeseiten.

Temporäre Merker
Wenn man an einer großen Seite arbeitet, empfiehlt es sich, die Seite entweder als In-Arbeit oder als Unfertig zu kennzeichnen. Dadurch wird sichergestellt, dass die Wiki Administratoren die Seite nicht als Fertig zur Übersetzung markieren, während sie noch häufig geändert wird.

Um eine Seite zu kennzeichnen, füge entweder  (Seite in Bearbeitung) oder   als erste Zeile ein. Mit  lädst du andere ein, mit dir zusammen die Seite fertigzustellen, während   anzeigt, dass du die Arbeit selbst erledigen wirst und andere dir etwas Zeit geben sollen.

Wenn die Arbeit getan ist, vergesse bitte nicht, die Markierungen zu entfernen!

Beispiele
Um dich schnell mit der Struktur und dem Stil des FreeCAD Wikis vertraut zu machen, schaue dir die Modell Seite an: GuiBefehl Modell.

Struktur
Der Anlaufstelle für Anwender bietet ein Inhaltsverzeichnis. Dies wird als Hauptreferenz für die automatische Erstellung der Hilfe ohne Internetverbindung, die du von FreeCAD aus erreichen kannst, sowie der PDF Dokumentation ohne Internetverbindung verwendet.

Die Vorlage Template:Docnav dient dem sequentiellen Verweisen von Seiten, entsprechend der Struktur des Inhaltsverzeichnisses der Online-Hilfe. Siehe Tabelle Vorlagen für eine Liste aller Vorlagen.

Seitennamen
Seitennamen sollten kurz sein, und sie sollten "Title Case" verwenden: Jedes Wort sollte mit einem Großbuchstaben beginnen, es sei denn, es handelt sich um Artikel (articles), Verhältniswörter (prepositions), Bindewörter (conjunctions) oder Partikel (grammatical particles), wie z.B. "of", "on", "in", "a", "an", "and".


 * Schlechter Seitenname:
 * Construction of AeroCompany airplanes


 * Guter Seitenname:
 * Construction of AeroCompany Airplanes

Die Arbeitsbereichsseite der obersten Ebene muss das Format  haben, wobei   der Name des Arbeitsbereichs ist, zum Beispiel  PartDesign Arbeitsbereich. Und die Namen der Seiten, die die Befehle (oder Werkzeuge) beschreiben, die zu einem Arbeitsbereich gehören, müssen dieses Format haben:, zum Beispiel PartDesign Polster. Beachte, dass du den Befehlsnamen so verwenden solltest, wie er im Quellcode vorkommt.

Oberbegriffe
Absatzüberschriften sollten kurz sein und "Sentence Case" verwenden: Alle Wörter, außer dem ersten und Namen (proper names), sollten kleingeschrieben werden. Man sollte keine  Überschriften  als Wiki-Textauszeichnung verwenden, da der Seitentitel automatisch als Hauptüberschrift   hinzugefügt wird.

Verweise
Du solltest nach Möglichkeit den ursprünglichen Verweisnamen für die Verweise verwenden. Dies verdeutlicht die referenzierte Seite in der gedruckten oder Dokumentation ohne Internetzugang. Du musst die Verwendung von nicht aussagekräftigen Wörtern für den Verweis vermeiden.


 * Schlechter Verweis
 * Weitere Informationen zum entwerfen von 2D Objekten klicke hier.


 * Guter Verweis
 * Für weitere Informationen zum entwerfen von 2D Objekten beziehe dich auf den Entwurf Arbeitsbereich.

Das bevorzugte Format für einen Verweis ist:

Übersetzt:

Beachte, dass für den Teil vor dem  Zeichen, der eigentliche Verweis, die Groß-/Kleinschreibung relevant ist. Wenn dein Seitenname  lautet, wird der Verweis fehlschlagen, wenn du   (Großbuchstabe P) eingibst. Vor dem Zeichen  sollten alle Leerzeichen durch Unterstriche  ersetzt werden. Dies dient der Unterstützung von Übersetzern, die eine Übersetzungssoftware verwenden. Ohne die Unterstriche würde der Verweis von der Software übersetzt werden, was unerwünscht ist.

Um zu einem bestimmten Abschnitt zu verweisen füge ein Zeichen und seinen Oberbegriff dem Seitennamen hinzu. Beispiel:

Übersetzt:

Innerhalb der gleichen Seite kannst du den Seitennamen weglassen. Beispiel:

Um einen Verweis zum Anfang der Seite zu erstellen, kannst du verwenden:

Diese Vorlage sollte automatisch den richtigen Text abhängig von der Sprache der Seite anzeigen. Ein Verweis oben auf die Seite ist besonders nützlich für lange Seiten, da er dem Benutzer erlaubt, schnell zum Inhaltsverzeichnis zurückzuspringen. Du kannst ihn an das Ende eines jeden Absatzes setzen. Achte darauf, dass sich vor und nach der Vorlage eine Leerzeile befindet.


 * Image link
 * [[Image:Draft_Wire.svg|24px|Optionaler Text, der beim Schweben über dem Bild angezeigt wird|link=Draft_Wire]]

Um ein Bild als Verweis zu benutzen:


 * Image link + text link
 * [[Image:Draft_Wire.svg|24px|link=Draft_Wire]] Linienzug

Wenn du den optionalen Text weglässt, wird der Verweis selbst beim Schweben über dem Bild angezeigt, was vorzuziehen ist, und du solltest zusätzlich einen Textverweis nach dem Bildverweis hinzufügen:

Arbeitsbereichsseiten
Jede Seite eines Arbeitsbereichs sollte mit
 * dem Namen des Arbeitsbereichs,
 * ein Bild des Aussehens der Arbeitsbereichs (Menü und Werkzeugleiste in deiner Standardposition), und
 * eine Beschreibung dessen, wofür der Arbeitsbereich verwendet wird

Siehe #Screen capture für Konventionen zum Einbeziehen von Bildern.

Befehlsseiten
Die Befehlsseiten, die die Arbeitsbereichswerkzeuge beschrieben werden, sollten nicht zu lang sein, sie sollten nur erklären, was ein Befehl tun kann und was nicht, und wie man ihn benutzt. Du solltest Bilder und Beispiele auf ein Minimum beschränken; Tutorien können die Anwendung des Werkzeugs erweitern und Schritt für Schritt Details liefern.

Bitte beziehe dich auf die GuiBefehlsmodell seite für weitere Details.

Tutorien
Ein gut geschriebenes Tutorium sollte dem Benutzer vermitteln, wie er bestimmte praktische Ergebnisse schnell erreichen kann. Es sollte nicht extrem lang sein, aber es sollte eine ausreichende Anzahl von Schritt-für-Schritt Anleitungen und Bildern enthalten, die den Benutzer bei der Verwendung der verschiedenen Werkzeuge anleiten.

Für Beispiele besuche die Tutorien Seite.

Vorlagen
Das Gestalten der FreeCAD Wiki Seiten wird durch die Verwendung von Vorlagen (Help:Editing) erreicht. Sie sorgen für ein einheitliches Erscheinungsbild aller Seiten und ermöglichen es auch, das Wiki neu zu gestalten. Die komplette Liste der definierten Vorlagen kannst du unter Special:PrefixIndex/Template: einsehen. Bitte verwende aber nur die in den Tabellen unten aufgeführten Vorlagen. Nur in ganz speziellen Fällen solltest du HTML Kennzeichen direkt verwenden.

Klicke auf den Vorlagenverweis, um die Gebrauchsanweisungen für eine Vorlage und ihre Einführung zu sehen. Vorlagen sind eine leistungsstarke Funktion der MediaWiki Software; Du solltest ein erfahrener Wiki Benutzer sein, wenn du Ergänzungen und Änderungen an bestehenden Vorlagen vorschlagen möchtest. Wenn Vorlagen falsch implementiert sind, erschweren sie die Übersetzung von Seiten in andere Sprachen, so dass ihre Verwendung auf die Textformatierung beschränkt werden sollte; Seitentransklusion sollte vermieden werden. Siehe MediaWiki Hilfe:Vorlagen, um mehr zu erfahren.

Einfache Vorlagen
Diese Vorlagen akzeptieren einen einfachen Textparameter und formatieren es mit einem bestimmten Stil.

Komplexere Vorlagen
Diese Vorlagen erfordern mehr Eingabeparameter oder erzeugen einen Textblock mit einem bestimmten Format.

Grafiken
Bilder und Bildschirmfotos sind notwendig, um eine vollständige Dokumentation von FreeCAD zu erstellen. Sie sind besonders nützlich, um Beispiele und Tutorien zu illustrieren. Bilder sollten in ihrer Originalgröße angezeigt werden, damit sie genügend Details zeigen und lesbar sind, wenn sie Text enthalten. Bitmap Bilder sollten nicht in der Größe verändert werden.

Vermeide animierte Bilder (GIF) in den allgemeinen Hilfeseiten. Animationen und Videos sollten für Tutorien reserviert werden, die nicht als PDF Dokumentation ohne Internetverbindung verwendet werden sollen.

Bilder müssen über die Special:Upload Seite hochgeladen werden.

Namen
Gib deinem Bild einen aussagekräftigen Namen. Wenn dein Bild Merkmale eines bestimmten Befehls darstellt, solltest du den originalen, englischen Namen des Befehls mit am Ende verwenden.
 * Für den Befehl Draft Versetzen sollte das Bild heißen.

Bildschirmerfassung
Empfohlene Größen für Bildschirmfotos sind:
 * Natürliches 400x200 (oder Breite=400 und Höhe<=200), für Gui Befehl Seiten, damit das Bild in den linken Teil der Seite passt, und für andere Standard-Schnappschüsse.
 * Natürliches 600x400 (oder Breite=600 und Höhe<=400), für Gui Befehl Seiten, wenn du wirklich ein größeres Bild benötigst und das Bild trotzdem in den linken Teil der Seite passen soll, und für andere Standard Schnappschüsse.
 * Natürliches 1024x768 (oder Breite=1024 und Höhe<=768), nur für Vollbildschirm Bilder.
 * Kleinere Größen sind bei der Darstellung von Details möglich, verwende jedoch die natürliche Auflösung, keine Größenänderung oder Miniaturbilder, es sei denn, du hast einen sehr guten Grund dafür.
 * Größere Auflösungen sollten vermieden werden, da sie für andere Arten der Darstellung oder in der gedruckten PDF Dokumentation nicht sehr übertragbar sind.

Du solltest nicht von einer bestimmten Konfiguration deines Desktops oder Betriebssystems abhängig sein, wenn du Bildschirmfotos erstellst ich nd du solltest, wo immer möglich, visuelle Voreinstellungen der FreeCAD Oberfläche verwenden.

Um einen Bildschirmphoto zu erstellen, kannst du die von deinem Betriebssystem bereitgestellten Optionen oder eines dieser Makros verwenden: Makro Schnipsel und  Makro Bildschirm Wiki.

Text
Um die Übersetzung der Dokumentation zu erleichtern, machen Sie separate Bilder von der Benutzeroberfläche und dem 3D-Modell-Viewport. Das Bild des 3D-Modells kann bei jeder Übersetzung wiederverwendet werden, während ein Übersetzer bei Bedarf ein Bild der lokalisierten Oberfläche machen kann.

Symbole und Grafiken
Verweise auf die Illustrationen Seite für alle Illustrationen und Symbole, die für FreeCAD erstellt wurden und die sofort in den Dokumentationsseiten wiederverwendet werden können. Wenn du mit Symbolen beitragen möchtest, lies bitte die Richtlinien für Illustrationen.

Übersetzungen
Gemäß der allgemeinen Übereinkunft ist die englische Seite die Referenzseite im Wiki und muß zuerst erstellt werden. Wenn der Inhalt einer Seite geändert wird oder etwas hinzugefügt werden soll, muß dies zuerst auf der englischen Seite geschehen und erst danach die Änderung auf die übersetzte Seite übertragen werden.

Das FreeCAD Wiki unterstützt eine Übersetzungserweiterung, die es ermöglicht, Übersetzungen zwischen Seiten einfacher zu verwalten; Details hierzu unter Lokalisierung Übersetzung des Wiki.

Weitere hilfreiche Quellen sind:
 * ISO language codes: ein ISO Sprachcode mit zwei Buchstaben um die zu übersetzende Sprache zu benennen/identifizieren.
 * Google Translate: zur Hilfe beim Übersetzen.
 * Deepl translator: zur Hilfe beim Übersetzen.

GUIBefehl Übersetzen
Übersetzt:

Navi Übersetzen
Übersetzt:

Verweis Übersetzen
Part Module

Übersetzt:

Atelier Part

Docnav Übersetzen
Übersetzt:

Beispiel mit Symbolen:

Übersetzt:

Seiten erstellen
Vor dem Erstellen einer neuen Seiten solltest du zuerst prüfen, ob bereits eine ähnliche Seite existiert. Sollte das der Fall sein, ist es meist besser, die vorhandene Seite zu ändern. Im Zweifel öffne bitte zuerst ein neues Thema im Wiki-Forum.

Um eine neue Seite zu erstellen, hat man folgende Möglichkeiten:
 * Die URL mit dem gewünschten Seitennamen aufrufen, z.B.:, und auf 'Erstellen' klicken.
 * Eine Wiki-Suche nach dem Seitennamen durchführen und auf den roten Text in 'Erstelle die Seite "Meine Neue Seite" in diesem Wiki.' klicken.

Seiten umbenennen
Da FreeCAD ein Projekt ist, das ständig weiterentwickelt wird, ist es manchmal notwendig, den Inhalt des Wikis zu überarbeiten. Wenn die Namen von Befehlen im Quellcode geändert werden, müssen die Wiki Seiten, die sie dokumentieren, ebenfalls umbenannt werden. Dies kann nur von den Wiki Administratoren durchgeführt werden. Um diese zu informieren, eröffne ein Thema im Wiki Forum und liste den notwendigen Umbenennungsvorgang in diesem Formular auf:

old name        new name Old_page_name_1 New_page_name_1 Old_page_name_2 New_page_name_2 ...

Löschen von Dateien und Seiten
Falls du eine Datei löschen musst, gehe auf seine Seite  und bearbeite sie. Unabhängig davon, ob die Seite leer ist oder nicht, füge diesen Befehl als erstes Element der Seite hinzu:  und beschreibe unmittelbar darunter, warum die Seite  gelöscht werden soll. Zusätzlich eröffne ein Thema im Wiki Forum.

Für Seiten ist das Verfahren dasselbe.

Diskussion
Das Entwicklung/Wiki Unterforum im FreeCAD Forum bietet einen speziellen Raum für die Diskussion von Verbesserungen der Wiki Themen und des Erscheinungsbildes. Dort kann man Fragen stellen und Vorschläge anbringen.

Englisch
Siehe Glossar

Andere Sprachen

 * Italienisch
 * Französisch
 * Deutsch
 * Polnisch