Hi All,

I have just discovered that the Wiki allows us to create redirect pages.  I 
can't find this documented in the tigris wiki help, but it does work.  It 
means we can create a page, with only the text:

#REDIRECT <PageName>

...and anyone who loads the page, will automatically be redirected (with an 
appropriate message) to another page defined by PageName.

I also noticed that any words written in CamelCase (i.e. most classes) are 
automatically turned into links on the assumption that these might one day be 
link to real pages.

Perhaps we could use these two things as a big aid to the reader of the 
cookbook. My suggestion is as follows:

a) For each class used in argouml, we create a redirect page, directing the 
reader to the relevant page of the cookbook.  Doing this will automatically 
make every class reference link to the useful documentation describing how 
that class is used.  If the cookbook gets expanded or changed, then we only 
have to change one redirect page per class, to make the class universally 
link to a different page.

b) Alternatively, we could use the same method to link to externally 
generated javadoc documentation for argouml.

I have tried a) out for FigAssociation just as a test, but I'd like to know 
whether people think it is a good idea.:

http://argouml.tigris.org/wiki/FigAssociation

Regards,

Dave

P.S. Just to be clear, I'm not suggesting that we create wiki pages for 
classes which would duplicate the javadoc information.  In fact, we should 
avoid this.

------------------------------------------------------
http://argouml.tigris.org/ds/viewMessage.do?dsForumId=450&dsMessageId=993794

To unsubscribe from this discussion, e-mail: 
[[email protected]].

Reply via email to