Bug 15949 - please provide links to docs.xml and jakarta-site2
Summary: please provide links to docs.xml and jakarta-site2
Alias: None
Product: Ant
Classification: Unclassified
Component: Documentation (show other bugs)
Version: 1.1
Hardware: Other other
: P3 enhancement (vote)
Target Milestone: ---
Assignee: Ant Notifications List
URL: http://jakarta.apache.org/ant/faq.htm...
Depends on:
Reported: 2003-01-10 08:22 UTC by Ralf Hauser
Modified: 2008-02-22 12:18 UTC (History)
0 users

free docs.xml from jakarta-site2 subtree dependency (782 bytes, patch)
2003-01-16 07:48 UTC, Ralf Hauser
Details | Diff
The patch you were asking for. (1.92 KB, patch)
2003-01-16 09:34 UTC, Ralf Hauser
Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Ralf Hauser 2003-01-10 08:22:52 UTC
Otherwise, I have a hard time recreating your html file.

(see also: http://nagoya.apache.org/bugzilla/show_bug.cgi?id=15948 on missing
error messages from anakia that didn't help me resolve the problem either.)
Comment 1 Stefan Bodewig 2003-01-13 13:26:11 UTC
Is the FAQ no clearer?

If so, please close this bug.
Comment 2 Stefan Bodewig 2003-01-13 13:33:09 UTC
"no" should have been "now", sorry.
Comment 3 Ralf Hauser 2003-01-13 13:41:20 UTC
Hhmm, have your changes already been deployed - I don't really see much change
Also, the page is broader than my Mozilla1.3/MSIE window and doesn't adapt on
re-sizing - is that intentional??
Comment 4 Stefan Bodewig 2003-01-13 13:47:04 UTC
Yes, they have been deployed.

Two changes:

* it now says "docs.xml at the top level of the jakarta-ant CVS module"

* and "jakarta-site2 CVS module" instead of just "jakarta-site2 module"
Comment 5 Ralf Hauser 2003-01-13 13:58:37 UTC
hmm, that's kind of minimalisitc   ;)

Or 1) do you anyway advocate to rather use forrest/cocoon?

Also, 2) what do you say about the window size/horizontal scroll-bar/resizing issue?
Comment 6 Stefan Bodewig 2003-01-13 14:14:00 UTC
minimalistic?  Well, yes, certainly, patches welcome 8-)

forrest/cocoon?  We (as in "the Ant developers") have not yet decided what we want
to do with our doc building system in the future.  We are watching Forrest.
IM (as in "Stefan's") HO Forrest is not yet up to the task completely.

layout?  Well, it's always been that way ;-)  See ant.apache.org for an idea of
what we may be up to in the future (this looks like Forrest but uses Anakia).
Comment 7 Ralf Hauser 2003-01-13 19:11:27 UTC
If I were able to reproduce the faq.html, I would be happy to provide the
patches you are asking for...  (see my comment to
The new ant.apache.org looks nice! congrats! 
Would it be possible to produce also w3c validating xhtml11 instead of html4/loose ?
Comment 8 Stefan Bodewig 2003-01-15 13:42:00 UTC
The easiest way to reproduce the FAQ is to check out the complete jakarta-ant and
the complete jakarta-site2 CVS module so that the directories are siblings.

After that, run Ant on the docs.xml file inside the jakarta-ant directory.

The minimal amount of stuff you need from the Ant module is docs.xml, xdocs/faq.xml
and the complete xdocs/stylesheets directory.  You also need all the jars that
Anakia requires, which means you need the complete lib directory of jakarta-site2.
Comment 9 Ralf Hauser 2003-01-16 07:48:00 UTC
Created attachment 4460 [details]
free docs.xml from jakarta-site2 subtree dependency
Comment 10 Ralf Hauser 2003-01-16 08:05:58 UTC
It appears that all the jars needed for docs.xml/anakia to be able to properly
create faq.html from faq.xml can be found in the jakarta-velocity tree as well.
And this one is really needed to perform the translation. site2 appears to be
somewhat unneccessary overhead to a location-independent way to build a faq.
The last <echo> statement mentioning the velocity.log file addresses the issues
raised in http://nagoya.apache.org/bugzilla/show_bug.cgi?id=15948

One remaining issue: While the faq gets translated perfectly, it fails to
translate the following macros: header, footer, source, table.
First, in velocity.log, I got the error message:
[error] ResourceManager : unable to find resource 'VM_global_library.vm' in any
resource loader.
Found the missing file in jakarta-velocity\test\templates and placed in the
stylesheets directory.
No change in the faq.html, but a new error message in .log:
[error] VM #recurse: error : too few arguments to macro. Wanted 1 got 0
Comment 11 Ralf Hauser 2003-01-16 09:34:58 UTC
Created attachment 4461 [details]
The patch you were asking for.
Comment 12 Ralf Hauser 2003-01-16 09:37:11 UTC
O.k. figured that the VM_global_library.vm was the wrong direction, getting
velocity.properties into xdocs solved it.

Therefore, the second attachment/patch now is what I propose to have the next
person trying to do what I tried doing it in minutes, not hours (assuming you
update docs.xml with the first patch).
Comment 13 Conor MacNeill 2003-02-02 13:50:44 UTC
OK, just did a clean ant build, have jakarta-site checked out and did 
ant -f docs.xml

It all works, so I don't think we need to change that. Thanks
Comment 14 Ralf Hauser 2003-02-02 17:03:54 UTC

Sure, it works as is. But wouldn't a little bit more user-friendliness be useful
for two reasons:
1) more people using this velocity-based approach to generate html might
increase the prevalence of velocity in general
2) as per my patches - checking out jakarta-site isn't necessary, since all you
need is in velocity/build/lib already

Also, did you have a chance to look at the patches I provided?
It would be strange if an apache.org-person asks me for a patch in the first
place and now my contribution gets dumped apparently even without being looked
at at all...   :(

Comment 15 Conor MacNeill 2003-02-02 22:30:40 UTC
If you feel the bug has not been addressed, please feel free to reopen.

Of course I have looked at the patches. I don't see that replacing a dependency
on jakarta-site2 with a dependency on jakarta-velocity is a great change.

<     <property name="velocity.dir"     location="../jakarta-velocity" />

It is not really my mission to promote velocity usage. I like velocity in
general but all I want is a system which can build the Ant website. The
underlying technology is not that relevant.

As for the second patch, I didn't see the benefit of putting links into CVS from
the documentation since it is likely that the user will already have everything
checked out. 

What issue is it that you are trying to solve?
Comment 16 Ralf Hauser 2003-02-03 02:27:42 UTC
the issue to solve is: get a generic way to manage a website more effectively
than just plain html in a cvs.
In order to use the great mechanism you have developed for the ant website, I
only need the velocity engine, but not the entire jakarta-site tree and I am up
and running. The benefits are that your approach is a lot simpler than what
forrest/cocoon does and as Stefan wrote above: you are watching forrest/cocoon,
but even with your new ant.jakarta.org website you do use their layout ideas,
but not their underlying technology.
Comment 17 Conor MacNeill 2003-02-03 09:31:55 UTC
OK, I'm going to reopen as an enhancement - we can revisit.