You are here

public function FootnotesFilter::tips in Footnotes 8.2

Get the tips for the filter.

Parameters

bool $long: If get the long or short tip.

Return value

string The tip to show for the user.

Overrides FilterBase::tips

File

src/Plugin/Filter/FootnotesFilter.php, line 63

Class

FootnotesFilter
Provides a base filter for Footnotes filter.

Namespace

Drupal\footnotes\Plugin\Filter

Code

public function tips($long = FALSE) {
  if ($long) {
    return $this
      ->t('You can insert footnotes directly into texts with <code>[fn]This text becomes a footnote.[/fn]</code>. This will be replaced with a running number (the footnote reference) and the text within the [fn] tags will be moved to the bottom of the page (the footnote). See <a href=":link">Footnotes Readme page</a> for additional usage options.', [
      ':link' => 'http://drupal.org/project/footnotes">',
    ]);
  }
  else {
    return $this
      ->t('Use [fn]...[/fn] (or &lt;fn&gt;...&lt;/fn&gt;) to insert automatically numbered footnotes.');
  }
}