[dev] wiki as help

[Duck]

On Thursday 07 August 2008 06:46:11 Chuck Hagenbuch wrote:
> Quoting duck at obala.net:
> > I did a basic render and used Turba's help.xml as an example:
> > http://bugs.horde.org/ticket/7154. With it, we can manage the help
> > content online and update help files in the release process. We can
> > even distribute
> > help as html or text format someone would like to. But I will like
> > to see an configuration option to use a local help file or to link
> > to a desired wiki.
>
> This seems like a better direction to go than the help.xml files; I
> think bundling a static HTML version of the help with the app makes
> sense also, since the current XML format gives us pretty much no
> benefit except for the crude searching - how would we do search with
> this?
>
> On the other end, I guess we'd need an organizational standard for
> naming translations of the help docs, and version numbers. How do you
> suggest we deal with translations? Now at least we have the ability to
> make sure that an untranslated version of each help "item" is present.

I don't know all about naming wiki pages logic but, I purpose to create help 
pages like project pages appended with some special keywords like:
/Help – ex: Project/Turba/Help – cotains current help file s content
/FAQ – ex: Project/Turba/FAQ – conatins frequntly asked questions
/Api – ex: Project/Turba/Api – conatins reflactor rendered API definitions

Than we create another special block like „[[toc]]“ named „[[langs]]“ to show 
avaiable transations. It shod sccan the DB for pages called PagenameXxYx where 
XxYy are a locales defined in nls.php. For example Project/Turba/HelpSlSI or 
Project/Turba/HelpItIT …. If a requested locale page is not found, we should 
allow a user to add create a such page and of course to show him the available 
locales.
For API versions we can create subpages like /Api/Version (ex 
Project/Turba/Api/32cvs) and leave the main API page (probably a special page) 
to just show a list of available versions and to advertise the version is 
currently installed.

Duck