Macro documentation/de: Difference between revisions

From FreeCAD Documentation
(Created page with "oder verwende das {{incode|Translate}} Feld")
No edit summary
 
(47 intermediate revisions by 4 users not shown)
Line 1: Line 1:
<languages/>
<languages/>
{{TOCright}}


<span id="Description"></span>
== Beschreibung ==
== Beschreibung ==


Alle Makros sollten ordnungsgemäß dokumentiert werden, und zwar auf die gleiche Weise wie [[Gui Command/de|Gui Befehl]]e dokumentiert werden. Sie sollten eine eigene Wiki Seite haben und in einer der Kategorien unter [[Macros recipes/de|Makro Rezepte]] aufgeführt sein.
Alle Makros sollten ordentlich dokumentiert werden, und zwar auf die gleiche Weise wie [[Gui Command/de|GUI-Befehle]] dokumentiert werden.


Sie sollten eine eigene Wiki-Seite haben und in einer der Kategorien unter [[Macros_recipes/de|Makro-Rezepte]] aufgeführt sein.
Die [[Makros recipes/de|Makro Rezepte]] Seite hat eine gute Auswahl von Makros, die von erfahrenen Benutzern erstellt wurden, und viele von ihnen können direkt aus dem [[Addon Manager/de|Erweiterungsverwalter]] installiert werden.


Die Seite [[Macros_ecipes/de|Makro Rezepte]] enthält eine gute Auswahl von Makros, die von erfahrenen Benutzern erstellt wurden, und viele von ihnen können direkt mit dem [[Std_AddonMgr/de|Addon-Manager]] installiert werden.
Siehe [[GuiCommand model/de|GuiBefehl Modell]] und Makroseiten wie [[Macro Loft/de|Makro Ausfromung]] und [[Macro Site From Contours/de|Makro Seite Aus Konturen]], um zu sehen, wie Makros dokumentiert werden sollten. Es sollten mindestens zwei Abschnitte enthalten sein, ein Abschnitt {{Emphasis|Description}} mit allgemeinen Informationen zur Verwendung und ein Abschnitt {{Emphasis|Script}}, 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.

Siehe [[GuiCommand_model/de|GuiBefehl Modell]] und Makroseiten wie [[Macro_Loft/de|Makro Ausformung]] und [[Macro_Site_From_Contours/de|Makro Bereich aus Konturen]], um zu sehen, wie Makros dokumentiert werden sollten. Es sollten mindestens zwei Abschnitte enthalten sein, ein Abschnitt {{Emphasis|Beschreibung}} (Description) mit allgemeinen Informationen zur Verwendung und ein Abschnitt {{Emphasis|Skript}}, 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 [[Workbenches/de|Arbeitsbereichs]] aufgenommen werden.
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 [[Workbenches/de|Arbeitsbereichs]] aufgenommen werden.


<span id="New_macro_page"></span>
== Neue Makroseite ==
== Neue Makroseite ==


Die Originalseite muss in Englisch geschrieben sein. Nachdem ein Administrator sie zur Übersetzung markiert hat, kann sie in andere Sprachen übersetzt werden.
Erstelle eine neue Seite für das Makro, die mit dem Wort {{incode|Macro_}} beginnt, zum Beispiel {{incode|Macro_Excellent_Modification}}. Der Verweis kann ohne Unterstriche als {{incode|<nowiki>[[Macro Excellent Modification/de|Makro Excellent Modification]]</nowiki>}} verwendet werden, was zu [[Macro Excellent Modification/de|Makro Ausgezeichnete Änderung]] führt; die Leerzeichen werden automatisch in Unterstriche umgewandelt.

Erstelle eine neue Seite für das Makro, die mit dem Wort {{incode|Macro_}} beginnt, gefolgt von dem Namen des Makros, zum Beispiel {{incode|Macro_Excellent_Modification}}. Um die Seite zu verknüpfen, verwendet man: {{incode|<nowiki>[[Macro_Excellent_Modification/de|Makro Excellent Modification]]</nowiki>}}.


Auf der neuen Seite solltest du oben [[Template:Macro]] verwenden, mit einem Minimum an Informationen:
Auf der neuen Seite solltest du oben [[Template:Macro]] verwenden, mit einem Minimum an Informationen:
Line 31: Line 38:
|Date=2018-11-30
|Date=2018-11-30
|Version=3.14516
|Version=3.14516
|SeeAlso=[[Macro Regular Modification]]
|SeeAlso=[[Macro_Regular_Modification|Macro Regular Modification]]
}}</nowiki>
}}</nowiki>


Line 53: Line 60:
}}</nowiki>
}}</nowiki>


* Use [[:Special:Upload]] to upload the custom icon in [[SVG|SVG]] or PNG formats. It should have the same name as the macro.
* Verwende [[:Special:Upload]], um das benutzerdefinierte Symbol in den [[SVG/de|SVG]] oder PNG Formaten hochzuladen. Es sollte den gleichen Namen wie das Makro haben.
* Otherwise it will default to <code>Icon=Text-x-python.svg</code> [[Image:Text-x-python.svg|32px]].
* Andernfalls wird es standardmäßig auf <code>Icon=Text-x-python.svg</code> [[Image:Text-x-python.svg|32px]] gesetzt.
* For the macro used in the Python console by FreeCAD use <code>Icon=Text_console_python.png</code> [[Image:Text_console_python.png|32px]].
* Für das von FreeCAD in der Python Konsole verwendete Makro verwende <code>Icon=Text_console_python.png</code> [[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.
* Für das Beispielvideomakro verwende dieses Skelett des Symbols [[Image:Text_Video_Movie.png|32px]] und fülle den Bildschirm aus, um z.B. folgendes zu erhalten: [[Image:Macro_crank_simul.png|32px]] und speichern Sie neue Symbol mit dem gleichen Namen desein Makros.


[[Template:Macro]] will put the information on using and installing the macros in every page.
[[Template:Macro]] wird die Informationen zur Verwendung und Installation der Makros in jede Seite einfügen.


[[Image:Macro Recipes MacroHowToInstall.png|200px]]
[[Image:Macro_Recipes_MacroHowToInstall.png|200px]]
{{Caption|[[How to install macros]] and [[Customize Toolbars|customize toolbars]] links in the infobox in each macro page}}
{{Caption|Die Verweise [[How_to_install_macros/de|Wie Makros installiert werden]] und [[Customize Toolbars/de|Werkzeugleisten anpassen]] in der Infobox auf jeder Makroseite}}




<span id="Adding_the_macro_documentation"></span>
=== Hinzufügen der Makrodokumentation ===
=== Hinzufügen der Makrodokumentation ===


* Just like a [[Gui Command|Gui Command]], explain what the macro does, its inputs, outputs, options, and limitations, if any.
* Wie bei einem [[Gui_Command/de|Gui Befehl]], erkläre was das Makro tut, seine Eingänge, Ausgänge, Optionen und Begrenzungen, falls vorhanden.
* Include a personalized icon in [[SVG|SVG]] or PNG format for your macro so that other users can include it in a custom toolbar.
* Füge ein personalisiertes Symbol im Format [[SVG/de|SVG]] oder PNG für dein Makro ein, damit andere Benutzer es in eine benutzerdefinierte Werkzeugleiste einfügen können.
* Füge ein oder mehrere Bilder hinzu, um die Verwendung deines Werkzeugs zu verdeutlichen.
* Add one or more images to clarify the usage of your tool.
* Wenn das Makro eine komplexe Aufgabe erfüllt, solltest du in Erwägung ziehen, ein animiertes GIF hinzuzufügen, um seine Fähigkeiten zu demonstrieren. Das GIF Bild sollte eine maximale Größe von 500 x 500 Pixel haben; wenn das GIF größer ist, funktioniert die Animation möglicherweise nicht. Ändere die Größe des GIFs nicht, da das Wiki GIFs mit geänderter Größe nicht abspielen wird.
* 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.
* Erwähne verwandte Makros und Arbeitsbereiche, die die Funktion dieses Werkzeugs ergänzen.
* 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 {{MenuCommand|Help → About FreeCAD → Copy to clipboard}}.
* Erwähne die Version von FreeCAD, die zur Erstellung des Makros verwendet wurde. Diese Informationen können unter {{MenuCommand|Hilfe→ Über FreeCAD → In Zwischenablage kopieren}} entnommen werden.


:Wenn diese Informationen eingefügt werden, sieht es folgendermaßen aus
:When this information is pasted, it looks like this
{{Code|code=
{{Code|code=
OS: Ubuntu 18.04.1 LTS
OS: Ubuntu 18.04.1 LTS
Line 89: Line 97:
}}
}}


Ziehe in Betracht, diese Informationen in einem Kommentarblock innerhalb des Codes des Makros hinzuzufügen.
Consider adding this information in a comment block inside the code of the macro.


<span id="Adding_the_macro_code"></span>
=== Hinzufügen des Makrocodes ===
=== Hinzufügen des Makrocodes ===


Inside the {{Emphasis|Script}} 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|Python]].
Innerhalb des {{Emphasis|Skript}} Abschnitts verwende [[Template:MacroCode]], um den Code des Makros in der Seite zu platzieren. Dadurch wird ein Textblock erstellt, der die Monospace Schriftart verwendet, wodurch der für [[Python/de|Python]] wichtige Weißraum erhalten bleibt.


If the block of code contains the characters <code>{{ }}</code> (double closing brace and opening brace) or <code>{{!}}</code> (vertical bar), the <code>&lt;nowiki&gt; ... &lt;/nowiki&gt;</code> tags can be added explicitly to allow displaying these special symbols.
Wenn der Codeblock die Zeichen <code>{{ }}</code> (doppelte schließende und öffnende Klammer) oder <code>{{!}}</code> (senkrechter Balken) enthält, können die <code>&lt;nowiki&gt; ... &lt;/nowiki&gt;</code> Markierungen explizit hinzugefügt werden, um die Anzeige dieser speziellen Symbole zu ermöglichen.


This [[Template:MacroCode]] essentially generates a block of HTML tags <code>&lt;pre&gt; ... &lt;/pre&gt;</code>, so these can be used directly instead of using the template. The [[Std_AddonMgr|Addon Manager]] will search for the biggest such block and use it for the body of the macro.
Dieser[[Template:MacroCode]] erzeugt im Wesentlichen einen Block von HTML Markierungen <code>&lt;pre&gt; ... &lt;/pre&gt;</code>, so dass diese direkt anstelle der Vorlagen verwendet werden können. Der [[Std_AddonMgr/de|Erweiterungsverwalter]] sucht nach dem größten solcher Blöcke und verwendet ihn für den Körper des Makros.


<nowiki>{{MacroCode|code=
<nowiki>{{MacroCode|code=
Line 105: Line 114:
}}</nowiki>
}}</nowiki>


Or if it includes the vertical bar <code>{{!}}</code>.
Oder wenn es den vertikalen Balken einschließt <code>{{!}}</code>.
<nowiki>{{MacroCode|code=
<nowiki>{{MacroCode|code=
&lt;nowiki&gt;
&lt;nowiki&gt;
Line 121: Line 130:
</pre></nowiki>
</pre></nowiki>


Füge Kopfzeileninformationen vor deinem eigentlichen Code hinzu.
Add header information before your actual code.
<nowiki>{{MacroCode|code=
{{Code|code=
__Title__="Title_Of_macro"
__Title__="Title_Of_macro"
__Author__ = "User_Name"
__Author__ = "User_Name"
Line 135: Line 144:
__Status__ = "stable"
__Status__ = "stable"
__Requires__ = "freecad 0.14.3706"
__Requires__ = "freecad 0.14.3706"
__Communication__ = "http://www.freecadweb.org/wiki/index.php?title=User:User_Name"
__Communication__ = "http://www.freecadweb.org/wiki/index.php?title=User:User_Name"


«Your code should be here»
«Your code should be here»
}}
}}</nowiki>


Starting with FreeCAD 0.17, this information is used by the [[Std_AddonMgr|Addon Manager]], which downloads the macro from the [https://github.com/FreeCAD/FreeCAD-macros FreeCAD-macros] repository.
Beginnend mit FreeCAD 0.17 werden diese Informationen vom [[Std_AddonMgr/de|Erweiterungsverwalter]] verwendet, der das Makro aus dem [https://github.com/FreeCAD/FreeCAD-macros FreeCAD-Makros] Repositorium herunterlädt.


<span id="Adding_macro_code_outside_of_the_wiki"></span>
=== Hinzufügen von Makrocode außerhalb des Wikis ===
=== 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.
Wenn dein Makro zu groß ist, so dass es 64 KB überschreitet, kann es nicht im Wiki bereitgestellt werden. In diesem Fall verwende [[Template:Codeextralink]] mit einem Verweis auf die raw Web Adresse des Codes.


Zum Beispiel:
Zum Beispiel:
Line 152: Line 162:
{{Codeextralink|https://gist.githubusercontent.com/mario52a/8d40ab6c018c2bde678f/raw/e16ad9ea7b38c0c47e42aa3019be01dd1267a620/FCInfo_en_Ver_1-20_Docked.FCMacro}}
{{Codeextralink|https://gist.githubusercontent.com/mario52a/8d40ab6c018c2bde678f/raw/e16ad9ea7b38c0c47e42aa3019be01dd1267a620/FCInfo_en_Ver_1-20_Docked.FCMacro}}


This template must be placed at the beginning of the macro page, in the {{Emphasis|Description}} section. It must be the first block of code in the page so that the [[Addon Manager|Addon Manager]] [[File:AddonManager.svg|24px]] can automatically detect it and import it. See [[Macro CirclePlus|Macro CirclePlus]] for an example of the usage.
Diese Vorlage muss am Anfang der Makroseite im Abschnitt {{Emphasis|Beschreibung}} platziert werden. Es muss der erste Codeblock in der Seite sein, damit der [[File:Std_AddonMgr.svg|24px]] [[Std_AddonMgr/de|Addon-Manager]] sie automatisch erkennen und importieren kann. Siehe [[Macro_CirclePlus/de|Makro CirclePlus]] für ein Anwendungsbeispiel.


{{ColoredParagraph|'''PS:''' In case upgrade in GitHub the path of the RAW code is modified not forgotten modify the link in the Codeextralink template.}}
{{ColoredParagraph|'''PS:''' Im Falle einer Aktualisierung in GitHub wird der Pfad des RAW Codes geändert, nicht vergessen, den Verweis in der Codeextralink Vorlage zu ändern.}}


<span id="Adding_the_new_macro_to_the_wiki_repository"></span>
== Hinzufügen des neuen Makros zum Wiki Repositorium ==
== Hinzufügen des neuen Makros zum Wiki Repositorium ==


Use [[Template:MacroLink]] to include a line in the appropriate category in [[Macros recipes|Macros recipes]]; create a new category if needed.
Verwende [[Template:MacroLink]] , um eine Zeile in die entsprechende Kategorie in [[Macros_recipes/de|Makro-Rezepte]] einzuschließen; erstelle bei Bedarf eine neue Kategorie.


{{Code|code=
{{Code|code=
Line 166: Line 177:
}}
}}


* Das erste Argument ist der Name der Makroseite im Wiki.
* The first argument is the name of the macro page in the wiki.
* Das zweite Argument ist der angezeigte Text, der sich vom Seitennamen unterscheiden kann. Dadurch wird ein Verweis auf das erste Argument erstellt, der das zweite Argument als Text anzeigt.
* 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.
* Nach dem Doppelpunkt folgt eine kurze Beschreibung des Makros.
* A short description of the macro comes after the colon.


You can also use the optional parameter <code>Icon=</code> to specify the image file that will be placed at the start of the line. The icon should be an [[SVG|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|Python]] script [[Image:Text-x-python.svg|24px]].
Du kannst auch den optionalen Parameter <code>Icon=</code> verwenden, um die Bilddatei anzugeben, die am Anfang der Zeile platziert wird. Das Symbol sollte eine [[SVG/de|SVG]] oder eine PNG Datei sein und den gleichen Namen wie dein Makro haben. Wenn dieser Parameter nicht angegeben wird, wird das Standardsymbol für ein [[Python/de|Python]] Skript [[Image:Text-x-python.svg|24px]] verwendet.
{{Code|code=
{{Code|code=
<nowiki>
<nowiki>
Line 177: Line 188:
}}
}}


Um diese Vorlage zu lokalisieren, verwende den entsprechenden Sprachverweis im ersten Argument.
To localize this template, use the appropriate language link in the first argument.
{{Code|code=
{{Code|code=
<nowiki>
<nowiki>
Line 184: Line 195:
}}
}}


<span id="Adding_the_new_macro_to_the_central_repository"></span>
== Hinzufügen des neuen Makros zum zentralen Repositorium ==
== Hinzufügen des neuen Makros zum zentralen Repositorium ==


To make a macro installable from the [[Addon Manager|Addon Manager]] it should be included in the central [https://github.com/FreeCAD/FreeCAD-macros FreeCAD-macros] repository.
Um ein Makro aus dem [[Std_AddonMgr/de|Addon-Manager]] installierbar zu machen, sollte es in das zentrale [https://github.com/FreeCAD/FreeCAD-macros FreeCAD-Makros] -Repositorium aufgenommen werden.


In order to include the macro there, first it must be reviewed by the FreeCAD community in the [https://forum.freecadweb.org/viewforum.php?f=22 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.
Um das Makro dort aufzunehmen, muss es zunächst von der FreeCAD Gemeinschaft im [https://forum.freecadweb.org/viewforum.php?f=22 Python scripting and macros] Unterforum überprüft werden. Sobald dies geschehen ist, sollte das FreeCAD-Makro Repositorium abgezweigt werden, das neue Makro sollte in einen Zweig aufgenommen werden, und dann sollte der Zweig gepusht und in das Upstream- Repositorium zusammengeführt werden.


[[Category:Macros{{#translation:}}]]
[[Category:Macros{{#translation:}}]]

Latest revision as of 19:36, 27 April 2023

Beschreibung

Alle Makros sollten ordentlich 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 Seite Makro Rezepte enthält eine gute Auswahl von Makros, die von erfahrenen Benutzern erstellt wurden, und viele von ihnen können direkt mit dem Addon-Manager installiert werden.

Siehe GuiBefehl Modell und Makroseiten wie Makro Ausformung und Makro Bereich aus Konturen, um zu sehen, wie Makros dokumentiert werden sollten. Es sollten mindestens zwei Abschnitte enthalten sein, ein Abschnitt Beschreibung (Description) mit allgemeinen Informationen zur Verwendung und ein Abschnitt Skript, 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

Die Originalseite muss in Englisch geschrieben sein. Nachdem ein Administrator sie zur Übersetzung markiert hat, kann sie in andere Sprachen übersetzt werden.

Erstelle eine neue Seite für das Makro, die mit dem Wort Macro_ beginnt, gefolgt von dem Namen des Makros, zum Beispiel Macro_Excellent_Modification. Um die Seite zu verknüpfen, verwendet man: [[Macro_Excellent_Modification/de|Makro Excellent Modification]].

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

{{Macro
|Name=Macro Excellent Modification
|Description=This macro does excellent things on existing shapes
|Author=your username
|Date=2018-11-30
}}

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

{{Macro
|Name=Macro Excellent Modification
|Icon=Macro_custom_icon.svg
|Description=This macro does excellent things on existing shapes
|Author=your username
|Date=2018-11-30
|Version=3.14516
|SeeAlso=[[Macro_Regular_Modification|Macro Regular Modification]]
}}

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

{{Macro/fr
|Name=Macro Excellent Modification translated
|Icon=Macro_Excellent_Modification.svg
|Description=(Translated description)
|Author=your username
|Date=2018-11-30
}}

oder verwende das Translate Feld

{{Macro/fr
|Name=Macro Excellent Modification
|Translate=Macro Excellent Modification translated
|Description=(Translated description)
|Author=your username
|Date=2018-11-30
}}
  • Verwende Special:Upload, um das benutzerdefinierte Symbol in den SVG oder PNG Formaten hochzuladen. Es sollte den gleichen Namen wie das Makro haben.
  • Andernfalls wird es standardmäßig auf Icon=Text-x-python.svg gesetzt.
  • Für das von FreeCAD in der Python Konsole verwendete Makro verwende Icon=Text_console_python.png .
  • Für das Beispielvideomakro verwende dieses Skelett des Symbols und fülle den Bildschirm aus, um z.B. folgendes zu erhalten: und speichern Sie neue Symbol mit dem gleichen Namen desein Makros.

Template:Macro wird die Informationen zur Verwendung und Installation der Makros in jede Seite einfügen.

Die Verweise Wie Makros installiert werden und Werkzeugleisten anpassen in der Infobox auf jeder Makroseite


Hinzufügen der Makrodokumentation

  • Wie bei einem Gui Befehl, erkläre was das Makro tut, seine Eingänge, Ausgänge, Optionen und Begrenzungen, falls vorhanden.
  • Füge ein personalisiertes Symbol im Format SVG oder PNG für dein Makro ein, damit andere Benutzer es in eine benutzerdefinierte Werkzeugleiste einfügen können.
  • Füge ein oder mehrere Bilder hinzu, um die Verwendung deines Werkzeugs zu verdeutlichen.
  • Wenn das Makro eine komplexe Aufgabe erfüllt, solltest du in Erwägung ziehen, ein animiertes GIF hinzuzufügen, um seine Fähigkeiten zu demonstrieren. Das GIF Bild sollte eine maximale Größe von 500 x 500 Pixel haben; wenn das GIF größer ist, funktioniert die Animation möglicherweise nicht. Ändere die Größe des GIFs nicht, da das Wiki GIFs mit geänderter Größe nicht abspielen wird.
  • Erwähne verwandte Makros und Arbeitsbereiche, die die Funktion dieses Werkzeugs ergänzen.
  • Erwähne die Version von FreeCAD, die zur Erstellung des Makros verwendet wurde. Diese Informationen können unter Hilfe→ Über FreeCAD → In Zwischenablage kopieren entnommen werden.
Wenn diese Informationen eingefügt werden, sieht es folgendermaßen aus
OS: Ubuntu 18.04.1 LTS
Word size of OS: 64-bit
Word size of FreeCAD: 64-bit
Version: 0.18.15302 (Git)
Build type: Release
Branch: master
Hash: 2e03d2f298677b8212c22cbbc3cb20b7c80eabb5
Python version: 2.7.15rc1
Qt version: 4.8.7
Coin version: 4.0.0a
OCC version: 7.3.0
Locale: English/UnitedStates (en_US)

Ziehe in Betracht, diese Informationen in einem Kommentarblock innerhalb des Codes des Makros hinzuzufügen.

Hinzufügen des Makrocodes

Innerhalb des Skript Abschnitts verwende Template:MacroCode, um den Code des Makros in der Seite zu platzieren. Dadurch wird ein Textblock erstellt, der die Monospace Schriftart verwendet, wodurch der für Python wichtige Weißraum erhalten bleibt.

Wenn der Codeblock die Zeichen {{ }} (doppelte schließende und öffnende Klammer) oder | (senkrechter Balken) enthält, können die <nowiki> ... </nowiki> Markierungen explizit hinzugefügt werden, um die Anzeige dieser speziellen Symbole zu ermöglichen.

DieserTemplate:MacroCode erzeugt im Wesentlichen einen Block von HTML Markierungen <pre> ... </pre>, so dass diese direkt anstelle der Vorlagen verwendet werden können. Der Erweiterungsverwalter sucht nach dem größten solcher Blöcke und verwendet ihn für den Körper des Makros.

{{MacroCode|code=

«Your code should be here»

}}

Oder wenn es den vertikalen Balken einschließt |.

{{MacroCode|code=
<nowiki>

«Your code should be here»

</nowiki>
}}

Oder

<pre>

«Your code should be here»

</pre>

Füge Kopfzeileninformationen vor deinem eigentlichen Code hinzu.

__Title__="Title_Of_macro"
__Author__ = "User_Name"
__Version__ = "00.11"
__Date__    = "2015-07-25"
__Comment__ = "This is the comment of the macro"
__Web__ = "http://forum.freecadweb.org/viewtopic.php?f=3&t=7384"
__Wiki__ = "http://www.freecadweb.org/wiki/index.php?title=Macro_Title_Of_macro"
__Icon__  = "/usr/lib/freecad/Mod/plugins/icons/Title_Of_macro"
__IconW__  = "C:/Documents and Settings/YourUserName/Application Data/FreeCAD"
__Help__ = "start the macro and follow the instructions"
__Status__ = "stable"
__Requires__ = "freecad 0.14.3706"
__Communication__ = "http://www.freecadweb.org/wiki/index.php?title=User:User_Name"

«Your code should be here»

Beginnend mit FreeCAD 0.17 werden diese Informationen vom Erweiterungsverwalter verwendet, der das Makro aus dem FreeCAD-Makros Repositorium herunterlädt.

Hinzufügen von Makrocode außerhalb des Wikis

Wenn dein Makro zu groß ist, so dass es 64 KB überschreitet, kann es nicht im Wiki bereitgestellt werden. In diesem Fall verwende Template:Codeextralink mit einem Verweis auf die raw Web Adresse des Codes.

Zum Beispiel:

{{Codeextralink|https://gist.githubusercontent.com/mario52a/8d40ab6c018c2bde678f/raw/e16ad9ea7b38c0c47e42aa3019be01dd1267a620/FCInfo_en_Ver_1-20_Docked.FCMacro}}

Es wird angezeigt als:

Temporary code for external macro link. Do not use this code. This code is used exclusively by Addon Manager. Link for optional manual installation: Macro


# This code is copied instead of the original macro code
# to guide the user to the online download page.
# Use it if the code of the macro is larger than 64 KB and cannot be included in the wiki
# or if the RAW code URL is somewhere else in the wiki.

from PySide import QtGui, QtCore

diag = QtGui.QMessageBox(QtGui.QMessageBox.Information,
    "Information",
    "This macro must be downloaded from this link\n"
    "\n"
    "https://gist.githubusercontent.com/mario52a/8d40ab6c018c2bde678f/raw/e16ad9ea7b38c0c47e42aa3019be01dd1267a620/FCInfo_en_Ver_1-20_Docked.FCMacro" + "\n"
    "\n"
    "Quit this window to access the download page")

diag.setWindowFlags(QtCore.Qt.WindowStaysOnTopHint)
diag.setWindowModality(QtCore.Qt.ApplicationModal)
diag.exec_()

import webbrowser 
webbrowser.open("https://gist.githubusercontent.com/mario52a/8d40ab6c018c2bde678f/raw/e16ad9ea7b38c0c47e42aa3019be01dd1267a620/FCInfo_en_Ver_1-20_Docked.FCMacro")


Diese Vorlage muss am Anfang der Makroseite im Abschnitt Beschreibung platziert werden. Es muss der erste Codeblock in der Seite sein, damit der Addon-Manager sie automatisch erkennen und importieren kann. Siehe Makro CirclePlus für ein Anwendungsbeispiel.

PS: Im Falle einer Aktualisierung in GitHub wird der Pfad des RAW Codes geändert, nicht vergessen, den Verweis in der Codeextralink Vorlage zu ändern.

Hinzufügen des neuen Makros zum Wiki Repositorium

Verwende Template:MacroLink , um eine Zeile in die entsprechende Kategorie in Makro-Rezepte einzuschließen; erstelle bei Bedarf eine neue Kategorie.

* {{MacroLink|Macro_Excellent_Modification|Macro Excellent Modification}}: the macro described in a short sentence.
  • Das erste Argument ist der Name der Makroseite im Wiki.
  • Das zweite Argument ist der angezeigte Text, der sich vom Seitennamen unterscheiden kann. Dadurch wird ein Verweis auf das erste Argument erstellt, der das zweite Argument als Text anzeigt.
  • Nach dem Doppelpunkt folgt eine kurze Beschreibung des Makros.

Du kannst auch den optionalen Parameter Icon= verwenden, um die Bilddatei anzugeben, die am Anfang der Zeile platziert wird. Das Symbol sollte eine SVG oder eine PNG Datei sein und den gleichen Namen wie dein Makro haben. Wenn dieser Parameter nicht angegeben wird, wird das Standardsymbol für ein Python Skript verwendet.

* {{MacroLink|Icon=Macro_Excellent_Modification.svg|Macro_Excellent_Modification|Macro Excellent Modification}}: the macro described in a short sentence.

Um diese Vorlage zu lokalisieren, verwende den entsprechenden Sprachverweis im ersten Argument.

* {{MacroLink|Macro_Excellent_Modification/fr|Macro Excellent Modification}}: (translated description)

Hinzufügen des neuen Makros zum zentralen Repositorium

Um ein Makro aus dem Addon-Manager installierbar zu machen, sollte es in das zentrale FreeCAD-Makros -Repositorium aufgenommen werden.

Um das Makro dort aufzunehmen, muss es zunächst von der FreeCAD Gemeinschaft im Python scripting and macros Unterforum überprüft werden. Sobald dies geschehen ist, sollte das FreeCAD-Makro Repositorium abgezweigt werden, das neue Makro sollte in einen Zweig aufgenommen werden, und dann sollte der Zweig gepusht und in das Upstream- Repositorium zusammengeführt werden.