WikiSeiten

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page WikiPages and the translation is 99% complete.
Outdated translations are marked like this.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎русский

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 [[Category:Sandbox]] am Ende des Wiki-Codes.
  • Bitte beachte die Übersetzungen. Das FreeCAD Wiki verwendet automatische Übersetzungsunterstützung, um Seiten in vielen Sprachen anzubieten. Es ist wie eine 3. Dimension: jede Seite kann in mehreren Sprachversionen existieren. Auf vielen Seiten wirst du Markierungen sehen wie <translate>...</translate> und viele Kennzeichnungen wie <!--T:8-->. Letztere werden durch das Übersetzungssystem erstellt, du solltest sie nie manuell erstellen. Sie verbinden die Überschriften und Paragrafen durch ihre übersetzten Versionen. Du solltest sie nicht ändern, denn das würde diese Verweise zerstören. Es wäre trotzdem in Ordnung, Paragrafen zu verschieben oder den Wortlaut zu ändern, solange die zugehörigen Kennzeichen beibehalten werden. Wenn du eine Überschrift oder einen Paragrafen löschst, solltest du auch die zugehörigen Kennzeichen löschen. Bitte sei dir bewusst, dass sich das Ändern von existierenden Überschriften und Paragrafen 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.

Allgemeine Richtlinien

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.
Gute Beschreibung

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

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 Datei → Speichern, eine Vorlage zum Gestalten von zu drückenden Tasten, wie Shift, eine weitere Vorlage zum Anzeigen eines booleschen Wertes true 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 {{UnfinishedDocu}} als erste Zeile ein. Mit {{UnfinishedDocu}} lädst du andere ein, mit dir zusammen die Seite fertigzustellen, während {{Seite in Bearbeitung}} 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 Template:Docnav dient dem sequentiellen Verweis von Seiten, entsprechend der Struktur des Inhaltsverzeichnisses. Siehe #Vorlagen für eine Liste aller Vorlagen.

Seitennamen

Die Seitennamen sollten kurz sein, und sie sollten "Satzfall" statt "Titelfall" verwenden. Dies ist der von Wikipedia verwendete Stil für deine Artikel.

Schlechter Seitenname
Konstruktion von LuftfahrtUnternehmensflugzeugen
Guter Seitenname
Konstruktion von LuftfahrtUnternehmensflugzeugen

Die Arbeitsbereichsseite der obersten Ebene muss das Format XYZ Arbeitsbereich haben, wobei XYZ 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: XYZ Befehl, zum Beispiel PartDesign Polster. Beachte, dass du den Befehlsnamen so verwenden solltest, wie er im Quellcode vorkommt.

Eine frühere Konvention sah die Verwendung des Titelfalles vor; jedes Wort sollte mit einem Großbuchstaben beginnen, es sei denn, es handelt sich um Artikel, Präpositionen, Konjunktionen oder andere grammatikalische Partikel, d.h. "von, auf, in, a, an, und" usw. Es gibt viele Seiten, die diesen Stil verwenden, aber davon wird bei neuen Seiten abgeraten. Dies wird im Forumsbeitrag diskutiert (Verweise in Kleinbuchstaben) Verwende einen kleingeschriebenen Titel für eine Wiki Seite.

Oberbegriffe

Wie die Seitennamen sollten auch die Absatzüberschriften kurz sein und Groß- und Kleinschreibung verwenden. Du solltest keine H1 Überschriften (= Überschrift =) in feinem Wiki Markup verwenden, da der Seitentitel automatisch als Hauptüberschrift H1 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:

[[Name_of_page/de|Seitenname]]

Übersetzt:

[[Name_of_page/fr|nom de la page]]

Beachte, dass für den Teil vor dem | Zeichen, der eigentliche Verweis, die Groß-/Kleinschreibung relevant ist. Wenn dein Seitenname Name_der_Seite lautet, wird der Verweis fehlschlagen, wenn du Name_der_Seite (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:

[[WikiPages/de#Verweise|WikiSeiten]]

Übersetzt:

[[WikiPages/fr#Liens|WikiPages]]

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

[[#Verweise|Verweise]]

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

</translate>{{Top}}<translate>

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
Optionaler Text, der beim Schweben über dem Bild angezeigt wird

Um ein Bild als Verweis zu benutzen:

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

Image link + text link
Draft Wire.svg 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:

[[Image:Draft_Wire.svg|24px|link=Draft_Wire]] [[Draft_Wire/de|Linienzug]]

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#Templates_and_transcluding_pages) 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.

Vorlage Erscheinungsbild Beschreibung
Top

Anfang

Benutze sie, um einen Verweis auf den Anfang der Seite hinzuzufügen.
Emphasis Hervorhebung Verwende es, um ein Stück Text hervorzuheben.
KEY Alt Verwende es, um eine Tastaturtaste anzugeben, die gedrückt werden muss.
ASCII Ascii 065.svg Verwende es, um eine ascii Taste in einem Bild (.svg) anzugeben, die gedrückt werden muss. Du musst das gewünschte Zeichen oder die Nummer des ascii Codes des Zeichens angeben.
Button Abbrechen Verwende es, um eine Schaltfläche in der grafischen Benutzeroberfläche anzuzeigen, die gedrückt werden muss.
RadioButton RadioButtonFalse.svg Option Verwende es, um einen Auswahlknopf in der grafischen Benutzeroberfläche anzugeben, der RadioButtonTrue.svg Gewählt oder RadioButtonFalse.svg Nicht werden muß.
CheckBox CheckBoxFalse.svg Option Verwende es, um ein Kontrollkästchen in der grafischen Benutzeroberfläche anzuzeigen, das

CheckBoxTrue.svg Angehakt oder CheckBoxFalse.svg Nicht werden muß.

SpinBox 1.50 SpinBox.svg Verwende es, um eine Spinbox in der grafischen Benutzeroberfläche anzuzeigen, die geändert werden muss.
ComboBox Menu 1 ComboBox.svg Verwende es, um eine ComboBox in der grafischen Benutzeroberfläche anzuzeigen, die geändert werden muss.
FALSE, false false, false Verwende es, um z.B. einen falschen booleschen Wert als Eigenschaft im Eigenschaftseditor anzuzeigen. Dies ist eine Abkürzung. Da es sich um einen Wert handelt, bevorzuge Vorlage Wert falsch
TRUE, true true, true Verwende es, um z.B. einen Wahren booleschen Wert als Eigenschaft im Eigenschaftseditor anzuzeigen. Dies ist eine Abkürzung. Da es sich um einen Wert handelt, bevorzuge Vorlage Wert wahr
MenuCommand Datei → Speichern Verwende es, um die Lage eines Befehls innerhalb eines bestimmten Menüs anzugeben.
FileName Dateiname Verwende es, um den Namen einer Datei oder eines Verzeichnisses anzugeben.
SystemInput Gib diesen Text ein Verwende es, um vom Benutzer eingegebenen Eingabetext anzuzeigen.
SystemOutput Ausgabetext Verwende es, um Textausgaben aus dem System anzuzeigen.
Incode import FreeCAD Verwende es, um Inline Quellcode mit einer Monospace Schriftart einzubinden. Er sollte in eine Zeile passen.
PropertyView Ansicht EigenschaftFarbe Verwende es, um eine Ansichtseigenschaft im Eigenschaftseditor anzuzeigen. Ansichtseigenschaften sind wie Linienfarbe, Linienbreite, Punktfarbe, Punktgröße, usw.
PropertyData Daten-EigenschaftPosition Verwende es, um eine Dateneigenschaft im Eigenschaftseditor anzugeben. Dateneigenschaften sind für verschiedene Objekttypen unterschiedlich.
Properties Title / TitleProperty Basis Verwende es, um den Titel einer Eigenschaftsgruppe im Eigenschaftseditor anzugeben. Der Titel wird nicht in das automatische Inhaltsverzeichnis aufgenommen.
Obsolete in der Version veraltet 0.19 Verwende es, um anzuzeigen, dass eine bestimmte Funktion ab einer bestimmten FreeCAD Version veraltet ist.
Version eingeführt in Version 0.18 Verwende es, um anzuzeigen, dass eine bestimmte Funktion erst ab einer bestimmten FreeCAD Version verfügbar ist.
VersionMinus version 0.16 und darunter Verwende es, um anzuzeigen, dass eine bestimmte Funktion nachfolgend mit einer bestimmten FreeCAD Version anfängt.
VersionPlus v0.17 und darüber Verwende es, um anzuzeigen, dass eine bestimmte Funktion oben ist, die mit einer bestimmten FreeCAD Version anfängt.
ColoredText Farbiger Text Verwende diese Vorlage, um den Hintergrund, den Text oder Hintergrund und Text einzufärben. (FarbigerText Seite für weitere Beispiele)
ColoredParagraph
Farbiger Absatz
Verwende diese Vorlage, um den Hintergrund, den Text oder Hintergrund und Text über die gesamte Länge der Seite einzufärben. (/de|FarbigerAbsatz Seite für weitere Beispiele)

Komplexere Vorlagen

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

Vorlage Erscheinungsbild Beschreibung
Prettytable Diese Tabelle Benutze es, um Tabellen wie diese zu formatieren. Es können zusätzliche Tabelleneigenschaften hinzugefügt werden.
Caption

Beschriftung für ein Bild

Verwenden Sie es, um eine Erklärung unter einem Bild hinzuzufügen. Sie kann linksbündig oder mittig ausgerichtet sein.
Clear Verwende es, um Spalten zu löschen. Folge der Definition der Vorlage, um eine detaillierte Erklärung zu erhalten. Sie wird oft verwendet, um zu verhindern, dass Text neben nicht verwandten Bildern fließt.
Code
{{{1}}}
Verwende ihn, um mehrzeilige Code Beispiele mit einer Monospace Schriftart einzubinden. Die Standardsprache ist Python, es können aber auch andere Sprachen angegeben werden.

Python Code sollte sich an die allgemeinen Empfehlungen halten, die von PEP8: Stil Leitfaden für Python Code. Insbesondere sollten Klammern unmittelbar auf den Funktionsnamen folgen, und auf ein Komma sollte ein Leerzeichen folgen. Dies macht den Code besser lesbar.

Falsche Überschrift
Heading
Verwende es, um eine Überschrift zu erstellen, die nicht automatisch in das für die Offline Dokumentation verwendete Inhaltsverzeichnis aufgenommen wird.
GuiCommand Siehe Gui Befehl und GuiCommand Modell Benutze es, um einen Kasten mit nützlichen Informationen zu Dokument Arbeitsbereichsbefehlen (werkzeuge) zu erstellen.
TutorialInfo See for example Basic modeling tutorial Verwende es, um einen Kasten mit nützlichen Informationen zur Dokumentation von Tutorien zu erstellen.
Macro Siehe Beispiel Makro FlattenWire Verwende es, um eine Box mit nützlichen Informationen zur Dokumentation zu erstellen Makros.
Docnav Verwende es, um eine Leiste mit den Wörtern "next", "previous" und "index" und Links zu den entsprechenden Verweisen zu erstellen, was nützlich ist, um Seiten in eine bestimmte Reihenfolge zu bringen.
VeryImportantMessage
Important Message
Verwenden es, um einen hervorgehobenen Kasten mit einer sehr wichtigen Nachricht zu erstellen. Verwende es sparsam, nur um auf größere Probleme in der Funktionalität der Software, Abkündigungen von Werkzeugen und Ähnliches hinzuweisen.
Page in progress
Under construction icon-blue.svg
This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.
Verwende dies für Seiten, die noch in Arbeit sind oder gerade überarbeitet werden. Vergiss nicht, dies zu entfernen, wenn die Seite fertig ist.
UnfinishedDocu

This documentation is not finished. Please help and contribute documentation.

GuiCommand model explains how commands should be documented. Browse Category:UnfinishedDocu/de to see more incomplete pages like this one. See Category:Command Reference for all commands.

See WikiPages to learn about editing the wiki pages, and go to Help FreeCAD to learn about other ways in which you can contribute.

Verwende es, um ein hervorgehobenes Feld zu erzeugen, das eine unfertige Dokumentationsseite anzeigt.
Softredirect Verwende es anstelle der normalen Umleitung, wenn du auf eine spezielle Seite (z. B. Media: oder Category:) umleitest, in deren Fällen die normale Umleitung deaktiviert ist.
Quote

Template:Error

—William Shakespeare, Julius Cäsar, Akt III, Szene I
Verwende es, um einen Textkasten mit einem wörtlichen Zitat und einer Referenz zu erstellen.
Userdocnavi, Powerdocnavi Verwende diese, um Navigationsboxen für die Benutzerdokumentation, die Dokumentation für erfahrene Nutzer und die Entwicklerdokumentation zu erstellen. Dies ermöglicht ein schnelles Springen zwischen verschiedenen Abschnitten der Dokumentation. Außerdem platzieren sie die entsprechende Seite in der richtigen Kategorie.

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 du ein Bild hast, das die Merkmale eines bestimmten Befehls präsentiert, solltest du den gleichen Namen wie der Befehl mit _example am Ende verwenden.

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: Snip.png Makro Schnipsel und Macro Screen Wiki.png 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:

Einige Hinweise für Übersetzer

GUIBefehl Übersetzen

{{GuiCommand
|Name=FEM EquationFluxsolver
|MenuLocation=Solve → Equation fluxsolver
|Workbenches=[[Fem_Workbench|FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial|FEM tutorial]]
}}

Übersetzt:

{{GuiCommand/fr
|Name=FEM EquationFluxsolver
|Name/fr=FEM EquationFluxsolver
|MenuLocation=Solveur → Equation fluxsolver
|Workbenches=[[Fem_Workbench/fr|Atelier FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial/fr|FEM tutoriel]]
}}

Navi Übersetzen

{{FEM_Tools_navi}}

Übersetzt:

{{FEM_Tools_navi/fr}}

Verweis Übersetzen

[[Part_Module|Part Module]]

Übersetzt:

[[Part_Module/fr|Atelier Pièces]]

Docnav Übersetzen

{{Docnav
|[[About_FreeCAD|About FreeCAD]]
|[[Installing_on_Windows|Installing on Windows]]
}}

Übersetzt:

{{Docnav/fr
|[[About_FreeCAD/fr|À propos de FreeCAD]]
|[[Installing_on_Windows/fr|Installation sous Windows]]
}}

Beispiel mit Symbolen:

{{Docnav
|[[Std_Save|Save]]
|[[Std_SaveCopy|SaveCopy]]
|[[Std_File_Menu|Std File Menu]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

Übersetzt:

{{Docnav/fr
|[[Std_Save/fr|Enregistrer]]
|[[Std_SaveCopy/fr|Enregistrer une copie]]
|[[Std_File_Menu/fr|Menu fichier]]
|IconL=Std_Save.svg
|IconR=Std_SaveCopy.svg
|IconC=Freecad.svg
}}

Erstellen, umbenennen und löschen von Seiten

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, tue eins der folgenden Dinge:

  • Besuche die URL mit dem gewünschten Seitennamen, z.B.: https://wiki.freecadweb.org/MeineNeueSeite/de, und klicke auf 'Erstellen'.
  • Führe eine Wiki-Suche nach dem Seitennamen durch und klicke auf den roten Text in 'Erstelle die Seite "MeineneueSeite" in diesem Wiki.'.

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 (https://www.freecadweb.org/wiki/File:***.***) und bearbeite sie. Unabhängig davon, ob die Seite leer ist oder nicht, füge diesen Befehl als erstes Element der Seite hinzu: {{Delete}} 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.

Terminologie - Benennungspolitik

Englisch

Siehe Glossar

Andere Sprachen