Support/ScreenshotAnnotator: Difference between revisions

← Older edit

Support/ScreenshotAnnotator (view source)

Revision as of 09:05, 14 July 2021

2,104 bytes added , 14 July 2021

category -> Support Archive

Kelimutu

1,325

edits

@@ Line 5: / Line 5: @@
 An annotation will consist of:
-* A rectangular frame that will appear
+* A rectangular frame that will appear when the mouse is hovering over the image (not just the annotation itself)
-** Coordinates for the rectangular frame
+** Coordinates for the top left and bottom right corners of the rectangular frame
 * Text to show by default (DefaultText), when the mouse is not hovering over the annotation
-* Text to show when hovering over the annotation (HoverText). This text should replace DefaultText.
+* Text to show when hovering over the annotation (HoverText). This text should replace DefaultText while the mouse is over the annotation.
 ===Syntax requirements===
 * DefaultText and HoverText should support full TikiWiki syntax, meaning '''Bold text''', ''Italic text'', new lines (%%%) and [[Links]] should be supported
-* 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.
+ (x1,y1),(x2,y2) [Zonelink] Static text with support for wiki syntax
+ - attrib1 = value1
+ - attrib2 = value2
+ Hover text which can span across multiple lines
+ with support for wiki syntax
 ===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
+===Style requirements===
+* All CSS used for e.g. frame border and background, and text style, should be globally part of the theme used on SUMO
+** While testing the plugin, the CSS can be inline
+* The wireframe around an annotation should only be visible when the mouse is hovering over the image (which would show all annotation frames).
+** It should be possible to change this behavior with a setting of the plugin (for example, we might want to always show the frames if that proves to be better)
+==Annotation Editor Requirements ==
+* When logged in contributors are viewing a KB article, they should see a link for each image/screenshot of an article (either overlaid on the top-right corner of an image, or immediately under it)
+** Clicking on that image should open up a screenshot annotation editor, where the contributor can add/edit/remove annotations for that particular screenshot.
+** The annotations should be loaded from the '''staging copy''' of the article, not the live article.
+*** Nelson says there is a php function in tikiwiki that can modify the contents of a specific tag of a wiki article, so saving this should be fairly straightforward
+*** If the clicked screenshot doesn't exist in the staging copy, an error message should be displayed informing that the staging copy has changed. (It could also automatically direct the contributor to the staging copy when this happens.)
+* The annotation editor should show the image in full size, and include Add and Remove buttons.
+* Selecting an annotation should allow you to change the size and location with the mouse.
+* Selecting an annotation should allow you to enter both hover text and standard text in two text boxes. Again, bold/italic text, as well as links and new lines should be supported.
+* When saving the changes of the annotations, the staging copy should be modified, just like in a normal article edit. Approvers will then be able to review the changes.
 ==Notes regarding possible way to localize annotations==
@@ Line 39: / Line 61: @@
 LPH: yep... if you add a version attribute on the content tag, there is something to do about this. Each region already has a unique identifier
+[[Category:Support Archive]]