CAM Comment/en: Difference between revisions

From FreeCAD Documentation
(Updating to match new version of source page)
(Updating to match new version of source page)
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
<languages/>
<languages/>

{{Docnav
{{Docnav
|[[Path_Fixture|Fixture]]
|[[Path_Fixture|Fixture]]
|[[Path_Stop|Stop]]
|[[Path_Stop|Stop]]
|[[Path_Workbench|Path]]
|[[Path_Workbench|Path]]
|IconL=Path_Fixture.png
|IconL=Path_Fixture.svg
|IconC=Workbench_Path.svg
|IconR=Path_Stop.svg
|IconR=Path_Stop.svg
|IconC=Workbench_Path.svg
}}
}}


{{GuiCommand
{{GuiCommand
|Name=Path Comment
|Name=Path Comment
|MenuLocation=Path → Supplemental commands → Comment
|MenuLocation=Path → Supplemental Commands → Comment
|Workbenches=[[Path_Workbench|Path]]
|Workbenches=[[Path_Workbench|Path]]
|Shortcut={{KEY|P}} {{KEY|C}}
|SeeAlso=
}}
}}


Line 23: Line 22:
==Usage==
==Usage==


# Press the {{KEY|[[Image:Path_Comment.svg|16px]] [[Path Comment|Comment]]}} button or use the {{KEY|P}} then {{KEY|C}} keyboard shortcut.
# Press the {{KEY|[[Image:Path_Comment.svg|16px]] [[Path_Comment|Comment]]}} button or use the {{KEY|P}} then {{KEY|C}} keyboard shortcut.
# Write your comment in the '''Comment''' property
# Write your comment in the '''Comment''' property


Line 31: Line 30:


==Scripting==
==Scripting==

{{Emphasis|See also:}} [[FreeCAD Scripting Basics|FreeCAD Scripting Basics]].
{{Emphasis|See also:}} [[FreeCAD_Scripting_Basics|FreeCAD Scripting Basics]].


Example:
Example:

{{Code|code=
{{Code|code=
#Place code example here.
#Place code example here.
Line 43: Line 44:
|[[Path_Stop|Stop]]
|[[Path_Stop|Stop]]
|[[Path_Workbench|Path]]
|[[Path_Workbench|Path]]
|IconL=Path_Fixture.png
|IconL=Path_Fixture.svg
|IconC=Workbench_Path.svg
|IconR=Path_Stop.svg
|IconR=Path_Stop.svg
|IconC=Workbench_Path.svg
}}
}}


{{Path_Tools_navi{{#translation:}}}}
{{Path_Tools_navi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{Userdocnavi{{#translation:}}}}
{{clear}}

Revision as of 11:05, 20 August 2021

Path Comment

Menu location
Path → Supplemental Commands → Comment
Workbenches
Path
Default shortcut
None
Introduced in version
-
See also
None

Description

This tool inserts a comment. When exporting a project to G-code, the comments will be inserted in the G-code program, and can be read by people reading the file. Some machine controllers will also display comments on their display screens.

Usage

  1. Press the Comment button or use the P then C keyboard shortcut.
  2. Write your comment in the Comment property

Properties

  • DataComment: The text of your comment

Scripting

See also: FreeCAD Scripting Basics.

Example:

#Place code example here.