Moodle

Index of help files requires updating

Details

  • Type: Bug Bug
  • Status: Open Open
  • Priority: Minor Minor
  • Resolution: Unresolved
  • Affects Version/s: 1.8, 1.9
  • Fix Version/s: None
  • Component/s: Documentation
  • Labels:
    None
  • Affected Branches:
    MOODLE_18_STABLE, MOODLE_19_STABLE

Description

Some help files e.g. Forum Display Period are not indexed.

Issue Links

This issue will help resolve:
MDL-10492 Role sensitive, searchable, help Minor Open

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
Helen Foster added a comment -

Comments from Martin:

I used to always update the index.html files but I don't think everyone does, they need work for sure, something more automatic, not happening in 1.9.

It's pretty tricky, perhaps an index.php that has an array of filepath -> full name, in each directory

$help['grade/rank.html'] = "Ranking of students';

Show
Helen Foster added a comment - Comments from Martin: I used to always update the index.html files but I don't think everyone does, they need work for sure, something more automatic, not happening in 1.9. It's pretty tricky, perhaps an index.php that has an array of filepath -> full name, in each directory $help['grade/rank.html'] = "Ranking of students';
Hide
Permalink
Nicolas Connault added a comment -

index.php has very limited automation, with quite a few hard-coded exceptions.

IMO there should be some consistent rules/convention for deciding which help files are to be indexed or not. For example, we could assume that every "index.html" file is a sub-index that should be displayed on the help.php?file=index.html page.

Pages that have sub-indices themselves could have an index.php script instead, which would extend a class defined in the main index.php file. It would have its own special rules for building an index of help files, if needed, with full paths etc... I think that this solution would offer both automaticity and flexibility.

Show
Nicolas Connault added a comment - index.php has very limited automation, with quite a few hard-coded exceptions. IMO there should be some consistent rules/convention for deciding which help files are to be indexed or not. For example, we could assume that every "index.html" file is a sub-index that should be displayed on the help.php?file=index.html page. Pages that have sub-indices themselves could have an index.php script instead, which would extend a class defined in the main index.php file. It would have its own special rules for building an index of help files, if needed, with full paths etc... I think that this solution would offer both automaticity and flexibility.
Hide
Permalink
Eloy Lafuente (stronk7) added a comment -

One idea about index.html files....

What if, instead of maintaining them as manually edited html files... we create one big php structure (array of arrays or so), containing all the help files tree.

And then, for all the page titles... we create one translatable helptitles.php lang file.

That way ALL languages will share the index structure and by simply translating the titles will have access to everything. And the help files structure will need to be defined only once (not by each language).

Just an idea... FYC... ciao

Show
Eloy Lafuente (stronk7) added a comment - One idea about index.html files.... What if, instead of maintaining them as manually edited html files... we create one big php structure (array of arrays or so), containing all the help files tree. And then, for all the page titles... we create one translatable helptitles.php lang file. That way ALL languages will share the index structure and by simply translating the titles will have access to everything. And the help files structure will need to be defined only once (not by each language). Just an idea... FYC... ciao

People

Vote (0)
Watch (3)

Dates

  • Created:
    Updated:
Atlassian JIRA (v4.4.3#663-r165197) | Report a problem
Powered by a free Atlassian JIRA open source license for Moodle. Try JIRA - bug tracking software for your team.