1
iunderwood
XOOPS 2.5 Help System

I really like this feature, and it looks really good w/ the system module.

However, I would like to know if anyone has a document or an example on how a non-System module uses the help system to a more full effect ... or can point me in a good direction to start.
++I;
Resized Image

2
Mamba
Re: XOOPS 2.5 Help System
  • 2010/12/20 7:26

  • Mamba

  • Moderator

  • Posts: 11366

  • Since: 2004/4/23


The easy way:

Under /language/english

create subdirectory /help

and in it a file:

module_index.html

which will be your template for help. Change the code as needed:

<div id="help-template" class="outer">
<
h1 class="head">HelpMyModule</h1>

<
h4 class="odd">Description</h4>
<
class="even">
MyModule is a module that does followingXXX
</p>

</
div>


You can also check out the templates for System module to see how it is being done there.

This will list your module's help in the overall help, but it won't set it a direct link in the toolbar menu itself. I am not sure at the moment if you can do it directly.
Support XOOPS => DONATE
Use 2.5.10 | Docs | Modules | Bugs

3
iunderwood
Re: XOOPS 2.5 Help System

That's what I thought for the actual help page itself.

I like the way that the system help is rendered, but it seems to build all its options based off of the admin/directory/xoops_version.php structure.

I, however, don't code each of my admin functions in its own directory, mostly because I hate the clutter. I'm curious if it'd be possible to be able to expand or add an array in 2.5.1 or something such:

$modversion['helpinfo'][]['name'] = "My Help 1";
$modversion['helpinfo'][]['filename'] = "help1.html";

That way I, or anyone else could write a decent help system into our xoops_version files w/o having to create a massive directory structure to support it.

Just a thought. :)
++I;
Resized Image

Login

Who's Online

242 user(s) are online (173 user(s) are browsing Support Forums)


Members: 0


Guests: 242


more...

Donat-O-Meter

Stats
Goal: $100.00
Due Date: Mar 31
Gross Amount: $0.00
Net Balance: $0.00
Left to go: $100.00
Make donations with PayPal!

Latest GitHub Commits