Std WhatsThis: Difference between revisions
Renatorivo (talk | contribs) (Marked this version for translation) |
(Marked this version for translation) |
||
(14 intermediate revisions by 3 users not shown) | |||
Line 4: | Line 4: | ||
<!--T:15--> |
<!--T:15--> |
||
{{Docnav |
{{Docnav |
||
|[[Std_About| |
|[[Std_About|About]] |
||
| |
| |
||
|[[Std_Help_Menu|Std Help Menu]] |
|[[Std_Help_Menu|Std Help Menu]] |
||
Line 24: | Line 24: | ||
<!--T:6--> |
<!--T:6--> |
||
The '''Std WhatsThis''' command opens the help documentation for a |
The '''Std WhatsThis''' command opens the help documentation for a specific command. |
||
⚫ | |||
Since FreeCAD version 0.20 this command and the Help system are managed by a separate Help Module. For versions 0.20 and 0.21 this module is an [https://github.com/FreeCAD/FreeCAD-Help addon] that must be [[Std_AddonMgr|installed]] separately. In later versions the Help Module is integrated in FreeCAD. |
|||
==Usage== <!--T:7--> |
==Usage== <!--T:7--> |
||
Line 33: | Line 36: | ||
#* Select the {{MenuCommand|Help → [[Image:Std_WhatsThis.svg|16px]] What's This?}} option from the menu. |
#* Select the {{MenuCommand|Help → [[Image:Std_WhatsThis.svg|16px]] What's This?}} option from the menu. |
||
#* Use the keyboard shortcut: {{KEY|Shift}}+{{KEY|F1}}. |
#* Use the keyboard shortcut: {{KEY|Shift}}+{{KEY|F1}}. |
||
# Click |
# Click a toolbar button or a menu option. |
||
# The help documentation for the selected command opens |
# The help documentation for the selected command opens. |
||
==Notes== <!--T:16--> |
==Notes== <!--T:16--> |
||
<!--T: |
<!--T:21--> |
||
* The Help system has a number of preferences. See [[Preferences_Editor#Help|Preferences Editor]]. |
|||
* Some commands are not documented, in that case the offline help will open on a blank page and report that the page could not be found. |
|||
* The documentation is based on Qt compiled HTML pages. For it to launch Qt Assistant must be installed. |
|||
* On Debian/Ubuntu and possibly other Linux systems, the offline documentation may need to be installed separately. The package is named {{FileName|freecad-doc}}, or {{FileName|freecad-daily-doc}} (for the freecad-daily PPA). See [[Installing_Helpfile|Installing Helpfile]]. |
|||
⚫ | |||
Read this post to understand how the commands must be named in the code to match the help pages in the wiki. |
|||
* [https://forum.freecadweb.org/viewtopic.php?t=27265 Bunch of TechDraw pages don't have the correct name] |
|||
<!--T:18--> |
<!--T:18--> |
||
{{Docnav |
{{Docnav |
||
|[[Std_About| |
|[[Std_About|About]] |
||
| |
| |
||
|[[Std_Help_Menu|Std Help Menu]] |
|[[Std_Help_Menu|Std Help Menu]] |
||
Line 60: | Line 58: | ||
{{Std Base navi{{#translation:}}}} |
{{Std Base navi{{#translation:}}}} |
||
{{Userdocnavi{{#translation:}}}} |
{{Userdocnavi{{#translation:}}}} |
||
{{clear}} |
Latest revision as of 23:43, 27 October 2023
Std WhatsThis |
Menu location |
---|
Help → What's This? |
Workbenches |
All |
Default shortcut |
Shift+F1 |
Introduced in version |
- |
See also |
Std OnlineHelp |
Description
The Std WhatsThis command opens the help documentation for a specific command.
Since FreeCAD version 0.20 this command and the Help system are managed by a separate Help Module. For versions 0.20 and 0.21 this module is an addon that must be installed separately. In later versions the Help Module is integrated in FreeCAD.
Usage
- There are several ways to invoke the command:
- Press the Std WhatsThis button.
- Select the Help → What's This? option from the menu.
- Use the keyboard shortcut: Shift+F1.
- Click a toolbar button or a menu option.
- The help documentation for the selected command opens.
Notes
- The Help system has a number of preferences. See Preferences Editor.
Std Base
- File: New, Open, Close, Close All, Save, Save As, Save a Copy, Save All, Revert, Import, Export,Merge project, Project information, Print, Print preview, Export PDF, Recent files, Exit
- Edit: Undo, Redo, Cut, Copy, Paste, Duplicate selection, Refresh, Box selection, Box element selection, Select All, Delete, Send to Python Console, Placement, Transform, Alignment, Toggle Edit mode, Edit mode, Preferences
- View:
- Miscellaneous: Create new view, Orthographic view, Perspective view, Fullscreen, Bounding box, Toggle axis cross, Clipping plane, Texture mapping, Toggle navigation/Edit mode, Appearance, Random color, Workbench, Status bar
- Standard views: Fit all, Fit selection, Isometric, Dimetric, Trimetric, Home, Front, Top, Right, Rear, Bottom, Left, Rotate Left, Rotate Right
- Freeze display: Save views, Load views, Freeze view, Clear views
- Draw style: As is, Points, Wireframe, Hidden line, No shading, Shaded, Flat lines
- Stereo: Stereo red/cyan, Stereo quad buffer, Stereo Interleaved Rows, Stereo Interleaved Columns, Stereo Off, Issue camera position
- Zoom: Zoom In, Zoom Out, Box zoom
- Document window: Docked, Undocked, Fullscreen
- Visibility: Toggle visibility, Show selection, Hide selection, Select visible objects, Toggle all objects, Show all objects, Hide all objects, Toggle selectability, Toggle measurement, Clear measurement
- Toolbars: File, Edit, Clipboard, Workbench, Macro, View, Structure, Help
- Panels: Tree view, Property view, Selection view, Tasks, Python console, DAG view, Model, Report view
- Link navigation: Go to linked object, Go to the deepest linked object, Select all links
- Tree view actions: Sync view, Sync selection, Sync placement, Pre-selection, Record selection, Single document, Multi document, Collapse/Expand, Initiate dragging, Go to selection, Selection Back, Selection Forward
- Tools: Edit parameters, Save image, Load image, Scene inspector, Dependency graph, Project utility, Measure distance, Add text document, View turntable, Units calculator, Customize, Addon manager
- Macro: Macro recording, Macros, Recent macros, Execute macro, Attach to remote debugger, Debug macro, Stop debugging, Step over, Step into, Toggle breakpoint
- Help: Help, FreeCAD Website, Donate, Users documentation, Python scripting documentation, Automatic Python modules documentation, FreeCAD Forum, FreeCAD FAQ, Report a bug, About FreeCAD, What's This
User documentation
- Getting started
- Installation: Download, Windows, Linux, Mac, Additional components, Docker, AppImage, Ubuntu Snap
- Basics: About FreeCAD, Interface, Mouse navigation, Selection methods, Object name, Preferences, Workbenches, Document structure, Properties, Help FreeCAD, Donate
- Help: Tutorials, Video tutorials
- Workbenches: Std Base, Arch, Assembly, CAM, Draft, FEM, Inspection, Mesh, OpenSCAD, Part, PartDesign, Points, Reverse Engineering, Robot, Sketcher, Spreadsheet, Surface, TechDraw, Test Framework
- Hubs: User hub, Power users hub, Developer hub