Wierd incosistency with help files in plugins - is 2.0 the time to fix it?

Wierd incosistency with help files in plugins - is 2.0 the time to fix it?

by Tim Hunt -
Number of replies: 2
Gambar Core developers Gambar Documentation writers Gambar Particularly helpful Moodlers Gambar Peer reviewers Gambar Plugin developers
If you look at http://docs.moodle.org/en/Development:Places_to_search_for_lang_strings, you will see we have a slightly weird incosistency

For a plugin like question/type/dragdrop, the lang files would be in a module called qtype_dragdrop. If this was a standard plugin, then the correct paths are

lang files: lang/en_utf8/qtype_dragdrop.php
help files: lang/help/qtype_dragdrop/helpfile.php

If this was a third-part plugin, the lang files would be in

lang files: question/type/dragdrop/lang/en_utf8/qtype_dragdrop.php
help files: question/type/dragdrop/lang/en_utf8/help/dragdrop/helpfile.php

It would be more conistent if that last path was .../help/qtype_dragdrop/helpfile.php

It would, of course, be a pain for plugin-authours if we changed this. However there will be lots of other pain for plugin authors when upgradeing to Moodle 2.0, so this this the moment to fix this incosistency?


Average of ratings: -
In reply to Tim Hunt

Re: Wierd incosistency with help files in plugins - is 2.0 the time to fix it?

by sam marshall -
Gambar Core developers Gambar Peer reviewers Gambar Plugin developers
Absolutely agree - help search is a mess.

This doesn't actually need to break existing plugins (although as you note, 2.0 will anyway so there's no reason not to), since it could be added as an additional path. However just changing it might be better.

--sam
Average of ratings:Useful (1)