#3 Wiki Help

[JT Moree]

The portal's index.cgi should add wiki help. this way
users can add notes to help themselves or each other.
It's user definable help!!!

might add it into the standard menubar that each app
generates, if they have configured themselves to
support the wiki help feature. This would mean you
would have to potentially start using the prepDoc()
that the Portal
provides or I make the configuration option specify to
display in menu, append to bottom of page or both.

MOST screens in xiwa dont have a portal menu. and are
in a frame set anyway. the wikihelp_tb will include a
toggle for menu vs append to bottom.

Would we want the user comments to always showup or be
toggeable, so that it would say:

<content here>
+ Wiki Help _Add Comment_

And then when you click on it, I display the hidden
divs that contain the user
comments. The _Add Comment_ would be the link to add a
new entry.

Or we could simply have a link to open in a new window.
probably either is fine.

at first it would just be text. no markup. we might
integrate a wiki engine later. for now we just store
the input text in the database for that app.

new table wikihelp_tb
>> app varchar
>> state varchar
>> command varchar
>> menu boolean
>> notes text (defaults to NULL or empty string)

if a record does not exist for given app,state,command
then no Wiki section is appended and No link is
generated. this way the programmer decides which
screens get the option and which dont.

The wiki section would append a textArea with the text
in it. When the user edits it and clicks the Submit
button, they will be warned that the new text will not
show up until they submit that page. then a new window
opens and submits the text.

or we could have a link to a seperate page instead of
appending it. yes i like this better. so simply a <a
>> href="wiki.cgi?app=xiwa&state=Journal&command=edit"
>> target="wikiHelp">Wiki Help</a>
>> would do.

The wiki.cgi would simply retrieve and display and
allow for editing the text.

If I implement this, it will be part of the core Portal
and will hopefully be addable without any major work on
behalf of the App authors. In fact, I might make it on
by default and you have to explicitly disable it.
> I think the programmer should decide based on the
option being in the table or not

Would we want this to fall under the user rights
mechanism, so that a user would have to be granted the
permission or is this something that all users should
always be able to have, as long as they are able to
access the app?

> all users for now

[JT Moree]

Logged In: YES
user_id=236631

no changelog is neccessary. for now this is just a quick
and dirty implementation. we might want to have an extended
online wiki feature which would be hosted on our servers.
then Online WikiHelp would be next to the local one and
people would have to authenticate to post to it. but that
is for much later.