Re: [generguide-devel] External References in Modular Documentation

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

On Monday 13 Oct 2003 6:00 pm, Sean Wheller wrote:
> Each document in the generguide repository is an
> independent document. We can validate it and transform
> it.

I assume you are refering to the generguide/guide docs rather than 
generguide/docs/sdocbook/generguide.xml .


>
> However, if a xref is inserted to a document. That
> document by default required that an element with an
> id corresponding to the linkend of  the xref is
> available in the document. If it is not, then the
> document in invalid.

Yes.  Good point.

>
> How do we propose to handle this in generguide?

Currently, we only have 2 files in generguide/guide/* which use xref.  
netbeans.xml is one of them and references "refactorit".  At the moment, 
netbeans.xml is stored as invalid xml.

This is not ideal because it means that netbeans.xml now depends on 
refactorit.xml to be included, otherwise the resultant documentation will 
have invalid linkends.

I have removed some of the other xlinks we used to have by refering to 
sections by name:  "See the refactoring section for further explaination".  
However, this also is non-ideal.

I suggest for release 0.2, we allow sections with invalid xml to be saved, and 
we revisit this problem in future releases. 

>
> I would use olink, but I think that olink is way to
> complicated for our users. Artur explained that there
> was no specific reason why olink had never been used
> in generguide documents. It was just a case of there
> had never been a requirement.
>
> Now, while building the GenerGuide User Manual I have
> such a requirement, but don't want to induce practices
> that will be a problem for others to manage.
>
> Direction appreciated.
>
> Sean Wheller
>
> __________________________________
> Do you Yahoo!?
> The New Yahoo! Shopping - with improved product search
> http://shopping.yahoo.com
>
>
> -------------------------------------------------------
> This SF.net email is sponsored by: SF.net Giveback Program.
> SourceForge.net hosts over 70,000 Open Source Projects.
> See the people who have HELPED US provide better services:
> Click here: http://sourceforge.net/supporters.php
> _______________________________________________
> generguide-devel mailing list
> gen...@li...
> https://lists.sourceforge.net/lists/listinfo/generguide-devel

-- 
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