Re: yelp and FAQ

Sean Wheller <[email protected]> Sun, 8 May 2005 21:19:00 +0200
Newsgroups gmane.editors.conglomerate.devel
Organization In Words
Message-ID <[email protected]>
On Sunday 08 May 2005 21:09, Geert Stappers wrote:
> On Sun, May 08, 2005 at 05:20:10PM +0200, Sean Wheller wrote:
> > On Sunday 08 May 2005 16:59, Geert Stappers wrote:
>
>   [ yelp doesn't handel QandAset ]
>
> > > I have no appateit for diving in other Conglomerate related technology.
>
>   <snip/>
>
> > What I think is that we should not package FAQ with conglomerate. Only
> > put the FAQ on the Web Site.
> >
> > If we must package the FAQ then lets add a transformation to the cong
> > build and ship a html file instead.
> >
> > The user manual remains as XML.
>
> When possible, then should all files remain XML.

Whenever the target viewer is Yelp and Yelp is able to support the XML doc 
type then documents should be XML. However, if like is the case with qanda, 
yelp does not support the doctype, then a solution is to transform that 
document to HTML which yelp can view without problems.

>
> Wait with the transformation to HTML.
> AFAIK is/was the reason for the HTML switch to support Fink,
> but that issue is solved. Please confirm that there is no need for HTML.

Yes, the problem was solved by commenting out the processing instruction that 
was in faq.xml.qna. Since this fixed the problem, there is no longer a 
stopper. However, even though the document is formatted as an article, Yelp 
still has no clue on how to handle the qandsets. The resulting output under 
yelp is poorly formatted to say the least and is a far cry from what is 
actually intended as a docbook faq.

>
>
> What to do with the FAQ:
> Leave it in doc/C and ship Conglomerate with it.
> In the past few days was expressed that there is no reason
> to enforce that the user must have Internet acces.

FAQ is not something you put in a manual. It is good on a Web Site. The User 
Manual should cover everything a user needs in order to complete tasks with 
conglomerate.

>
>
> What is the reason that it currently is left out?

Faq was originally brought into conglomerate.xml by entity inclusion. When the 
file was changed to an article, it made conglomerate.xml invalid.

-- 
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)

iD8DBQBCfmYn9PtDMvDDTqYRArf9AKCZ2vA1N8OH9bfbVe19y/KXGditVQCfZtMX
QoNzWUtv22togOsNmqGFJYg=
=A/mP
-----END PGP SIGNATURE-----