Open topic with navigation

Changing report menu item names and icons

Report plug-ins are XML files that define the menu item and the report to run from the repository shortcut menu. You can change the menu item name and icon in the XML file. You can also rename plug-in files to more easily identify the report they are related to.

If you need to create a report plug-in, see Adding shortcuts to run reports from the Source Tree window.

Note: Only make changes to the menu item name and icon values in the XML file. Do not change other values because the plug-in may stop working.

1. Open the report plug-in XML file in a text editor. Plug-ins are stored in the plugins directory in the Surround SCM application directory by default.

2. Modify the <menu-item name="Report Name" /> line.

• To change the name, replace the name value with the text to display in the menu. For example, <menu-item name="Run Files Awaiting Review Report" />. The name is required and must be unique. Errors occur if multiple plug-ins use the same menu item name.
• To change the icon, add an icon value and path to the image file. For example, <menu-item name="Run Files Awaiting Review Report" icon="NeedsReview.png" />. An icon value is optional. You can enter a relative file path if the image is in the plugins directory or a full path to an image in another directory. If an icon is already specified for the plug-in, you can replace the path to use a different image or delete the icon attribute to use the default report icon. For best results, use an icon that is 16x16 pixels in BMP, GIF, or PNG format.

3. Save and close the file.

4. Optionally rename the file to use a more intuitive name.

5. Restart Surround SCM for the changes to take effect.