Macro documentation

From FreeCAD Documentation
Jump to: navigation, search
Other languages:
English • ‎français • ‎italiano

Description

All macros should be properly documented in the same way Gui Commands are documented. They should have an individual wiki page, and should be listed in one of the categories in Macros recipes.

The Macros recipes page has a good selection of macros created by experienced users, and many of them can be directly installed from the Addon Manager.

See GuiCommand model and macro pages like Macro Loft and Macro Site From Contours to see how macros should be documented. At least two sections should be included, a Description section with general usage information, and a Script section to hold the actual macro code. Other sections may be included as needed to explain with more detail the usage of the macro.

If a macro provides a well defined functionality, and is well documented, it could be included eventually as part of a new or an existing workbench.

New macro page

Create a new page for the macro starting with the word Macro_, for example, Macro_Excellent_Modification. The link can be used without underscores as [[Macro Excellent Modification|Macro Excellent Modification]], which results in Macro Excellent Modification; the spaces are automatically converted to underscores.

In the new page you should use Template:Macro at the top, with a minimum of information:

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

You can add a custom icon if it doesn't have the same name as the macro; you can also add other fields of information.

{{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]]
}}

When translating the page, use a localized template. You need to specify the name with the two letter language code (/fr, /it, /de), and you need to indicate the icon explicitly

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

or use the Translate field

{{Macro/fr
|Name=Macro Excellent Modification
|Translate=Macro Excellent Modification translated
|Description=(Translated description)
|Author=your username
|Date=2018-11-30
}}
  • 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 Icon=Text-x-python.png Text-x-python.png.
  • For the macro used in the Python console by FreeCAD use Icon=Text_console_python.png Text console python.png.
  • For the example video macro use this skeleton of the icon Text Video Movie.png and fill the screen for obtain ex: Macro crank simul.png 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.

Macro Recipes MacroHowToInstall.png

How to install macros and customize toolbars links in the infobox in each macro page


Adding the macro documentation

  • 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 Help → About FreeCAD → Copy to clipboard.
When this information is pasted, it looks like this
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)

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

Adding the macro code

Inside the Script section, use Template:Code 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: | (vertical bar) or { } (closing brace or opening brace) do not use this template, as the template won't be parsed correctly.
In this cases, you must use the HTML tags <pre> ... </pre>.
{{Code|code=

«Your code should be here»

}}

Add header information before your actual code.

{{Code|code=
__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»
}}

This information can be used by the addons_installer.FCMacro macro, or by the Plugin Loader program, to install the macro and check for new versions. Starting with FreeCAD 0.17, this information is also used by the Addon Manager, which downloads the macro from the FreeCAD-macros repository.

Adding macro code outside of the wiki

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.

For example:

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

It will be displayed as:

Temporary code for external macro link. Do not use this code. This code is used exclusively by Addon_Installer.


##This code is copied instead of the original macro code

##to guide the user to the offline 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 extra wiki location

import PySide

from PySide import QtGui ,QtCore

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

diag.setWindowFlags(PySide.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")
<class="rawcodeurl"><a href="https://gist.githubusercontent.com/mario52a/8d40ab6c018c2bde678f/raw/e16ad9ea7b38c0c47e42aa3019be01dd1267a620/FCInfo_en_Ver_1-20_Docked.FCMacro">raw code</a>


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

PS: In case upgrade in GitHub the path of the RAW code is modified not forgotten modify the link in the Codeextralink template.

Adding the new macro to the wiki repository

Use Template:MacroLink to include a line in the appropriate category in Macros recipes; create a new category if needed.

* {{MacroLink|Macro_Excellent_Modification|Macro Excellent Modification}}: the macro described in a short sentence.
  • 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 Icon= 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 Text-x-python.png.

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

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

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

Adding the new macro to the central repository

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.