Sandbox:Mario52

Description
Ce petit tutoriel vous guide sur la façon d'utiliser les macros disponibles et de les incorporer dans l'éditeur de FreeCAD.

This short tutorial will guide you on how to use macros available and incorporate them into the FreeCAD editor.

Python
Python est un langage de programmation vraiment simple d'utilisation et vraiment facile à apprendre

Python is a programming language, very simple to use and very fast to learn].

Location and destination macros
Cette section vous permet de localiser l'emplacement définitif de vos macros.

This section allows you to locate the final location of your macros.

1 : click Menu > Macro > Macros or the click the bottom "Open a dialog to let you execute a macro Recorded"



2 : one dialog box open

3 : the address of "Macro destination" (here C:\Users\your_user_name\AppData\Roaming\FreeCAD\)

In Ubuntu, this is normally /home/your_user_name/.FreeCAD

4 : copy the address of "Macro destination" (here C:\Users\your_user_name\AppData\Roaming\FreeCAD\)



5 : paste the address into your browser and confirm



6 : leave open the explorer



Method Copy and Paste
Pour l'exemple nous allons copier la macro Macro_Apothem_Based_Prism_GUI

S'il y a un ou plusieurs icône(s) téléchargez les aussi, positionnez votre souris sur l'icône cliquez sur le bouton droit et cliquez sur "Enregistrez l'image sous..." cet icône ou les icônes seront placés dans le répertoire des macros et un de ces icônes servira comme icône de raccourci à placer sur la barre des tâches.



Après avoir copié votre code nous allons coller le code dans l'éditeur de FreeCAD.

For example we will copy the macro Macro_Apothem_Based_Prism_GUI

If there are one or more icon (s) download also position your mouse over the icon, click the right mouse button and click "Save image as ..." the icon or icons are placed in the macro directory and one of these icons serve as a shortcut icon to place on the toolsbar.

After copying your code we will paste the code in FreeCAD editor.

1 : Ouvrez FreeCAD et ouvrons l'éditeur de code incorporé dans FreeCAD

1 : Open FreeCAD and open the editor in FreeCAD



2 : La fenêtre des fichiers macros s'ouvre, cliquez sur le bouton

2 : The window macros file opens, click button



3 : Une nouvelle fenêtre s'ouvre, entrez le nom de la macro a créer (ici "Macro_Apothem_Based_Prism_GUI") puis cliquez sur le bouton

3 : A new window opens, enter the macro name (here "Macro_Apothem_Based_Prism_GUI")and click the create button



4 : La fenêtre d'édition de macros de FreeCAD est maintenant disponible et porte le nom de notre future macro.

4 : The editing window FreeCAD macros is now available and has the name of our future macro.



5 : Coller votre code dans la fenêtre éditeur de macro et cliquez sur la petite croix pour fermer la fenêtre.

5 : Paste your code in the macro editor window and click the little cross to close the window.



6 : Une fenêtre d'avertissement s'affiche et demande une confirmation de sauvegarde du code, cliquer sur le bouton

PS: Pour que la modification soit prise en compte il faut enregistrer la macro puis la rouvrir et seulement l'exécuter.

6 : A warning window appears asking for confirmation of save code, click on

PS: For the change silk consideration must save the macro and reopen it and just run it.



7 : Cliquez sur votre nouvelle macro et sur le bouton

7 : Click on your new macro and button



8 : La macro s'exécute, remplissez les champs avec vos valeurs et cliquez sur le bouton

8 : The macro runs, complete the fields with your values and click the button



9 : La macro retourne une erreur ! nous n'avons pas de document ouvert, ouvrons un document et répétons les opérations 7 et 8. Certaines macros ouvrent un nouveau document s'il n'en trouve pas.

9 : The macro returns an error! we do not have to open document, open a document and repeat the operation 7 and 8. Some macros open a new document if it does not find one.



10 : Et voici notre prisme

10 : Here here is our prism



11 : Vous pouvez aussi ouvrir votre macro dans l'éditeur pour l'exécuter ou la modifier, cliquez sur le bouton

11 : You can also open your macro in the editor to run or modify, click the button



12 :



The indentation errors
L'indentation dans la programmation phyton est très importante et fait partie intégrante du code, un espace ou un décalage inapproprié provoque une erreur d'indentation ex :

The indentation in the phyton programming is very important and integral part of the code, a space or an inappropriate shift causes an indentation error ex :

 : ('expected an indented block', ('C:/Users/d/AppData/Roaming/FreeCAD/Macro_Apothem_Based_Prism_GUI.FCMacro', 21, 3, 'def priSm(self):\n'))

l'erreur renvoyée donne 'expected an indented block' indentation de bloc attendue à la ligne 21, 3, normal après un class p: il faut a la ligne suivante un indentation d'au moins un espace.

gives the error returned 'expected an indented block' block indentation expected to line 21, 3, normal after a class p : must be the next line an indentation at least one space.

1 : Dans cet exemple le code a été collé sans aucune indentation et bien sûr ne fonctionne pas ! ici certainement une erreur du programmeur au moment de coller son code sur la page car il n'aurait jamais su le faire fonctionner.

1 : In this example, the code was stuck without any indentation and of course does not work! here definitely a programmer error when pasting the code on the page as it would have never known it to work.



2 : le code a été corrige les indentations à la bonne place.

2 : the code was correct indentations in the right place.



3 : nous sélectionnons le code et nous voyons que la sélection est bien au bord du code, la macro doit fonctionner tout va bien

3 : we select the code, and we see that the selection is at the edge of the code, the macro must works so good



4 : Ici un espace supplémentaire est sélectionné (ça peut arriver) vous devez alors copier le code dans un traitement de texte pour supprimer un espace dans toutes les lignes

4 : Here additional space is selected (it can happen) then you need to copy the code into a word processor to remove one space all lines



5 : Ici le code a été copié dans une fenêtre du forum avec le bouton apparemment la sélection est bonne

5 : Here the code has been copied in a forum window with the button apparently the selection is good



6 : Mais la sélection collée dans l'éditeur de FreeCAD donne une surprise, une indentation de quatre espaces a été ajoutée par le système ? le code n'est pas bon

6 : But the selection pasted into the FreeCAD editor gives a surprise, an indent of four spaces has been added by the system ? the code is not good



7 : Vous devez effacer tous les espaces supplémentaires c'est à dire quatre espaces à chaque ligne (pour Windows le traitement de textes notepad-plus-plus permet sélection verticale avec une combinaison de touches + Mouse dragging ou Menu > Edition > Indentation > Réduire l'indentation

7 : You must delete all the extra space that is four spaces on each line (for Windows word processing notepad-plus-plus enables vertical selection with a combination of buttons + Mouse dragging or Menu> Edit> Indent> Decrease the indentation



8 : Code parfait.

8 : Perfect code.



Method Script in a compressed .ZIP file
Téléchargez votre fichier si c'est un fichier.zip (exemple) FCInfo_fr_Ver_1-14_Docked.FCMacro.zip.

Des gratuits pour Windows 7-zip ou L-Zarc ou quickzip

Pour Linux utilisez la commande suivante dans un terminal:

Vous devez maintenant décompresser le fichier et le copier dans votre répertoire de macros.

Download the file compressed here (example) FCInfo_en_Ver_1-14_Docked.FCMacro.zip.

Free for Windows 7-zip ou L-Zarc ou quickzip

For Linux use this on the terminal

you must unzip the zip and copy all the files in your macro directory.

Process
1 : Téléchargez votre fichier dans votre dossier habituel, ici le dossier Temp

1 : Download your file in your local folder here the folder Temp



2 : Décompressez votre fichier dans le dossier.

2 : Unzip your file in the folder.



3 : Le décompresseur a fini son travail et a créé un nouveau dossier avec le fichier décompressé

3 : The decompressor finished his work and created a new folder with the unpacked file



4 : Entrez dans le répertoire nouvellement créé, positionnez vous sur le fichier, cliquez avec le bouton droit de la souris et faites Couper.

4 : Enter in the newly created directory, move about the file, click the right mouse button and click on Cut.



5 : Retournez dans votre explorateur resté ouvert dans l'emplacement des macros (ici C:\Users\your_user_name\AppData\Roaming\FreeCAD\) et fermez l'explorateur.

5 : Return to your browser remained open in the macro location (here C:\Users\your_user_name\AppData\Roaming\FreeCAD\) and close the browser.



6 : Ouvrez FreeCAD et entrez dans le menu macro par Menu > Macro > Macros ou cliquez sur le  "Ouvre une boîte de dialogue pour exécuter une macro enregistrée"

6 : Open FreeCAD click Menu > Macro > Macros or the click the  "Open a dialog to let you execute a macro Recorded"



7 : La fenêtre des macros s'ouvre, sélectionnez votre macro et cliquez sur le bouton

7 : The macros window open, select your macro and click the button



8 : Votre macro est exécutée et vous attend

8 : Your macro is executed and waiting