Bug 650 - [Chameleon-Documentation]Documentation should not refer to a script file to find information
: [Chameleon-Documentation]Documentation should not refer to a script file to f...
Status: RESOLVED FIXED
: Chameleon
Documentation
: 1.99
: PC Linux
: P2 normal
: 2.0 Final
Assigned To:
: http://dev1.dmsolutions.ca/gommap/doc...
:
:
:
:
  Show dependency treegraph
 
Reported: 2004-08-26 16:12 by
Modified: 2005-01-11 10:56 (History)


Attachments


Note

You need to log in before you can comment on or make changes to this bug.


Description From 2004-08-26 16:12:47
Documentation should not refer to a script file to find information as for the
"Sharedresource" widget, the "enableJS" attribute (see below).  Information
should be extracted for users and written in this document.  To find the page
see the URL above.

"ENABLEJS
    Type: Widget Only
    Options: "[TRUE|FALSE]", "FALSE"

Enable outputting of the values in this sharedresource as a javascript
sharedresource. There are strict formatting rules for maszContents in order to
use ENABLEJS. Please see comments in SharedResource.widget.php for formatting
rules."
------- Comment #1 From 2004-09-03 13:36:14 -------
Changed Target to 1.99 Final.
------- Comment #2 From 2004-11-03 09:41:17 -------
Actually, I would rather see this wording changed so that it is not necessary to
move the comments from the code into the documentation.  The comments in the
code are very specifically targetted at widget developers, not application
developers.  The requirement to set enablejs="true" is actually only for a
couple of widgets (JSTreeView and JSList).  We should state something like:

Enables outputting the values in this sharedresource as a javascript
sharedresource.  This is required only for specific widgets, and the
documentation for those widgets will clearly specify that you need to set this
value to true.  If unsure, set this to false or remove it altogether.
------- Comment #3 From 2005-01-11 10:56:40 -------
done in documentation.