Menu
▾
▴
generguide-devel — Discussion for developers of generguide
You can subscribe to this list here.
| 2003 |
Jan
|
Feb
|
Mar
|
Apr
|
May
|
Jun
(33) |
Jul
(21) |
Aug
(20) |
Sep
(80) |
Oct
(62) |
Nov
(8) |
Dec
|
|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 2004 |
Jan
|
Feb
|
Mar
|
Apr
|
May
(1) |
Jun
(4) |
Jul
|
Aug
|
Sep
|
Oct
|
Nov
|
Dec
(2) |
| 2006 |
Jan
|
Feb
|
Mar
(1) |
Apr
|
May
|
Jun
|
Jul
(3) |
Aug
(6) |
Sep
(1) |
Oct
(6) |
Nov
(7) |
Dec
(12) |
| 2007 |
Jan
(9) |
Feb
(12) |
Mar
(1) |
Apr
(4) |
May
(6) |
Jun
(11) |
Jul
(16) |
Aug
(19) |
Sep
|
Oct
|
Nov
|
Dec
|
|
From: John R. <joh...@bi...> - 2003-07-03 12:10:27
|
Artur, It is like this. I have installed cygwin. This installation completed OK, but I cannot tell if ssh and/or cvs client have installed or not. Cameron has advised me I need these to get started. How can I tell, apart from looking at the installation elements selection list. The error message I get when I try to access the source files using the cvs command given to me by Cameron suggests to me (a unix novice) that the cvs client is not installed. The command is: cvs -d :ext:joh...@cv...:/cvsroot/generguide checkout generguide Meanwhile, Cameron has suggested two morecvs clients for me to try. Any ideas?? Cheers John Raper Technical Writer JAR Documentation and Training P/L 9807 6224 0411 863 882 Web: www.lasotell.com.au -----Original Message----- From: Artur Hefczyc [SMTP:ko...@pl...] Sent: Thursday, July 03, 2003 4:58 PM To: gen...@li... Subject: Re: [generguide-devel] Re: Cygwin Install > > You should be able to a graphic attached to this email. > > Sorry, couldn't read it in my linux mail client. > > > It shows in two screen dumps what was installed when I installed cygwin. > > The second screen shows the shells that are installed. > > It does not look like ssh or cvs client is included. > > > > Did you see the message I placed on the forum notice board? > No. > > I just had a quick look on the web. It seems that some of the windows CVS > clients now come with ssh support. Here are 2 which I'd try in the following > order: > > 1. http://www.wincvs.org > 2. http://www.tortoisecvs.org/ Hm, John it looks like you have some problems with CygWin. I use it every day and it seems to me that most problems I was able to solve during last 2 years of use. However I can not participate in your discussion and help you because I don't know what is going on. Please send description of your problems directly to this mailing list or to my private address. Maybe I am able to help. good luck. Artur. -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ ------------------------------------------------------- This SF.Net email sponsored by: Free pre-built ASP.NET sites including Data Reports, E-commerce, Portals, and Forums are available now. Download today and enter to win an XBOX or Visual Studio .NET. http://aspnet.click-url.com/go/psa00100006ave/direct;at.asp_061203_01/01 _______________________________________________ generguide-devel mailing list gen...@li... https://lists.sourceforge.net/lists/listinfo/generguide-devel |
|
From: Artur H. <ko...@pl...> - 2003-07-03 11:05:59
|
> I sent this email to the wrong list. > No wonder Artur has not responded. :) Because he didn't receive that e-mail. :0 I am subscribed to mapbuilder and look in coming posts. Seriously I can't see it anywhere, I started to worry that my mailbox doesn't work correctly. > Anyway, I've gone ahead and updated the bin/build.sh script to convert > commented entities to uncommented entities. Ok, to tell the truth I don't like this however I can't see better solution either. Maybe some day I will be able to convince you to emacs use ;-) > I've created a new file: guide/resources/entities.ent for storing generguide's > entities. Ok, I also expected to do it this way. I was thinking about putting there DTD for our guideconfig.xml file too. (In future of course when you accept my DTD idea proposition.) > Next, I plan to go and remove geotools specific information from the guide. Although my time is shrinking due to comming leave and trip to UK I think I can prepare sed script to automaticaly remove most of GT2 and geotools occurences. Replacement logic could be based on my replacement proposition which was sent to you few weeks (or days) ago. Artur -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ |
|
From: Cameron S. <ca...@sh...> - 2003-07-03 10:33:47
|
Oops, I sent this email to the wrong list. No wonder Artur has not responded. :) Anyway, I've gone ahead and updated the bin/build.sh script to convert commented entities to uncommented entities. I've created a new file: guide/resources/entities.ent for storing generguide's entities. I've also got a response from the XXE team saying that entities and <xi:include> functionality should be supported in next release (before 16 August). I'm not sure if the functionality will be in the free version. Next, I plan to go and remove geotools specific information from the guide. -- 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-07-03 06:56:02
|
> > You should be able to a graphic attached to this email. > > Sorry, couldn't read it in my linux mail client. > > > It shows in two screen dumps what was installed when I installed cygwin. > > The second screen shows the shells that are installed. > > It does not look like ssh or cvs client is included. > > > > Did you see the message I placed on the forum notice board? > No. > > I just had a quick look on the web. It seems that some of the windows CVS > clients now come with ssh support. Here are 2 which I'd try in the following > order: > > 1. http://www.wincvs.org > 2. http://www.tortoisecvs.org/ Hm, John it looks like you have some problems with CygWin. I use it every day and it seems to me that most problems I was able to solve during last 2 years of use. However I can not participate in your discussion and help you because I don't know what is going on. Please send description of your problems directly to this mailing list or to my private address. Maybe I am able to help. good luck. Artur. -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ |
|
From: Cameron S. <ca...@sh...> - 2003-07-02 20:39:52
|
On Wednesday 02 Jul 2003 1:53 pm, John Raper wrote: > Cameron, > You should be able to a graphic attached to this email. Sorry, couldn't read it in my linux mail client. > It shows in two screen dumps what was installed when I installed cygwin. > The second screen shows the shells that are installed. > It does not look like ssh or cvs client is included. > > Did you see the message I placed on the forum notice board? No. I just had a quick look on the web. It seems that some of the windows CVS clients now come with ssh support. Here are 2 which I'd try in the following order: 1. http://www.wincvs.org 2. http://www.tortoisecvs.org/ -- 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: Cameron S. <ca...@sh...> - 2003-07-02 11:08:23
|
On Tuesday 01 Jul 2003 4:21 pm, Artur Hefczyc wrote: > There is file: entitiesuse.xml in our repository. > It describes how to use entities with sample code. > Of course I have checked all code and it works. > (entitiesuse.xml uses entities on itself) Thanks, this works for me. -- Cameron Shorter http://shorter.net/cameron Open Source Developer http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com/ |
|
From: Cameron S. <ca...@sh...> - 2003-07-02 10:54:47
|
On Tuesday 01 Jul 2003 1:31 pm, John Raper wrote: > Cameron, > I persevered and got this far. > The installation of cygwin took a few goes. > I may not have installed the cvs client option as I found the only way to > get the cygwin installation not to hang was to leave the selections at the > default (which I assume was for a full installation). This may mean I > installed none of the options because none were selected. > > The text below is from the cygwin session when I attempted to checkout the > file as you suggested. Some troubleshooting for you. > > JAR@jar-desktop ~ > $ cvs-d:joh...@cv...:/cvsroot/generguidecheckout > generguide BASH: > cvs-d:joh...@cv...:/cvsroot/generguidecheckout: No such > file or directory There are typos above, there should be a SPACE after "cvs" and before "checkout" and between "checkout" and "generguide". One one line, try: cvs -d :joh...@cv...:/cvsroot/generguide checkout generguide I'll write the line again with SPACE to try and avoid any mail formating problems: cvsSPACE-dSPACE:joh...@cv...:/cvsroot/generguideSPACEcheckoutSPACEgenerguide Good luck. -- Cameron Shorter http://shorter.net/cameron Open Source Developer http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com/ |
|
From: Artur H. <ko...@pl...> - 2003-07-01 15:19:50
|
There is file: entitiesuse.xml in our repository. It describes how to use entities with sample code. Of course I have checked all code and it works. (entitiesuse.xml uses entities on itself) Please be patient. I tried to finish it as soon as possible so language used needs serious cleaning. I will do it soon. But now you can use entities according to this guide in your XML documents. I have also put this guide on the net to make it easy reading: http://wttools.sourceforge.net/emacs-stuff/entitiesuse.html Let me know if you find any troubles. Artur -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ |
|
From: Artur H. <ko...@pl...> - 2003-06-30 14:42:03
|
> I have not done it because I have not got to it yet.
> I've just committed all my files into CVS, so if you want to change the files
> now you can.
1. File name extension was changed.
2. Added 'basic.xml' file describing methods and tools for XML
processing (still under construction)
3. Added files:
- entitiesuse.xml (main section file)
- entitiesusedef.ent (external entities definition)
- entxml.xml (external XML file included with use of entity)
describing entities use and processing. (also still under contruction)
it works already as self sample entity use.
Artur
--
Artur Hefczyc
Open Source Developer
http://generguide.sourceforge.net/
http://www.geotools.org/
http://wttools.sourceforge.net/
|
|
From: Cameron S. <ca...@sh...> - 2003-06-30 12:16:44
|
On Monday 30 Jun 2003 1:11 pm, Artur Hefczyc wrote: > As I remember your were convinced to change > files to xml extension. However there are still > sgml files in CVS repository. > > So what is our current policy in this matter? I agree. Lets change move all files from .sgml to .xml . I have not done it because I have not got to it yet. I've just committed all my files into CVS, so if you want to change the files now you can. Cameron |
|
From: Artur H. <ko...@pl...> - 2003-06-30 12:10:23
|
As I remember your were convinced to change files to xml extension. However there are still sgml files in CVS repository. So what is our current policy in this matter? Artur -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ |
|
From: Artur H. <ko...@pl...> - 2003-06-30 10:25:19
|
> You suggested a while back that we use entities for text replacement (which I > agree is a great idea). > Have you looked into it further and got something working? > I unsuccessfully tried getting the generguide/bin/build.sh to build a test > sgml file with entities. I didn't spend much time on it in case you had > already worked out how to do it. I did some small experiments, and it seems to me that it worked as I expected. However the most time I recently spend on it was reading some XML books (only Polish versions). I tried to learn more about entities and DTD. So I think I am much better prepared now in theory. I also found some info that some tools can't work well with entities indeed. So if you are not in a hurry leave this problem for me as task. I try to prepare some sample code today or tomorrow. Artur -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ |
|
From: Cameron S. <ca...@sh...> - 2003-06-30 10:06:00
|
Artur, You suggested a while back that we use entities for text replacement (which I agree is a great idea). Have you looked into it further and got something working? I unsuccessfully tried getting the generguide/bin/build.sh to build a test sgml file with entities. I didn't spend much time on it in case you had already worked out how to do it. -- Cameron Shorter http://shorter.net/cameron Open Source Developer http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com/ |
|
From: Cameron S. <ca...@sh...> - 2003-06-29 11:39:39
|
On Sunday 29 Jun 2003 10:57 am, Jeff Turner wrote: > It's good stuff! Quite an impressive amount of docs when you see it all > split up like that. Thanks, yes. > > I wonder if the Maven people would be interested in including it as a > plugin. They already have some basic project docs included, but nothing > as comprehensive. Yes, I was thinking we should approach maven guys in a month or so. I'd like to polish the text up first. > > Also, it might be worthwhile to have the XML available on the website, as > well as the HTML. Then people can use XInclude to pull relevant bits > into their project, which will always be up-to-date. Yes, that is a good idea. -- Cameron Shorter http://shorter.net/cameron Open Source Developer http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com/ |
|
From: Cameron S. <ca...@sh...> - 2003-06-29 11:33:30
|
On Saturday 28 Jun 2003 10:11 pm, Artur Hefczyc wrote: > -----BEGIN PGP SIGNED MESSAGE----- > Hash: SHA1 > > On Saturday 28 of June 2003 16:35, Cameron Shorter wrote: > > On Friday 27 Jun 2003 3:40 pm, Artur Hefczyc wrote: > > > As I noted google refreshes his data base about twice a week. > > > So it seems to me it would be good to publish all our sections > > > as sample guides on project site. > > > > Yes, it is already part of the site. See links at: > > http://generguide.sourceforge.net/sampleguides.html > > (This guide is a week or 2 old) > > Is this what you are talking about? > > I was thinking about something different. > We have more than 50 SGML files in directory generguide/guide. > I suggest to generate HTML version of all of them and make them > available from project web site. We have the whole guide at: http://generguide.sourceforge.net/developersguide/developersguide.html I think we should try to avoid having more than one copy of the guides on the site otherwise we will confuse readers. We could break html pages into chunks by using the chunks stylesheet. > > I can see 2 benefits: > 1. Someone browsing and reading our project site can think something > like that: > "Interesting project, authors suggest to use their documents as > templates and patterns for my project developers guide. Ok, I would > like to see first, what parts I can use for my guide and than maybe > I will try to use it." > So giving easy access to HTML version we can improve chance > that someone start to use it. > It seems to me giving full sample guide (GeoTools) is not exactly the same. > > I have also another idea what is next step after above. If you agree for > such move I would like to create page containing list of all sections > places in following HTML form: > input1: "Project name" > input2: "Project site" > input3: "Project developer" > list of checkboxes for each available section (each section name is URL to > section text): > x - cvs > x - ant > x - doc license > x - design > x - coding conventions > <submit> > After user fill form and click <submit> button, sample developers guide > should be generated. I think it should not be very difficult to set it up > on SF site as cgi script. I love this idea!!! Maybe from the form, we can create links to the generic developers guide. It will be made slightly complicated by having selectable sections within sections. Eg: x Communication x IRC o email Actually, I wonder whether we could automate building the form by running a style sheet over the developer's guide and extracting editable sections? Also, on the form, put a [View] button next to each section which would call a cgi script which builds the section in real time: Eg: x Communication [View] x IRC [View] o email [View] In above example, email is not selected, so when View Communication is selected the Communication section is shown IRC but not email sections. > > 2. Our documents describe many aspects of software development. > If we present them on project site, google will index them in it's DB. > So I expect people looking for particular development information can > find our project site much easier. The more they can not only learn > something about subject they are interested in at the moment of reading > but also they can find our project interesting for different purposes than > just source of information. Yes, isn't this what the following URL is giving us? http://generguide.sourceforge.net/developersguide/developersguide.html > > I did some experiment in few last weeks. I put some pages (I wrote earlier) > about emacs, jdee and xml on my home machine and pointed to them > from wttools project site. > I have been watching logs about pages visit. Most of visitors were > directed to my machine from Google as response to query containing > for example: "emacs xml" or "dtd xml". Yes, maybe we need to put some references to generguide in prominent places on the web. -- Cameron Shorter http://shorter.net/cameron Open Source Developer http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com/ |
|
From: Artur H. <ko...@pl...> - 2003-06-28 21:11:23
|
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 On Saturday 28 of June 2003 16:35, Cameron Shorter wrote: > On Friday 27 Jun 2003 3:40 pm, Artur Hefczyc wrote: > > As I noted google refreshes his data base about twice a week. > > So it seems to me it would be good to publish all our sections > > as sample guides on project site. > Yes, it is already part of the site. See links at: > http://generguide.sourceforge.net/sampleguides.html > (This guide is a week or 2 old) > Is this what you are talking about? I was thinking about something different. We have more than 50 SGML files in directory generguide/guide. I suggest to generate HTML version of all of them and make them available from project web site. I can see 2 benefits: 1. Someone browsing and reading our project site can think something like that: "Interesting project, authors suggest to use their documents as templates and patterns for my project developers guide. Ok, I would like to see first, what parts I can use for my guide and than maybe I will try to use it." So giving easy access to HTML version we can improve chance that someone start to use it. It seems to me giving full sample guide (GeoTools) is not exactly the same. I have also another idea what is next step after above. If you agree for such move I would like to create page containing list of all sections places in following HTML form: input1: "Project name" input2: "Project site" input3: "Project developer" list of checkboxes for each available section (each section name is URL to section text): x - cvs x - ant x - doc license x - design x - coding conventions <submit> After user fill form and click <submit> button, sample developers guide should be generated. I think it should not be very difficult to set it up on SF site as cgi script. 2. Our documents describe many aspects of software development. If we present them on project site, google will index them in it's DB. So I expect people looking for particular development information can find our project site much easier. The more they can not only learn something about subject they are interested in at the moment of reading but also they can find our project interesting for different purposes than just source of information. I did some experiment in few last weeks. I put some pages (I wrote earlier) about emacs, jdee and xml on my home machine and pointed to them from wttools project site. I have been watching logs about pages visit. Most of visitors were directed to my machine from Google as response to query containing for example: "emacs xml" or "dtd xml". Artur - -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.2 (GNU/Linux) iD8DBQE+/gR10/6x1bjSKPkRAj/QAJ9oruVtKYyOTL5vj5j6rZme86gqzACfeobx nfxiDwczyxntfCl664BIw9I= =jySp -----END PGP SIGNATURE----- |
|
From: Cameron S. <ca...@sh...> - 2003-06-28 05:37:42
|
On Friday 27 Jun 2003 3:40 pm, Artur Hefczyc wrote: > As I noted google refreshes his data base about twice a week. > So it seems to me it would be good to publish all our sections > as sample guides on project site. Yes, it is already part of the site. See links at: http://generguide.sourceforge.net/sampleguides.html (This guide is a week or 2 old) Is this what you are talking about? -- Cameron Shorter http://shorter.net/cameron Open Source Developer http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com/ |
|
From: Artur H. <ko...@pl...> - 2003-06-27 14:39:26
|
As I noted google refreshes his data base about twice a week. So it seems to me it would be good to publish all our sections as sample guides on project site. I don't see any good place for this yet. But I think it could be also good for receiving feedbacks from visitors if they could see our documents without installing all stuff. Artur -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ |
|
From: Cameron S. <ca...@sh...> - 2003-06-25 12:26:27
|
On Saturday 21 Jun 2003 10:23 pm, Artur Hefczyc wrote: > I have walked through file sources and tried to analyse > different kind of 'geotools' occurrence. > I attached file with samples and my proposition > for translating from existing text to tagret, project independent > format. Yes, I like your suggested transforms. Very minor comments attached. I assume that we can handle these using entities. -- Cameron Shorter http://shorter.net/cameron Open Source Developer http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com/ |
|
From: Cameron S. <ca...@sh...> - 2003-06-25 12:26:27
|
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. |
|
From: Artur H. <ko...@pl...> - 2003-06-25 10:35:01
|
> John is a tech writer who works with me. He is new to open source, CVS, ssh, > docbook etc. Just the sort of person who is likely to write sections for > generguide in the future. So hopefully we should be able to find out if what > we write makes sence to our target audience. Great, John welcome. > Once John works out how to install ssh/CVS/XXE on windows, I'm hoping he will > help us clean up our documentation, organise it, and generally make it more > professional. It would be perfect if our docs are enough source of information to setup whole environment. However it is not yet. I use all this stuff in Windows platform too, so if you have any problems let me know through this list. I am sure I can help. And at the end, after you successfully install all necessary tools, I (or someone else) will extract your questions (and answers) from e-mails and correct documentations. good luck Artur -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ |
|
From: Cameron S. <ca...@sh...> - 2003-06-25 10:25:23
|
Hi John, Welcome to the generguide email list. We now have 3 people on this list. Artur, John is a tech writer who works with me. He is new to open source, CVS, ssh, docbook etc. Just the sort of person who is likely to write sections for generguide in the future. So hopefully we should be able to find out if what we write makes sence to our target audience. Once John works out how to install ssh/CVS/XXE on windows, I'm hoping he will help us clean up our documentation, organise it, and generally make it more professional. Is this right John? -- Cameron Shorter http://shorter.net/cameron Open Source Developer http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com/ |
|
From: Artur H. <ko...@pl...> - 2003-06-23 22:26:01
|
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1 - -- Artur Hefczyc Open Source Developer http://generguide.sourceforge.net/ http://www.geotools.org/ http://wttools.sourceforge.net/ -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.2.2 (GNU/Linux) iD8DBQE+935y0/6x1bjSKPkRAoFgAKC7n9tMM6CqyASqlvhOlx01+oeWdwCfQ5aj I5Omj4Qr5HAMTXmR8+3sxJo= =dPHx -----END PGP SIGNATURE----- |
|
From: Artur H. <ko...@pl...> - 2003-06-23 13:07:43
|
> Simple string replacement should be sufficient. I don't think we need worry
> about looping.
> Keeping it simple will make the project more usable by others.
Yes, ok, when I talked about loops I was thinking about accessing
multiple elements for example, lets assume we have custom project which
has part of configuration as follows:
<project>
<name>
<unix>generguide</unix>
<short>Generic Guides</short>
<full>Generic Software Developers' Guide</full>
</name>
<site href="http://generguide.sourceforge.net/">Home Site</site>
<site href=http://sourceforge.net/projects/generguide/>Project Management Site</site>
<developers>
<developer>
<name>Cameron Shorter</name>
<role>Manager</role>
<email>ca...@us...</email>
</developer>
<developer>
<name>Artur Hefczyc</name>
<role>Developer</role>
<email>ko...@us...</email>
</developer>
<developer>
<name>Neo</name>
<role>Developer</name>
<email>ne...@us...</email>
</developer>
</developers>
</project>
We can refer easily to each type of project name. Both methods can
be used as well: xinclude with xpointer or simple translation from
entity to character string value.
However use of 'site' configuration is not yet that easy. But probably
possible to accomplish with both methods or at last we can simplify
config file definition without lost functionality.
And than if we want to put list of developers in project document
we have to indicate in generic document where it should be
placed.
We can not accomplish it with <xinclude> tag + xpointer or
something like that because we don't want to have tags from config
file in our document and the more there is no way access multiple elements
from config file. Simple entity use can't help here as well.
If we simplify config file format for defining list of developers we will
lost some functionality.
To solve problem of such case I have following idea:
In generic document we will put entity &developers-list; for example.
Config file can contain developers definition as above.
Config processing tool will extract all elements from config file and create
entities definition with following values:
project-unix-name="generguide"
project-short-name="Generic Guides"
project-full-name="Generic Software Developers' Guide"
project-sites-list=file:/path/to/sites-file.xml
project-developers=file:/path/to/developers-file.xml
and also generate 2 XML files, one for project sites list and second for
sdcobook table containing list of developers.
So we don't lost
1. Simplicity for including project custom data
2. Flexibility for customizing project
> I still think we can use replacement of generic sections with project specific
> sections as well.
This is the main reason to avoid cross-referencing documents.
But if you find it necessary there is something called "olinks". I don't know
exactly how to use it but I have seen some documents on the Internet
explaining it. So you can assign me a task to learn how to do it.
Artur
--
Artur Hefczyc
Open Source Developer
http://www.geotools.org/
http://wttools.sourceforge.net/
|
|
From: Cameron S. <ca...@sh...> - 2003-06-23 11:56:08
|
On Monday 23 Jun 2003 10:12 am, Artur Hefczyc wrote: > What do you think about it? I love the idea of entities. I was thinking about setting up a name/value config file as well, but this sounds better. Simple string replacement should be sufficient. I don't think we need worry about looping. Keeping it simple will make the project more usable by others. > > 2. It seems to me I have found a way to define CSS for our DTD extension. > So probably displaying our DTD tags will be possible on any > WYSIWYG editor. > However with entities concept it is not necessary. > > 3. References between sections (files). Do we need them or should avoid > doing it? There is a way to do it. Not directly with SDocBook use, but with > something like xinclude and additional XML processing tools. Yes, I was planning to keep references between sections. But I realise this is a problem for validating so am interested to hear any better ideas. Maybe we can remove all links and just say "In the Testing/Junit section we discuss this further". I still think we can use replacement of generic sections with project specific sections as well. -- Cameron Shorter http://shorter.net/cameron Open Source Developer http://mapbuilder.sourceforge.net http://geotools.org Senior Software Engineer http://www.adi-limited.com/ |
54 messages has been excluded from this view by a project administrator.
