function constant_contact_help in Constant Contact 6.2

Same name and namespace in other branches

1. 5 constant_contact.module \constant_contact_help()
2. 6.3 constant_contact.module \constant_contact_help()
3. 6 constant_contact.module \constant_contact_help()
4. 7.3 constant_contact.module \constant_contact_help()

Displays the admin help page

File

./constant_contact.module, line 20

Code

function constant_contact_help($path, $arg) {
  switch ($path) {
    case 'admin/help#constant_contact':
      return '<p>' . t('
	  <p>This module works with the new <a target="_blank" href="@api">Constant Contact REST API</a></p>
	  <p><a target="_blank" href="@cc">Signup for a free 60-day trial</a> if you do not already have an account.</p>
	  <p>To setup a custom signup form please follow the instructions below:</p>
	  <ol>
	  <li>First you need to <a target="_blank" href="@dev">Register for an API key</a> with constant contact</li>
	  <li>Next you should visit the <a href="@settings">settings page</a>, enter your account username, password and API key then save the page.</li>
	  <li>Now you can return to the <a href="@settings">settings page</a> and configure the options such as which contact lists the subscribers are added to or excluded from.</li>
	  <li>If you want to display a signup checkbox on the register page simply check the appropriate checkbox, if you want to use the form block method see <a href="@blocks">this page</a>.</li>
	  </ol>
	  <p>Detailed instructions, screen shots and videos will be available in a future release.</p>
	  <h6>Known Issues</h6>
	  <ul>
	   <li>If you want to mass delete users you probably need to mass unsubscribe them first.</li>
	   <li>Custom fields may not work on your specific setup, we have tested with the profile module only, this feature is still under development.</li>
	   <li>Updating custom fields will not work if they are displayed in a different section to the main form.</li>
	  </ul>
	  ', array(
        '@api' => 'http://developer.constantcontact.com/doc/reference',
        '@dev' => 'http://developer.constant_contact.com/license/login',
        '@cc' => 'http://www.jdoqocy.com/click-3699287-10296666',
        '@settings' => url('admin/constant_contact/settings'),
        '@blocks' => url('admin/build/block'),
      )) . '</p>';
    case 'admin/constant_contact/lists':
      return t('<p>You can manage your contact lists below, this saves having to visit the constant contact website if you want to edit a list name</p><p>Editing a list name will not break your registration form, deleting a list will break it but only if you are using that list in the signup form, you should edit the settings to remove the list from the signup form after you have deleted it here.</p>');
    case 'admin/constant_contact/settings':
      return t('<p>Edit your Constant Contact account settings and configure your settings.</p>');
    case 'admin/constant_contact/lists/add':
      return t('<p>This will add a new contact list to your Constant Contact account.</p>');
    case 'admin/constant_contact/lists/edit/%':
      return t('<p>This will update the contact list with your Constant Contact account.</p>');
    case 'admin/constant_contact/lists/delete/%':
      return t('<p>This will delete the contact list from your Constant Contact account, users subscribed to the list will be unsubscribed from the list first but will remain subscribed to other lists.</p>');
  }
}