WikiSeiten

From FreeCAD Documentation
Jump to navigation Jump to search
This page is a translated version of the page WikiPages and the translation is 98% complete.
Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎polski

Diese Seite ist eine Erweiterung der Seite Help:Editing und bietet gemeinsame Richtlinien zu den bewährten Verfahren, die beim Schreiben oder Aktualisieren der FreeCAD Dokumentation zu befolgen sind. Sie fasst Diskussionen und Ideenfindung sofern es die FreeCAD Dokumentation betrifft, zusammen.

Für das Bild kannst du das Makro Schnitt Snip.png verwenden um das Bild im ausgewählten Fenster oder Makro Bildschirm Wiki Macro Screen Wiki.png zu fassen und ein Bild mit Standardformat, ein Rotationsbild oder einen in Serie gespeicherten Bildschirm zu erstellen und du musst es mit Gimp oder einem anderen zusammensetzen, um eine Datei Gif animiert zu erstellen.

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.
  • 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 einzelne Markierungen wie diese <!--T:8--> in vielen Abschnitten. Erstere ermöglichen die Übersetzungsunterstützung. Ändere sie nicht. Letztere werden vom System erstellt. Sie verknüpfen die Überschriften/Abschnitte mit deinen übersetzten Versionen. Wenn du die Nummerierung offensichtlich änderst, wirst du diese Verknüpfungen zerstören. Es ist jedoch in Ordnung, Absätze zu verschieben oder den Wortlaut zu ändern, solange die Markierungen bei ihnen bleiben. Wenn du einen Absatz entfernst, solltest du die Markierung mit ihm entfernen. Bitte beachte, dass Änderungen an bestehenden Überschriften und Absätzen möglicherweise Auswirkungen auf die aktuellen Übersetzungen haben. Deine Änderungen sollten es wert sein. Mache dir keine Sorgen, wenn du neues Material hinzufügst, denn das System fügt neue Markierungen automatisch nach deinen Bearbeitungen hinzu. Für weitere Informationen siehe Lokalisierung und im Original Hilfe:Erweiterung:Übersetzen/Seitenübersetzungsbeispiel.

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.

Zentralisierte Information

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 kein Einschließen durch Verweis von Seiten (Help:Editing#Templates and transcluding pages), da dies die Übersetzung des Wikis erschwert. Verwende nur die unten unter #Templates beschriebenen Vorlagen.

Formgebung

Vorlagen werden für die Gestaltung des in den Hilfeseiten verwendeten Textes verwendet.

Es gibt eine Vorlage zum Gestalten von Menübefehlen, wie Datei → Speichern, eine weitere Vorlage zum Gestalten von zu drückenden Tasten, wie Shift, eine weitere Vorlage zum Anzeigen eines booleschen Wertes true usw. Dadurch erhält die Dokumentation ein einheitliches Erscheinungsbild und kann ohne großen Aufwand übersetzt werden. Bitte machen Sie sich mit dem Abschnitt #Templates vertraut, vor dem Schreiben von Hilfeseiten.

Vorläufige Markierungen

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ügt man einfach entweder {{Page in progress}} oder {{UnfinishedDocu}} als erste Zeile einer Seite hinzu. Mit {{UnfinishedDocu}} lädt man alle ein, mitzumachen und die Seite fertigzustellen, während mit {{Page in progress}} der Autor die Arbeit erledigt und andere ihm etwas Zeit geben sollten.

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

Beispiele

Du kannst dich schnell mit der Struktur und dem Stil des FreeCAD Wiki durch einen Blick auf die folgenden Seiten, die als Referenzseiten für den Rest der FreeCAD-Dokumentation angesehen werden können, vertraut machen.

Struktur

Allgemein

Du solltest normalerweise keinen =Kopfzeile= Abschnitt für eine Seite verwenden, da der Seitentitel automatisch hinzugefügt wird.

Der Anlaufstelle für Anwender bietet ein Inhaltsverzeichnis; dieses 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 wird verwendet, um entsprechend der Struktur der Inhaltsverzeichnis auf die Seite davor und die Seite danach zu verweisen. Eine Liste aller Vorlagen findest du unter #Templates.

Seitennamen

Die Seitennamen sollten kurz sein, und sie sollten "Satzfall" statt "Titelfall" verwenden. Dies ist der [von Wikipedia verwendete https://en.wikipedia.org/wiki/Wikipedia:Manual_of_Style/Capital_letters#Headings,_headers,_and_captions Stil] für ihre Artikel.

Grundsätzlich sollten alle Wörter außer dem ersten und Eigennamen in Kleinbuchstaben geschrieben werden.

Verwende: Tutorium über die Konstruktion von Flugzeugen der AeroCompany

Vermeide: Tutorium Über Die Konstruktion Von Flugzeugen Der AeroCompany

Anmerkung: 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.

Seitennamen für Arbeitsbereiche und Werkzeuge

Die Arbeitsbereichsseite der obersten Ebene muss das Format XYZ Arbeitsbereich haben, wobei XYZ der Name des Arbeitsbereichs ist. Siehe Arbeitsbereichsseiten für den Inhalt.

Seiten, die die Werkzeuge (Gui Befehle) des Arbeitsbereichs beschreiben, müssen das Format XYZ Werkzeug haben, wobei Werkzeug der Name des spezifischen Werkzeugs ist. Siehe Befehl (Werkzeug) Seiten für den Inhalt.

Schlechter Name
Arbeiten mit architektonischen Objekten
Arbeiten mit architektonischen Wänden
Entwerfen von 2D Objekten
Werkzeug: Bau einer Linie zwischen zwei Punkten
Guter Name
Arch Arbeitsbereich
Arch Mauer
Entwurf Arbeitsbereich
Entwurf Linie

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 zu diesem Thema findest du unter hier.
So-la-la-Verweis
Weitere Informationen zu diesem Thema findest du unter Entwerfen von 2D Objekten.
Guter Verweis
Weitere Informationen zu diesem Thema findest Du beim Entwurf von 2D Objekten im Entwurf Arbeitsbereich.

Seitennavigation

Navigationsverweise helfen dem Benutzer, durch die Fülle der Informationen in diesem Wiki zu stöbern. Erwäge die Verwendung der folgenden Verweise, um das Browsen für den Leser unterhaltsamer zu gestalten:

  • "Anfang" Verweis. Bei langen Seiten kannst du zum Inhaltsverzeichnis zurückkehren.
  • "zurück" Verweis. Dies ermöglicht es, zu einem bestimmten Thema zurückzukehren. Ein Rückverweis ist viel nützlicher als die "Zurück" Schaltfläche des Browsers, da er strukturelle Informationen enthält. Ein Rückverweis könnte dich eine Stufe in der Informationshierarchie nach oben führen. Siehe z.B. Externe Arbeitsbereiche: von wo immer du auf eine Seite über einen externen Arbeitsbereich gelangst, möchtest du vielleicht sehen, welche anderen Arbeitsbereiche verfügbar sind.

Siehe im folgenden Abschnitt wie diese Verknüpfungen erstellt werden.

Seitenanfangsverweise

Gib einfach das Folgende an der Stelle ein, an der du den Anfangsverweis haben möchtest.

[[#top|top]]

Du kannst es an das Ende jedes Kapitels setzen. Vergewissere dich dass vorher eine Leerzeile steht, damit der letzte Absatz frei bleibt.

Anmerkung 1: Wenn du die MediaWiki Plattform kennst, wirst Du feststellen, dass dies auch ohne die Definition von "Anfang" als Verweisziel mit <div>< funktioniert. Dies funktioniert natürlich nur, wenn "top" nicht für andere Dinge verwendet wird. Anmerkung 2: Wenn du denkst, dass das nützlich ist, kannst du einfach damit anfangen, ein wenig zu üben, indem du einen "Anfang" Verweis am Ende jedes Abschnitts dieser wirklich langen Seite anbringst.

Anfang

Rückverweise

Für einen Verweis zurück gibt es zwei Möglichkeiten:

  • gehe zurück zum Anfang der anderen Seite
  • gehe zurück zu einem bestimmten Abschnitt der anderen Seite

Für den Leser ist es bequemer, gleich zum entsprechenden Abschnitt der Seite zu springen, z.B. zu einer Liste ähnlicher Punkte.

Das allgemeine Format für einen Verweis ist:

[[pagename|pagename]]

Um diese Zeile zu übersetzen:

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

Für diese Seite wäre es [[WikiPages/de|WikiSeiten]]. Beachte, dass der Fall relevant ist. Wenn dein Seitenname "WikiSeiten" lautet, schlägt der Verweis fehl, wenn du "Wikiseiten" (in Kleinbuchstaben 's') eingibst. Es empfiehlt sich, die Seite in einem anderen Reiter zu öffnen und den Seitennamen zu kopieren und einzufügen.

Um einen bestimmten Abschnitt als Verweisziel zu verwenden, füge einfach den Abschnittsnamen (d.h. den Überschriftentext) nach einem '#' Zeichen hinter dem Seitennamen ein. Beispiel:

[[WikiPages/de#Seitenanfangverweise]]

Das Ergebnis ist ein bisschen hässlich, wegen des '#' in WikiPages/de#Seitenanfangsverweise. Dies kann durch die Verwendung der '|' Syntax zur Eingabe einer Beschriftung vermieden werden. Siehe dieses Beispiel:

[[WikiPages/de#Seitenanfangsverweise|WikiSeiten]]

Um diese Zeile zu übersetzen:

[[WikiPages/fr#Début|WikiPages début]]

Anstelle von "WikiPages" kannst du jeden beliebigen Text eingeben. Das Ergebnis ist viel besser: WikiPages oder WikiPages/Top Page Links oder was immer du möchtest. Es ist ein bisschen mehr, um die Quelle einzugeben, aber das ist ein kleiner Preis, den man für ausgezeichnete Benutzerfreundlichkeit zahlen muss. Innerhalb derselben Seite machst du das Gleiche, aber du kannst den Seitennamen weglassen, z.B. [[#Top Page Links|Top Page Links]] ergibt Top Page Links.


Anfang

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.

Befehl (Werkzeug) Seiten

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.

Begrenzungen und Unzulänglichkeiten sollten direkt auf der Befehlsseite dokumentiert werden, möglicherweise unter einem Abschnitt "Beschränkungen" oder " Begrenzungen".

Beachte bitte die Gui Befehl Seite für bestimmte Anzeichen, wie diese Befehle dargestellt werden sollten und und verwende das GuiBefehl Modell um mit dem Füllen der Informationen zu beginnen wo es angebracht ist. Verwende Erhitzer KeinBefehl, um Informationen einzufüllen, die sich nicht auf einen Befehl beziehen.

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.

Eine Reihe von Tutorien, in denen die Komplexität jeweils zunimmt, könnte hilfreich sein, um an einer oder mehreren Arbeitsbereichen Grund-, Zwischen- und Expertenwerkzeuge zu erkunden.

Siehe die Tutoriumsrichtlinien für eine grundlegende Idee, wie man ein Tutorium einrichtet.

Siehe einige Beispiele

So wie sich FreeCAD entwickelt können einige Tutorials für moderne Versionen des Programms zu alt werden, daher ist es wichtig, die Version oder Einschränkungen der in dieser speziellen Version des Tutoriums verwendeten Werkzeuge zu erwähnen.

Sprache

Ausdrücke

Du solltest umgangssprachliche Ausdrücke wie z.B. "ein Paar" vermeiden. Bitte als "einige" umformulieren, wenn es sich um eine unbestimmte Zahl handelt, oder die richtige Menge verwenden.

Prägnanz

Versuche Wiederholungen zu vermeiden um Beschreibungen kurz zu halten.

Schlechte Beschreibung

PartDesign Arbeitsbereich: der PartDesign Arbeitsbereich ist ein Arbeitsbereich zur Teilekonstuktion 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.

Stil

Vorlagen

Das Gestalten von FreeCAD Wiki Seiten wird durch die Verwendung von Vorlagen (Help:Editing#Templates_and_transcluding_pages) erreicht. Bitte verwende nur die in den folgenden Tabellen aufgeführten Vorlagen; dies ermöglicht die Neugestaltung des gesamten Wikis durch Aktualisierung der Vorlage und hilft, ein einheitliches Erscheinungsbild auf allen Seiten zu erreichen. Nur in besonderen Fällen solltest du HTML Kennzeichen direkt verwenden.

Du kannst die vollständige Liste definierter Vorlagen einsehen, durch Zugriff auf Special:PrefixIndex/Template:. Allerdings werden nicht alle dort aufgeführten Vorlagen für die Gestaltung des Textes verwendet, und andere sind veraltet; bitte verwende nur die in den folgenden Tabellen aufgeführten.

Klicke auf den Vorlagenverweis, um die Gebrauchsanweisungen für die 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.

Simple styling templates

These templates accept a simple text parameter, and format it with a particular style.

Template Appearance Description
Emphasis emphasis Use it to emphasize a piece of text.
KEY Alt Use it to indicate a keyboard key that needs to be pressed.
ASCII Ascii 065.svg Use it to indicate a ascii key in a image (.svg) that needs to be pressed. You must give the character desired or the number of the code ascii of the character.
Button Cancel Use it to indicate a button in the graphical user interface that needs to be pressed.
RadioButton RadioButtonFalse.svg Cancel Use it to indicate a radio button in the graphical user interface that needs to be RadioButtonTrue.svg Checked or RadioButtonFalse.svg not Checked.
CheckBox CheckBoxFalse.svg Cancel Use it to indicate a checkbox in the graphical user interface that needs to be CheckBoxTrue.svg Checked or CheckBoxFalse.svg not Checked.
SpinBox 1.50 SpinBox.svg Use it to indicate a spinbox in the graphical user interface that needs to be modified.
ComboBox Menu 1 ComboBox.svg Use it to indicate a ComboBox in the graphical user interface that needs to be modified.
FALSE, false false, false Use it to indicate a False Boolean value, for example, as a property in the property editor. This is a shortcut. Since it is a value, prefer Template Value false
TRUE, true true, true Use it to indicate a True Boolean value, for example, as a property in the property editor. This is a shortcut. Since it is a value, prefer Template Value true
MenuCommand File → Save Use it to indicate the location of a command inside a particular menu.
FileName File name Use it to indicate a name of a file or directory.
SystemInput Type this text Use it to indicate user typed input text.
SystemOutput Output text Use it to indicate text output from the system.
Optional [Insert or not] Use it in programming descriptions to indicate a text or function argument that is optional.
Choice That } Use it in programming descriptions to indicate a choice between two values.
Incode import FreeCAD Use it to include in-line source code with a monospace font. It should fit in one line.
Variable TYPEMyAttribute Use it in programming descriptions to indicate a value or a parameter, optionally with a type in front of it.
PropertyView ViewColor Use it to indicate a View property in the property editor. View properties are like Line Color, Line Width, Point Color, Point Size, etc.
PropertyData DataPosition Use it to indicate a Data property in the property editor. Data properties are different for different types of objects.
Properties Title / TitleProperty Base Use it to indicate the title of a property group in the property editor. The title will not be included in the automatic table of contents.
PropertyTasks / TasksTag TASK Tasks Use it to indicate the argument for tasks.
TitleTasks ===Tasks Title=== Use it to indicate the title for tasks.
Version introduced in version 0.18 Use it to indicate that a particular feature is available only starting with a specific FreeCAD version.
VersionMinus version 0.16 and below Use it to indicate that a particular feature is below starting with a specific FreeCAD version.
VersionPlus v0.17 and above Use it to indicate that a particular feature is above starting with a specific FreeCAD version.
Obsolete obsolete in version 0.19 Use it to indicate that a particular feature is obsolete starting with a specific FreeCAD version.
ColoredText Colored Text Use this template to colored the background, text or background and text. (ColoredText page for more examples)
ColoredParagraph
Colored Paragraph
Use this template to colored the background, text or background and text along the entire length of the page. (ColoredParagraph page for more examples)

More complex templates

These templates require more input parameters, or produce a block of text with a particular format.

Template Appearance Description
Prettytable This table Use it to format tables such as this one; additional table properties can be added.
Caption

Some caption for an image

Some caption for an image (centered)

Use it to indicate an explanation text below an image in the documentation and tutorials. It can be left aligned or center aligned.
Clear Use it to clear columns. Follow the definition of the template for a detailed explanation. It is often used to stop text from flowing next to unrelated images.
Code
import FreeCAD
Source code style. Use it to include multi-line code examples with a monospace font. The default language is Python, bur other languages can be specified.
Fake heading
Heading
Use it to create create a heading that will not be included automatically in the table of contents that is used for the offline documentation.
GuiCommand See Gui Command and GuiCommand model Use it to create a box with useful information to document workbench tools (GuiCommands) of FreeCAD.
Macro See example Macro FlattenWire Use it to create a box with useful information to document macros.
Docnav Use it to create a bar with the words "next", "previous", and "index", and links to the appropriate articles, which is useful for navigating certain help pages which go in a particular sequence.
VeryImportantMessage
Important Message
Use it to create a highlighted box with a very important message. Use sparingly, only to indicate major problems in the functionality of the software, discontinuation of tools, and similar.
Softredirect Use it instead of the normal redirect, when you are redirecting to a special page (such as Media: or Category:), in which cases the normal redirect is disabled.
UnfinishedDocu

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

Gui Command explains how tools should be documented. See Draft ShapeString for an example of a well documented tool. Browse Category:UnfinishedDocu/de to see 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.

Use it to create a highlighted box indicating an unfinished documentation page.
Quote

Cry "Havoc" and let slip the dogs of war.

—William Shakespeare, Julius Caesar, act III, scene I
Use it to create a box of text with a literal quote and reference.
Userdocnavi, Powerdocnavi, Devdocnavi Use them to create navigation boxes for the user documentation, the power user documentation, and the developer documentation. This allows quickly jumping between different sections of the documentation.

They also place the corresponding page in the proper category. (2019) Currently the Userdocnavi is the most used, while the others aren't used. It's a work in progress to design them correctly, and add them to all documentation pages.

Veraltete Vorlagen

Vorlage Erscheinung Beschreibung
Klick veraltet Verwende diese Funktion, um ein Bild mit einem unsichtbaren Verweis zu überlagern. Du solltest stattdessen die native Wiki Bildeinschlussmethode verwenden.
DASH veraltet Benutze diese Option, um ein mehrzeiliges Textfeld für Code mit farbigem Hintergrund anzuzeigen. Du solltest den Stil verwenden, den du erhälst, indem du die Quellzeile mit einem Leerzeichen beginnst.
Disambig veraltet Benutze es als Disambiguierungsmeldung in einer Seite.
Informationen veraltet Verwende sie, um eine standardisierte Tabelle zu erstellen, die vollständige Informationen über die Datei enthält, einschließlich einer Beschreibung dessen, was sie zeigt und wie sie erstellt wurde, Copyright Status und Quelle.
Sprachen veraltet Benutze diese Funktion, um verfügbare Übersetzungen anzuzeigen. Mit dem neuen Wiki, das Übersetzungen und Sprachen über ein spezielles Plugin behandelt, ist es überholt.
Nachricht veraltet Benutze sie, um einen Textblock mit farbigem Hintergrund anzuzeigen, um auf eine Nachricht von geringer Bedeutung hinzuweisen.
Bildschirmfoto veraltet Benutze es, um Bildschirmfotos der Software einzufügen. Siehe stattdessen #Screen capture.

Um eine globalen Ansicht auf den chromatischen Aspekt zu haben, siehe Graphische Basisvorlagen.

Code=

Code muss mit der Code Vorlage formatiert werden. Die Beschreibung eines solchen Codes sollte danach folgen. Die Hervorhebung sollte streng nur auf dem Wort oder den Zeilen verwendet werden, die hervorgehoben werden müssen.

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.

Beispiel einer schlechten Codebeschreibung

makeAngularDimension (Mittelpunkt,[Winkel1,Winkel2],p3): erzeugt eine Winkelbemaßung aus dem gegebenen Zentrum,
 mit der gegebenen Liste von Winkeln, durch p3 hindurch. Gibt das neu erstellte Objekt zurück.

Beispiel einer guten Codebeschreibung

Dimension = makeAngularDimension(center, anglelist, p3)
Dimension = makeAngularDimension(center, [angle1, angle2], p3)
  • Erstellt eine Winkelabmessung aus dem gegebenen center Punkt, wobei die anglelist angle1 und angle2 enthält und durch den Punkt p3 verläuft.
  • Gibt das neu erstellte Dimension Objekt zurück.

Grafiken

Bilder und Screenshots sind notwendig, um eine vollständige Dokumentation von FreeCAD zu erstellen. Bilder sind besonders nützlich, um Beispiele und Tutorien zu illustrieren.

Allgemein

Vermeide Miniaturansichten und Größenänderungen von bitmap Bildern (Verkleinerung oder Vergrößerung). Bilder sollten in ihrer Originalgröße gezeigt werden, damit sie genügend Details darstellen und lesbar sind, wenn sie Text enthalten. Eine Ausnahme bilden SVG Bilder, die ohne Detailverlust auf jede gewünschte Größe skaliert werden können.

Vermeide animierte Bilder (GIF) in den allgemeinen Hilfeseiten Gui Befehl. 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 zeigst. Du solltest, wo immer möglich, visuelle Voreinstellungen der FreeCAD Oberfläche verwenden.

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.

Wenn Ihr Bildschirmfoto Text enthält, verwenden Sie die gleiche Auflösung der Originalschnittstelle in FreeCAD, damit der Text lesbar ist.

Gute Darstellungsgröße zum Lesen von Text

PartDesign revolution parameters (original size, 307px)

Schlechte Darstellungsgröße zum Lesen von Text

PartDesign revolution parameters (scaled to 190px)

Auf dem zweiten Bild ist der Text weniger klar, und es gibt visuelle Artefakte aufgrund der Neuskalierung der ursprünglichen Breite von 307px to 190px.

Bildchen (icons) und Grafiken

Refer to the Artwork page for all artwork and icons that have been created for FreeCAD, which can be immediately reused in documentation pages. If you would like to contribute with icons, please read the Artwork Guidelines.

Ü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 Übersetze das FreeCAD Wiki.

Weitere hilfreiche Quellen sind:

Einige Hinweise für Übersetzer

Einen GUI-Befehl bestimmen

{{GuiCommand
|Name=FEM EquationFluxsolver
|Icon=Fem-equation-fluxsolver.svg
|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
|Icon=Fem-equation-fluxsolver.svg
|MenuLocation= Solveur  Equation fluxsolver
|Workbenches=[[Fem Workbench/fr|Atelier FEM]]
|Shortcut={{KEY|F}} {{KEY|S}}
|Version=0.17
|SeeAlso=[[FEM_tutorial/fr|FEM tutoriel]]
}}

Einrichtung einer Vorlage

{{FEM Tools navi}}

übersetzt:

{{FEM Tools navi/fr}}

Einrichtung einer Verknüpfung

[[Part_Module]]

übersetzt:

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

oder:

[[Part_Module|Part Module]]

übersetzt:

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

Einrichtung von Docnav

Um die Template:Docnav Navigationsleiste örtlich festzulegen, siehe diesen Forumsbeitrag Docnav vorherig/nächster im Forum.

Im Wesentlichen muss eine neu übersetzte Vorlage erstellt werden, Template:Docnav/it.

Die übersetzte Vorlage sollte die entsprechenden übersetzten Verknüpfungen als "vorherige" und "nächste" Parameter zusammen mit dem übersetzten Text enthalten:

{{docnav/it
|[[Installing/it|Installazione]]
|[[Mouse Model/it|Navigazione 3D - Tipo di mouse]]
}}

Die übersetzte Vorlage sollte die entsprechenden übersetzten Verknüpfungen als "vorherige" und "nächste" Parameter mit Bildchen zusammen mit dem übersetzten Text enthalten:

{{Docnav/it
|[[Mesh Import/it|Importa Mesh]]
|[[Mesh MeshFromShape/it|Crea uno Mesh da un shape]]
|[[Mesh_Workbench|Mesh]]
|IconL=Mesh_ImportMesh.png
|IconC=Workbench_Mesh.svg
|IconR=Mesh_FromPartShape.svg
}}

Enthält auch die entsprechende Sprachkategorie

[[Category:Template/it]]

Wenn die lokalisierte Kategorie nicht in der übersetzten Vorlage enthalten ist, bleibt die übersetzte Vorlage in der Standardkategorie Englisch.

Verwendung spezieller Seiten

  • Special:LonelyPages lists those pages that are not linked from other pages in the FreeCAD wiki, therefore nobody can access these pages. If you find any in your native language, try to create the connection that exists in the English version of the page, otherwise no one can read them.
  • Special:UncategorizedPages lists pages without an assigned category, therefore they do not appear when you browse the wiki by categories. Assign a category.
  • Special:WantedPages lists pages that are called in a page, but that do not exist. These are shown as red links in the text. Deprecated and very annoying.
  • Others Wanted (files and templates)
  • Special:WantedCategories lists categories that are used in a page, but that do not exist. They can be created immediately by clicking on the red link. Skip.
  • Special:Categories lists all categories in the wiki. They allow you to compare the number of pages inside a translated category, which should preferably match then number of pages inside the English language category.
  • Special:ListRedirects lists all redirected pages. If there is any red links, something does not work well. Investigate which link is missing. Light blue links lead to pages outside the site, no problem.
  • Special:RecentChanges lists the most recent changes done to the wiki, including the pages changed, the number of changes to a particular page, whether these were additions or subtractions, and the user responsible.
  • Special:LanguageStats shows translation statistics for all message groups for a single language. Shows the parts not translated in a given language, only for those pages marked for translation. To see what has not been translated, set the language code and press Show statistics. It also contains the link to see what has been recently translated into that language. Note: if entering the English code en shows pages, it is likely that the original page contains markup errors, with the exception of the sidebar.
  • Special:PageTranslation lists all pages marked for translation, and those unmarked but that have translation tags. Only administrators can mark pages for translation.
  • Category:Pages to delete: lists all pages that should be deleted because they were created by mistake, are obsolete, or no longer necessary.

Umbenennen, Verschieben und Löschen

Seiten umbenennen

Da FreeCAD ein Projekt in ständiger Entwicklung ist, ist es notwendig, die Wiki-Seiten zu überarbeiten. Eine Aufgabe ist dabei, zu überprüfen, ob die Datei- und Seitennamen noch den Konventionen entsprechen. Wenn ein Arbeitsbereich z.B. einen Komponentennamen geändert hat, muss die Wiki-Seite, die ihn beschreibt, umbenannt werden. Dies kann nur von Wiki-Administratoren durchgeführt werden. Um sie zu informieren, öffnet man ein Thema im Wiki-Forum und listet die notwendige Umbenennung in dieser Form auf:

alt name                     new name
OLD_PAGE_NAME    NEW_PAGE_NAME
...

Dateien verschieben

Dateien umzubenennen, ist in vielen Fällen, das gleiche, wie sie zu verschieben. Das bedeutet, dass die Datei eine neue Datei unter einem neuen Namen wird, während ihr Inhalt erhalten bleibt.

Um eine Datei zu verschieben, gehe zu ihrer Seite (https://www.freecadweb.org/wiki/File:***.***) und klicke oben rechts auf das Menü Mehr und wähle dort den erscheinende Menüpunkt Verschieben. Dadurch öffnet sich eine Seite mit allen Informationen zur Ausführung einer Verschiebung.

Löschen von Dateien und Seiten

Falls du eine Datei löschen musst, gehe auf die 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 unten, warum dies gelöscht werden soll. Zusätzlich öffnst du ein Thema im Wiki Forum.

Für Seiten ist das Verfahren dasselbe.

Roboter

Gehe zu WikiRoboter um Anleitungen zum Einrichten und Verwenden von Robotern zur Automatisierung sich wiederholender Aufgaben im FreeCAD Wiki zu finden.

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.

Ideenfindung

Das Folgende steht zur Diskussion. Hier kannst du aufhören zu lesen, wenn du nicht beabsichtigst, Änderungen an den FreeCAD Wikiseiten Stilregeln vorzuschlagen. Du solltest jedes wikispezifische Thema auf [Entwicklung/Wiki Unterforum] diskutieren. Beiträge sind willkommen.


Siehe Wiki brainstorming. Die Informationen hierzu wurden dorthin verschoben, um diese Seite nicht zu überladen. ---Vocx (talk) 00:38, 2 November 2018 (UTC)

Terminologie - Benennungsrichtlinie

Englisch

Siehe Glossar

Andere Sprachen

Startzentrum

Vorschlag zur Erstellung der Seite:

Siehe Sandbox:Start center. Die Informationen hierzu wurden dorthin verschoben, um diese Seite nicht zu überladen.---Vocx (talk) 00:28, 2 November 2018 (UTC)

Sandkasten für Makroabmessungen

Siehe Sandbox:Macro dimensions. Die Informationen hier wurden dorthin verschoben, um diese Seite nicht zu überladen.---Vocx (talk) 23:43, 1 November 2018 (UTC)

Sandkasten für PartDesign Verrundung

Siehe Sandbox:PartDesign fillet. Die Informationen hier wurden dorthin verschoben, um diese Seite nicht zu überladen.---Vocx (talk) 23:36, 1 November 2018 (UTC)