Suggestion: Better help file index

Started by SSH, Tue 02/09/2003 15:12:17

Previous topic - Next topic

SSH

It seems that lots of people are having trouble finding pre-existing functions in the help file index and getting RTFMed as a result.
For example, search for walkbehind and you get 3 topics: Character functions, Object functions and Room/Screen functions. It would be better if you got 1 topic for each function that has "walkbehind" in the name or description, not to mention the part of then room tutorial where walkbehinds are done.
12

Pumaman

The help file is a bit of a hack, I have to admit. I'll see what I can do about sorting it out, but as you can probably appreciate it's not my highest of priorities.

Gilbert

Actually there's something that's a bit annoying in the script function reference part. As some of the functions can, in fact, belong to two categories. For example:

AreCharObjColliding() can belong to both the "character" and "object" related sections (it's now only in char section)

That makes it difficult to look for functions sometimes. However it may not be an good idea to have duplicated functions in different sections either. I have no proposal about it at the moment.

SSH

I'm sure that there would be plenty of volunteers to re-do the help file if you were to ask for help (e.g. me, but I have no idea about creating Help files  :( )
12

Pumaman

The thing is that at the moment the help file is automatically generated from a text document, so it's a bit more complicated than it first appears.

SSH

Funnily enough, the keywords are already in there and work fine when you click on the "See alsos" at the bottom of a function ref, but they're just not in the index!
12

Pumaman

It's because each section (like "Hotspot functions") is a single page in the help file, and the full text search just returns the name of the page that it found the match on, not the name of the sub-section with the match.

SMF spam blocked by CleanTalk