diff --git a/prepopulate.module b/prepopulate.module
index af9c21a..ace50de 100644
--- a/prepopulate.module
+++ b/prepopulate.module
@@ -10,13 +10,81 @@
*/
/**
- * Implementation of hook_help().
+ * Implements hook_help().
*/
function prepopulate_help($path, $arg) {
switch ($path) {
- case 'admin/modules#description':
- return t('Pre-populates forms with HTTP GET or POST data');
- break;
+ case 'admin/help#prepopulate':
+ $output = '
' . t('About') . '
';
+ $output .= '
' . t('The Prepopulate module sets default values to form elements with data fetched from the URL. Form fields can be populated with HTTP GET or POST data.') . '
';
+ $output .= '
' . t('Uses') . '
';
+ $output .= '
' . t('Simple usage') . '
';
+ $output .= '
' . t('Set the defaul value for the title field on a node creation form:') . ' ';
+ $output .= 'http://www.example.com/node/add/content?edit[title]=This is the title ';
+ $output .= t('With "non-clean" urls:') . ' ';
+ $output .= 'http://www.example.com?q=node/add/content&edit[title]=This is the title
';
+ $output .= '
' . t('POST requests') . '
';
+
+ $output .= t("Since Prepopulate uses the \$_REQUEST variable, you have access to values from either GET request in the URL, or the form POST requests. In the below example, we set the default value of a node form's title based on a POST Request:");
+ $output .= '
' . check_plain('
+
+
+') . '';
+ $output .= '
' . t('How to find what variable to set') . '
';
+ $output .= t('This can be tricky, but there are a few things to keep in mind that should help.') . ' ';
+ $output .= t('form_default_values.module is quite simple. It looks through the form, looking for a variable that matches the name given on the URL, and puts the default value in when it finds a match. Drupal keeps HTML form entities in an edit[] array structure. All your variables will be contained within the edit[] array.') . ' ';
+ $output .= check_plain(t('A good starting point is to look at the HTML code of a rendered Drupal form. Once you find the appropriate (or tag, use the value of the name attribute in your URL, contained in the edit array. For example, if the tag looks like this:')) . ' ';
+ $output .= '' . check_plain('') . ' ';
+ $output .= t('then try this URL:') . ' ';
+ $output .= 'http://www.example.com/node/add/content?edit[title]=Automatic filled in title ';
+ $output .= t('Fields are a bit more complicated:') . ' ';
+ $output .= '' . check_plain('') . ' ';
+ $output .= t('The key is to put this in the edit[] array nested, like this:') . ' ';
+ $output .= 'http://www.example.com/node/add/content?edit[field_office][0][node_name]=AL-235 ';
+ $output .= t('Another example:') . ' ';
+ $output .= '' . check_plain('') . ' ';
+ $output .= t('would be:') . ' ';
+ $output .= 'http://www.example.com/node/add/content?edit[field_content][0][value]=A long text string ';
+ $output .= t("and, again, for non-clean URLs, it's:") . ' ';
+ $output .= 'http://www.example.com?q=node/add/content&edit[field_content][0][value]=A long text string ';
+ $output .= t('Fields will vary a bit depending on how the input widgets are configured. Here are some examples.') . ' ';
+ $output .= t('Date fields with a separate time entry would look like:') . ' ';
+ $output .= 'edit[field_date][0][value][date]=11%20Aug%202010&edit[field_date][0][value][time]=12:00PM ';
+ $output .= t('Select Lists:') . ' ';
+ $output .= 'edit[field_selectList][value]=1 ';
+ $output .= t('Note that in this example "1" is the key value for the select field.') . ' ';
+ $output .= t('Node Reference:');
+ $output .= 'edit[field_nodereference][0][nid][nid]=[nid: #] ';
+ $output .= t('Some Non-field API examples:') . ' ';
+ $output .= t('Taxomony Tags:') . ' ';
+ $output .= 'edit[taxonomy][tags][1]=myTag ';
+ $output .= '
' . t('Body fields') . '
';
+ $output .= t('Body fields are different. Though their HTML entity looks like this:') . ' ';
+ $output .= '' . check_plain('') . ' ';
+ $output .= t('You can not just take the name "body" throw it into a edit[body] and expect it to work. Drupal wraps the body field into a "body_field"
+array when it gets processed. So, for body fields, a URL like:') . ' ';
+ $output .= 'http://www.example.com/node/add/content?edit[body_field][body]=This is the body ought to do the trick. ';
+ $output .= '
' . t('Multiple fields') . '
';
+ $output .= t('Prepopulate can handle pre-filling multiple fields from one URL. Just separate the edit variables with an ampersand:') . ' ';
+ $output .= 'http://www.example.com/node/add/content?edit[title]=The title&edit[body_field][body]=The body ';
+ $output .= t("You're already using the ampersand with non-clean URLs:") . ' ';
+ $output .= 'http://www.example.com?q=node/add/content&edit[title]=The title&edit[body_field][body]=The body ';
+ $output .= '
' . t('Escaping special characters') . '
';
+ $output .= t("Some characters can't be put into URLs. Spaces, for example, work mostly, but occasionally they'll have to be replaced with the string %20. This is known as percent encoding. Wikipedia has a partial list of percent codes at") . ' ' . l(t('http://en.wikipedia.org/wiki/Percent-encoding'), 'http://en.wikipedia.org/wiki/Percent-encoding') . '. ';
+ $output .= t("If you're having trouble getting content into field names, or are getting 'page not found' errors from Drupal, you should check to ensure that illegal characters are properly encoded.") . ' ';
+ $output .= '
' . t('Bookmarklets') . '
';
+ $output .= t('form_default_values.module was created for bookmarklets. Here is a bookmarklet for posting web links to a site:') . ' ';
+ $output .= "javascript:u=document.location.href;t=document.title;s=window.getSelection();void(window.open(%22http://example.com/node/add/content-web-link?edit[title]=%22+escape(t)+'&edit[body_field][body]='+escape(s)+'&edit[field_url][0][value]='+escape(u),'_blank','width=1024,height=500,status=yes,resizable=yes,scrollbars=yes')); ";
+ $output .= t('This turns into a URL like this:') . ' ';
+ $output .= 'http://example.com/node/add/content-web-link?edit[title]=drupal.org%20%7C%20Community%20plumbing&edit[body_field][body]=&edit[field_url][0][value]=http%3A//drupal.org/ ';
+ $output .= t('Selecting some text on the page first would put that text into the body of the node.wraps the body field into a "body_field" array when it gets processed. So, for body fields, a URL like:') . ' ';
+ $output .= 'http://www.example.com/node/add/content?edit[body_field][body]=This is the body ';
+ $output .= t('ought to do the trick.') . ' ';
+
+ return $output;
}
}