Changes between Version 2 and Version 3 of TEXT_FRAME_NON_FLOW_R0

Timestamp:

01/27/09 03:30:07 (16 years ago)

Author:

sriggins

Comment:

--

TEXT_FRAME_NON_FLOW_R0

@@ -4 +4 @@
 
 = Analysis =
-^(Give as much as possible of the needed information for designing and implementing the task in the following sections.)^
 
 == Overview ==
-^(Provide a brief overview of the whole task in its first revision. Stick to the current revision of the task, but keep an eye to the whole task progress, and stay alert for possible smells.)^
+
+A non-flow text frame is a frame that displays a text content.  I personally feel that a non-flow and a flow text frame should be the same; the only difference being that a "non-flow" frame doesn't have a connection for it's overflow text to flow into.  However, because text is still being figured out, I'll talk about a "non-flow" frame in this task description.
+
+As mentioned above, the difference between a non-flow frame and a flow frame is how the overflow text is handled.  Effective this is a user interface issue; When the user creates a "non-flow" frame they are telling Sophie that they don't want the frame to flow its text into a another frame (be it on the same page or a different page)  This could end up being just a default setting for the frame.
+
+A text frame in either case has a frame style.   This style is likely going to be defined by properties defined in:
+
+ * [wiki:FRAME_INSETS_R0]
+ * [wiki:FRAME_MARGINS_R0]
+ * [wiki:RAME_PADDING_R0]
+ * [wiki:FRAME_BORDERS_R0]
+
+The text rendering needs to honor these properties.  In theory, the frame content size won't even know these properties exist and will just render inside the rectangle it is told to render inside, but I can't find where else this is defined, so I am writing about it here.
+
+The frame should have an option in the Frame Options HUD to use scrollbars.  This option should be off by default.  The scrolls bars would only show if the text would not fit inside of the content area of the frame, in which case the text would be re-flowed due to the narrower width of the new content area.
+
+If the scrollbar option is off, the overflow text is simply not rendered.  A user can click in the field and use any of the four arrow keys to scroll through the text, but there is no visual feedback as to how much, if at all the text is scrolled.
+
 
 == Task requirements ==
-^(List the necessary requirements that the task must fulfill.)^
+
+ * Render text inside of a frame
+ * Add a scrollbar option to the text frame HUD
+ * Support scrolling with the arrow keys as well
+ * Honor the frame style properties
 
 == Task result ==
-^(List the end product of the task (for example "Source code", "Wiki page", etc.))^
+
+The result of this task is code.
 
 == Implementation idea ==
-^(Provide some rough implementation idea(s).)^
+
+ * Consider designing this with flow text in mind
+ * When the user clicks in the field, maybe the field can hilite to let them know they have changed focus
+ * Talk with milo about who is doing text pagination and rendering, because that same engine should be used to render the text in this frame
+ * Make sure the general frame system is giving you enough information to render your content so that you don't have to figure it out yourself, because images and movies will need to follow the same rules
 
 == Related ==
-^(Add links to related tasks that could be useful or helpful.)^
+
+ * [wiki:FRAME_INSETS_R0]
+ * [wiki:FRAME_MARGINS_R0]
+ * [wiki:RAME_PADDING_R0]
+ * [wiki:FRAME_BORDERS_R0]
 
 == How to demo ==
-^(Provide instructions for demonstration of the task.)^
+
+Show the text frame with text that fits within the frame, with too much text to fit inside the frame, scrolling with and without scrollbars.  Show how the frame properties render around the text frame, such as borders and shadows.
 
 = Design =