Std DlgMacroRecord: Difference between revisions

From FreeCAD Documentation
No edit summary
(Revised. Added 'in progress' for now.)
Line 1: Line 1:
<languages/>
<languages/>

{{UnfinishedDocu{{#translation:}}}} <!-- Needs English UI image -->
{{Page in progress}}

<translate>
<translate>

<!--T:1-->
{{Docnav
|
|[[Std_MacroStopRecord|Std MacroStopRecord]]
|[[Std_Macro_Menu|Std Macro Menu]]
|
|IconR=Std_MacroStopRecord.svg
|IconC=Freecad.svg
}}

{{GuiCommand
{{GuiCommand
|Name=Std DlgMacroRecord
|Name=Std DlgMacroRecord
|MenuLocation={{StdMenu|[[Std Macro Menu|Macro]]}} → Macro recording...
|MenuLocation=Macro → Macro recording...
|Workbenches=All
|Workbenches=All
|SeeAlso=[[Std_DlgMacroExecuteDirect|Execute macro]], [[Std Macro Menu]]
|SeeAlso=[[Std_MacroStopRecord|Std MacroStopRecord]]
}}
}}


== Description == <!--T:2-->
==Description==


The '''Std DlgMacroRecord''' command starts a [[Macros|macro]] recording session during which all user actions are stored in a FreeCAD macro file ({{FileName|.FCMacro}}). Such a file can later be replayed, executed, to repeat the recorded actions.
<!--T:3-->
The [[Image:Std_DlgMacroRecord.svg|16px]] Start Macro recording function initiates a recording session of a [[macros|macro]]. This means it will record all operation the user makes in the [[3D view]]. Once the user is finished with the sequence of action, the [[File:Std MacroStopRecord.svg|16px]] [[Std MacroStopRecord|Stop Macro Recording]] functions ends the macro recording session. This is a powerful technique to record repetitive sequences of actions (in to [[Python]] code that can be saved in a FreeCAD Macro file ({{incode|.FCMacro}})), that can be executed at a later time or even transferred to another computer running FreeCAD.


== Usage == <!--T:5-->
==Usage==


# There are several ways to invoke the command:
<!--T:4-->
#* Press the {{Button|[[Image:Std_DlgMacroRecord.svg|16px]] [[Std_DlgMacroRecord|Std DlgMacroRecord]]}} button.
#The Macro Record function is accessible via several ways:
#* The {{Button|[[Image:Std_DlgMacroRecord.svg|16px]] Macro recording}} button in the macro toolbar [[File:Macros_toolbar.jpg|96px]]
#* Select the {{MenuCommand|Macro → [[Image:Std_DlgMacroRecord.svg|16px]] Macro recording...}} option from the menu.
# The Macro recording dialog box opens.
#* The menu {{MenuCommand|{{StdMenu|[[Std Macro Menu|Macro]]}} → Macro recording}},
# Enter a name for the macro in the '''Macro name''' input box.
# '''Result:''' A dialog box will appear querying the user for the following information
# Optionally change the '''Macro path''' by pressing the {{Button|...}} button.
#: [[Image:Menu_Std_DlgMacroRecord_it.png‎|Macro recording]]
# Optionally press the {{Button|Cancel}} button to abort the command.
#::* '''Macro name''': Enter the name of the new macro.
# The {{Button|Stop}} button does not work at this time.
#::* '''Macro path''': Path macro library. To change the path, click {{Button| ... }}.
#::* {{KEY|Record}}: Record the macro (starts recording all actions in the [[3D view]]).
# Press the {{Button|Record}} button to start the recording session.
# To end the recording session do one of the following:
#:::'''Note:''' The button {{Button|[[File:Std MacroStopRecord.svg|16px]] Stop macro recording session}} in the macros toolbar [[File:Macros_toolbar.jpg|96px]] will turn green [[File:Std MacroStopRecord.svg|16px]].
#* Press the {{Button|[[Image:Std_MacroStopRecord.svg|16px]] [[Std_MacroStopRecord|Std MacroStopRecord]]}} button.
#::* {{Button|Stop}}: Stop recording the macro.
#* Select the {{MenuCommand|Macro → [[Image:Std_MacroStopRecord.svg|16px]] Stop macro recording}} option from the menu.
#::* {{Button|Cancel}}: Cancels and closes the window.
# Once completed, click {{KEY|[[File:Std MacroStopRecord.svg|16px]] [[Std MacroStopRecord|Stop the macro recording session]]}} to stop recording the macro.


==Notes==
=== Executing the Macro=== <!--T:8-->


* Todo.
<!--T:15-->
# The macro can be executed several ways:
#* Through the {{MenuCommand|Macro → Macros...}} menu
#* Pressing the {{Button|[[File:Std_DlgMacroExecuteDirect.svg|16px]] [[Std_DlgMacroExecuteDirect|Execute this macro]]}} button in the macro toolbar
# Choose the macro
# Press {{Button|OK}}


==Preferences==
==Example== <!--T:9-->


* Todo.
<!--T:13-->
# Press the [File:Std DlgMacroRecord.svg|16px]] button
# Enter a name for the macro and press {{Button|OK}}
# Open a document
# Create an [[Image:Part_Box.svg|24px]] [[Part Box|Cube]]
# Change the color of the box
# Press on [[File:Std MacroStopRecord.svg|16px]] to stop the macro recording


==Properties==
<!--T:10-->

Result: The macro is available in your macros directory. [[#Executing the Macro|Execute]] the macro to recreate the steps you just recorded.
* Todo.

==Scripting==

* Todo.

{{Docnav
|
|[[Std_MacroStopRecord|Std MacroStopRecord]]
|[[Std_Macro_Menu|Std Macro Menu]]
|
|IconR=Std_MacroStopRecord.svg
|IconC=Freecad.svg
}}


</translate>
</translate>
{{Std Base{{#translation:}}}}
{{Std Base navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}
{{clear}}

Revision as of 19:31, 15 June 2020

This documentation is a work in progress. Please don't mark it as translatable since it will change in the next hours and days.


Std DlgMacroRecord

Menu location
Macro → Macro recording...
Workbenches
All
Default shortcut
None
Introduced in version
-
See also
Std MacroStopRecord

Description

The Std DlgMacroRecord command starts a macro recording session during which all user actions are stored in a FreeCAD macro file (.FCMacro). Such a file can later be replayed, executed, to repeat the recorded actions.

Usage

  1. There are several ways to invoke the command:
    • Press the Std DlgMacroRecord button.
    • Select the Macro → Macro recording... option from the menu.
  2. The Macro recording dialog box opens.
  3. Enter a name for the macro in the Macro name input box.
  4. Optionally change the Macro path by pressing the ... button.
  5. Optionally press the Cancel button to abort the command.
  6. The Stop button does not work at this time.
  7. Press the Record button to start the recording session.
  8. To end the recording session do one of the following:
    • Press the Std MacroStopRecord button.
    • Select the Macro → Stop macro recording option from the menu.

Notes

  • Todo.

Preferences

  • Todo.

Properties

  • Todo.

Scripting

  • Todo.