History | Log In     View a printable version of the current page.  
Issue Details (XML | Word | Printable)

Key: LPP-5140
Type: Bug Bug
Status: Resolved Resolved
Resolution: Fixed
Priority: P1 P1
Assignee: Benjamin Shine
Reporter: Bruce Cummins
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
OpenLaszlo

<attribute> 4.1 doc issues

Created: 21/Nov/07 02:28 PM   Updated: 26/Nov/07 05:29 PM
Component/s: Documentation
Affects Version/s: Cranberry
Fix Version/s: RingDingTools (4.1 Ref Guide + Tools)

Time Tracking:
Not Specified

Severity: Minor
Runtime: N/A
Fix in hand: False


 Description  « Hide
Comparing the 4.1 doc to the 3.4 documentation for the <attribute> tag:

* At the top of the page, on the right hand side, the word Extends is floating in space.
* The canvas is much shorter than the canvas in 3.4.
* Tag references aren't enclosed in angle brackets.
* Tag references aren't links.
* Guide link (now Developers Guide link) is missing the sub-link:
lps3: http://www.openlaszlo.org/lps3/docs/guide/methods-events-attributes.html#methods-events-attributes.attribute-tag
lps4: http://labs.openlaszlo.org/trunk-nightly/docs/developers/methods-events-attributes.html
* All the attributes are missing. Replaced by an empty Events table.


 All   Comments   Work Log   Change History      Sort Order: Ascending order - Click to sort in descending order
Benjamin Shine - 26/Nov/07 01:12 PM
> At the top of the page, on the right hand side, the word Extends is floating in space.
fix in progress.

> The canvas is much shorter than the canvas in 3.4.
I think this was a bug in 3.4. 3.4 has huge canvases which are mostly empty.

> Tag references aren't enclosed in angle brackets.
> Tag references aren't links.
In docbook, this appears as
 <tagname link="true">class</tagname>
...but I haven't figured out how to format it with the angle brackets.

Benjamin Shine - 26/Nov/07 01:16 PM
> All the attributes are missing. Replaced by an empty Events table.
This is because the info comes out of js2doc as <initargs> but it needs to be <property>s.

Benjamin Shine - 26/Nov/07 05:23 PM
> All the attributes are missing. Replaced by an empty Events table.
Fixed with r7374:
r7374 | ben | 2007-11-26 14:44:27 -0800 (Mon, 26 Nov 2007) | 32 lines

Change 20071126-ben-N by ben@slim.local on 2007-11-26 14:31:58 PST
    in /Users/ben/src/svn/openlaszlo/trunk
    for http://svn.openlaszlo.org/openlaszlo/trunk

Summary: Make attributes appear in reference for core language tags

New Features: In reference, attributes appear for core language tags:
    attribute, handler, import, include, library, method, splash

Bugs Fixed:
    LPP-5153 Refguide: in langref.xml, change <initarg> to <property>
    LPP-5139 RefGuide: event and handler are not meaningfully documented
    LPP-5112 (partial) Compare and repair commonly used tags and classes in 4.1 reference to 3.4 reference

Documentation:
langref.xml describes the core lzx language tags. It used to use the <initarg>
form, but we're no longer using that structure, so the doctools weren't generating
documentation for the attributes of these classes that had been treated as initargs.
This change restructures the js2doc for these classes to produce appropriate
attribute listings in the reference.

Tests:
Notice non-empty attributes list in:
http://localhost:8080/trunk/docs/reference/tag.attribute.html
http://localhost:8080/trunk/docs/reference/tag.handler.html
http://localhost:8080/trunk/docs/reference/tag.import.html
http://localhost:8080/trunk/docs/reference/tag.include.html
http://localhost:8080/trunk/docs/reference/tag.library.html
http://localhost:8080/trunk/docs/reference/tag.method.html
http://localhost:8080/trunk/docs/reference/tag.splash+as2.html

Benjamin Shine - 26/Nov/07 05:26 PM
> Tag references aren't enclosed in angle brackets.
> Tag references aren't links.
Filed separately as LPP-5155.

Benjamin Shine - 26/Nov/07 05:29 PM
> At the top of the page, on the right hand side, the word Extends is floating in space.
Filed as LPP-5156.