Re: faq.xml.qna

Sean Wheller <[email protected]> Sat, 7 May 2005 08:27:47 +0200
Newsgroups gmane.editors.conglomerate.devel
Organization In Words
Message-ID <[email protected]>
On Saturday 07 May 2005 01:25, Michèle Garoche wrote:
> Maybe I was not clear enough;

:-) Looks like we are not understanding each other.

> I have:
>   yelp pathtomanual (and then I need faq integrated into manual)  
> which works
>   Help > Web site works

Understood.

>   Help > FAQ does not work

This one cannot work in Yelp directly from the XML because Yelp does not 
support qanda sets. While the XML-instance may be loaded, Yelp cannot format 
it because it does not have support for the Docbook question and answer 
format. The alternative is for us to first transform the FAQ from XML to 
X/HTML. Then when you select the event Help > FAQ it will display the FAQ in 
your default browser.

>   Help > Manual does not work

This is not good. Do you get any error messages from Yelp when you invoke Yelp 
passing it the faq file?

Please test conglomerate.xml with xmllint to see whether or not it is valid 
and well-formed. I recently committed a patch to cvs that made the document 
such. If the doc is not well-formed, please get the conglomerate.xml from cvs 
and try that.

I removed FAQ from this version of the user manual. On my system I am able to 
open the file in help. Again, if you can invoke it from the command line, 
just for this test, so that you can see any error messages, it will be a good 
thing.

>
> Actually I have preferences, since there is no reason that mac users  
> have to connect to internet to read the help. So for me faq into  
> manual is better, because then yelp manual wich allows to read the faq.
> That's the same if the faq is not integrated into the manual by the  
> way, yelp manual should work.

Yes, you are correct. They should not have to connect to the Internet. 
However, the HTML file can also reside on the local file system. Therefore 
the event Help > FAQ will load an HTML file from the local disk, not the 
network.

I realize this does not fix your problem for now. But, it may be a way forward 
for the next release. What do you think?


-- 
Sean Wheller
Technical Author
[email protected]
084-854-9408
http://www.inwords.co.za
Registered Linux User #375355

_______________________________________________
Conglomerate-devel mailing list
[email protected]
http://lists.copyleft.no/mailman/listinfo/conglomerate-devel
signature.asc (application/pgp-signature, 189 B)
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.5 (GNU/Linux)

iD8DBQBCfF/n9PtDMvDDTqYRAo3yAJ4yoxuBDkuGLL8NTR8eUxXwE05ORgCffqvv
0ZjZcRmeVnxD8X0IiCy5rBE=
=s7cl
-----END PGP SIGNATURE-----