Help text task_id [message #1645] |
Mon, 15 September 2008 08:58 |
gpatti
Messages: 283 Registered: August 2008
|
Senior Member |
|
|
I'm trying my hand at building some help screens and I've noticed that the help screens display a default text of "Help text for <task_id>" at the top of the main body.
I have used the language facilities to display proper task descriptions on the screens, but can't figure out how I would change the default behaviour at the top of the help screens to show the task description rather than the task_id.
Is this possible?
|
|
|
Re: Help text task_id [message #1646 is a reply to message #1645] |
Mon, 15 September 2008 11:22 |
AJM
Messages: 2363 Registered: April 2006 Location: Surrey, UK
|
Senior Member |
|
|
It is possible, but I don't do it. I deliberately use the task_id as this uniquely identifies the task in question. Task descriptions may not be all that unique and could therefore be confusing.
If you want to use descriptions you could try adding the following line in the help.php script:
$help_id = getLanguageText($help_id);
This would translate the task_id into the relevant description.
Tony Marston
http://www.tonymarston.net
http://www.radicore.org
|
|
|
|
Re: Help text task_id [message #1648 is a reply to message #1647] |
Mon, 15 September 2008 13:13 |
AJM
Messages: 2363 Registered: April 2006 Location: Surrey, UK
|
Senior Member |
|
|
Sorry, I did mean std.help.inc and not help.php
If you change your copy of std.help.inc then it will be overwritten when you upgrade. Perhaps it would be better if I changed it to include both the id and description in the heading, in which case that would cover all the options.
Tony Marston
http://www.tonymarston.net
http://www.radicore.org
|
|
|
|
Re: Help text task_id [message #1654 is a reply to message #1652] |
Tue, 16 September 2008 04:54 |
AJM
Messages: 2363 Registered: April 2006 Location: Surrey, UK
|
Senior Member |
|
|
You also have to remember that it is possible for several tasks to have the same or similar descriptions, so when reporting problems it is vitally important to easily distinguish EXACTLY which task they are talking about.
Besides, if the heading on the help page contains both the task_id and the description would that cause a problem? Would it cause any confusion?
Tony Marston
http://www.tonymarston.net
http://www.radicore.org
|
|
|
|
|
|