Pictures in your project are managed through the Library, which stores all reusable elements such as images, variables, and snippets. Adding pictures to the library before inserting them into topics ensures they can be reused across multiple places in your documentation. This also makes updates easier: modifying a picture in the library automatically applies the changes everywhere it is used.
Adding Pictures to the Library and Topics
There are two primary methods for inserting a picture into the topic editor:
Method 1: From the Home Ribbon Tab
- Open the Home ribbon tab.
- In the Library group, click Add item.
- Select Add picture from the dropdown.
- The picture will appear in the library. Drag it into the topic editor to place it where needed.
Method 2: From the Insert Ribbon Tab
- Open the Insert ribbon tab.
- Click Insert picture and then choose Insert another picture.
- The selected picture is automatically added to the library and inserted into the topic editor.
Editing Pictures in the Topic Editor
When you select a picture in the topic editor, the Picture Tools / Format contextual ribbon tab appears. This provides a range of options for editing and customizing the picture's appearance and behavior.
Available Editing Options
- Change Picture
Swap the selected picture with another image. - Reset Picture Properties
Restore the original size, alignment, and formatting of the picture. - Align Picture
Control how the picture aligns within the text flow (e.g., Top to line, To left side, To right side). - Padding and Margins
Adjust spacing inside and around the picture to control its placement and separation from text. - Picture ID
Assign a unique identifier to the picture. This is particularly useful in HTML-based documentation formats, where the ID ensures that each picture can be referenced or styled individually. - Alternative Text (Alt Text)
Provide descriptive text for the picture. This is used in HTML-based documentation as placeholder content while the image loads and is also essential for accessibility. - CSS Classes
Add one or more space-separated CSS class names. These are exported to HTML and can be used by developers for applying custom styles or dynamic effects. - Dimensions (Width and Height)
Specify exact dimensions for the picture, overriding the default size if necessary. - Background Color
Set a background color for the picture. This is especially useful for transparent images or when using padding to create a border effect.
Best Practices
- Always add alternative text: It improves accessibility and enhances the usability of HTML-based documentation. It can also be defined at the library level for all instances of that picture.
- Leverage classes for advanced styling: Work with developers to define reusable CSS classes for common formatting needs.
See the How to add an item to the library step-by-step guide.