Support/ScreenshotAnnotator: Difference between revisions

Support/ScreenshotAnnotator (view source)

Revision as of 14:35, 23 June 2008

271 bytes removed , 23 June 2008

→‎Screenshot Annotator Requirements (Suggestions/Proposal)

Djst

1,623

edits

@@ Line 2: / Line 2: @@
 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) ==
+== Screenshot Annotator Requirements ==
-* Two types of annotations
+An annotation will consist of:
-*# 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.
+* A rectangular frame that will appear
-*# Frame always visible; text only visible when hovering. Typical usage: Long annotation text that would clutter the screenshot if always visible.
+** Coordinates for the rectangular frame
-* A screenshot should be reusable on many articles, with or without annotations, so annotations can't be strictly tied to a screenshot.
+* Text to show by default (DefaultText), when the mouse is not hovering over the annotation
-* 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.
+* Text to show when hovering over the annotation (HoverText). This text should replace DefaultText.
-* 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:
+===Syntax requirements===
-** If someone translates an article, the annotations for any image included should also be copied over.
+* DefaultText and HoverText should support full TikiWiki syntax, meaning '''Bold text''', ''Italic text'', new lines (%%%) and [[Links]] should be supported
-* 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.
+* The syntax for an annotation must be robust enough to support the above, but at the same time simple enough to be human readable. Nelson to figure out a good syntax based on feedback from TikiWiki community.
+===Review requirements===
+* An annotation will simply be a block of wiki code attached to the wiki body of an article containing an image. As such, it will be part of the article itself, subject to the same review process as a normal wiki edit, and fully localizable.
+* Saving an annotation edit should modify the staging copy of the article, not the live article
 ==Notes regarding possible way to localize annotations==