Task #9712
Document hooks in core
| Status: | New | Start date: | 2010-09-13 | |
|---|---|---|---|---|
| Priority: | Should have | Due date: | ||
| Assignee: | - | % Done: | 0% |
|
| Category: | - | |||
| Target version: | - | |||
| Votes: | 2 (View) |
Description
In order to make extension development a bit easier, it would be nice to document all the hooks in core.
I would take this task, my vision is to have a short description of every hook with details on when it is called and what it does, possibly including a short code example.
Max Kalus.
History
Updated by Daniel Siepmann 12 months ago
If this is still a Job, I'll help with it.
First we should define a small template that we can fill with information for one hook.
I'll fill it for each hook I used at the moment.
Perhaps it will be possible to do this job inside the wiki first, so everyone can help easily.
Updated by Francois Suter 12 months ago
Yes, that would be very nice. I think that starting in the wiki is a good idea.
The minimal information necessary IMO would be:
- name of the hook
- purprose
- parameters received
- expected return value
Having code examples is of course a great idea, but would require a lot of work. Better to have the list first and enhance it later.
Updated by Daniel Siepmann 12 months ago
A very first draft how this can look like can be found in the wiki: http://wiki.typo3.org/User:Layne.obserdia/Hook_List
Updated by Francois Suter 12 months ago
I prefer the second version. However you should not put too many efforts into formatting as this will be included in the official documentation in reStructured Text. This means we will probably use a format similar to what is currently planned for TypoScript reference, for example.
See:
for a reference.