public function ReadmehelpMarkdown::tips in README Help 8

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/ReadmehelpMarkdown.php, line 67

Class

ReadmehelpMarkdown

Provides a filter for markdown.

Namespace

Drupal\readmehelp\Plugin\Filter

Code

public function tips($long = FALSE) {
  return $this
    ->t('You can use <a href=":readmehelp" name=":name">markdown syntax</a> like in README files to format and style the text. This syntax is a subset of the <a href=":github">Github Flavoured Markdown</a>.', [
    ':readmehelp' => Url::fromRoute('help.page', [
      'name' => $this->provider,
    ])
      ->toString(),
    ':github' => 'https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet',
    ':name' => 'readmehelp-filter',
  ]);
}