Dropping the Tutorial namespace

Joomla! Documentation Workgroup

Moderators: Chris Davenport, Hutchy68

mvangeest
Joomla! Intern
Joomla! Intern
Posts: 54
Joined: Thu Jan 17, 2008 4:08 pm

Dropping the Tutorial namespace

Postby mvangeest » Tue Jan 11, 2011 4:45 pm

As the title says, I would like to propose the removal of the Tutorial namespace in favour of the Tutorial category. I've been looking into consolidating the different types of information on the Wiki (such as FAQs, tutorials, help screens, API docs etcetera) and I can name the following arguments for removal:
  • Consistency: there's no FAQ namespace, though API15, API16 etc. are admittedly useful. However, tutorials do not have a significantly 'special' structure that would warrant a namespace.
  • Flexibility: categories are easier to add and remove, not to mention the fact that categories can have subcategories and are easier to view an index of.
  • Extensions: index articles such as the Management series use the DPL extension, which selects articles based on their categories and not their namespace. For example, http://docs.joomla.org/Tutorial:Override_JFormFields is not shown in the list.
  • Use: http://docs.joomla.org/Category:Tutorials shows that either documentors are ignorant of the namespace, or they just like categories more, as the majority of the tutorials does not use the namespace. The list of Tutorial: articles can be found on http://docs.joomla.org/index.php?title=Special%3APrefixIndex&from=Tutorial%3A&namespace=0

I wouldn't mind doing most of the work of moving, but I'd like to get community consensus first.

By the way, shouldn't there be a central JDOC discussion page on the wiki for such proposals? On projects like Wikipedia, it seems that keeping the discussion right next to the discussed content works better than having a separate resource.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Dropping the Tutorial namespace

Postby Chris Davenport » Thu Jan 13, 2011 11:28 pm

I think that's a good suggestion. In fact there is no Tutorial namespace as such. It's actually a "pseudo-namespace" (see: http://www.mediawiki.org/wiki/Pseudo-namespace ) which was accidentally created when we imported some old content from an earlier, non-MediaWiki wiki. It would be good to systematically remove the Tutorial: namespace in favour of a Tutorial category, so if you have the time, please go ahead and do it.

Regards,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

mvangeest
Joomla! Intern
Joomla! Intern
Posts: 54
Joined: Thu Jan 17, 2008 4:08 pm

Re: Dropping the Tutorial namespace

Postby mvangeest » Fri Jan 14, 2011 3:31 pm

The interesting thing is that the page you linked to says that namespaces can only be searched using Special:Search when they're officially recognized. Since there are Tutorial and Tutorial Talk checkboxes on the search page, the namespace might be official after all. Anyway, such support can only be removed once the namespace is empty, and currently it's far from that. I'll start working on it now.

User avatar
Chris Davenport
Joomla! Ace
Joomla! Ace
Posts: 1383
Joined: Thu Aug 18, 2005 8:57 am
Location: Shrewsbury, Shropshire, United Kingdom

Re: Dropping the Tutorial namespace

Postby Chris Davenport » Sat Jan 15, 2011 9:01 pm

If I remember correctly, the Tutorial: namespace was added *after* most of the earlier material was imported so some pages will be in the real namespace and others in the pseudo-namespace, if you see what I mean. Anyway, please carry on moving pages out of Tutorial: and once it's clear it can be removed cleanly.

Thanks,
Chris.
Chris Davenport - Joomla Production Leadership Team

Lion Coppice http://www.lioncoppice.org/
Davenport Technology Services http://www.davenporttechnology.com/

mvangeest
Joomla! Intern
Joomla! Intern
Posts: 54
Joined: Thu Jan 17, 2008 4:08 pm

Re: Dropping the Tutorial namespace

Postby mvangeest » Sun Jan 16, 2011 12:23 pm

I finished the move yesterday. Only redirect pages should now remain in the Tutorial: namespace, and I'm not sure if they still have links pointing to them (Special:WhatLinksHere is useful, but applying it to every single page isn't fun). Anyway, it might be wise to keep the redirect pages around for some time so links in bookmarks, in the forum etc. will keep working. However, since Special:Search doesn't show redirect pages, I believe the namespace has outlived its usefulness. The Tutorial: pages can later be removed using the Special:PrefixIndex.

By the way, I have also created the JDOC:Proposals page and added another proposal, just for the sake of brainstorming.


Return to “Documentation - Feedback/Information/Suggestions”

Who is online

Users browsing this forum: No registered users and 6 guests