You are viewing a plain text version of this content. The canonical link for it is here.
Posted to derby-dev@db.apache.org by Andrew McIntyre <mc...@gmail.com> on 2006/09/07 08:06:38 UTC

[doc] Doc builders - remove your DITA toolkit directory after 'svn up'

I just checked in two fixes, for DERBY-408 and DERBY-1805, to the HTML
Book and PDF generation that involved modifying files from the DITA
toolkit. In order to pick up these changes in your build, please
remove your expanded copy of the DITA toolkit from your source tree.
The new changes will then be applied to a freshly expanded copy of the
toolkit from the DITA zip file in your lib directory.

With the fixes for DERBY-408 and DERBY-1805, the syntax diagrams in
the tools and reference manuals are now correctly formatted, tables
are numbered sequentially, and all of the internal links in the
manuals should now work correctly. These fixes should enhance the
usability and readability of our documentation.

These changes will be reflected in tomorrow night's doc build, and
viewable at http://db.apache.org/derby/docs around midnight PST. I
would really appreciate it if someone could click around the docs and
verify that all the links are now working correctly. All of the ones
I've tested do seem to be working, but I haven't had time to verify a
large cross-section of all the internal links.

At some point I intend to track down why Ant cannot identify that the
files involved in these updates from subversion need copying to the
DITA toolkit directory, but that's an issue for another day...

andrew

Re: Re: Re: [doc] Doc builders - remove your DITA toolkit directory after 'svn up'

Posted by Laura Stewart <sc...@gmail.com>.
That seemed to work when I did svn update on 1223.
I'll take a hard look at the links etc when I finish with 1223.
Thanks!

-- 
Laura Stewart

Re: Re: Re: [doc] Doc builders - remove your DITA toolkit directory after 'svn up'

Posted by Andrew McIntyre <mc...@gmail.com>.
On 9/7/06, Laura Stewart <sc...@gmail.com> wrote:
>
> Andrew -
> What I do to work on doc issues is slightly different than what you describe.
> I have the zip file at
> C:\Authoring\Derby
>
> When I unzipped it, I unzipped it into a specific issue that I was
> working on, for example:
> C:\Authoring\Derby\Derby1397\trunk\DITA-OT1.1.2.1
>
> And ever since, I have been copying the DITA-OT1.1.2.1 directory from
> one issue to ithe trunk directory for another new ssue that I work on.
>
> So for the current issues that I am working on, such as Derby1223,
> what do I need to do?

Actually, I just realized that I had made a mistake in the build.xml
with my placement of the copy of the modified DITA toolkit files. Just
svn up again, and then make sure that you see something similar to:

init:
     [copy] Copying 1 file to /Users/andrewm/derby-docs/DITA-OT1.1.2.1/xsl
     [copy] Copying 1 file to /Users/andrewm/derby-docs/DITA-OT1.1.2.1/xsl
     [copy] Copying 1 file to /Users/andrewm/derby-docs/DITA-OT1.1.2.1/xsl
     [copy] Copying 1 file to /Users/andrewm/derby-docs/DITA-OT1.1.2.1/xsl/xslfo
     [copy] Copying 1 file to /Users/andrewm/derby-docs/DITA-OT1.1.2.1/xsl/xslfo
     [copy] Copying 1 file to /Users/andrewm/derby-docs/DITA-OT1.1.2.1/xsl/xslfo
     [copy] Copying 1 file to /Users/andrewm/derby-docs/DITA-OT1.1.2.1/xsl/xslfo
     [copy] Copying 1 file to /Users/andrewm/derby-docs/DITA-OT1.1.2.1/xsl/xslfo

when you build. The number of files copied may be slightly different,
depending on whether any of the changes had already been applied to
your toolkit by Ant.

Conveniently, this was the next issue I was planning on looking into
with the doc build, and now it's fixed. :-)

andrew

Re: Re: [doc] Doc builders - remove your DITA toolkit directory after 'svn up'

Posted by Laura Stewart <sc...@gmail.com>.
On 9/7/06, Andrew McIntyre <mc...@gmail.com> wrote:
> On 9/7/06, Laura Stewart <sc...@gmail.com> wrote:
> >
> > Andrew -
> > I want to ber certain that I understand what needs to be done here.
> > I have the DITA toolkit (unzipped) as a directory (DITA-OT1.1.2.1) in
> > the paths where I work on each JIRA issue, for example:
> > C:\Authoring\Derby\Derby1223\docs\trunk\DITA-OT1.1.2.1.
> >
> > I have the zipped copy of the toolkit at C:\Authoring\Derby.
> > Are you saying that I need to remove the directory (example in the
> > previous paragraph) and that when I unzip the toolkit it will
> > automatically pick up your changes,,, or do I need to get a new copy
> > of the zip file from the Derby docs web page?
>
> Remove the unzipped copy, i.e. remove the entire directory
> C:\Authoring\Derby\Derby1223\docs\trunk\DITA-OT1.1.2.1.
>
> If you keep a copy of the DITA zip file in the lib directory of your
> doc tree checkout, at
> C:\Authoring\Derby\Derby1223\docs\trunk\lib\DITA-OT1.1.2.1_bin-ASL.zip,
> then Ant will expand that zip file back into
> C:\Authoring\Derby\Derby1223\docs\trunk\DITA-OT1.1.2.1 and apply the
> changes that I made the next time you run a doc build.
>
> andrew
>


Andrew -
What I do to work on doc issues is slightly different than what you describe.
I have the zip file at
C:\Authoring\Derby

When I unzipped it, I unzipped it into a specific issue that I was
working on, for example:
C:\Authoring\Derby\Derby1397\trunk\DITA-OT1.1.2.1

And ever since, I have been copying the DITA-OT1.1.2.1 directory from
one issue to ithe trunk directory for another new ssue that I work on.

So for the current issues that I am working on, such as Derby1223,
what do I need to do?

-- 
Laura Stewart

Re: Re: [doc] Doc builders - remove your DITA toolkit directory after 'svn up'

Posted by Andrew McIntyre <mc...@gmail.com>.
On 9/7/06, Laura Stewart <sc...@gmail.com> wrote:
>
> Andrew -
> I want to ber certain that I understand what needs to be done here.
> I have the DITA toolkit (unzipped) as a directory (DITA-OT1.1.2.1) in
> the paths where I work on each JIRA issue, for example:
> C:\Authoring\Derby\Derby1223\docs\trunk\DITA-OT1.1.2.1.
>
> I have the zipped copy of the toolkit at C:\Authoring\Derby.
> Are you saying that I need to remove the directory (example in the
> previous paragraph) and that when I unzip the toolkit it will
> automatically pick up your changes,,, or do I need to get a new copy
> of the zip file from the Derby docs web page?

Remove the unzipped copy, i.e. remove the entire directory
C:\Authoring\Derby\Derby1223\docs\trunk\DITA-OT1.1.2.1.

If you keep a copy of the DITA zip file in the lib directory of your
doc tree checkout, at
C:\Authoring\Derby\Derby1223\docs\trunk\lib\DITA-OT1.1.2.1_bin-ASL.zip,
then Ant will expand that zip file back into
C:\Authoring\Derby\Derby1223\docs\trunk\DITA-OT1.1.2.1 and apply the
changes that I made the next time you run a doc build.

andrew

Re: [doc] Doc builders - remove your DITA toolkit directory after 'svn up'

Posted by Laura Stewart <sc...@gmail.com>.
On 9/6/06, Andrew McIntyre <mc...@gmail.com> wrote:
> I just checked in two fixes, for DERBY-408 and DERBY-1805, to the HTML
> Book and PDF generation that involved modifying files from the DITA
> toolkit. In order to pick up these changes in your build, please
> remove your expanded copy of the DITA toolkit from your source tree.
> The new changes will then be applied to a freshly expanded copy of the
> toolkit from the DITA zip file in your lib directory.
>

Andrew -
I want to ber certain that I understand what needs to be done here.
I have the DITA toolkit (unzipped) as a directory (DITA-OT1.1.2.1) in
the paths where I work on each JIRA issue, for example:
C:\Authoring\Derby\Derby1223\docs\trunk\DITA-OT1.1.2.1.

I have the zipped copy of the toolkit at C:\Authoring\Derby.
Are you saying that I need to remove the directory (example in the
previous paragraph) and that when I unzip the toolkit it will
automatically pick up your changes,,, or do I need to get a new copy
of the zip file from the Derby docs web page?


-- 
Laura Stewart

Re: [doc] Doc builders - remove your DITA toolkit directory after 'svn up'

Posted by Andrew McIntyre <mc...@gmail.com>.
On 9/6/06, Andrew McIntyre <mc...@gmail.com> wrote:
>
> These changes will be reflected in tomorrow night's doc build, and
> viewable at http://db.apache.org/derby/docs around midnight PST. I
> would really appreciate it if someone could click around the docs and
> verify that all the links are now working correctly. All of the ones
> I've tested do seem to be working, but I haven't had time to verify a
> large cross-section of all the internal links.

I kicked off my nightly doc-build-and-sync again, so the documentation
at http://db.apache.org/derby/docs/dev/ should reflect the changes for
DERBY-408 and DERBY-1805 shortly.

andrew