Note: You are currently viewing documentation for Moodle 1.9. Up-to-date documentation for the latest stable version is available here: Moodle Docs reorganisation.

MoodleDocs:Moodle Docs reorganisation

From MoodleDocs
Revision as of 19:55, 17 March 2011 by Helen Foster (talk | contribs) (version namespace, tidying up, more things to do, things to think about)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Note: This page is for analysing and figuring out how best to reorganise Moodle Docs for 2.0 and beyond. It is a work-in-progress. Comments and suggestions are welcome! Please use the page comments or the Moodle documentation forum.


The plan for new versions of Moodle is to have:

  1. A table of contents, such as 2.0
  2. A version namespace


A version namespace

All documentation about Moodle 2.0 will be kept in a 2.0 namespace i.e. each page title and URL will contain '2.0' e.g. 2.0:Forum.

The existing teacher and administrator documentation will be cloned (including page histories), updated, tidied up and moved into the 2.0 namespace. When 2.1 is released, the process will be repeated for a 2.1 namespace.

  1. Create a 2.0 namespace as described in http://www.mediawiki.org/wiki/Manual:Using_custom_namespaces
  2. Use Special:Export to export pages from Category:Administrator and Category:Teacher
  3. Amend titles in the XML file by searching for <title> and replacing with <title>2.0:
  4. Use Special:Import to import the XML file and create the pages in the 2.0 namespace

Tidying up

  • Amend links within pages - all 2.0 pages should contain links to other 2.0 pages
  • Rename all pages which already had 2.0 in the title e.g. Backup 2.0
  • Remove references to legacy versions which are no longer maintained, such as Category:Moodle 1.6 or move to obsolete namespace
  • So that the pages in a category can be sorted according to their actual name, rather than having them all listed under '2.0', create templates for adding pages to major categories e.g. https://docs.moodle.org/test/Template:CategoryAdministrator (so that 2.0:Forum would be listed under F instead of 2.0) then replace [[Category:Administrator]] with {{CategoryAdministrator}}

More things to do

  • Change 'Moodle Docs for this page' links within Moodle 2.0
  • Go through every page in Moodle and ensure that the 'Moodle Docs for this page' link redirects to the correct documentation page
  • Ensure all new features and major improvements as listed in Moodle 2.0 release notes are well-explained
  • Completely rewrite Installing Moodle
  • Improve Upgrading to Moodle 2.0
  • Redesign Main Page
  • Create a custom search block to enable easy searching for pages in the 2.0 namespace

Things to think about

  • Would version namespaces in the developer documentation be worth having?
  • Should the existing teacher and administrator documentation be moved into a 1.9 namespace? The documentation About Moodle could remain in the main namespace.
  • Could any of the tidying up be automated or done more efficiently using phpMyAdmin? Or a search and replace of the XML file before importing?
  • Do we need a 2.0 category as well as a 2.0 namespace? Consider Category:Developer and the list of all pages in the Development namespace - are they both necessary?
  • From Eloy: The header automatically can show you: “You are viewing 2.0 doc page, also available : 1.9...”
  • Should templates be included when exporting pages?
  • Would it be helpful for pages in a particular namespace e.g. Development to be styled differently? See http://www.mediawiki.org/wiki/Help:Namespaces#Identifying_namespaces for CSS method.
  • Would anyone want version namespaces for Moodle Docs in other languages?