Opened 9 years ago

Closed 9 years ago

#11377 closed defect (fixed)

Tree documentation problemns

Reported by: JIm Fulton Owned by: Tom Trenka
Priority: high Milestone: 1.6
Component: Documentation Version: 1.4.0
Keywords: Cc:
Blocked By: Blocking:

Description

In learning about trees yesterday, I was frustrated by a couple of pretty significant documentation issues:

  1. The jsdoc link for Tree points to http://dojotoolkit.org/api/dijit/Tree.html which looks like it wants to be http://dojotoolkit.org/api/dijit/tree.html (which returns a 404) and, in any case, contains nothing useful.

There look to be useful jsdoc comments in the source, but they're painful to use.

  1. The examples in the guide:

http://dojotoolkit.org/reference-guide/dijit/Tree.html#dijit-tree

Don't work. This is because the links to the json data they use is broken. The prose is indecipherable without the data. I eventually found the data in a dojo release, but that was more work than it should have been.

  1. I found

http://download.dojotoolkit.org/release-1.4.3/dojo-release-1.4.0-docs.tar.gz

I was hopeful that I could arrange to make the json links work with the downloaded docs, however, unlike the on-line docs, the downloaded docs use absolute (server) paths for the json names, which seems to defeat using file URLs to access the examples.

I think problems 1 and 2 should be pretty easy to fix and would make it much easier for people to learn about trees.

Change History (5)

comment:1 Changed 9 years ago by Tom Trenka

For now, you can try the jsdocs at:

http://api-staging.dojotoolkit.org

Use the tree nav (no pun intended) to get your docs on dijit.Tree.

comment:2 Changed 9 years ago by dante

Milestone: tbd1.6

i've fixed 2) locally fwiw as part of the doc press.

The other issue of dijit/tree and dijit/Tree is solved by running the export on a non-ms machine.

comment:3 Changed 9 years ago by dante

Owner: set to dante
Status: newassigned

comment:4 Changed 9 years ago by dante

Owner: changed from dante to Tom Trenka
Status: assignednew

this is fixed on dtk.org, except the API. punting to tom to ensure that happens.

comment:5 Changed 9 years ago by Tom Trenka

Resolution: fixed
Status: newclosed

Looked fixed to me on DTK.

Note: See TracTickets for help on using tickets.