Conventions
ZW3D CAD-CAM Logo  
   ZW3D Base
Home > ZW3D Information > Conventions
Article Title Conventions
Here is a brief description of each section in this CAD Reference and examples of a few of the conventions that are used.
 

In this Article:

 
 

Menu Selections

Menu selection sequences are shown in the following format:

Help > Quick Tips...

Keywords and Icons

Many key words and phrases are shown in bold type for emphasis. They may be the key words on a form or button. Many are also phrases or form names that contain hypertext jumps in the online version of the documentation. Command and document icons are used at section headings to convey at a glance different types of information. The icons used are shown below.
 
 
Frame Located at a Point
Command icon
These are used in the ZW3D interface. They are shown along side the command name and/or description.
 

Required Inputs

Required Inputs
These indicate inputs that are required for the command to function.The input forms themselves are not shown.
 

Optional Inputs

Optional Inputs
These indicate inputs that are optional.They are not required for the command to function but many have default values assigned to them.The input forms themselves are not shown.
 
Forms and Dialogues
Forms and Dialogues
These indicate that the following documentation relates to ZW3D forms and dialogues.The images of the forms and dialogues may not be present in all cases.
 
General information
General information
These distinguish general information about ZW3D from command specific information.
 

Left-click Mouse

Middle-click Mouse

Right-click Mouse to access function
Left-click to access function
These indicate that the function that follows can only be accessed using the left mouse button over geometry or manager tree entity.

Middle-click to access function
These indicate that the function that follows can only be accessed using the middle mouse button over geometry or manager tree entity.

Right-click to access function
These indicate that the function that follows can only be accessed using the right mouse button over geometry or manager tree entity.

Applying ZW3D
Applying ZW3D
These indicate sections that show how ZW3D can be applied to real-world applications (CAD Reference only).
 
Invoked by
Invoked by
This indicates a menu sequence that can invoke a command. In ZW3D there are usually multiple ways to invoke commands.The Pull Down Menu method is usually the one indicated.
 
Notes
Notes
These indicate that a list of command or topic specific notes are to follow.
 
Caution
Caution
These indicate caution.The command or procedure that follows may cause objects or files to be damaged or deleted if not performed correctly.You should understand the procedure and proceed carefully.
 
ZW3D Tips & Techniques
ZW3D Tips & Techniques
These indicate an operating tip or trick.It will be followed by valuable information that you should read in order to take full advantage of ZW3D CAD/CAM.See CAD Tips & Techniques for a complete list.
 
 

Operational Sequences

Operational sequences are numbered:

Example:

  1. Select the edges to chamfer.
  2. Select the face on the first side of the edge. This face will receive the first setback distance. You may only select a face that borders the selected edge.
  3. Repeat steps 1 and 2 until all of the edges you want to chamfer are selected and their faces are specified and then middle-click to continue.
  4. Specify the first setback distance.
  5. Specify the second setback distance (or angle if the Angle option is selected - see below).
  6. Middle-click to execute the command.

OR

If there is only one operational step, it is preceded by a bullet.

Example:

  • Press the Control Keys (Ctrl+K) to toggle the coordinate readout on/off

 

Notes

A bullet is used to identify important notes in the middle of a topic.

Example:

  • You can also use this command to open (and execute) ZW3D macro files (*.mac) created using the ZW3D Design Automation Language

You will also find notes at the end of many topics.

Example:

Notes Notes

  • About Copying Sketches (see Tips & Techniques)
  • Assigning Names to Features (see Tips & Techniques)
  • During Path input, you can right-click and select Insert Curve List from the Input Options Menu. This will allow you to make a parametric list of existing curves to use as input for this command

 

Tips & Techniques

Tips & Techniques are provided throughout the documentation. They provide useful information and guidance that can help you take full advantage of ZW3D and its advanced features. An example is shown below. See Tips & Techniques for a complete list and links.

 

Example:
ZW3D Tips & Techniques
You can lock the position, tangency and radius of curvature for the end points and the point being edited. Note that the locking of constraints only applies to mid-curve points while the point is selected for editing. Only the end point constraints can be locked against all mid-curve editing.
 
 
 
 

Forms and Dialogues

Documentation for the contents of forms and dialogues is presented in the following format.Many forms are not shown graphically.The icon shown below is used to alert you that a form or dialogue is being documented.

The title of the form or section within a dialogue will appear to the right of the icon. Option titles or form content will appear below the icon followed by a description.

 

Example:

Forms and DialoguesFile Properties Form

  • Name - The current name of the active file
  • Location - The location of the archive of the active file
  • Size - The current size of the active file
  • Modified Displays - Yes or No if the active file has been modified since it was last saved

 

Example:

Required Inputs Required Inputs

Points
Select the points to project and then middle-click to continue.
 
Geometry
Select the curves and/or faces to project to.
 

There are options that are common to many forms and dialogues.  These are documented once for the type of forms in question.  For example, all of the command options forms contain a set of similar options.

 

3D/2D Usage

ZW3D offers many commands that can be used at multiple levels.For example, the Create Points command is available at the Part, Sketch and Drawing Sheet levels.These multi-level commands are only documented once in the order and ZW3D level that they appear (e.g., File, Object, Part, Sketch, Drawing Packet, Drawing Sheet and CAM Levels).

The Create Points command is documented in Wireframe Design under Points. The distinction (3D/2D) is appended to the titles of these multi-level commands.This means that they are used at the Part Level as well as the Sketch or Drawing Sheet Levels. The distinction (3D) or (2D) will appear alone to eliminate any possible confusion concerning the title of the command. If no distinction is provided, then the command is only used at the level in which it is documented.