|
| Summary: | [Chameleon-Documentation]Documentation should not refer to a script file to find information | ||
|---|---|---|---|
| Product: | Chameleon | Reporter: | Normand Savard <nsavard@mapgears.com> |
| Component: | Documentation | Assignee: | chameleon-dev <chameleon-dev@lists.maptools.org> |
| Status: | RESOLVED FIXED | ||
| Severity: | normal | ||
| Priority: | P2 | ||
| Version: | 1.99 | ||
| Target Milestone: | 2.0 Final | ||
| Hardware: | PC | ||
| OS: | Linux | ||
| URL: | http://dev1.dmsolutions.ca/gommap/docs/gommap_widget_reference.html#sharedresource | ||
| Whiteboard: | |||
Changed Target to 1.99 Final.
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.
done in documentation.
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."