Difference between revisions of "Help:Contents"

From Protocase Designer Documentation
Jump to: navigation, search
m
m
 
(26 intermediate revisions by the same user not shown)
Line 1: Line 1:
−
 
+
This page is for authors and editors of the Protocase Designer wiki. For help with Designer features and procedures, including Technical Support, see the Help links on the [[Main_Page|'''Home page''']]. For help with definitions of terms, see the [[Glossary | '''Protocase Designer Glossary''']].
−
==Enclosure Terminology==
+
==Glossary for Protocase Designer Wiki Editors==
 
{| border="1" cellpadding="5" cellspacing="0"
 
{| border="1" cellpadding="5" cellspacing="0"
 
!Term
 
!Term
Line 27: Line 27:
 
|-
 
|-
 
|depth||Parameter||Enter the depth for your enclosure.<br>New Assembly dialog box:<br>Depth<br>Depth: Bottom<br>Depth: Top<br>Depth: Recessed
 
|depth||Parameter||Enter the depth for your enclosure.<br>New Assembly dialog box:<br>Depth<br>Depth: Bottom<br>Depth: Top<br>Depth: Recessed
 +
|-
 +
|exclusion||Feature. (AVOID "keepout".)||Add an exclusion zone to the cutout to prevent other components from bumping into it.
 
|-
 
|-
 
|extrusion||Part||Click the left extrusion to open the Face Editor.
 
|extrusion||Part||Click the left extrusion to open the Face Editor.
Line 40: Line 42:
 
|front panel||Part||Click the front panel to open the Face Editor.
 
|front panel||Part||Click the front panel to open the Face Editor.
 
|-
 
|-
−
|gauge||Parameter||Select a gauge to use as the default thickness for your enclosure.
+
|gauge||Parameter. (AVOID "gage".)||Select a gauge to use as the default thickness for your enclosure.
 
|-
 
|-
 
|height||Parameter||Enter the default gauge for your enclosure.<br>New Assembly dialog box:<br>Height<br>Height: Front<br> Height: Rear<br>Height: Recessed
 
|height||Parameter||Enter the default gauge for your enclosure.<br>New Assembly dialog box:<br>Height<br>Height: Front<br> Height: Rear<br>Height: Recessed
Line 55: Line 57:
 
|-
 
|-
 
|panel||Part||Select a panel to open the Face Editor.
 
|panel||Part||Select a panel to open the Face Editor.
 +
|-
 +
|powder coat (also powder coating)||Feature. (AVOID "powdercoat".) ||Our stock powder coat colors are...|
 
|-
 
|-
 
|rear||Feature||
 
|rear||Feature||
Line 82: Line 86:
 
|width||Parameter||Enter the width for your enclosure.
 
|width||Parameter||Enter the width for your enclosure.
 
|}
 
|}
 +
<br><br>
 +
 +
==Protocase Customer-facing Email Addresses and Group References==
 +
{| border="1" cellpadding="5" cellspacing="0"
 +
!Address
 +
!General Term
 +
!Usage
 +
!Examples
 +
|-
 +
|info@protocase.com <br> or tech@protocase.com||Engineering & Design Services <br><br> NOTE: Nickname: For customers, no nickname or initials; always spell out in full. For internal use, "EDS" is OK. ||Everything except orders/ordering or a specific software problem in progress||"Please note: Fonts that appear smaller than Times New Roman and Myriad Pro may have to be enlarged to ensure proper white underbase. Please email info@protocase.com for more information."<br><br>
 +
"Tighter tolerances are possible; if this is necessary, please email info@protocase.com."
 +
|-
 +
|sales@protocase.com||Sales||Specific orders or general questions about ordering||
 +
|-
 +
|designer@protocase.com||Technical Support||Designer questions, problems, and the debug log||"This functionality does not work on previously corrupted files. If you want to use a previous file, first send it to designer@protocase.com; we will fix the Unicode issue and return the fixed file to you at no charge."<br>
 +
"If you have trouble importing a DXF file, please send it to designer@protocase.com and state that you cannot import it into Protocase Designer, and if possible let us know what software package it was created in."
 +
|}
 +
<br><br>
  
 
== Style Guide ==
 
== Style Guide ==
  
 
The following styles and grammar rules are used in the Protocase Designer documentation. Most styles and rules are referenced directly from the Microsoft Manual of Style.
 
The following styles and grammar rules are used in the Protocase Designer documentation. Most styles and rules are referenced directly from the Microsoft Manual of Style.
 +
 +
=== General Software Terms ===
 +
*Use of ''login'' versus ''log in'': use "log in" when used as a verb; use "login" when used as a noun or adjective. See http://grammarist.com/spelling/log-in-login/.
  
 
=== Menus ===
 
=== Menus ===
 
*Menus contain ''commands'', not ''menu items''.
 
*Menus contain ''commands'', not ''menu items''.
−
*Use ''click'' to describe user interaction with menus and menu commands. Do not use ''choose'', ''select'' or ''pick''. To open a submenu the user ''points'' to a command on the main menu, then ''clicks'' the appropriate command on the submenu.
+
*Use ''choose'' to describe clicking a command from a menu. Use ''point'' to indicate clicking a submenu. Alternatively, use the symbol ">" to indicate a menu, submenu, and command string.
 
*Use lowercase for the word ''menu'' when referring to a specific menu.
 
*Use lowercase for the word ''menu'' when referring to a specific menu.
 
*Refer to unavailable commands and options as ''unavailable'', not as ''dimmed'', ''disabled'', or ''grayed'', unless describing their appearance.
 
*Refer to unavailable commands and options as ''unavailable'', not as ''dimmed'', ''disabled'', or ''grayed'', unless describing their appearance.
Line 95: Line 120:
 
*Bold menu names and commands.
 
*Bold menu names and commands.
  
−
''Example''
+
''Examples''
−
:On the '''File''' menu, click '''Open'''.
+
:In the '''File''' menu, choose '''Open'''.
 +
:Choose '''File''' > '''Open'''.
 
:On the '''View''' menu, point to '''Sort by''', and then click '''Date'''.
 
:On the '''View''' menu, point to '''Sort by''', and then click '''Date'''.
 +
:Choose '''View''' > '''Zoom In''' or '''View''' > '''Zoom Out''', then click the face for each incremental zoom.
  
 
=== Toolbars ===
 
=== Toolbars ===
−
*General toolbars contain buttons.
+
*General toolbars contain buttons. The '''Drawing''' toolbar contains tools.
−
*A toolbar button with a submenu is called a ''menu button''.
+
the'' and ''button'' with toolbar buttons.
−
*Use ''click'' to describe user interaction with toolbar buttons except with the '''Drawing''' toolbar.
 
−
*In general, do not use the words ''the'' and ''button'' with toolbar buttons.
 
 
*Use lowercase for the word toolbar.
 
*Use lowercase for the word toolbar.
−
*The '''Drawing''' toolbar contains tools.
 
−
*Use ''select'' to describe user interaction with tools on the '''Drawing''' toolbar.
 
−
*Always surround tool names with the words ''the'' and ''tool''.
 
 
*Bold toolbar names, buttons, and tools.
 
*Bold toolbar names, buttons, and tools.
  
Line 125: Line 147:
 
===Mouse Terms===
 
===Mouse Terms===
 
*Use ''drag'', not ''click and drag''. The ''drag'' action includes holding down a button while moving the mouse and then releasing the button.
 
*Use ''drag'', not ''click and drag''. The ''drag'' action includes holding down a button while moving the mouse and then releasing the button.
−
*Use ''rotate'' to describe interaction with middle wheel button.
+
*Use ''wheel button'' to refer to the wheel button, which can be both rotated and clicked.  
−
*Use ''wheel button'' to refer to the third or middle button on the mouse. Users rotate the wheel itself, and they click the wheel button.
 
 
*Refer to the mouse pointer as ''the pointer''.
 
*Refer to the mouse pointer as ''the pointer''.
 
*Use ''click'', not ''click on''.
 
*Use ''click'', not ''click on''.
  
−
''Example''
+
''Examples''
 
:To see the '''Control''' menu, right-click anywhere in the window.
 
:To see the '''Control''' menu, right-click anywhere in the window.
 
:Click in the window to make it active.
 
:Click in the window to make it active.
−
:Right-click the selected text, and then click '''Copy'''.
+
:Right-click the selected text, and then choose '''Copy'''.
 
:Rotate the wheel button forward to scroll up in the document.
 
:Rotate the wheel button forward to scroll up in the document.
  
 
===Title and heading style and conventions===
 
===Title and heading style and conventions===
−
*Use sentence-style capitalization for titles and for headings.
+
*Use gerunds in procedure titles.
−
*Use imperative constructions for procedure titles.
 
 
*Describe what the user wants to do in the user's language.
 
*Describe what the user wants to do in the user's language.
  
−
''Example''
+
''Examples''
−
:Draw circles
+
:Drawing circles
−
:Reset view
+
:Resetting the view
  
 
===Procedures===
 
===Procedures===
−
#Title: identify the task using imperative
+
#Title: identify the task using gerund ("-ing" ending)
 
#Describe the task
 
#Describe the task
 
#*One or two sentences
 
#*One or two sentences
Line 153: Line 173:
 
#List prerequisites
 
#List prerequisites
 
#Highlight hazards
 
#Highlight hazards
−
#Write the steps (use [[Template:Procedure]])
+
#Write the steps
 
#*Use clear, present tense imperatives
 
#*Use clear, present tense imperatives
 
#**e.g. Set the starting time vs. Users should select a starting time
 
#**e.g. Set the starting time vs. Users should select a starting time
 
#*Keep sentences short
 
#*Keep sentences short
−
#*Group steps based on complexity
 
−
#*Limit number of steps (<10)
 
 
#*Make sure you can perform each step
 
#*Make sure you can perform each step
−
#*Do not tell the user every way to perform task (i.e. menu, button, etc.), unless the procedure is explaining one specific task.
+
#*Unless the procedure is explaining one specific task, write the ''best'' way, not every way (menus, buttons, etc.).
−
#*Fake step 2 if there are a lot of 1 step procedures
 
  
 
=== Image Naming Conventions ===
 
=== Image Naming Conventions ===
−
Examples<br>
 
 
'''Screenshots''': png files
 
'''Screenshots''': png files
 
*button-editface.png
 
*button-editface.png

Latest revision as of 14:48, 18 March 2016

This page is for authors and editors of the Protocase Designer wiki. For help with Designer features and procedures, including Technical Support, see the Help links on the Home page. For help with definitions of terms, see the Protocase Designer Glossary.

Glossary for Protocase Designer Wiki Editors

Term Usage Example
back AVOID. See rear N/A
back panel AVOID. See rear panel N/A
bottom Feature Use the view commands to view the bottom of your enclosure.
bottom panel Part Click the bottom panel to open the Face Editor.
bracket Part Click the bracket to open the Face Editor.
chassis Part Click the chassis to open the Face Editor.
color Parameter You can change the color of each Part.
New Assembly dialog box:
Color: Default
Color: Chassis
Color: Left/Right
Color: Top
Color: Bottom
Color: Front
Color: Rear
Color: Divider
colour AVOID. See color N/A
cover Part Click the cover to open the Face Editor.
default Parameter option Select the default color for your enclosure.
depth Parameter Enter the depth for your enclosure.
New Assembly dialog box:
Depth
Depth: Bottom
Depth: Top
Depth: Recessed
exclusion Feature. (AVOID "keepout".) Add an exclusion zone to the cutout to prevent other components from bumping into it.
extrusion Part Click the left extrusion to open the Face Editor.
face Feature You can draw features on the face using several drawing tools.
flange Part Select a color for the left flange.
flange mount Part Select a color for the flange mount.
front Feature Use the view commands to view the front of your enclosure.
front panel Part Click the front panel to open the Face Editor.
gauge Parameter. (AVOID "gage".) Select a gauge to use as the default thickness for your enclosure.
height Parameter Enter the default gauge for your enclosure.
New Assembly dialog box:
Height
Height: Front
Height: Rear
Height: Recessed
left extrusion Part Click the left extrusion to open the Face Editor.
left panel Part Click the left panel to open the Face Editor.
material Parameter Select a material for your enclosure.
metal type AVOID. See material N/A
mounting hardware Part You can add mounting hardware to your enclosure.
panel Part Select a panel to open the Face Editor.
powder coat (also powder coating) Feature. (AVOID "powdercoat".)
rear Feature
rear panel Part
right extrusion Part Click the right extrusion to open the Face Editor.
right panel Part Click the right panel to open the Face Editor.
self-clinching fastener Part You can add self-clinching fasteners to your enclosure.
side Feature
silkscreen Feature You can add custom silkscreen to your enclosure.
style Parameter We build enclosures of all styles.
thickness Parameter Select a gauge to use as the default thickness for your enclosure.
New Assembly dialog box:
Thickness
Thickness: Default
Thickness: Front
Thickness: Cover
Thickness: Chassis
Thickness: Rear
top Feature Use the view commands to view the top of your enclosure.
top panel Part Click the top panel to open the Face Editor.
type AVOID when used for enclosure. See style N/A
width Parameter Enter the width for your enclosure.



Protocase Customer-facing Email Addresses and Group References

Address General Term Usage Examples
info@protocase.com
or tech@protocase.com		 Engineering & Design Services

NOTE: Nickname: For customers, no nickname or initials; always spell out in full. For internal use, "EDS" is OK. 		Everything except orders/ordering or a specific software problem in progress "Please note: Fonts that appear smaller than Times New Roman and Myriad Pro may have to be enlarged to ensure proper white underbase. Please email info@protocase.com for more information."

"Tighter tolerances are possible; if this is necessary, please email info@protocase.com."

sales@protocase.com Sales Specific orders or general questions about ordering
designer@protocase.com Technical Support Designer questions, problems, and the debug log "This functionality does not work on previously corrupted files. If you want to use a previous file, first send it to designer@protocase.com; we will fix the Unicode issue and return the fixed file to you at no charge."

"If you have trouble importing a DXF file, please send it to designer@protocase.com and state that you cannot import it into Protocase Designer, and if possible let us know what software package it was created in."



Style Guide

The following styles and grammar rules are used in the Protocase Designer documentation. Most styles and rules are referenced directly from the Microsoft Manual of Style.

General Software Terms

Menus

  • Menus contain commands, not menu items.
  • Use choose to describe clicking a command from a menu. Use point to indicate clicking a submenu. Alternatively, use the symbol ">" to indicate a menu, submenu, and command string.
  • Use lowercase for the word menu when referring to a specific menu.
  • Refer to unavailable commands and options as unavailable, not as dimmed, disabled, or grayed, unless describing their appearance.
  • Always surround menu names with the words the and menu.
  • Bold menu names and commands.

Examples

In the File menu, choose Open.
Choose File > Open.
On the View menu, point to Sort by, and then click Date.
Choose View > Zoom In or View > Zoom Out, then click the face for each incremental zoom.

Toolbars

  • General toolbars contain buttons. The Drawing toolbar contains tools.

the and button with toolbar buttons.

  • Use lowercase for the word toolbar.
  • Bold toolbar names, buttons, and tools.

Example

On the Standard toolbar, click New.
On the Drawing toolbar, select the Rectangle tool.

Check Boxes

  • Two words. Use the identifier, check box, not just box.
  • Use select and clear, NOT turn on and turn off, mark and unmark, check and uncheck, or select and deselect.
  • Always include check box with the label name.

Example

Select the Spaces check box.
Click to clear the Bookmarks check box.

Mouse Terms

  • Use drag, not click and drag. The drag action includes holding down a button while moving the mouse and then releasing the button.
  • Use wheel button to refer to the wheel button, which can be both rotated and clicked.
  • Refer to the mouse pointer as the pointer.
  • Use click, not click on.

Examples

To see the Control menu, right-click anywhere in the window.
Click in the window to make it active.
Right-click the selected text, and then choose Copy.
Rotate the wheel button forward to scroll up in the document.

Title and heading style and conventions

  • Use gerunds in procedure titles.
  • Describe what the user wants to do in the user's language.

Examples

Drawing circles
Resetting the view

Procedures

  1. Title: identify the task using gerund ("-ing" ending)
  2. Describe the task
    • One or two sentences
    • Explain when and why
    • Cross-reference to related tasks
  3. List prerequisites
  4. Highlight hazards
  5. Write the steps
    • Use clear, present tense imperatives
      • e.g. Set the starting time vs. Users should select a starting time
    • Keep sentences short
    • Make sure you can perform each step
    • Unless the procedure is explaining one specific task, write the best way, not every way (menus, buttons, etc.).

Image Naming Conventions

Screenshots: png files

  • button-editface.png
  • button-acceptclose.png
  • dialogbox-editproperties.png
  • dialogbox-showparts.png
  • tool-circle-construction.png
  • tool-edit.png
  • window-faceeditor-ushape-rear.png
  • window-main-rackmount-nocover.png

Sketches: jpg files

  • sketch-powersupply-pcb.jpg
  • sketch-mounting-dimensions-rear.jpg

Photos: jpg or png files

  • photo-fan-60mm.png
  • photo-powersupply.png
Retrieved from "https://www.protocasedesigner.com/wiki/index.php?title=Help:Contents&oldid=2750"