Re: [generguide-devel] Some thoughts

[Cameron S. <ca...@sh...>]

On Saturday 21 Jun 2003 12:08 am, Artur Hefczyc wrote:
> -----BEGIN PGP SIGNED MESSAGE-----
> Hash: SHA1
>
> I am working on sgml files and I would like to share some
> thoughts about it:
>
> 1. It would be good to have some tool for automatic formating xml code
> (something like jalopy for Java). I have such functionality in emacs but it
> is not perfect, particulary, it tries to format 'programlisting' content.

Yes, I've been meaning to try and find one for vim.

> 2. We can use short version of xinclude tag:
> <xi:include
> 	href="file.sgml"
> 	xmlns:xi="http://www.w3.org/2001/XInclude"/>
> instead of:
> <xi:include
> 	href="file.sgml"
> 	xmlns:xi="http://www.w3.org/2001/XInclude">
> </xi:include>

Sure, I'm not fussed either way.

> 3. I also added something like comment string at the end of
> each sgml file. Please don't remove it. I need it to properly
> operate on this files under emacs. I realize that it is my own
> tool dependend and it shouldn't be there, however I will remove
> it later after I finish all manual processing on them.

OK.  I was wondering what these comments were.

>
> 4. There are something like this:
> <programlisting>cd $GEOTOOLS_HOME/geotools2
> maven build</programlisting>
> in maven.sgml file. $GEOTOOLS_HOME variable is undefined
> in document, and so more it looks like it's use in not valid.
> It seems to me $GEOTOOLS_HOME should be replaced with something
> like $PROJECTS_HOME

Fair enough.  This is probably something were we can replace with an &Entity;

>
> 5. In many examples where paths to files are used sometimes '\' is
> used as file separator and sometimes '/'. I suggest to use only one
> variant: '/' - this char is properly understood by almost all systems:
> unix like, java and event recent Windows systems.

Yes, good idea.

>
> I am working on removing GeoTools and GT2 from documents.
> It is not that easy as I have thought before. They exist in many different
> contexts and I want to make smart replacement.
> More details I will send probably in about 10-12 hours. I need a little
> sleep ;)

:)

>
> I have added DTD prolog to each file and made some reformating
> of XML code.

ok.