28 replies [Last post]
Qlaras's picture
Offline
Joined: 09/26/2011
Juice: 11
Was this information Helpful?

I know that the Downloads page says that documentation for 3.0 will be created once it is out of beta, but I'm wondering if this is being worked on at all or not - even if in beta (or even alpha) form itself.

I'm just starting out on Drupal, and running Drupal 7 w/Ubercart 3.x - so running without documentation at all is frustrating, but Drupal 7 has enough features that I want to take advantage of, sticking with the older version isn't worth it for me.

Thanks!

longwave's picture
Offline
Joined: 09/20/2008
Juice: 630
Re: Ubercart 3.x Documentation?

Most of the 2.x documentation will apply to 3.x, if you have a specific question you can always use the forums if you can't figure it out yourself.

--
These forums are for general support questions about Ubercart.
Bug reports and feature requests should be posted at http://drupal.org/project/issues/ubercart
Latest API documentation can be found at http://api.ubercart.me/

DCWD's picture
Offline
Joined: 12/29/2011
Juice: 8
Frustrating

Hi,

I am also using Ubercart 3.x on Drupal 7 and am finding that, 1 the documentation is slightly out of date, and 2 nothing is covered in any decent detail, it's all just a very basic quick overview. Also the Demo page just doesn't seem to exist anymore. I'm have a pretty short deadline on a pretty large project, I gave myself plenty of time to learn to use Ubercart but am finding it quite difficult to get my head around. Is there any chance of the documentation for 3.x being released any time soon?

DanLanglois's picture
Offline
Joined: 01/10/2012
Juice: 48
3.x docs

I'm going to take a stab at this now/here. I think that a logical place to start w/3.x documentation is an Ubercart Hook Index.
Here, from old docs, is a 1.x Hook Index.

hook_add_to_cart
Allows modules to perform an action when an item is being added to the cart and stop the action from occurring if need be.

hook_add_to_cart_data
Allows modules to copy extra data for a product when it is added to the cart.

hook_cart_item
Act on items added to a customer's shopping cart.

hook_cart_pane
Add information to the cart view screen.

hook_checkout_pane
Define panes used in the checkout process.

hook_download_authorize
Define additional checks before allowing a customer to download a file.

hook_file_action
Create new actions to operate on files found in the file downloads directory.

hook_file_transfer_alter
Alter a file before a customer downloads it.

hook_line_item
Define order line items displayed on cart and order screens.

hook_order
Execute code when Übercart loads, saves, or acts on an order.

hook_order_pane
Define panes used on the order screens to display and edit orders.

hook_payment_gateway
Define payment gateways used to process payments.

hook_payment_method
Define methods customers can use to pay for orders.

hook_shipping_method
Define methods to receive shipping quotes and fulfill orders.

hook_shipping_type
Define product shipping types so they may be shipped.

hook_store_status
Add items to the store status table on the main store administration screen.

hook_uc_message
Provide default messages for long configurable messages in your module.

These can all be linked to the API Documentation Index--the pages exist. However,
most of these hooks are not in 3.x.

I'm going to take a stab at this now/here. I think that a logical place to start w/3.x documentation is a Ubercart Hook Index.
Here, from old docs, is a 1.x Hook Index.

hook_add_to_cart
Allows modules to perform an action when an item is being added to the cart and stop the action from occurring if need be.

hook_add_to_cart_data
Allows modules to copy extra data for a product when it is added to the cart.

hook_cart_item
Act on items added to a customer's shopping cart.

hook_cart_pane
Add information to the cart view screen.

hook_checkout_pane
Define panes used in the checkout process.

hook_download_authorize
Define additional checks before allowing a customer to download a file.

hook_file_action
Create new actions to operate on files found in the file downloads directory.

hook_file_transfer_alter
Alter a file before a customer downloads it.

hook_line_item
Define order line items displayed on cart and order screens.

hook_order
Execute code when Übercart loads, saves, or acts on an order.

hook_order_pane
Define panes used on the order screens to display and edit orders.

hook_payment_gateway
Define payment gateways used to process payments.

hook_payment_method
Define methods customers can use to pay for orders.

hook_shipping_method
Define methods to receive shipping quotes and fulfill orders.

hook_shipping_type
Define product shipping types so they may be shipped.

hook_store_status
Add items to the store status table on the main store administration screen.

hook_uc_message
Provide default messages for long configurable messages in your module.

These can all be linked to the API Documentation Index--the pages exist. However, most of these hooks are not in 3.x, I take it that this is largely because the names have been changed. For example, there is no longer a hook_shipping_method, although there is a uc_shipping_method. I see this hook being invoked by uc_shipping.module 3.x. I haven't found a hook_shipping_type being invoked in 3.x. hook_shipping_method was invoked in uc_quote.module, under shipping, in 2.x. But still no hook_shipping_type being invoked, that I've found. But it's invoked by uc_quote_module, under shipping, in 1.x. I expected to find something about hook_shipping_type at http://www.ubercart.org/docs/developer/6866/converting_modules_ubercart_..., but I'm still looking for any mention of what happened to it. I haven't looked in the right place, I suppose. I suppose this exercise, is not about shipping, but let's start somewhere. Silly question, is it possible for me to generate documentation from the modules? I mean, I think there is automation for this, but I'm kind of new to this particular environment. Also, I'm not cross-referencing w/the help docs that the ubercart module installs. In any case, I started with the idea of updating a hook index. I take this to be starting small. btw, http://api.ubercart.org/ is down?

DanLanglois's picture
Offline
Joined: 01/10/2012
Juice: 48
api docs

When I generate docs w/doxygen, they look like this:

http://ubercartdocs.comyr.com/doxygenUbercartdocs/html/modules.html

Click on modules-->hooks to see function documentation, for example.

DanLanglois's picture
Offline
Joined: 01/10/2012
Juice: 48
Edit docs

I notice the 'revisions' tab on http://www.ubercart.org/docs. What has happened w/this page since July 2011, therefore turns out to be..quantifiable. And the previous edit, February 2010. How about adding an edit tab to much of the documentation, maybe the ability to add a child page, too.

TR
TR's picture
Offline
Bug FinderFAQ ModeratorGetting busy with the Ubercode.
Joined: 11/05/2007
Juice: 3266
Re: Edit docs

You may edit and add documentation to http://drupal.org/documentation/modules/ubercart

<tr>.
DanLanglois's picture
Offline
Joined: 01/10/2012
Juice: 48
Re: Re: Edit docs

Thanks, though I note that in fact, the Read documentation link on http://drupal.org/project/ubercart points to ubercart.org, and might better point to the community documentation page. Which also, probably doesn't need a link to API documentation. Although, it has one. but, that link is wrong it points to:
API documentation: http://api.ubercart.me/

..which is not Ubercart API documentation but a copy of the Drupal developer's API reference. Which I suppose that I could fix, but I'm going to sit on my hands and think about my next move. I've never made a Drupal full project, maybe an ubercart quickstart? Smiling

longwave's picture
Offline
Joined: 09/20/2008
Juice: 630
Re: Re: Re: Edit docs

api.ubercart.me contains all available Drupal and Ubercart API documentation, for example see http://api.ubercart.me/api/drupal/drupal--includes--module.inc/group/hoo... which lists all the Drupal and Ubercart hooks.

--
These forums are for general support questions about Ubercart.
Bug reports and feature requests should be posted at http://drupal.org/project/issues/ubercart
Latest API documentation can be found at http://api.ubercart.me/

a.Knutson's picture
Offline
Administrator
Joined: 11/22/2011
Juice: 477
Re: Re: Re: Re: Edit docs

I've updated our API link to point to http://api.ubercart.me. Great resource!

a.Knutson's picture
Offline
Administrator
Joined: 11/22/2011
Juice: 477
Re: api docs

Looks like that link doesn't point to the right URL DanLanglois. Might want to check it.

DanLanglois's picture
Offline
Joined: 01/10/2012
Juice: 48
Re: Re: api docs

re: a.Knutson #10..happy to fix it if there's an issue, but I did check it, and, actually, that link is still up for me--I do wonder if there's some kind of misunderstanding here, cuz if there's a problem w/the link I will fix it, happy to guarantee satisfaction. Are you getting a 404 error or what is the scenario? What link are you following, what do you see, what did you expect to see? I touted that link as a link to doxygen generated docs for ubercart, and that's what is there. To quote my earlier post:

 api docs 


When I generate docs w/doxygen, they look like this:
 
http://ubercartdocs.comyr.com/doxygenUbercartdocs/html/modules.html
 
Click on modules-->hooks to see function documentation, for example.

On the other hand, I had asserted that http://api.ubercart.me/ was not Ubercart API documentation but a copy of the Drupal developer's API reference. I see now that, although all of the drupal documentation is also included, ubercart API docs can be found embedded here. Now, ok, in a sense, I made a mistake. But I wonder whether it isn't a mistake to embed the Ubercart API documentation into the entire Drupal developer's API reference. That makes for an alphabetically ordered, searchable list of over 6000 functions, for example. 48 of which, are ubercart hooks. Is this what I should expect to find? Say, that I'm willing to stipulate that it is, if others think so. Fine. That leaves the question of what API link you've updated re:#9 'I've updated our API link..' The link on http://www.ubercart.org/docs/developer is still down (this is the broken link: http://api.ubercart.org). There is no API link on http://drupal.org/project/ubercart, where I originally looked for one. The Read documentation link under 'Resources' on that page still points to ubercart ,where there is no link to the community docs (where one can find the API link, which goes to the 6000 functions, 48 of which, are ubercart hooks, of course--what did I expect?). I hope we're close at least, to where we are?

DanLanglois's picture
Offline
Joined: 01/10/2012
Juice: 48
Re: Re: Re: api docs

I do see that the '•Ubercart API Examples' link on http://www.ubercart.org/docs has been changed to point to http://api.ubercart.me/. Also, I'm leaning hard on myself to get used to the idea that the API reference has to for example include 6000 plus functions. I'm thinking it over. How do other modules do it? If I don't even know, then I guess I don't need to have a doctrinaire opinion..

longwave's picture
Offline
Joined: 09/20/2008
Juice: 630
Re: Re: Re: Re: api docs

I find it useful to include all the Drupal documentation, as then all function names are hyperlinked; you can click through from the code to find out what a particular core function or hook does, not just the Ubercart ones.

We could have a specific Ubercart top level section added to the documentation; patches and suggestions are welcome, but should be posted over at http://drupal.org/project/issues/ubercart where the project maintainers can review and commit them.

--
These forums are for general support questions about Ubercart.
Bug reports and feature requests should be posted at http://drupal.org/project/issues/ubercart
Latest API documentation can be found at http://api.ubercart.me/

a.Knutson's picture
Offline
Administrator
Joined: 11/22/2011
Juice: 477
Re: Re: Re: api docs

I'm not familiar with doxygen, so perhaps it's my ignorance. But when I click on your link expecting to see a 'modules' link

Quote:

Click on modules-->hooks to see function documentation, for example.

I only see the image I've attached to this post. Let me know if there is a misunderstanding on my part Dan.

Quote:

The link on http://www.ubercart.org/docs/developer is still down (this is the broken link: http://api.ubercart.org).

fixed!

AttachmentSize
brokenURL.PNG 115.24 KB
DanLanglois's picture
Offline
Joined: 01/10/2012
Juice: 48
Re: Re: Re: Re: api docs

Let you know if there is a misunderstanding on your part. No, I think you do understand that I wasn't clowning around when I went to some trouble of my own to generate documentation for ubercart, after looking for documentation that I should have found. I didn't want others' time to be wasted as mine had been, so I posted that documentation, which task some ubercart committer might ideally have gotten to before me. And the proper documentation, labelled properly, and posted in the right place, is all I want, but I don't care enough to pursue it further. It wouldn't be for me anyways.

a.Knutson's picture
Offline
Administrator
Joined: 11/22/2011
Juice: 477
Hey Dan I think we're having

Hey Dan

I think we're having some major miscommunication issue here. I am 100% serious in my responses to you. And have no intention of wasting your time. I am merely trying to communicate what I thought was an error in your link.

The image you see as the file attachment is a screen-snippet I took of the page I am directed to when I click your link. I clicked on that link with 4 different browsers now (Chrome, Firefox, IE, and Safari) and received the same page redirect to http://www.000webhost.com/admin-review

Based on that page, I am going to assume the Doxygen will not allow you to link to others what you are seeing when you yourself click that link. Perhaps you could use a screen-snippet tool to show me what you're looking at.

Again, please realize I am sincere in my responses. Sorry for this miscommunication Dan.

DanLanglois's picture
Offline
Joined: 01/10/2012
Juice: 48
Re: Hey DanI think we're having

Really? Ok, then miscommunication it is. In which case, no need to apologize, I apologize. But before you assume that doxygen will not allow, etc., what does it say in the file attachment that you posted? Check back in a few hours, is what it says, right? And yet you posted that image, which you must have grabbed on some previous day. And you've been posting replies to me, w/out having gone back to check that link, even after i reposted it. So. Some miscommunication. But I'll blame myself, if I can at this point take it that we agree, that the site is not down now, whether it was down in the past, whatever. And, then, to keep this thread on track. For clarity's sake, I'll quote myself:

Quote:

There is no API link on http://drupal.org/project/ubercart, where I originally looked for one. The Read documentation link under 'Resources' on that page still points to ubercart ,where there is no link to the community docs..

I don't care to insist on an API link on the drupal project page as I do there, though i haven't actually changed my mind. But I think the community docs link does need to be on the project page, I'd prioritize this. note, that the community docs are not simply developer API docs, or even primarily--it's all this:

Download: http://drupal.org/project/ubercart
Homepage: http://www.ubercart.org
Documentation: http://www.ubercart.org/docs
API documentation: http://api.ubercart.me/
Forums: http://www.ubercart.org/forum
Contributions: http://www.ubercart.org/contrib
Live sites: http://www.ubercart.org/site

Installing Ubercart
Configuring your store
Accepting credit card payments
Conditional Actions
Processing orders
Product SKUs and adjustments
Product attributes and options
Product features
Remove checkout distractions
Selling files
Selling site access (roles)
UC Recurring Payments and Subscriptions
Understanding Product Classes
Viewing reports
Contributed modules
HowTos
Tutorials

I basically feel that it's seriously unlikely that anybody looking for this stuff is going to find it, generally (this, because I hadn't found it when I was looking for it, after all). So that's why I suggest changing the 'Read documentation' link on the drupal ubercart project page. Note that I'm not talking about getting rid of any links to ubercart.org, except the one 'Read documentation ' link under 'Resources' on that page. I know there have been some comments about just getting rid of the ubercart links, I'm able to sympathise w/the motivation here, ubercart.org needs some updates, but my position is ubercart.org needs some updates, not deprecate ubercart.org site or anything. Which might be more realistic (though I am, for example, for deprecating the ubercart.org contributions workflow--modules belong on drupal.org). So, what make-work, am I generating? Change one link, the 'Read documentation' link, to point to the community docs, that's real progress in itself. I don't mean to get into being a gadfly as a lifestyle, btw. Somebody in in a position to make this change? I hope that your positive attitude rubs off on me. Smiling

goingnative's picture
Offline
Joined: 04/10/2012
Juice: 38
Re: Ubercart 3.x Documentation?

There is a fully rewritten Drupal 7, Ubercart 3 ecommerce manual.

DanZ's picture
Offline
Joined: 08/07/2011
Juice: 1738
How to contribute docs?

I'm working my way through a couple Ubercart projects and have been frustrated by lack of dev docs for U3. With help from the forums, though, I'm gradually figuring it out.

I could document the tasks required to complete my projects and make tutorials. This would be useful information to the rest of the community.

Where, though, would I put those docs? http://www.ubercart.org/docs/developer is the obvious way to go, but there's no U3 dev doc tree at all there, and I have no idea how to put in a doc anyway.

end user's picture
Offline
Joined: 01/11/2008
Juice: 1738
Re: How to contribute docs?
DanZ's picture
Offline
Joined: 08/07/2011
Juice: 1738
end user wrote: How about
end user wrote:

How about here http://drupal.org/documentation/modules/ubercart

Yeah, I suppose I may end up using that. It seems like there ought to be just one repository of Ubercart docs, though, either here or there. Also, that one is kinda random....

a.Knutson's picture
Offline
Administrator
Joined: 11/22/2011
Juice: 477
Re: end user wrote: How about

Anything you can do to improve documentation would be fantastic DanZ. If you make adjustments at all to the drupal.org project documentation section, let me know of the changes and I'll duplicate those additions on our end. Ultimately documentation should be located in both places, as Drupal.org can be quite confusing for newbies.

If you get serious about helping out on that end, I'll throw you the permissions necessary to make your job easier with keeping things up to date on Ubercart.org's end.

Thanks for your interest in helping out. The only way this project thrives is because people like you step up and help out.

DanZ's picture
Offline
Joined: 08/07/2011
Juice: 1738
Re: Re: end user wrote:How about

I'm a novice to Drupal and Ubercart, but I'm committed to Ubercart for at least two years, and I expect to be making lots of tweaks in that time.

As I've set up the system, there have been dozens of times I've had to ask, "How the heck do I make Ubercart/Drupal do....?" Then I spend a bunch of "quality" time with Google and these forums trying to figure it out. Then, I write it down in my log so I can remember what the heck I actually did.

I figure that the stuff I run into is the same thing that lots of other newbies run into and want to know about. So, most of the work is already done. It's just a matter of turning the stuff in my log into something that someone else would want to read.

goatvirus's picture
Offline
Joined: 12/03/2009
Juice: 57
documentation on porting modules from 6.x-2.x to 7.x-3.x?

Can anyone out there please point me towards any existing documentation re: how the Ubercart API hooks have changed, and how to port custom modules for Ubercart from 6.x-2.x to 7.x-3.x

Yes, I know there's documentation on porting Drupal modules in general ( eg: http://drupal.org/node/224333 ) but I am looking for something similar that describes how the Ubercart hooks themselves have changed.

DanZ's picture
Offline
Joined: 08/07/2011
Juice: 1738
Re: documentation on porting modules from 6.x-2.x to 7.x-3.x?

I'm not sure if there is such a document.

The big change is that most of the names of modules and their associated hooks, file names, etc. are more detailed. So, you won't get something like hook_uc_hookname(). You'll get something like hook_uc_order_hookname().

At this point, your best bet might be http://api.ubercart.me. It has the full, up-to-date documentation for all Ubercart functions, including hooks, for both Ubercart 6.x-2.x and 7.x-3.x.

When you find a hook in D6 code, you can read about it there, then switch to the D7 version, and read about that.

goatvirus's picture
Offline
Joined: 12/03/2009
Juice: 57
documentation on porting modules from 6.x-2.x to 7.x-3.x?

well, the documentation that's there at api.ubercart.me seems to be all about 7.x-3.x ... if i look up old hook names from 6.x-2.x i find nothing. and these used to be documented online at api.ubercart.org

so where do i find them now?

TR
TR's picture
Offline
Bug FinderFAQ ModeratorGetting busy with the Ubercode.
Joined: 11/05/2007
Juice: 3266
Re: documentation on porting modules from 6.x-2.x to 7.x-3.x?

There are two tabs in the top right of the page at api.ubercart.me. By default, you will see/search the Drupal 7 API. But if you click on the Drupal 6 tab, you can see/search the Drupal 6 API.

<tr>.
TR
TR's picture
Offline
Bug FinderFAQ ModeratorGetting busy with the Ubercode.
Joined: 11/05/2007
Juice: 3266
Re: Re: documentation on porting modules from 6.x-2.x to 7.x-3.x

Also, Ubercart for D7 has built-in rules for the Coder Upgrade module, so you can use that module to automatically upgrade a lot of your D6 code to D7. Much of what needs to be done for both Drupal and Ubercart can be done automatically this way.

See http://drupal.org/project/coder - this is mentioned in the drupal.org documentation about how to upgrade a module, found at http://drupal.org/update/modules/6/7

<tr>.