Macro documentation/de

Beschreibung
Alle Makros sollten ordnungsgemäß dokumentiert werden, und zwar auf die gleiche Weise wie Gui Befehle dokumentiert werden. Sie sollten eine eigene Wiki Seite haben und in einer der Kategorien unter Makro Rezepte aufgeführt sein.

Die Makro Rezepte Seite hat eine gute Auswahl von Makros, die von erfahrenen Benutzern erstellt wurden, und viele von ihnen können direkt aus dem Erweiterungsverwalter installiert werden.

Siehe GuiBefehl Modell und Makroseiten wie Makro Ausfromung und Makro Seite Aus Konturen, um zu sehen, wie Makros dokumentiert werden sollten. Es sollten mindestens zwei Abschnitte enthalten sein, ein Abschnitt mit allgemeinen Informationen zur Verwendung und ein Abschnitt, der den eigentlichen Makrocode enthält. Bei Bedarf können weitere Abschnitte hinzugefügt werden, um die Verwendung des Makros näher zu erläutern.

Wenn ein Makro eine gut definierte Funktionalität bietet und gut dokumentiert ist, könnte es schließlich als Teil einer neuen oder eines bestehenden Arbeitsbereichs aufgenommen werden.

Neue Makroseite
Erstelle eine neue Seite für das Makro, die mit dem Wort beginnt, zum Beispiel. Der Verweis kann ohne Unterstriche als verwendet werden, was zu Makro Ausgezeichnete Änderung führt; die Leerzeichen werden automatisch in Unterstriche umgewandelt.

Auf der neuen Seite solltest du oben Template:Macro verwenden, mit einem Minimum an Informationen:

Du kannst ein benutzerdefiniertes Symbol hinzufügen, wenn es nicht den gleichen Namen wie das Makro hat; du kannst auch andere Informationsfelder hinzufügen.

Wenn die Seite übersetzt wird, verwende eine lokalisierte Vorlage. Du musst den Namen mit dem aus zwei Buchstaben bestehenden Sprachcode angeben, und du musst das Symbol explizit angeben

oder verwende das Feld


 * Use Special:Upload to upload the custom icon in SVG or PNG formats. It should have the same name as the macro.
 * Otherwise it will default to  [[Image:Text-x-python.svg|32px]].
 * For the macro used in the Python console by FreeCAD use  [[Image:Text_console_python.png|32px]].
 * For the example video macro use this skeleton of the icon [[Image:Text_Video_Movie.png|32px]] and fill the screen for obtain ex: [[Image:Macro_crank_simul.png|32px]] and save the new icon with the same name of your macro.

Template:Macro will put the information on using and installing the macros in every page.



Hinzufügen der Makrodokumentation

 * Just like a Gui Command, explain what the macro does, its inputs, outputs, options, and limitations, if any.
 * Include a personalized icon in SVG or PNG format for your macro so that other users can include it in a custom toolbar.
 * Add one or more images to clarify the usage of your tool.
 * If the macro performs a complex task, consider adding an animated GIF to showcase its capabilities. The GIF image should have a maximum size of 500 x 500 pixels; if the GIF is bigger, the animation may not work. Do not resize the GIF as the wiki will not play resized GIFs.
 * Mention related macros and workbenches that complement the function of this tool.
 * Mention the version of FreeCAD used to create the macro. This information can be gathered from.


 * When this information is pasted, it looks like this

Consider adding this information in a comment block inside the code of the macro.

Hinzufügen des Makrocodes
Inside the section, use Template:MacroCode to place the code of the macro in the page. This will create a block of text that uses monospace font, which will preserve the whitespace that is essential for Python.

If the block of code contains the characters  (double closing brace and opening brace) or   (vertical bar), the   tags can be added explicitly to allow displaying these special symbols.

This Template:MacroCode essentially generates a block of HTML tags, so these can be used directly instead of using the template. The Addon Manager will search for the biggest such block and use it for the body of the macro.

Or if it includes the vertical bar.

Oder

«Your code should be here»

Add header information before your actual code.

Starting with FreeCAD 0.17, this information is used by the Addon Manager, which downloads the macro from the FreeCAD-macros repository.

Hinzufügen von Makrocode außerhalb des Wikis
If your macro is too big that it exceeds 64 KB, it won't be able to be hosted on the wiki. In this case, use Template:Codeextralink with a link to the raw web address of the code.

Zum Beispiel:

Es wird angezeigt als:

This template must be placed at the beginning of the macro page, in the section. It must be the first block of code in the page so that the Addon Manager can automatically detect it and import it. See Macro CirclePlus for an example of the usage.

Hinzufügen des neuen Makros zum Wiki Repositorium
Use Template:MacroLink to include a line in the appropriate category in Macros recipes; create a new category if needed.


 * The first argument is the name of the macro page in the wiki.
 * The second argument is the displayed text, which may be different from the page name. This will create a link to the first argument, showing the second argument as the text.
 * A short description of the macro comes after the colon.

You can also use the optional parameter  to specify the image file that will be placed at the start of the line. The icon should be an SVG or a PNG file, and should have the same name as your macro. If this parameter is not given it will use the default icon for a Python script.

To localize this template, use the appropriate language link in the first argument.

Hinzufügen des neuen Makros zum zentralen Repositorium
To make a macro installable from the Addon Manager it should be included in the central FreeCAD-macros repository.

In order to include the macro there, first it must be reviewed by the FreeCAD community in the Python scripting and macros subforum. Once this is done, the FreeCAD-macros repository should be forked, the new macro should be included in a branch, and then the branch should be pushed and merged into the upstream repository.