We have a template for how to fix core files to support this hook properly. This commit points people to it.

I tried using this code with the short name and it didn't work.
When I changed my code to use my extension's long name, it worked.

- Add function signature
- Better markdown formatting
- Improve readbility of example code

Examples and explanations on this page use $objectType, so standardizing on that.

The paragraph between the "Summary" heading and the next heading needs
to be short because we use this paragraph when generating the hooks
summary page.

To document the changes in CRM-20926, we need some kind of doc about the XML
menu structure...  which doesn't seem to exist.

This change fixes some quirks in the `h_c_xmlMenu` doc and also adds a
section for the XML.  This revision is not exhausive, but it covers some
common ones, and it's enough that we can add-in more.

Run the following command to do so:
./bin/hook-summary.py

Updated to reflect that a fix has been merged. Moved warning to the top where it is more likely to be useful. Also, seems more appropriate as a "note" than a "convention" or "tip."

Removed scary warning that only applies to a single point release.

- Now includes for hook_civicrm_inboundSMS

Done with:
./bin/tools generate:hook-list

- Keep the summary short
- Use a separate "Notes" section for overflow

This way MkDocs will be able to report errors for broken links

Done with:

perl -0777 -i -pe \
's@(?<!!)\[([^\]]*)\]\((?!https?://)(?!mailto:)(/(?:(?:(?:/(?![\)#]))|[^/)#])(?!.md))+)/?(#[^)]*)?\)@[$1]($2.md$3)@gm' \
`find . -name '*.md'`

Made minor formatting changes to improve appearance of rendered file.

* They have been moved to the CiviRules Guide:
  https://docs.civicrm.org/civirules/en/latest/
* Close #183

Close #86

This updates the docs to ensure that hook parameters exactly match the names
in the code.

Prior to 4.7.19, the names of hook-parameters didn't really matter (as long
as they were in the right order).  In 4.7.19, the names took on extra
significance because Symfony-based listeners use objects and fields (e.g.
`$event->firstParam`) instead of ordered params (`function($firstParam)`).