Moodle Community Sites
  1. Moodle Community Sites
  2. MDLSITE-1369

Improve navigation between different versions of the English Moodle Docs

    Details

    • Type: New Feature New Feature
    • Status: Closed
    • Priority: Critical Critical
    • Resolution: Fixed
    • Component/s: docs.moodle.org
    • Labels:
    • Workaround:
      tweak url for required version and try your luck.
    • Rank:
      19597

      Description

      Google led me to this doc. i infact was concerned with 1.9. (so i changed the url)

      the 'previous versions' block only links to the main page. It would be nice if there was a link to the current page in the 1.9 version.

      if it doesn't exist, maybe say so somewhere.

      Edited by Helen to add:

      The 2.0, 2.1 and 2.2 documentation wikis contain many pages with the same name in each wiki. It would be very helpful to provide links to these pages

      e.g. http://docs.moodle.org/22/en/Authentication would have links to http://docs.moodle.org/21/en/Authentication http://docs.moodle.org/20/en/Authentication and if possible also http://docs.moodle.org/19/en/Authentication

      Also, when editing a page, it would be helpful to have a message at the top of the page stating which version the user is in and providing links to pages in other wikis.

        Issue Links

          Activity

          Hide
          Helen Foster added a comment -

          Apu, thanks for creating this issue. +100 from me!

          Show
          Helen Foster added a comment - Apu, thanks for creating this issue. +100 from me!
          Hide
          Martin Dougiamas added a comment - - edited

          I'd really prefer this was automatic, which means some PHP code to look into the other databases.

          Problems are that other databases might have different names for the same page, but I don't think this is a blocker. We can live with just links to same-named pages.

          Any thoughts from anyone on how to implement this?

          Show
          Martin Dougiamas added a comment - - edited I'd really prefer this was automatic, which means some PHP code to look into the other databases. Problems are that other databases might have different names for the same page, but I don't think this is a blocker. We can live with just links to same-named pages. Any thoughts from anyone on how to implement this?
          Hide
          Aparup Banerjee added a comment - - edited

          imo i think the same-named pages would be enough for now. The wiki doesn't seem to be a well-regulated structure so different names are likely.

          That said, there's a few techniques to document classification out there which may lead to something more desired. (lucene engine?)

          Show
          Aparup Banerjee added a comment - - edited imo i think the same-named pages would be enough for now. The wiki doesn't seem to be a well-regulated structure so different names are likely. That said, there's a few techniques to document classification out there which may lead to something more desired. (lucene engine?)
          Hide
          Eloy Lafuente (stronk7) added a comment - - edited

          I think we could do something like:

          • In LocalSettings, create one structure like:
            $versiongroups = array(
                'en' => array('19', '20', 'dev'),
                'de' => array('19', '20'),
                'ja' => array('19', '20')
            );
            
          • Create one php script, able to iterate over all the version wikis on each group (en, de, ja), looking for all the page names and matchings and adding results to one table (versiongroups) with this structure:
            pagename varchar(xxxx) - unique index, will contain the page name
            versions varchar(255) - will contain the versions where the page is available (19, 20, dev)
            
          • Create one simple extension providing one block with the information in that table in a visual way

          Just the draft idea. It will be +1 query by page but it won't cause a big impact at all IMO.

          Ciao

          Show
          Eloy Lafuente (stronk7) added a comment - - edited I think we could do something like: In LocalSettings, create one structure like: $versiongroups = array( 'en' => array('19', '20', 'dev'), 'de' => array('19', '20'), 'ja' => array('19', '20') ); Create one php script, able to iterate over all the version wikis on each group (en, de, ja), looking for all the page names and matchings and adding results to one table (versiongroups) with this structure: pagename varchar(xxxx) - unique index, will contain the page name versions varchar(255) - will contain the versions where the page is available (19, 20, dev) Create one simple extension providing one block with the information in that table in a visual way Just the draft idea. It will be +1 query by page but it won't cause a big impact at all IMO. Ciao
          Hide
          Martin Dougiamas added a comment -

          Sounds like a good idea, Eloy!

          Jordan, could you look at the first part sometime?

          Show
          Martin Dougiamas added a comment - Sounds like a good idea, Eloy! Jordan, could you look at the first part sometime?
          Hide
          Helen Foster added a comment -

          Oops, very sorry to have closed this issue in error. (I meant to close the duplicate issue.)

          Show
          Helen Foster added a comment - Oops, very sorry to have closed this issue in error. (I meant to close the duplicate issue.)
          Hide
          Helen Foster added a comment -

          VIP watchers if you have any more ideas of how this feature can be implemented, they would be most welcome!

          Show
          Helen Foster added a comment - VIP watchers if you have any more ideas of how this feature can be implemented, they would be most welcome!
          Hide
          Helen Foster added a comment -

          I've just edited the system messages for Sidebar, Noarticletext and Noarticletext-nopermission to link to pages with the same name in other wikis so that, for example http://docs.moodle.org/22/en/Authentication links to http://docs.moodle.org/21/en/Authentication http://docs.moodle.org/20/en/Authentication and http://docs.moodle.org/19/en/Authentication Also, when pages don't exist, for example http://docs.moodle.org/21/en/Gravatars they display a hopefully helpful message.

          Is this simple solution enough?

          Show
          Helen Foster added a comment - I've just edited the system messages for Sidebar, Noarticletext and Noarticletext-nopermission to link to pages with the same name in other wikis so that, for example http://docs.moodle.org/22/en/Authentication links to http://docs.moodle.org/21/en/Authentication http://docs.moodle.org/20/en/Authentication and http://docs.moodle.org/19/en/Authentication Also, when pages don't exist, for example http://docs.moodle.org/21/en/Gravatars they display a hopefully helpful message. Is this simple solution enough?
          Hide
          Eloy Lafuente (stronk7) added a comment -

          Great, I think that will help a lot in 90% of the cases! And the default, not matching page message seems correct enough too.

          Anyway, I'll try to spend some time soon in the proposed "matcher" commented above, just to try it and decide. Given that I've pending to update codebase to 1.17.2, I can make one quick and dirty attempt.

          Ciao

          Show
          Eloy Lafuente (stronk7) added a comment - Great, I think that will help a lot in 90% of the cases! And the default, not matching page message seems correct enough too. Anyway, I'll try to spend some time soon in the proposed "matcher" commented above, just to try it and decide. Given that I've pending to update codebase to 1.17.2, I can make one quick and dirty attempt. Ciao
          Hide
          Aparup Banerjee added a comment -

          Helen, that simple solution looks great to me!

          Show
          Aparup Banerjee added a comment - Helen, that simple solution looks great to me!
          Hide
          Helen Foster added a comment -

          Thanks Apu, marking as resolved.

          Show
          Helen Foster added a comment - Thanks Apu, marking as resolved.

            People

            • Votes:
              4 Vote for this issue
              Watchers:
              5 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Development