function facebook_comments_block_help in Facebook Comments Block 8.2

Same name and namespace in other branches

1. 8 facebook_comments_block.module \facebook_comments_block_help()
2. 7.2 facebook_comments_block.module \facebook_comments_block_help()
3. 7 facebook_comments_block.module \facebook_comments_block_help()

Implements hook_help().

File

./facebook_comments_block.module, line 14

facebook_comments_block.module

Code

function facebook_comments_block_help($route_name, RouteMatchInterface $route_match) {
  switch ($route_name) {
    case 'help.page.facebook_comments_block':
      $output = '';
      $output .= '<h3>' . t('About') . '</h3>';
      $output .= '<p>' . t('This module allows users to comment using Facebook\'s commenting box with as little configuration as possible. It adds a new block "Facebook Comments" which acts as a Facebook commenting widget.') . '</p>';
      $output .= '<h3>' . t('Configuration') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('You can place a facebook comment block in a region by selecting <em>Place block</em> on the <a href=":blocks">Block layout page</a>.', array(
        ':blocks' => Url::fromRoute('block.admin_display')
          ->toString(),
      )) . '</dt>';
      $output .= '<dt>' . t('Under the "FACEBOOK COMMENTS BOX SETTINGS" you can configure the following.') . '</dt>';
      $output .= '<dd>' . t('Facebook Application ID: (Optional).') . '</dd>';
      $output .= '<dd>' . t('Main domain: (Optional) If you have more than one domain you can set the main domain for facebook comments box to use the same commenting widget across all other domains.') . '</dd>';
      $output .= '<dd>' . t('Language: Select the default language of the comments plugin.') . '</dd>';
      $output .= '<dd>' . t('Color Scheme: Set the color schema of facebook comments box.') . '</dd>';
      $output .= '<dd>' . t('Order of comments: Set the order of comments.') . '</dd>';
      $output .= '<dd>' . t('Number of posts: Select how many posts you want to display by default.') . '</dd>';
      $output .= '<dd>' . t('Width: Set width of facebook comments box.') . '</dd>';
      $output .= '</dl>';
      $output .= '<h3>' . t('Troubleshooting') . '</h3>';
      $output .= '<dl>';
      $output .= '<dt>' . t('If the block did not appear:') . '</dt>';
      $output .= '<dd>' . t("check if you have entered a correct FACEBOOK APP ID, leave it blank in case you don't have a Facebook app.") . '</a></dd>';
      $output .= '</dl>';
      return $output;
  }
}