Re: [webmin-devel] Web links in help files

[John H. <j....@pl...>]

On Wed, 2003-11-26 at 09:57, John Horne wrote:
> On Tue, 2003-11-25 at 22:14, Jamie Cameron wrote:
> >
> > Normal HTML doesn't, but webmin help files do :-)
> > You can use pseudo-HTML like :
> > <include pagename>
> > to have help/pagename.html inserted at that point.
> > 
> > I should really document this in the help section of the module
> > developer's documentation!
> > 
> Wow, that is good. I looked at server-side includes and javascript but
> couldn't find quite what I wanted.
> 
> In my case the above 'include' works fine when specifying a plain text
> file...but. It removed all the formatting, so I got a whole page of line
> after line of text - no blank lines, no space padding etc. I'll have a
> look to see if anything can be done about this.
> 
Okay, I have this all sussed now :-)

>From my module the main help link is to a 'help.html' file in the help
directory. Within this are other '<A HREF=' links, which webmin takes to
be html files within the help directory. Within *these* files I simply
put something like:

   <HEADER>xxx</HEADER>

   <pre>
   <include some_text_file>
   </pre>

where 'some_text_file' is some plain text file. (Actually I have used
soft links to the files which are in the modules main directory and not
the help directory.) The 'include' inserts the file into the web page,
and the 'pre' prevent the newlines, spaces, etc from being transformed.

So from the module the user clicks on the 'help' link, and that displays
a load of text (html) and some other links to plain text files. By
clicking on those links they get the relevant plain text file displayed.
Very nice :-)


John.

-- 
---------------------------------------------------------------
John Horne, University of Plymouth, UK  Tel: +44 (0)1752 233914
E-mail: Joh...@pl...       Fax: +44 (0)1752 233839