public function FilterMarkdown::tips in Markdown 8.2

Generates a filter's tip.

A filter's tips should be informative and to the point. Short tips are preferably one-liners.

@todo Split into getSummaryItem() and buildGuidelines().

Parameters

bool $long: Whether this callback should return a short tip to display in a form (FALSE), or whether a more elaborate filter tips should be returned for template_preprocess_filter_tips() (TRUE).

Return value

string|null Translated text to display as a tip, or NULL if this filter has no tip.

Overrides FilterBase::tips

File

src/Plugin/Filter/FilterMarkdown.php, line 485

Class

FilterMarkdown

Provides a filter for Markdown.

Namespace

Drupal\markdown\Plugin\Filter

Code

public function tips($long = FALSE) {

  // On the "short" tips, don't show anything.
  // @see \Drupal\markdown\Plugin\Filter\FilterMarkdown::processTextFormat
  if (!$long) {
    return NULL;
  }
  return $this
    ->moreInfo($this
    ->t('Parses markdown and converts it to HTML.'), 'https://www.drupal.org/docs/8/modules/markdown');
}