Referring to WSO2 products

Using the full name vs using the abbreviation

• Always use the full name in the first usage in an article or Wiki page and then indicate the abbreviation in parentheses.

• See the product's page on the web site for the correct name.

• You can then use that abbreviation throughout the rest of the article or page.

  • Example:
    • WSO2 API Manager (WSO2 API-M) is 100% open source. You can install WSO2 API-M and get up and running in minutes.

Note For SEO, it is always best to use the full name unless it is a well-known, market-accepted term. For example while ESB is a known abbreviation, OB, and IS are not. * All WSO2 product names have a space between words. * Example: * WSO2 API Manager

Actions in the product

We use the following verbs to describe actions the user takes when interacting with our products:

Scenario 1

• Click a button or link (not "click on" or "press") and bold the name of the item.
• Do not include the words "button" or "link" unless it's not obvious which object you're talking about.
  • Example:
    • In a dialog with just Cancel and Save, write: "Click Save", but if there's a link and a button with Save in its label, you would write "Click the Save button".

Scenario 2

• Click a menu command with "->" as the separator.
  • Example:
    • "Click File -> New -> Proxy Service." If it's not clear from context that you're talking about a menu, mention the menu by name, such as "In the file menu, click New -> Proxy Service."

Scenario 3

• Select and clear check boxes, not click (too ambiguous).
  • Example:
    • "Select the foo check box and clear the bar check box."

Scenario 4

• Right-click an object to display the pop-up menu.
  • Example:
    • "Right-click the object, and then choose New->Widget from the pop-up menu."