You are here

Home » API reference » Markdown 5 » markdown.module

function markdown_filter_tips in Markdown 5

Same name and namespace in other branches
  1. 6 markdown.module \markdown_filter_tips()

Implementation of hook_filter_tips().

File

./markdown.module, line 54

Code

function markdown_filter_tips($delta = 0, $format = -1, $long) {
  if ($long) {
    return t('Quick Tips:<ul>
      <li>Two or more spaces at a line\'s end = Line break</li>
      <li>Double returns = Paragraph</li>
      <li>*Single asterisks* or _single underscores_ = <em>Emphasis</em></li>
      <li>**Double** or __double__ = <strong>Strong</strong></li>
      <li>This is [a link](http://the.link.example.com "The optional title text")</li>
      </ul>For complete details on the Markdown syntax, see the <a href="http://daringfireball.net/projects/markdown/syntax">Markdown documentation</a> and <a href="http://michelf.com/projects/php-markdown/extra/">Markdown Extra documentation</a> for tables, footnotes, and more.');
  }
  else {
    return t('You can use <a href="@filter_tips">Markdown syntax</a> to format and style the text. Also see <a href="@markdown_extra">Markdown Extra</a> for tables, footnotes, and more.', array(
      '@filter_tips' => url('filter/tips'),
      '@markdown_extra' => 'http://michelf.com/projects/php-markdown/extra/',
    ));
  }
}