Summary
This article provides options about inserting images into the Knowledge Base for TeamDynamix Knowledge Base editors.
Content
Note: This article is intended for KB editors.
When images are pasted into KB articles, the system will always generate thumbnails that can be clicked to view the full image.
Opening the editor box to edit that "image" is actually just modifying the thumbnail, and thumbnails are not meant to be resized.
If the full-scale image is needed, do not paste the image into the KB document. Use the image upload functionality from the toolbar instead.
There are going to be situations where it's better to have the thumbnails and other situations where it's better to not have them.
This is not perfect, but this is the behavior TeamDynamix landed on that allows people to use both options.
Style-Guide
Section copied from: Knowledge Base: KB Style Guide Checklist (ETS Internal)
Images – keep accessibility in mind
- Explanation or instruction step goes above the image
- For full-size images (uploaded or hyperlinked):
- Include Alternative Text describing the relevant part of the image
- Lock aspect ratio and use a common width(s) for all (or most) images within the article
- Width 300 works on mobile phone, portrait mode. Much wider needs to switch to landscape to be readable.
- Width 700 is the largest we should use
- Black border size = 1
- For thumbnail images (pasted into article):
- Add text immediately above thumbnail saying, in italics: Click thumbnail to see full-size image
- Edit default Alternative Text to describe the relevant parts of the full-size image
- Add a blank line below the image for visual space before the next step.
Further Readings
TeamDynamix: Knowledge Base Reference Manual
Knowledge Base: KB Style Guide Checklist (ETS Internal)
Need additional help?
If you need further assistance, see TeamDynamix: Need Help?