Moodle
  1. Moodle
  2. MDL-22449

Wiki 2.0 needs help buttons (with short help) for all options and major UI elements.

    Details

    • Type: Bug Bug
    • Status: Closed
    • Priority: Critical Critical
    • Resolution: Fixed
    • Affects Version/s: 2.0
    • Fix Version/s: 2.0.2
    • Component/s: Wiki (2.x)
    • Labels:
    • Affected Branches:
      MOODLE_20_STABLE
    • Fixed Branches:
      MOODLE_20_STABLE
    • Rank:
      278

      Description

      Wiki 2.0 needs help buttons (with short help) for all options and major UI elements.

        Activity

        Hide
        Ludo ( Marc Alier) added a comment -

        Marc, start creating the help buttons linking to dummy help files, so we and tsala can start writting documentation.

        Show
        Ludo ( Marc Alier) added a comment - Marc, start creating the help buttons linking to dummy help files, so we and tsala can start writting documentation.
        Hide
        Helen Foster added a comment -

        Please note that in 2.0 there are no longer html help files, but rather help strings in mod/wiki/lang/en/wiki.php - see http://docs.moodle.org/en/Development:Help_strings for more info.

        Show
        Helen Foster added a comment - Please note that in 2.0 there are no longer html help files, but rather help strings in mod/wiki/lang/en/wiki.php - see http://docs.moodle.org/en/Development:Help_strings for more info.
        Hide
        Helen Foster added a comment -

        Thanks for adding help buttons to the UI. If you could come up with draft help text then I'd be happy to reword it.

        Also, I think we need a help popup for editing a wiki page, explaining how to create links to other pages in the wiki.

        Show
        Helen Foster added a comment - Thanks for adding help buttons to the UI. If you could come up with draft help text then I'd be happy to reword it. Also, I think we need a help popup for editing a wiki page, explaining how to create links to other pages in the wiki.
        Hide
        Martin Dougiamas added a comment -

        Any progress on this blocker?

        Show
        Martin Dougiamas added a comment - Any progress on this blocker?
        Hide
        Helen Foster added a comment -

        Here are my suggested help strings:

        $string['firstpagetitle_help'] = 'The first page name is displayed in the navigation bar and at the top of the first page.';

        $string['wikimode_help'] = 'The wiki mode determines whether everyone can edit the wiki - a collaborative wiki - or whether everyone has their own wiki which only they can edit - an individual wiki.'

        $string['defaultformat_help'] = 'Currently only HTML format can be used for editing wiki pages. Additional formats will be available in future.';

        $string['forceformat_help'] = 'If the format is forced (checkbox ticked), there is no option to choose a format when editing a wiki page.';

        $string['diff_help'] = 'Selected versions of the page may be compared in order to find the differences.';

        Show
        Helen Foster added a comment - Here are my suggested help strings: $string ['firstpagetitle_help'] = 'The first page name is displayed in the navigation bar and at the top of the first page.'; $string ['wikimode_help'] = 'The wiki mode determines whether everyone can edit the wiki - a collaborative wiki - or whether everyone has their own wiki which only they can edit - an individual wiki.' $string ['defaultformat_help'] = 'Currently only HTML format can be used for editing wiki pages. Additional formats will be available in future.'; $string ['forceformat_help'] = 'If the format is forced (checkbox ticked), there is no option to choose a format when editing a wiki page.'; $string ['diff_help'] = 'Selected versions of the page may be compared in order to find the differences.';
        Hide
        Jordi Piguillem Poch added a comment -

        I added some help string at wiki creation menu and at map tab.

        Show
        Jordi Piguillem Poch added a comment - I added some help string at wiki creation menu and at map tab.
        Hide
        Helen Foster added a comment -

        Thanks Jordi, I just updated the defaultformat_help string to include the formats mentioned in MDL-22594.

        Show
        Helen Foster added a comment - Thanks Jordi, I just updated the defaultformat_help string to include the formats mentioned in MDL-22594 .
        Hide
        Helen Foster added a comment -

        Please could we also have help popups for:

        • Editing a wiki page - explaining how to create links to other pages in the wiki
        • Creating a new page - explaining the different formats
        Show
        Helen Foster added a comment - Please could we also have help popups for: Editing a wiki page - explaining how to create links to other pages in the wiki Creating a new page - explaining the different formats
        Hide
        Dongsheng Cai added a comment -

        Helen, Jordi added help text for editing wiki pages, creating wiki pages, is there more need to be added?

        Show
        Dongsheng Cai added a comment - Helen, Jordi added help text for editing wiki pages, creating wiki pages, is there more need to be added?
        Hide
        Ludo ( Marc Alier) added a comment -

        Some explanations of wiki formats must be added to docs.moodle.org and probably some help at map options (like "page list", it's name explains itself but somebody may want a help icon like in other options)

        Show
        Ludo ( Marc Alier) added a comment - Some explanations of wiki formats must be added to docs.moodle.org and probably some help at map options (like "page list", it's name explains itself but somebody may want a help icon like in other options)
        Hide
        Helen Foster added a comment -

        Hi Dongsheng,

        On mod/wiki/edit.php please could you change the text 'General' to 'Editing [Page name]' (replacing [Page name] with the actual page name, as for the wiki in 1.9).

        Also, could you change 'Content' to 'HTML format', 'Creole format' or 'NWiki format' as appropriate with the help popup next to the text.

        Please ping me if you'd like me to explain anything further.

        Show
        Helen Foster added a comment - Hi Dongsheng, On mod/wiki/edit.php please could you change the text 'General' to 'Editing [Page name] ' (replacing [Page name] with the actual page name, as for the wiki in 1.9). Also, could you change 'Content' to 'HTML format', 'Creole format' or 'NWiki format' as appropriate with the help popup next to the text. Please ping me if you'd like me to explain anything further.
        Hide
        Dongsheng Cai added a comment -

        Hi Helen

        I just changed General to editing this page [[pagename]]
        changed 'Content' to format name.

        Show
        Dongsheng Cai added a comment - Hi Helen I just changed General to editing this page [ [pagename] ] changed 'Content' to format name.
        Hide
        Helen Foster added a comment -

        Thanks a lot Dongsheng, it looks much better now.

        I'm going to review all the map options as Ludo suggests, then I think we're done with this issue.

        Show
        Helen Foster added a comment - Thanks a lot Dongsheng, it looks much better now. I'm going to review all the map options as Ludo suggests, then I think we're done with this issue.
        Hide
        Dongsheng Cai added a comment -

        Hi Helen

        Have you reviewed the changes, can we resolve this issue?

        Thanks.

        Show
        Dongsheng Cai added a comment - Hi Helen Have you reviewed the changes, can we resolve this issue? Thanks.
        Hide
        Martin Dougiamas added a comment -

        Helen can you help here!

        Show
        Martin Dougiamas added a comment - Helen can you help here!
        Hide
        Helen Foster added a comment -

        Apologies for the delay in responding. Looking at the wiki again, I think we need help popups for the comments (completely different to comments elsewhere in Moodle), history and map tabs.

        Dongsheng, if I come up with help strings, could you add buttons to the UI?

        Show
        Helen Foster added a comment - Apologies for the delay in responding. Looking at the wiki again, I think we need help popups for the comments (completely different to comments elsewhere in Moodle), history and map tabs. Dongsheng, if I come up with help strings, could you add buttons to the UI?
        Hide
        Dongsheng Cai added a comment -

        Hi,Helen

        I attached a patch to add help text to wiki.

        1. in comment form: The HTML editor is used for commenting wiki page.
        2. history page title: Show wiki page's change history
        3. map page title, not sure what should we put here.

        Show
        Dongsheng Cai added a comment - Hi,Helen I attached a patch to add help text to wiki. 1. in comment form: The HTML editor is used for commenting wiki page. 2. history page title: Show wiki page's change history 3. map page title, not sure what should we put here.
        Hide
        Helen Foster added a comment -

        About the comments tab, I was confused - I thought it was like the comments tab in Moodle Docs, however it seems it is similar to comments elsewhere in Moodle. Thus perhaps a help popup isn't necessary after all.

        For the history tab, how about:

        The history lists links to previous versions of the page.

        I'm not sure how the map tab options work so I'm going to spend some more time experimenting.

        Show
        Helen Foster added a comment - About the comments tab, I was confused - I thought it was like the comments tab in Moodle Docs, however it seems it is similar to comments elsewhere in Moodle. Thus perhaps a help popup isn't necessary after all. For the history tab, how about: The history lists links to previous versions of the page. I'm not sure how the map tab options work so I'm going to spend some more time experimenting.
        Hide
        Dongsheng Cai added a comment -

        Helen

        I changed history help text to "The history lists links to previous versions of the page."

        The map table contains related links to current page, or page list of wiki instance, when you choose one of the option, you will see a help icon (but not all of them)

        Show
        Dongsheng Cai added a comment - Helen I changed history help text to "The history lists links to previous versions of the page." The map table contains related links to current page, or page list of wiki instance, when you choose one of the option, you will see a help icon (but not all of them)
        Hide
        Dongsheng Cai added a comment -

        I added more help buttons to wiki map tab, including:
        page list: All pages included in this wiki
        navigation: This page comes from and this page goes to
        Page index
        Updated pages: Recently updated wiki pages

        Show
        Dongsheng Cai added a comment - I added more help buttons to wiki map tab, including: page list: All pages included in this wiki navigation: This page comes from and this page goes to Page index Updated pages: Recently updated wiki pages
        Hide
        Jérôme Mouneyrac added a comment - - edited

        Peer reviewed code, +1

        Show
        Jérôme Mouneyrac added a comment - - edited Peer reviewed code, +1
        Hide
        Dongsheng Cai added a comment -

        PULL-55

        pull request submitted, under review.

        Thanks everyone.

        Show
        Dongsheng Cai added a comment - PULL-55 pull request submitted, under review. Thanks everyone.
        Hide
        Eloy Lafuente (stronk7) added a comment -

        Closing as fixed, thanks guys!

        Helen: I've performed the tests in PULL-55 about the things introduced until now. If you consider that there are other places requiring more help, or some of the current ones need some modification, feel free to reopen this/create new issue. For your consideration, TIA!

        Show
        Eloy Lafuente (stronk7) added a comment - Closing as fixed, thanks guys! Helen: I've performed the tests in PULL-55 about the things introduced until now. If you consider that there are other places requiring more help, or some of the current ones need some modification, feel free to reopen this/create new issue. For your consideration, TIA!

          People

          • Votes:
            0 Vote for this issue
            Watchers:
            2 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved: