Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Requirements for image files

Updated on January 21, 2021

Ensure that you name and save your image files correctly to avoid any processing errors.

  • Use the .png format.

  • Choose a meaningful file name that complies with the following requirements:

    1. Use lowercase letters only.

    2. Use hyphens instead of underscores or spaces.

    3. Do not use single quotes or smart quotes.

    4. Do not use special characters, such as (&, !, @,), and so on.

    5. Do not include the folder structure in the name.

    6. Do not start the file name with numbers. Instead, start with descriptive information.

    For example:
    • cm-icon-add
    • mob-icon-gear-blue
    • rpt-menu-explorer-options
    • dsm-strategy
  • Store images in the Git repository, in the Resources\Images folder specific to your project.

    For example: For Pega Platform content, store the files in the dita-tech-enablement\platform-helpsystem\Resources\Images folder.

  • Using callouts

    Use callouts to draw the user's attention to a particular part of a graphic or to provide additional information. Each callout is composed of three parts: the rectangle that you use to select a part of the screenshot, the connecting line, and the callout text with an explanation.

  • Selection and line settings

    The use of common selection and line settings ensures consistency throughout documentation.

  • Blur settings

    The use of common blur settings ensures consistency throughout documentation.

  • Magnification settings

    The use of common magnification settings ensures consistency throughout documentation.

  • Spotlight settings

    The use of common spotlight settings ensures consistency throughout documentation.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us