Suggestions for a less confusing api.drupal.org to newbies

mishhh - March 12, 2007 - 21:50

I'm a newbie myself and I'm still searching functions from time to time on api.drupal.org.

I want to make some suggestions about hook chapter in api.drupal.org.
I guess this chapter is the most important in the eyes of a newbie who tries to understand drupal.
First time when I read that chapter I was so confused because the style of presentation.

1. Hook means a module name
First of all, for clearing the mind of a newbie, near every hook word, someone please attach the fact that hook must be replaced with a module name. Don't bother about repetition of this fact.
A footer will also do it if such a repetition is not welcomed.
"What is a hook" is explained only on the main page of hooks. Only once. Then you don't hear it anymore. All other info can really confuse you.
When a newbie will see this time and time again, the info will imprint easier into his head. Hence the understanding will come faster.

2. Code => Example code of a hook
What confused me so much was the code given as an example. It was only an example, but I didn't knew that.
I've scratched my head over to understand what that code means and how drupal will understand through that code what modules are saying.
Of course it was just an example of a hook. Not the code of a hook. But in the beginning, I didn't knew that. I was so close to drop drupal only for this.
So.
Pls, replace the word "Code" with "Example Code of a hook" or something. Trust me the presentation of the code is very confusing. When you see "Example of code" you get it fast.

I second that. It took me a

platform8 - March 21, 2007 - 03:51

I second that. It took me a while to work out I was dealing with example code heh.

anyone for thirds?

mike stewart - March 27, 2007 - 03:57

Yes, it would be very helpful if there were a bit more background documentation on the API.

Also an overview of the flow of Drupal would help: such as what happens (e.g., what events/functions are fired), and in what order, when a browser hits page: www.Drupal-Example.com/node/123

or does this Drupal Holy Grail exist somewhere?

This would be wonderful:)

mishhh - March 29, 2007 - 08:11

The possibility of seeing the flow of drupal in action is very appealing.

But I guess this is very hard to implement...

:)

i like where this thread is

alienzed - July 19, 2009 - 05:14

i like where this thread is going

 
 

Drupal is a registered trademark of Dries Buytaert.