[Poll] How should the QML elements page be presented?
-
We used to have a table of the main QML elements, with links to the documentation, grouped by main use case - which presented elements on a single page. Currently we have a vertical list of elements and description over a few pages, grouped by use-case, and also an alphabetically grouped view. Which one would you prefer to be the default one in http://doc.qt.nokia.com/4.7-snapshot/qdeclarativeelements.html?
-
http://chaos.troll.no/~hhartz/qmlelements.png is a snapshot of how the "Table of use-cases" was arranged. Attached as this is the only one not present in the current documentation.
-
Would be nice to have all of them, and an option to select which way you want the page presented.
-
[quote author="Henrik Hartz" date="1291981348"]http://chaos.troll.no/~hhartz/qmlelements.png is a snapshot of how the "Table of use-cases" was arranged. Attached as this is the only one not present in the current documentation.[/quote]
+1 This looks better.
-
I think both should be implemented. For newbies use-case view is better, but for more experienced developers alphabetical list is much more useful (they know what they look for and can find it in sorted list much faster than in use-cased list)
-
To me, the alphabetically sorted list is pretty useless, since it will become longer and longer, and I'm too used to press ctrl+f to search in it anyway, so I don't use the sorting at all (why sort when you can search? :) ).
The vertical list is easier to read for me, and when I search is easier to find the highlighted piece.
-
Yes i prefer alphabetic too, have seen many times same element that could fit in more than one use case ... the tutorials anyway cover the use cases best and is good for newbies
-
Should the same strategy be applied to the regular classes as well?
-
I tend to prefer the "table of use cases". I'm usually at the documentation outside of Qt Creator because I'm trying to find things I think exist, but don't necessarily know the name of but I know associated classes. Things like trying to find the exact name of one of the *Animations are rather annoying to find since you have to scan the entire list without groupings.
I know there's currently a set of "grouped by use cases" pages, but the links to them are all linked off a main page rather then having all the groupings on a single page. Making it impossible to quickly find what you're looking for since you have to know what group it's in (rather then just looking over the page for similarly named items), and there's the annoying click->loadwait->back->click cycle if it's not what you're after.
-
[quote author="Denis Kormalev" date="1291991675"]I think both should be implemented. For newbies use-case view is better, but for more experienced developers alphabetical list is much more useful (they know what they look for and can find it in sorted list much faster than in use-cased list)[/quote]
I agree. Ideally both of them.