Current documentation needs to be edited by hand to fix links for including in a release. Some very good documentation that could be included in Releases is held back because of the amount of effort needed to bring documentation up to "release quality." We also lack enough people to perform all the work manually. Even if we did, I'm sure these folks' time is better spent in other ways to TWiki's benefit!

A detailed technical analysis of the problem belongs here too. An example is that Codev.CoreTeam notation is not good when distributing a page to another wiki. TWiki:Codev/CoreTeam needs to be used instead.

Solution:

Create a Perl 5.005 (or above) script to help automate this tedious work.

Result:

Better documentation & more time for fun for documentation writers! This improves the experience of users using TWiki and reduces the need for support. Ultimately this may improve the adoption rate of TWiki and help those who are trying to promote TWiki as an IT & knowledge management solution internal to their organizations.

-- GrantBow - 15 Jan 2003

Could you provide an example of the link fixing you talk about? I don't understand.

-- MattWilkie - 15 Jan 2003

Oops, sorry, I added a TWiki:Codev/CoreTeam example.

-- GrantBow - 15 Jan 2003

Ok, I see what you're getting at (I think) -- you're referring to cases where a link in the distribution package refers to a link on twiki.org and such page is not present (or not up-to-date) in the distribution package.

My point is there are probably some links that need such correction and some that don't, so, if the process is automated, it must deal with both, in other words, have a way of recognizing which should be changed and which should be left as is (to refer to pages in the distribution package).

Or, am I missing something?

-- RandyKramer - 16 Jan 2003

It should be relatively straighforward; the Codev web/zone doesn't exist in the release package so just search for 'Codev.' and replace with 'TWiki:Codev/'. Repeat for any other webs like Support not in the release.

-- MattWilkie - 16 Jan 2003

Wouldn't the above example of TWiki:Codev/CoreTeam be properly written TWiki:Codev.CoreTeam? I think this is a bug, discussed on Plugins.InterwikiPluginDev

-- MartinCleaver - 17 Jan 2003