function editor_note_help in Editor Notes 7

Same name and namespace in other branches

1. 8 editor_note.module \editor_note_help()

Implements hook_help().

File

./editor_note.module, line 13

Main functionality for Editor Notes module.

Code

function editor_note_help($path) {
  if ($path == 'admin/help#editor_note') {
    $output = '<h3>' . t('About') . '</h3>';
    $output .= '<p>' . t('The modules improves administration/editorial usability and provides configurable "Editor Notes" field, which can be added to any Drupal entity.') . '</p>';
    $output .= '<p>' . t('Concept of "Editor Notes" is similar to "Comments". The main difference is that "Editor Notes" are for editors and admins rather than for end users.') . '</p>';
    $output .= '<h3>' . t('Usage') . '</h3>';
    $usage = array(
      t('As website editor I can write status notes to myself and other editors working on the same material.'),
      t('The module provides "Editor Notes" field available on "Manage Fields" page.'),
      t('This field can also be added to any Drupal fieldable entity (user etc).'),
      t('List of previously added notes displays in "content edit" form in configurable table.'),
      t('Notes can also be displayed for the end user in configurable table if necessary.'),
      t('When editor opens "content add" form for the first time he sees a field (textarea) providing him an option to add the first note.'),
      t('When editor opens "content edit" form he sees "Editor Notes" widget with already added notes if any found.'),
    );
    $output .= theme('item_list', array(
      'items' => $usage,
    ));
    $output .= '<h3>' . t('Features') . '</h3>';
    $features = array(
      t('Website editor can only add / update / delete his own notes by default.'),
      t('However notes may also be updated or removed by any user with "Administer any editor note" permission.'),
      t('CRUD operations on notes support Ajax and perform in configurable modal window without page reload.'),
      t('Module supports Views, content revisions and content translation.'),
    );
    $output .= theme('item_list', array(
      'items' => $features,
    ));
    $output .= '<h3>' . t('Similar Projects') . '</h3>';
    $output .= '<p><strong>' . t('The key feature of the Editor Notes module is that editor is able to browse (add/update/remove) notes directly in "edit content" form.') . '</strong></p>';
    $output .= '<p>' . t('It helps to save time when adding/updating large amount of content.') . '</p>';
    $projects = array(
      t('!module creates a block that displays a textarea pre-filled with the existing comment for that specific page.', array(
        '!module' => l(t('Admin Notes'), 'https://www.drupal.org/project/admin_notes'),
      )),
      t('!module introduces a new content type "sitenotes." It also creates a menu item in the Admin >> Site building menu, where it is available only to privileged users.', array(
        '!module' => l(t('SiteNotes'), 'https://www.drupal.org/project/sitenotes'),
      )),
      t('!module consist of titles and text rendered into a block. The notes are specific to each authenticated user and can only be viewed by the user who created them.', array(
        '!module' => l(t('Personal Notes'), 'https://www.drupal.org/project/personal_notes'),
      )),
      t('!module creates a block with the ability to add, delete and edit notes. Notes are stored on a per path basis and the block can be made visible to certain roles/paths.', array(
        '!module' => l(t('Stickynote'), 'https://www.drupal.org/project/stickynote'),
      )),
    );
    $output .= theme('item_list', array(
      'items' => $projects,
    ));
    $output .= '<p>' . t('The difference from mentioned above modules is that Editor Notes creates configurable ajaxified field (instead of blocks or content type).') . '</p>';
    $output .= '<p>' . t('Field can be attached to an entity and associated with that entity. Each field item controls CRUD operations based on authorship (like Comment module).') . '</p>';
    $output .= '<h3>' . t('Requirements') . '</h3>';
    $requirements = array(
      l(t('Chaos tool suite'), 'https://www.drupal.org/project/ctools'),
      l(t('Entity API'), 'https://www.drupal.org/project/entity'),
    );
    $output .= theme('item_list', array(
      'items' => $requirements,
    ));
    $output .= '<h3>' . t('Installation') . '</h3>';
    $installation = array(
      t('Drop the entire Editor Note module into your "sites/all/modules" folder.'),
      t('Enable the module from the !page.', array(
        '!page' => l(t('modules page'), 'admin/modules'),
      )),
      t('Create new or edit existing content type and add a new field of type "Editor Notes".'),
    );
    $output .= theme('item_list', array(
      'items' => $installation,
      'type' => 'ol',
    ));
    $output .= '<h3>' . t('Sponsorship') . '</h3>';
    $credit = array(
      l(t('EPAM Systems'), 'https://www.drupal.org/node/2114867'),
      l(t('NBC Universal'), 'http://www.nbcuni.com'),
    );
    $output .= '<p>' . t('This project was sponsored by') . ':</p>';
    $output .= theme('item_list', array(
      'items' => $credit,
    ));
    $output .= '<h3>' . t('Acknowledgments') . '</h3>';
    $output .= '<p>' . t('Special thanks to !username1 and !username2 for reviewing the module.', array(
      '!username1' => l(t('Sergei Churilo'), 'https://www.drupal.org/user/584658'),
      '!username2' => l(t('Alexey Yahnenko'), 'https://www.drupal.org/user/2635711'),
    )) . '</p>';
    $output .= '<h3>' . t('Author') . '</h3>';
    $output .= '<p>' . l(t('Rostislav Sergeenkov'), 'https://www.drupal.org/u/rostislav-sergeenkov') . '</p>';
    return $output;
  }
}