public function TocFilter::tips in TOC filter 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/TocFilter.php, line 180

Contains \Drupal\toc_filter\Plugin\Filter\TocFilter.

Class

TocFilter

Provides a filter to display a table of contents.

Namespace

Drupal\toc_filter\Plugin\Filter

Code

public function tips($long = FALSE) {
  return $this
    ->t("Converts header tags into a hierarchical table of contents. (i.e [toc type=(tree|menu|responsive) title='Table of Contents']");
}