Issue Details (XML | Word | Printable)

Key: MDL-10244
Type: Bug Bug
Status: Open Open
Priority: Minor Minor
Assignee: Martin Dougiamas
Reporter: Helen Foster
Votes: 0
Watchers: 3
Operations

Add/Edit UI Mockup to this issue
If you were logged in you would be able to see more operations.
Moodle

Index of help files requires updating

Created: 25/Jun/07 04:19 PM   Updated: 01/Jul/08 06:55 PM
Return to search
Component/s: Documentation
Affects Version/s: 1.8, 1.9
Fix Version/s: None

Issue Links:
Dependency
 

Participants: Eloy Lafuente (stronk7), Helen Foster, Martin Dougiamas and Nicolas Connault
Security Level: None
QA Assignee: Helen Foster
Affected Branches: MOODLE_18_STABLE, MOODLE_19_STABLE


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

 All   Comments   Change History   Version Control      Sort Order: Ascending order - Click to sort in descending order
Helen Foster added a comment - 25/Feb/08 11:11 PM
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';


Nicolas Connault added a comment - 21/Mar/08 07:35 PM
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.


Eloy Lafuente (stronk7) added a comment - 14/Apr/08 10:03 AM
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