Re: faq.xml.qna

Le 8 mai 2005 à 16:22, Sean Wheller a écrit :

> My conclusion on this is that it has nothing to do with  
> documentation itself,
> rather it is about some event in the software of which I have no  
> knowledge.
It has to do with cvs anonymous slowness. 10 days behind.

>
> It seems that Michèle is able to open yelp and view the manual.  
> Although I am
> not sure if that is showing only the manual or the faq as well. If I
> understand correctly he just did 'yelp' and opened the default for  
> gnome.
I don't know right now, since now that the change has made its way  
through cvs, I should make the tarball, compile it and install it,  
then I can tell if both open, though apparently there is no reason  
why not, but I rely only on fact, so please wait one hour or so till  
I can say it compiles.
Except that here he is she.

>
> Michèle if you can do yelp path/to/faq.xml and it opens then the  
> problem is
> not with docs. But please see what I have done below.
That would not be a solution, too complicated for mac users, they are  
not used to go with complicated paths. But as I said, there is no  
reason why it should not work.

>
> The file faq.xml.qna is valid and well-formed on my system. What I  
> have done
> now is commented out the processing instruction referring to local  
> host and
> committed that to cvs.
>
> <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
>     "http://www.docbook.org/xml/4.1.2/docbookx.dtd">
>
> <!--<?xml-stylesheet type="text/css"
> href="http://localhost/xml/styles/docbook.css"?>-->
>
>
> When I invoke yelp passing faq.xml.qna
>
> sean@sean:~> yelp projects/gnome/conglomerate/doc/C/faq.xml.qna
>
> It opens, but as expected is not formatted correctly due to the  
> fact that Yelp
> has no clue want to do with a <qandaset>.
>
> <qandaset>
>         <qandadiv id="generalfaq">
>             <title>General questions</title>
>             <qandaentry>
>                 <question>
>                     <para>Why not just use XXX xml editor?</para>
>                 </question>
>                 <answer>
>                     <para>Conglomerate is usable for editing all  
> XML documents but it is not
> always the ideal editor. Conglomerate really comes into its own  
> when dealing
> with documents which are content based rather than attribute based.  
> Therefore
> it is much better for editing documents types traditionally handled  
> in word
> processors rather than configuration files which require a more  
> traditional
> tree structure. </para>
>                 </answer>
>             </qandaentry>
>         </qandadiv>
>         <qandadiv id="docfaq">
>             <title>Document questions</title>
>             <qandaentry>
>                 <question>
>                     <para>Can Conglomerate edit an XML document of  
> type XXX?</para>
>                 </question>
>                 <answer>
>                     <para>Yes, conglomerate will allow you to edit any
> &quot;well-formed&quot; XML document. Although having a &quot;Display
> Specification&quot; for the document will make it better. </para>
>                 </answer>
>             </qandaentry>
> ....
> </qandaset>
>
> Not much I can do about this, the Yelp maintainer needs to add  
> support for
> this.
No, this is simple, just a special xds file and it should be well. I  
can write it if needed. Otherwise the solution is to transform it as  
an article, that's what I've done in my patch.

But anyway, I can do it just for Mac, if it is not wanted in the tree.


Cheers,
Michèle
<http://micmacfr.homeunix.org>