You are here

public function MarkdownParserInterface::tips in Markdown 3.0.x

Generates a filter's tip.

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

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.

1 method overrides MarkdownParserInterface::tips()
BaseParser::tips in src/Plugin/Markdown/BaseParser.php
Generates a filter's tip.

File

src/Plugin/Markdown/MarkdownParserInterface.php, line 205

Class

MarkdownParserInterface
Interface MarkdownInterface.

Namespace

Drupal\markdown\Plugin\Markdown

Code

public function tips($long = FALSE);