First, set off all code visually by placing it within <code> blocks, as in
The cart link should be in the following format:
/cart/add/cart_link_content.
Secondly, the nomenclature used in the help text doesn't match the nomenclature used on /admin/store/settings/cart_links. This creates serious confusion for a new user.
The nomenclature is also inconsistent within the help itself. For example, "product number" could be the SKU number, the node ID, or any other number. I'd stick to using the term "product node id" consistently.
The documentation on the Ubercart site (http://www.ubercart.org/contrib/1427) is also flawed: the sample link (http://livetest.ubercart.org/uc1/cart) produces an error message of "is not a product. Unable to add to cart."
There's no help for cart link product actions, nor a link to them if they're on another page of documentation.
"Track clicks through cart links that specify tracking IDs." sounds like "Allow tracking IDs in cart links". You should have a cross link to the tracking ID help.
Cart links messages should have a numeric key... there's no explanation of the numbering scheme. Is it the product node id?
Cart links restrictions: should they begin with a forward slash? Probably not, but here's your example from the help text:
Example: /cart/add/e-p1_q5-imonday_special?destination=cart
The help text doesn't cover the cart links restrictions or the invalid link redirect page. An example of a cart links restriction would be very helpful.
The help text should give a recommendation for where you;d want to redirect the invalid link.
Comments
Comment #1
modulist commentedIt's not clear in the syntax when you should use a an underscore (_) and when you should use a hyphen (-). If that's explained elsewhere in the Ubercart help, there should be a cross-link to that page.
Comment #2
tr commentedComment #3
xibun commentedspecifically an example for text fields would also be appreciated.
Comment #4
univate commentedWhat would be rather simple and useful to build is a cart_link builder:
ie: a form that allows you to
* select a product
* select attributes/options
* select quantity
* any other flags like the empty cart option
And it spits out a link.
Sure would be easier then trying to work out the ids of your various products/attributes (I do know you can have ubercart spit out the links when you add them to a cart but its not that intuitiveness to end users).
Comment #5
rsbecker commentedI just installed ubercart 6.x.2.3 and for the first time see the following:
Ajax Cart driven cart links
For use with Ajax Cart add class ajax-cart-link to links.
What does this mean? How do i add this class, and where?
Comment #6
tr commented@rsbecker: Your question has nothing to do with the topic of this thread. In the future, please open a new thread if you have a new problem. That message looks like it comes from the contributed Ajax Cart module. It is definitely not generated by Ubercart core. When making a bug report it is usually helpful if you list what contributed modules you're using and make an attempt to isolate the bug to one of those modules by turning them off and seeing if you still have the problem.
Comment #7
rsbecker commentedWith all due respect, the title of the topic is improvements to instructional text for the cart links API, and the message I got appears at the top of the Cart Links Settings page, not in the Ajax Cart settings page. The user has no way of knowing whether that message was generated by Ubercart core or the Ajax Cart module. It is not a bug, and I am not reporting a bug. This essentially is a support request for clarification of the documentation and, I think, this is the appropriate place to ask the question.
I do think it is, as the thread discusses, a problem of nomenclature, although you and I may disagree about what part of the nomenclauture is the subject of the thread.
The problem I have is with the concept of classes in the Cart Links API. The only place in Ubercart I can see where you explicitly can set classes and then add items to a class is for products. It appears that classes are created in the Cart Links API as a means of grouping predicates, but you don't create the group and then add the predicates. Instead, you create a predicate and assign it a group name.
The message about creating a class for the Ajax Cart Link does not make sense. That may be the fault of the Ajax Cart developers. But the bigger issue is that although the cart links instructional text explains how to create an individual link it does not explain anything about how or why you would group them to accomplish multiple tasks or how you would decide the order in which tasks are performed.
Your response to me reflects the view that "we're all developers and we know those things." I am not a developer, although by now I'm a pretty sophisticated end user. I don't know those things and I believe documentation should address the issue I'm raising. Quite frankly, the documentation for the Cart Links API left me totally confused.
Comment #8
univate commented@rsbecker - the correct place for support with ubercart is actually on the ubercart.org forums. The maintainers of this module have asked to keep this issue queue focuses on development issues (bugs and feature development).
Of course if you are making a suggestion on improving the cart links documentation/instructions which is this issue then thats a different matter.
Comment #9
rsbecker commentedThen please consider my post a suggestion.
Comment #10
tr commented@rsbecker: You're missing the point - your "suggestion" has nothing to do with Ubercart - your issue is with the Ajax Cart module and needs to be addressed in the issue queue for that module. Any suggestions you make here about a non-Ubercart module will be ignored because the Ubercart maintainers and the Ajax Cart maintainers are not the same people.
Regardless, this has nothing to do with a "we're all developers and we know those things" attitude and everything to do with how to make a good bug report. In particular, we expect you to make some effort to determine where the problem lies BEFORE you post. So like I said in #6, disabling modules other than Ubercart to see if the problem goes away would be a good first step before you report the issue to the Ubercart issue queue.
Although you say "The user has no way of knowing whether that message was generated by Ubercart core or the Ajax Cart module", it's clear to me that you *should* have at least strongly suspected that the Ajax Cart module was the most likely culprit. After all, YOU are the one who had to find, download, install, and enable the "Ajax Driven Cart" module, so when you see a message about "Ajax Cart driven cart links" I would expect that to ring a bell.
Much of your post in #7 is highly confusing - Cart Links have no concept of classes or predicates or multiple tasks or order of tasks or group names - it sounds like perhaps you're talking about Conditional Actions. And again - those sorts of issues are not relevant to this thread, so if you have further questions along those lines please take them to ubercart.org like @univate suggested.
Comment #11
tr commentedCart links help page and tests have been substantially improved in both the 6.x-2.x branch and the 7.x-3.x branch. If you have further specific requests for improvement please submit them in the form of a patch in a new issue.