Code freeze for Mozart 1.3.2

Boriss Mejias boris.mejias at uclouvain.be
Wed Jun 14 14:41:55 CEST 2006


Filip Konvička wrote:
> Hi!
> 
>>> the chm documentation has some corrupt TOC entries in the tree: 
>>> Mozart/Getting Started/System/Changes has a missing entry for the 
>>> 1.3.2 release, and
>>
>> this one was weird. I re-compiled the documentation and the link 
>> appeared. But there is still a red x in the entry "Changes" that I 
>> couldn't get rid off. any idea ?
> 
> This is a "new content here" mark :-)) It is called "Mark this entry as 
> new" in HTML Help Workshop.
>

:D thanks for the clarification.

>> indeed. This is the QTk stuff, and now I added all the correspondent 
>> sub-entries.
> 
> The 5.1 node opens chapter 6. (Please don't shoot the messenger!! ;-))

well, I had a look again at this, but it is a bit of a mess. It happens 
that documentation of Mozart is written in sgml format. Using those 
files, the html and hhc are automatically generated. The hhc files are 
used to create the index for the windows help.

One problem is that the automatic generation is a process done in the 
mozart directory, but not in the standard library. In fact, there is a 
file named mozart-stdlib.hhc in the CVS, but it is not up to date. 
Another problem is that QTk belongs to the standard library, and it has 
two directories for documentation. One is written in sgml, and another 
one in html, and I don't know if they have the same content.

Looking a bit more into the documentation of the standard library, it 
seems that the approach is that documentation in the mozart directory is 
written in sgml, and in the mozart-stdlib is written is html, except by 
the QTk library, which is written in both. And in fact, it can be reach 
from an independent node "High-level Window Programming with QTk" or via 
the standard library.

Does any developer knows about this issue related to documentation??

For the release, I'm going to remove the sub-entries, because they are 
all wrong from node 5.1, and I think the fix should involve a decision 
about keeping the documentation in sgml or html for the QTk library, and 
for that we need the help of other developers who worked on this before.

cheers
Boriss

> 
> Cheers,
> Filip
> 




More information about the mozart-hackers mailing list