Re: FOP Servlet, contrib stuff and tutorial
On Tue, 2002-12-03 at 22:04, J.Pietschmann wrote: > Keiron Liddle wrote: > >>>- move contrib/servlet to examples/servlet > >>>- move contrib/plan to examples/plan > >>>- move contrib/mathml to examples/mathml > > One of the purposes that these serve is to demonstrate how to write an > > extension and for FOP to pick it up in the classpath. This might take > > away that. > > Granted for plan and mathml, but the servlet sees real use, and > getting it built easily may be in order. Okay, for the servlet. I wasn't thinking of that. > In either case I personally expect source which can be of real use > in the src tree rather than anywhere else, and I don't think it > matters much if the written documentation points to examples/something > or src/java/org/something/else, as long as it is distributed with the > binary distro, and this shouldn't be too hard to arrange. Well for the extension examples. If someone wants to write their own extension, they get the directory then change the source code and a few other things and it is ready. If it is in the source tree (including the META-INF) it could make it much more difficult for someone to start with. > J.Pietschmann - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
Re: FOP Servlet, contrib stuff and tutorial
Keiron Liddle wrote: - move contrib/servlet to examples/servlet - move contrib/plan to examples/plan - move contrib/mathml to examples/mathml One of the purposes that these serve is to demonstrate how to write an extension and for FOP to pick it up in the classpath. This might take away that. Granted for plan and mathml, but the servlet sees real use, and getting it built easily may be in order. In either case I personally expect source which can be of real use in the src tree rather than anywhere else, and I don't think it matters much if the written documentation points to examples/something or src/java/org/something/else, as long as it is distributed with the binary distro, and this shouldn't be too hard to arrange. J.Pietschmann - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
Re: FOP Servlet, contrib stuff and tutorial
On Sun, 2002-12-01 at 20:58, J.Pietschmann wrote: > > - move contrib/servlet to examples/servlet > > - move contrib/plan to examples/plan > > - move contrib/mathml to examples/mathml > Unless license restrictions get in the way, I'd rather move them > to src/java/org/apache/fop/* One of the purposes that these serve is to demonstrate how to write an extension and for FOP to pick it up in the classpath. This might take away that. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
Re: FOP Servlet, contrib stuff and tutorial
Jeremias Maerki wrote: IMO the following things should be done: - move the hyph directory to src/hyph +1 - move the FO schema to src/foschema dunno ... WTF, +1 - move src/org to src/java/org +0 I don't like it but if its good for Cocoon, it sure has to be good for everybody else... - move contrib/servlet to examples/servlet - move contrib/plan to examples/plan - move contrib/mathml to examples/mathml Unless license restrictions get in the way, I'd rather move them to src/java/org/apache/fop/* - move conf to src/conf +0.999 - remove docs/examples/embedding +1 - move docs/examples to examples/fo +1 - place the tutorial in examples/tutorial or tutorial (don't know yet) Difficult. I'd thought of docs/tutorial first, but probably it should be src/xdocs/tutorial... J.Pietschmann - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
Re: FOP Servlet, contrib stuff and tutorial
Also following other project's conventions. The config files get included in the jar, so I think they ARE source. Another issue with the conf dir is that it's also part of the binary distribution. Christian - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
Re: FOP Servlet, contrib stuff and tutorial
Jeremias Maerki wrote: On 27.11.2002 17:12:38 Oleg Tkachenko wrote: Jeremias Maerki wrote: [..] The question is actually whether contrib/servlet stuff is included into the distribution. If so, I don't see any reason to duplicate java code and war. Just need to change documentation and probably leave explanatory readme file in the examples/embedding directory. If not, the duplication seems reasonable. Looking to the archive [1] I see Joerg said "Contrib/servlet is not distributed, instead, the Java source and a war file is in docs/examples/embedding." I believe we should wait till Joerg is back to clarify that. My intention. I just wanted to get this started. Sounds like the only problem is that the contrib/servlet stuff is not in the distribution. I'll add this and remove the old docs/example/embedding stuff. Christian - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
Re: FOP Servlet, contrib stuff and tutorial
On 27.11.2002 17:12:38 Oleg Tkachenko wrote: > Jeremias Maerki wrote: > > > Oleg and I wonder what we should do with the fact that the FOP servlet > > exists in docs/examples/embedding and contrib/servlet. Joerg seems to > > have some ideas about this, so I hope he tells us when he's back from > > holidays. But the other's opinion is also wanted here. IMO the servlet > > should always be built from the sources now in contrib. The > > docs/examples/embedding stuff should be deleted. Joerg thinks > > differently, I think. > The question is actually whether contrib/servlet stuff is included into the > distribution. If so, I don't see any reason to duplicate java code and war. > Just need to change documentation and probably leave explanatory readme file > in the examples/embedding directory. > If not, the duplication seems reasonable. > Looking to the archive [1] I see Joerg said "Contrib/servlet is not > distributed, instead, the Java source and a war file is in > docs/examples/embedding." I believe we should wait till Joerg is back to > clarify that. My intention. I just wanted to get this started. > > I've started a "How to use FOP in Java/Usage patterns" tutorial > > yesterday. When finished it will consist of some Java sources, a few XML > > files (XMLs, FOs, XSLTs) and documentation in XML format. > That's great. > > > IMO the following things should be done: > > - move the hyph directory to src/hyph > +1 > > - move the FO schema to src/foschema > -1 Is it really source? I believe that's more documentation/test stuff. IMO that would make it hard to find. > > - move src/org to src/java/org > This can confuse people, as it may look like java.org.* packages. Such ones do > exist and are reserved to SUN afair. This has nothing to do with package names. I followed the conventions used in other Apache projects. The "java" directory is simply there to separate the other stuff from the Java stuff. Think of the various IDEs where you have to specify the Java source directories. Not having the java dir includes all other subdirectories which could be confusing. > > - move contrib/servlet to examples/servlet > > - move contrib/plan to examples/plan > > - move contrib/mathml to examples/mathml > +1 > > > - move conf to src/conf > -1 it's not a source actually. Also following other project's conventions. The config files get included in the jar, so I think they ARE source. > > - remove docs/examples/embedding > > - move docs/examples to examples/fo > +1 > > - place the tutorial in examples/tutorial or tutorial (don't know yet) > docs/tutorial ? > > [1] http://marc.theaimsgroup.com/?l=fop-dev&m=103196215022751&w=2 Jeremias Maerki - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
Re: FOP Servlet, contrib stuff and tutorial
Jeremias Maerki wrote: Oleg and I wonder what we should do with the fact that the FOP servlet exists in docs/examples/embedding and contrib/servlet. Joerg seems to have some ideas about this, so I hope he tells us when he's back from holidays. But the other's opinion is also wanted here. IMO the servlet should always be built from the sources now in contrib. The docs/examples/embedding stuff should be deleted. Joerg thinks differently, I think. The question is actually whether contrib/servlet stuff is included into the distribution. If so, I don't see any reason to duplicate java code and war. Just need to change documentation and probably leave explanatory readme file in the examples/embedding directory. If not, the duplication seems reasonable. Looking to the archive [1] I see Joerg said "Contrib/servlet is not distributed, instead, the Java source and a war file is in docs/examples/embedding." I believe we should wait till Joerg is back to clarify that. I've started a "How to use FOP in Java/Usage patterns" tutorial yesterday. When finished it will consist of some Java sources, a few XML files (XMLs, FOs, XSLTs) and documentation in XML format. That's great. IMO the following things should be done: - move the hyph directory to src/hyph +1 - move the FO schema to src/foschema -1 Is it really source? I believe that's more documentation/test stuff. - move src/org to src/java/org This can confuse people, as it may look like java.org.* packages. Such ones do exist and are reserved to SUN afair. - move contrib/servlet to examples/servlet - move contrib/plan to examples/plan - move contrib/mathml to examples/mathml +1 - move conf to src/conf -1 it's not a source actually. - remove docs/examples/embedding - move docs/examples to examples/fo +1 - place the tutorial in examples/tutorial or tutorial (don't know yet) docs/tutorial ? [1] http://marc.theaimsgroup.com/?l=fop-dev&m=103196215022751&w=2 -- Oleg Tkachenko eXperanto team Multiconn Technologies, Israel - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
Re: FOP Servlet, contrib stuff and tutorial
On Wednesday 27 November 2002 09:36, Keiron Liddle wrote: > On Tue, 2002-11-26 at 13:53, Jeremias Maerki wrote: >. . . > > Problems that need to be addressed: > > - All Java sources need to be checked easily before a release (do they > > compile, do they work?). > > Could ant call help out here? No extra build.sh or build.bat. >. . . The ant "ant" task can easily call an external build.xml. The "cvs" task allows sources to be checked out (but AFAIK requires command-line CVS to be installed on Windows systems). -Bertrand - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
Re: FOP Servlet, contrib stuff and tutorial
On Tue, 2002-11-26 at 13:53, Jeremias Maerki wrote: > (Warning: this mail starts slowly and is getting mean at the end...) > > Oleg and I wonder what we should do with the fact that the FOP servlet > exists in docs/examples/embedding and contrib/servlet. Joerg seems to > have some ideas about this, so I hope he tells us when he's back from > holidays. But the other's opinion is also wanted here. IMO the servlet > should always be built from the sources now in contrib. The > docs/examples/embedding stuff should be deleted. Joerg thinks > differently, I think. I think there should be a requirement that it compiles and works if it will be distributed. > In the trunk we've also got the plan and MathML goodies. > > I've started a "How to use FOP in Java/Usage patterns" tutorial > yesterday. When finished it will consist of some Java sources, a few XML > files (XMLs, FOs, XSLTs) and documentation in XML format. Great idea! > The question is where's the best location to place all this stuff. It > would be best if we reorganized the directory structure, especially in > the context of moving to forrest. Let's take an inventory: > > - basic documentation/website (maint and trunk) > - FOP servlet > - MathML extension (trunk only) > - Plan extension (trunk only) > - FOP usage tutorial (yet to come) > - FO schema > - FO samples (docs/examples/*) > - Testcases > - Hyphenation source files > - Sample config files > (anything else?) > > Problems that need to be addressed: > - All Java sources need to be checked easily before a release (do they > compile, do they work?). Could ant call help out here? No extra build.sh or build.bat. I'm not sure how/if it can do it but something about calling an external build.xml? > - Helpful information has to be easily found. > - Consistent approach to place files. > > In the past new stuff has been added to the codebase "somehow". This > should be cleaned up, too, while we're cleaning up the documentation. > Of course, that will generate a lot of work and probably some > reshuffling in CVS but will result in a cleaner directory structure. I > volunteer to do this in both the maint and trunk but I will probably > need help with CVS surgery if this is needed. > > IMO the following things should be done: > - move the hyph directory to src/hyph +1 > - move the FO schema to src/foschema +1 > - move src/org to src/java/org +1 > - move conf to src/conf +1 > - move contrib/servlet to examples/servlet > - move contrib/plan to examples/plan > - move contrib/mathml to examples/mathml > - remove docs/examples/embedding > - move docs/examples to examples/fo > - place the tutorial in examples/tutorial or tutorial (don't know yet) So the examples are: tutorials, fo documents, embedding examples and extensions. Sounds clearer to be under: examples/ +1 Another thing I was thinking of. The pdf bookmark extension is a bit confusing being placed in .../fop/extensions/ because it suggests a generic extension which it isn't. The testing will also be needed to move somewhere better I think. It will have code, fo files, other resources and some way of running tests. - To unsubscribe, e-mail: [EMAIL PROTECTED] For additional commands, email: [EMAIL PROTECTED]
