Support/ScreenshotAnnotator

From MozillaWiki
< Support
Revision as of 15:41, 22 April 2008 by Djst (talk | contribs)
Jump to navigation Jump to search

Basic annotation description

An annotation is a simple frame + text overlaid on a screenshot to make it easy to point out the area of focus in a screenshot.

Screenshot Annotator Requirements (Suggestions/Proposal)

  • Two types of annotations
    1. Frame and text always visible. Typical usage: Short annotation text (e.g. just a number "1") overlaid next to the frame. Actual description of annotation is in the article itself.
    2. Frame always visible; text only visible when hovering. Typical usage: Long annotation text that would clutter the screenshot if always visible.
  • A screenshot should be reusable on many articles, with or without annotations, so annotations can't be strictly tied to a screenshot.
  • Because a screenshot can be used on more than one article, each screenshot should support more than one annotation group. For example, we could reuse an Options window screenshot and point out the specific pref the user should click in each article.
  • It should be possible to reuse both a screenshot + annotation group in another article. For example, we might want to reuse a generic screenshot of the toolbar with an annotation that points out where the Location Bar is.
  • Annotations should respect l10n, meaning:
    • If someone translates an article, the annotations for any image included should also be copied over.
  • Annotations must be treated the same way as article edits, meaning they would have to be approved by reviewers before published. Otherwise we'll end up with spam and/or offending annotations.