plainblack.com
Username Password
search
Bookmark and Share
Subscribe

Debugging Macros

Macros are a very powerful part of WebGUI, but they can sometimes be hard to debug. These are very common mistakes made when using Macros:

Unconfigured Macros in the WebGUI.conf file 

The most common mistake is to try to use a Macro that is not enabled in your WebGUI.conf file.  This mistake is especially common among people who have hosted WebGUI sites.  The WebGUI.conf file has a list of Macros, and the shortcuts that they have been configured to use. 

You can view the list of Macros that are enabled on your site in the built-in WebGUI Help.

  1. Log in as an Admin or Content Manager.
  2. Turn on Admin mode
  3. From the Admin Panel or Admin Console, select the Help icon, which is a life preserver.
  4. Select the Macros tab.
  5. Select the Macros entry on that page.
  6. Select the Macros, List of Available entry on that page.

Bad Macro Syntax.

Macros have a hard time handling quotes and commas.  This is especially true when nesting Macros.  The Help entries for each Macro will tell you if it can be safely nested inside other Macros.  If WebGUI cannot parse and understand your Macro, it will return the original Macro without any processing.

There are never spaces before or after the commas between Macro arguments.

In most cases, you don't need quotes around the Macro arguments.

Be sure to use a backslash \ to escape any extra commas or single or double quotes when you manually enter in arguments to a Macro.  This is especially true when using simple HTML as Macro arguments.

Bad Macro Arguments.

Some Macros will tell you if a bad argument is passed, such as a templateId, file URL or product ID.  However, many macros will just error out, and return the original Macro without any processing.  In that case, please double check whatever data you sent to the macro.

Keywords:

Search | Most Popular | Recent Changes | Wiki Home
© 2018 Plain Black Corporation | All Rights Reserved