Re: [Firebird-docs] Do we ever build release notes all together?

2011-10-18 Thread Helen Borrie
At 04:44 AM 19/10/2011, Paul Vinkenoog wrote:
>Hi Norman,
>
>> Sorry, I cannot type:
>>
>> > I'm wondering if this is something we might need to fix. I have had a
>> > look in rlsnotes20/install/Compatibility20x.docbook where at least one
>> > section has an id="compat-sql" but I can find no cross refernce (or xref
>> > tags) to it anywhere.
>> That should of course read :
>>
>> ...
>> > section has an id="rnfbtwo-compat" but I can find no cross refernece ...
>
>Really?  ;-)

Can't think of any reason we'd ever want to build release notes all together.  
However, anyone who has this desire is welcome to do it after my death. ;-)

Over the years release notes are a mish-mash of stuff from multiple sources.  
Things didn't start to come "together" until Paul sorted out the docbook 
framework during one of the Fb 1.5 sub-release cycles.  At that point I spent a 
lot of time backporting Word and RTF sources into the framework for both Fb 1.5 
and Vulcan.  (AFAIR, the Vulcan release notes never made it into CVS.)

A new mess began with v.2.1, when the notes that were done were a merger of new 
stuff in 2.1 and the stuff to date in 2.0.x.  At that point, there were no Lang 
Updates so the merger was done to meet demand and the Ref Manual project was 
being subjected to a lengthy assassination.  At that point also, the 2.0.x 
series was still being treated as an interim step towards the evolving new 
architectures.  There was no expectation that 2.0.x would have six sub-releases 
and 2.1 would still be alive in 2011!

It was further complicated by breaking out the bug fixes and 
compatibility/migration notes into separate documents.  That was done to 
appease the kit builders who were complaining about the size of the PDF.  Since 
then, it's not so relevant as I have NitroPDF and can shrink PDFs if there are 
complaints about their size.  Furthermore, they took to including the Lang 
Updates in the kits and *those* are not getting any smaller!

The id duplications occur (mostly) because the earlier 2.0 tags are repeated in 
the 2.1 notes and I gave up trying to catch them eventually.  I doubt I ever 
will now - it's enough trouble and heartache trying to capture and verify 
content. ;-)


Helen


--
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2d-oct
___
Firebird-docs mailing list
Firebird-docs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/firebird-docs


Re: [Firebird-docs] Do we ever build release notes all together?

2011-10-18 Thread Paul Vinkenoog
Hi Norman,

> Sorry, I cannot type:
>
> > I'm wondering if this is something we might need to fix. I have had a
> > look in rlsnotes20/install/Compatibility20x.docbook where at least one
> > section has an id="compat-sql" but I can find no cross refernce (or xref
> > tags) to it anywhere.
> That should of course read :
>
> ...
> > section has an id="rnfbtwo-compat" but I can find no cross refernece ...

Really?  ;-)

Paul Vinkenoog

--
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2d-oct
___
Firebird-docs mailing list
Firebird-docs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/firebird-docs


Re: [Firebird-docs] Do we ever build release notes all together?

2011-10-18 Thread Paul Vinkenoog
Hi Norman,

> BUILD FAILED
> ...
> org.apache.fop.fo.ValidationException: 
> file:/home/norman/SourceCode/cvs/firebird/manual/inter/fo/rlsnotes.fo:14412:78:
>  
> Property id "toc.rlsnotes.rnfbtwo-compat" previously used; id values 
> must be unique in document.
>
>
> To me it looks like the duplicate ids warned about above are causing 
> problems in the TOC.

Yes, because if there are duplicate ids, you can't tell which one to link to.

In this case, rnfbtwo-compat is the id of
- the chapter "Known Compatibility Issues" in "Firebird 2 Migration & 
Installation" (file rlsnotes210/install/Compatibility20x.docbook)
- the chapter "Known Compatibility Issues" in the Firebird 2 Release Notes 
(file rlsnotes20/Compatibility.docbook) 

> I'm wondering if this is something we might need to fix.

It would be better (ids must be unique througout a ), though in practice 
we get away with it because there's usually no reason to build all the Release 
Notes together.

> Equally XXE doesn't like editing the xml file in that, and other,
> folders - I get the impression that it doesn't like included entities
> anymore or the "*.docbook" suffix is giving it grief!

The file extension shouldn't make any difference. But if I open rlsnotes.xml as 
a document set, I can't open some of the subdocuments because they contain 
entities that were "referenced, but not declared". In fact they _were_ 
declared: in rlsnotes.xml, the top document. So this is an error in XXE. With 
xincludes, this doesn't happen.


> PS. Anyone know the cvs command to revert an edit back to how it was
> before I started editing? I tried "cvs unedit filename" which hasn't helped.

AFAIR, unedit fell into disgrace. If I want to go back to the version in CVS, I 
always delete or rename the local file and do a cvs update.


Cheers,
Paul

--
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2d-oct
___
Firebird-docs mailing list
Firebird-docs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/firebird-docs


Re: [Firebird-docs] Do we ever build release notes all together?

2011-10-18 Thread Norman Dunbar
Sorry, I cannot type:

> I'm wondering if this is something we might need to fix. I have had a
> look in rlsnotes20/install/Compatibility20x.docbook where at least one
> section has an id="compat-sql" but I can find no cross refernce (or xref
> tags) to it anywhere.
That should of course read :

...
> section has an id="rnfbtwo-compat" but I can find no cross refernece ...
...


Cheers,
Norm

-- 
Norman Dunbar
Dunbar IT Consultants Ltd

Registered address:
Thorpe House
61 Richardshaw Lane
Pudsey
West Yorkshire
United Kingdom
LS28 7EL

Company Number: 05132767

--
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2d-oct
___
Firebird-docs mailing list
Firebird-docs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/firebird-docs


[Firebird-docs] Do we ever build release notes all together?

2011-10-18 Thread Norman Dunbar
I'm attempting to build the release notes as follows:

./build.sh docs -Dbase=rlsnotes

The build works fine for both HTML options but fails on pdf with the 
following warnings:

fo:
[java] Making portrait pages on A4 paper (210mmx297mm)
[java] multiple "IDs" for constraint linkend: rnfbtwo-compat.
[java] multiple "IDs" for constraint linkend: compat-firebirdvar.
[java] multiple "IDs" for constraint linkend: bug-206-bugsfixed.
[java] multiple "IDs" for constraint linkend: bug-205-bugsfixed.
[java] multiple "IDs" for constraint linkend: nbackupbugs.
[java] multiple "IDs" for constraint linkend: bug-204-bugsfixed.
[java] multiple "IDs" for constraint linkend: bug-202-bugsfixed.
[java] multiple "IDs" for constraint linkend: rnfbtwo-compat.
[java] multiple "IDs" for constraint linkend: compat-sql-ddl.
[java] multiple "IDs" for constraint linkend: rnfbtwo-compat.
[java] multiple "IDs" for constraint linkend: compat-firebirdvar.


Then later on, this error stops the build:

fo2pdf:
...
BUILD FAILED
...
org.apache.fop.fo.ValidationException: 
file:/home/norman/SourceCode/cvs/firebird/manual/inter/fo/rlsnotes.fo:14412:78: 
Property id "toc.rlsnotes.rnfbtwo-compat" previously used; id values 
must be unique in document.


To me it looks like the duplicate ids warned about above are causing 
problems in the TOC.


I can build each individual release note separately as follows, just not 
all in one document.

for x in 15 19 20 25 210
do
./build.sh docs -Dbase=rlsnotes -Did=rlsnotes${x}
done


I'm wondering if this is something we might need to fix. I have had a 
look in rlsnotes20/install/Compatibility20x.docbook where at least one 
section has an id="compat-sql" but I can find no cross refernce (or xref 
tags) to it anywhere.

Equally XXE doesn't like editing the xml file in that, and other, 
folders - I get the impression that it doesn't like included entities 
anymore or the "*.docbook" suffix is giving it grief!


Cheers,
Norm.

PS. Anyone know the cvs command to revert an edit back to how it was 
before I started editing? I tried "cvs unedit filename" which hasn't helped.

-- 
Norman Dunbar
Dunbar IT Consultants Ltd

Registered address:
Thorpe House
61 Richardshaw Lane
Pudsey
West Yorkshire
United Kingdom
LS28 7EL

Company Number: 05132767

--
All the data continuously generated in your IT infrastructure contains a
definitive record of customers, application performance, security
threats, fraudulent activity and more. Splunk takes this data and makes
sense of it. Business sense. IT sense. Common sense.
http://p.sf.net/sfu/splunk-d2d-oct
___
Firebird-docs mailing list
Firebird-docs@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/firebird-docs