Menu
▾
▴
generguide-devel
|
From: Artur H. <ko...@pl...> - 2003-08-31 20:36:42
|
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Hi,
I am working (discovering how things work), documenting it and
working again.
I have made some changes, I hope it will not affect you badly.
1. Added support for CATALOGS to generpublish.sh script
(it works if you start it with option '-k')
Internet and especially SF are very weak recently so to process
XML files effectively I need maping DTDs and MODs to my local
file system.
2. Documentation for using xinclude.xsl with java tools has been written.
Description for generating HTML, PDF and other formats has to be
added yet.
3. I have updated xinclude.mod and put it to our web site at address:
http://generguide.sourceforge.net/xinclude/1.0/xinclude.mod
4. Well, the last one, but not the less important. I have changed XML prolog
in all our guides to following form:
<!ENTITY % xinclude
PUBLIC "-//GenerGuide//ELEMENTS XInclude for SDocBook V1.0//EN"
"http://generguide.sourceforge.net/xinclude/1.0/xinclude.mod">
The one, most important consequence is, when you will be processing
documentation xinclude.mod have to be loaded by processing tool.
Because it is located on the web site you should note significant increase
of time necessary for processing.
But benefit is that you don't need to worry about having this file on your
disk in proper location when you are editing XML documentation.
But before you start to hate me for wasting your time with waiting
forever until processing will finish I give you tip how to avoid
downloading xinclude.mod (and sdocbook DTD) each time file is
processed.
1. Set environment variable similar to main below:
export SGML_CATALOG_FILES="/sgml/catalog:/sgml/dtds/sdocbook-1.0/sdocbook.cat"
2. Put attached catalog file in place pointed by above variable and
sdocbook.cat in directory where you have simplified docbook dtd.
(If you have)
3. Look in catalog file and ensure that it points to correct xinclude.mod
location on your HDD.
4. Always start generpublish.sh with '-k' parameter.
Because you usually call xmltools with '--novalid' sdocbook DTD is
not downloaded so, you don't need sdocbook.cat indeed. But in a case
if you would like to validate XML document with them this catalog may help.
For Java tools once more file is needed. The CatalogManager.properties
file works as above environment variable and it has to be somewhere in
directory given as classpath. If you want to use it, look inside and ensure
that 'catalog' property has correct value.
There is document in our guide/ directory describing this matter a little bit
- - basicxml.xml - which is not included in developersguide.
On the other side I saw (and worked according this rule) that you have
added xinclude declaration to all XML files. However it is necessary only
where it is used, so it could be removed in many files what can speed
processing up. (Not too much if you use xinclude.mod from your disk).
It seems to me that I have even sent you description how to set/use
catalogs under xxe.
I hope I didn't forget about anything. If you find something wrong
send me message I will correct it ASAP.
uff....
and still working on this.....
Artur
- --
Artur Hefczyc "Don't change people, just live with them."
Open Source Developer:
http://www.geotools.org/
http://generguide.sourceforge.net/
http://wttools.sourceforge.net/
http://maven-plugins.sourceforge.net/
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.2.2 (GNU/Linux)
iD8DBQE/Ulw10/6x1bjSKPkRAtXRAKDEkMjjQnFoevENMYDrNf6t5STPfQCgqvPF
KVoUURFtXSBeavu8EYR1p7I=
=Asiu
-----END PGP SIGNATURE-----
|
|
From: Cameron S. <ca...@sh...> - 2003-09-01 11:21:23
|
On Monday 01 Sep 2003 6:36 am, Artur Hefczyc wrote: > 1. Added support for CATALOGS to generpublish.sh script > (it works if you start it with option '-k') Should we include CATALOG files into the generguide repository, then generguide.sh can use CATALOGs without needing a user to set them up themselves? Ie, the "generguide -k" option could set the CATALOG variables itself. > 2. Documentation for using xinclude.xsl with java tools has been written. Cool. It is good to get all this information down. I think that it currently contains too much detail and that we need to revisit this and simplify it, possibly by writing wrapper scripts which hide most of the options from the user. > 4. Well, the last one, but not the less important. I have changed XML > prolog in all our guides to following form: > <!ENTITY % xinclude > PUBLIC "-//GenerGuide//ELEMENTS XInclude for SDocBook V1.0//EN" > "http://generguide.sourceforge.net/xinclude/1.0/xinclude.mod"> > > The one, most important consequence is, when you will be processing > documentation xinclude.mod have to be loaded by processing tool. > Because it is located on the web site you should note significant > increase of time necessary for processing. > But benefit is that you don't need to worry about having this file on > your disk in proper location when you are editing XML documentation. > > But before you start to hate me for wasting your time with waiting > forever until processing will finish I give you tip how to avoid > downloading xinclude.mod (and sdocbook DTD) each time file is > processed. > > 1. Set environment variable similar to main below: > export > SGML_CATALOG_FILES="/sgml/catalog:/sgml/dtds/sdocbook-1.0/sdocbook.cat" 2. > Put attached catalog file in place pointed by above variable and > sdocbook.cat in directory where you have simplified docbook dtd. > (If you have) > 3. Look in catalog file and ensure that it points to correct xinclude.mod > location on your HDD. > 4. Always start generpublish.sh with '-k' parameter. As mentioned above, maybe we should wrap above processing into the generguide.sh script. > There is document in our guide/ directory describing this matter a little > bit - - basicxml.xml - which is not included in developersguide. This is good stuff. It would be good to incorporate it into the developers guide. I invisage that we will eventually have one huge repository for all sorts of business processes. From this repository we will build guides that are relevant for the project we are working on. Eg: Java Developers Guide XSL Developers Guide Tips on Buying Property How to write a newspaper and so on. > > On the other side I saw (and worked according this rule) that you have > added xinclude declaration to all XML files. However it is necessary only > where it is used, so it could be removed in many files what can speed > processing up. (Not too much if you use xinclude.mod from your disk). OK, good idea. > > It seems to me that I have even sent you description how to set/use > catalogs under xxe. Yes, however I still have not been bothered setting it up. I'm yet to be bothered by not having it. I know you keep trying to convert me. :) -- Cameron Shorter http://cameron.shorter.net Open Source Developer http://generguide.sourceforge.net http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com |
|
From: Artur H. <ko...@pl...> - 2003-09-01 12:30:09
|
> On Monday 01 Sep 2003 6:36 am, Artur Hefczyc wrote: > > 1. Added support for CATALOGS to generpublish.sh script > > (it works if you start it with option '-k') > Should we include CATALOG files into the generguide repository, then > generguide.sh can use CATALOGs without needing a user to set them up > themselves? > Ie, the "generguide -k" option could set the CATALOG variables itself. Yes, it is good idea, however while I can know the place where xinclude.mod file is located (in our generguide project directory tree), I can't guess location of sdocbook.dtd (and other used DTDs) on user machine unless we add them to project directory tree (but I don't like this). So I will try to add today CATALOGS support for xinclude.mod only. > > 2. Documentation for using xinclude.xsl with java tools has been written. > Cool. It is good to get all this information down. I think that it currently > contains too much detail and that we need to revisit this and simplify it, > possibly by writing wrapper scripts which hide most of the options from the > user. Yes, you are right. It was my concern too. However some details are hard to find and it is good to have them documented somewhere. That was reason I was thinking where to put this info. documentation.xml seems to describe problems on higher level. So I think I can rewrite this section and omit technical details and move them to separate file. There is similar problem with entities, however they are described in separate file which don't have to be included in documents which don't require such technical info. Is this ok for you? > This is good stuff. It would be good to incorporate it into the developers > guide. > I invisage that we will eventually have one huge repository for all sorts of > business processes. From this repository we will build guides that are > relevant for the project we are working on. > Eg: Java Developers Guide > XSL Developers Guide > Tips on Buying Property > How to write a newspaper Yes, this is one of my expectations with this project. So I try to collect whole knowledge I have or can find, describe it as detaily as possible for further use. > > On the other side I saw (and worked according this rule) that you have > > added xinclude declaration to all XML files. However it is necessary only > > where it is used, so it could be removed in many files what can speed > > processing up. (Not too much if you use xinclude.mod from your disk). > OK, good idea. Is that mean I can remove <xinclude> declarations from files where it is not used? Or you want it to have common header in all files? > > It seems to me that I have even sent you description how to set/use > > catalogs under xxe. > Yes, however I still have not been bothered setting it up. I'm yet to be > bothered by not having it. I know you keep trying to convert me. :) Oh, no! :) I don't, however I was afraid because of changes I made you start to wait for processing XML files more time than you work on them. Artur -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ http://maven-plugins.sourceforge.net/ |
×
Want the latest updates on software, tech news, and AI?
Get latest updates about software, tech news, and AI from SourceForge directly in your inbox once a month.
Thanks for helping keep SourceForge clean.
X