First draft of documentation for Image Modal tool

[mhoeber]

In addition, cleaned up some build errors in course_grades and
course_students.

[mhoeber]

@srpearce and @lamagnifica can you review new section: http://draft-image-modal.readthedocs.org/en/latest/tools.html#image-modal

[mhoeber]

@talbs @cahrens for stud-1258: http://draft-image-modal.readthedocs.org/en/latest/tools.html#image-modal

[mhoeber]

We don't want to merge until PR 2362 is released.

[cahrens]

@mhoeboer I was not involved in the review of this PR. Can you have the dev who reviewed the PR review the documentation (and/or @caesar2164)?

[mhoeber]

@caesar2164

[caesar2164]

@mhoeboer - @dianakhuang, @singingwolfboy and @talbs looked at my code.

[srpearce]

The documentation looks good. My only question is whether we can call this something more descriptive than "image modal," which doesn't really tell users what the tool does. Since "zooming image" is already taken, maybe "enlarge image" (which has a different connotation)?

[lamagnifica]

Awesome feature!

17.5: I agree with Sylvia about the heading names. I also found the
introduction hard to understand: "Some large images are difficult for
students to view in the courseware. The image modal tool allows students to
enlarge the image, so they can see all the detail in context." (If the
image is too large to view, why would making it even larger help?) From the
example images, it looks like "image modal" adds a "Full Screen" option
for students to use, and that it includes zooming and dragging features.
Would "Add a Full Screen Option to an Image" work as a heading?

17.4.2, 17.5.2: rst question: For step 6, can the secondary numbered list
be forced to go to a, b, c numbering rather than repeating 1, 2, 3? If not,
I'd suggest rewriting to get these steps onto the same level as step 6
(that is, make them steps 6-9).

Thanks!
A

On Fri, Feb 7, 2014 at 2:29 PM, srpearce [email protected] wrote:

The documentation looks good. My only question is whether we can call this
something more descriptive than "image modal," which doesn't really tell
users what the tool does. Since "zooming image" is already taken, maybe
"enlarge image" (which has a different connotation)?

Reply to this email directly or view it on GitHubhttps://github.com/edx/edx-platform/pull/2519#issuecomment-34491032
.

[caesar2164]

@lamagnifica - 17.5: What is meant by the image is "too large" is that it has too much fine detail that is lost when scaled into the <800px wide courseware.

[mhoeber]

Thanks @srpearce and @lamagnifica . I think the full screen image option is a good name; I'm going to put this in and run it by Lou.

[talbs]

👍