Stripping CVS keywords
[project/helpers.git] / README.txt
1 README for helpers module.
2
3 h2. AUTHORS
4  Bčr Kessels | www.webschuur.com
5  Nancy Wichmann | nanwich.info
6  (please add yourself if you contributed)
7
8
9 h2. ABOUT
10 "Helpers?" I hear you ask...
11  A helper would, for example be: number_to_currency(), or distance_of_time_in_words(). Or off course something like select_year, or even select_country.
12 Basically all kinds of interesting and extremly usefull functions that are too specific to make it into core, but still very handy to have at hand. Stuff that you have wondered that "would be very usefull in addition to the default PHP",
13  How would it be to call a $form['country'] = select_country() and get a "select your country" select, prefilled with all the known countries in the world? Or to have a ready made function to render any number as a currency? Or even to render any percentage in a star-rating piece of HTML (render_rate_as_stars()) etc.
14 This is part of my abovementioned plan to "bring more Ruby on Rails delight to Drupal". And most of all to make Drupal a developer friendly environment (where developing no longer requires you to think about the folks that might put the currency symbol behind the value... But where that is simply a case of calling a proper function). More at: http://drupal.org/node/61397#comment-117091
15
16 h2. HOW TO CONTRIBUTE
17 Some notes on contributing.
18 We don't allow just anyone to write into this module, because that would undermine the goal "creating a good and helpfull toolbox". So please upload patches for this module.
19 Once we have seen your contributions, and we like them, we will agree on you writing directly to the module. Obviously you'd need write access first!
20
21 h2. CODING STANDARDS
22 All applications must folliow the Drupal coding standards. But we want something more:
23 * Name your functions very clear. theme_box is not as good as theme_general_block_element. convert_currency is far less descriptive then convert_currency_to_decimal. Be creative, and look at the other functions for inspiration.
24 * No need to include the work "helper" in your functions. Allthough Drupal has a guideline to name all the functions "module_name_foo_bar" we break this. Helpers must be usefull, not finger-breaking-complex to type. Hence we prefer theme_read_more above theme_helpers_read_more.
25 * Remove functions that went into core. I beleive that a lot of functions from the helpers might make it into core. Once they are in, please remove them from this module.
26 * Link to issues. If a patch in the queue tries to insert a function from this module into core, provide a link to that issue-thread.
27 * Doxygen. Each function MUST have documentation. A change to a function, REQUIRES you to change the docs too.