#3558 improve formatting help dialog

v1.0.0
closed
Cory Johns
sf-2 (994)
General
Tim Van Steenburgh
2015-08-20
2012-01-06
Dave Brondsema
No

From https://engr.geek.net/wiki/display/engr/Allura+Usability+Tests

  • Figuring out how to format text in a post is hard. Both of them requested we add formatting buttons like other forums had (will do this as a separate ticket). It might also help to rename the "Help" button "Formatting Help" and also change the sidebar link "Markdown Syntax Help" to "Formatting Help" because most people don't know what markdown is.
  • Even when they found the formatting help, it seemed overwhelming in the giant popup window. One of them had trouble figuring out how to close it.

The dialog popup has grown very large over time, and is now cumbersome. It also is a lot of HTML that we load on each page.

Change the dialog to be loaded with ajax. Also it should show only the table of contents initially, and when you click on a link, expand just that one section. That should help it stay small visually, and easy to navigate. TOC can be adjusted however you see fit (e.g. tabs on the side or whatever).

Discussion

  • Dave Brondsema

    Dave Brondsema - 2012-01-06
    • size: --> 2
    • milestone: limbo --> forge-jan-20
     

  • Dave Brondsema

    Dave Brondsema - 2012-01-27
    • Description has changed:

    Diff:

    --- old 
+++ new 
@@ -1,6 +1,8 @@
 From https://engr.geek.net/wiki/display/engr/Allura+Usability+Tests

-* Figuring out how to format text in a post is hard. Both of them requested we add formatting buttons like other forums had. It might also help to rename the "Help" button "Formatting Help" and also change the sidebar link "Markdown Syntax Help" to "Formatting Help" because most people don't know what markdown is.
+* Figuring out how to format text in a post is hard. Both of them requested we add formatting buttons like other forums had (will do this as a separate ticket). It might also help to rename the "Help" button "Formatting Help" and also change the sidebar link "Markdown Syntax Help" to "Formatting Help" because most people don't know what markdown is.
 * Even when they found the formatting help, it seemed overwhelming in the giant popup window. One of them had trouble figuring out how to close it.

 The dialog popup has grown very large over time, and is now cumbersome.  It also is a lot of HTML that we load on each page.
+
+Change the dialog to be loaded with ajax.  Also it should show only the table of contents initially, and when you click on a link, expand just that one section.  That should help it stay small visually, and easy to navigate.  TOC can be adjusted however you see fit (e.g. tabs on the side or whatever).
     

  • Cory Johns - 2012-01-30
    • status: open --> in-progress
    • assigned_to: Cory Johns
     

  • Cory Johns - 2012-01-31
    • status: in-progress --> code-review
    • qa: Tim Van Steenburgh
     

  • Cory Johns - 2012-01-31

    In the sftheme repo
    in the branch cj/3558:

    7e672ee : Added styling
    for modified Markdown Syntax Help dialog

    In the allura repo
    in the branch cj/3558:

    c8c3f95 : Fixed tests broken by button text change
    65976e0 : Fixed missed
    Formatting Help dialog views

    2b408ab : Changed missed
    "Markdown Syntax" buttons to "Formatting Help"

    dad5b1c : Refactored
    Markdown Syntax Guide dialog to be AJAX and broken up by section

    e16e8bb : Changed
    "Help" and "Markdown Syntax" buttons to "Formatting Help"

    To QA:

    In any Allura project:

    • On each of the Wiki, Tracker, Blog, and Discussion apps:
    • Check the Formatting Help button in the left navigation column, if present
    • On an edit screen, click the Formatting Help button above the textbox and browse the dialog

    Run the tests for at least the ForgeWiki, ForgeTracker, ForgeBlog, and ForgeDiscussion apps.

    Look for any other instances of the Markdown Syntax button or dialog that were missed.

     

  • Tim Van Steenburgh - 2012-01-31

    Nice, merged to dev.

    • status: code-review --> closed
     

Log in to post a comment.