I came upon this while working on the Token Filter module. All text filters have a tips callback function that returns either a short or long form of the tips.

The short form is familiar: it's what's shown on the edit page for a text format at admin/config/content/formats/my_format and in the expanded information under a text field that uses that format.

The long form, though, is (AFAIK) only shown on the page filter/tips (and filter/tips/my_filter).

My first question is, how is a visitor (or site architect) going to ever find this page filter/tips? It's not at an admin path, so doesn't get the admin theme, and is visible to anonymous users, so it's presumably intended for the non-admin audience. But how would they ever find it?

There is a theme function, theme_filter_tips_more_info(), that returns a link to this page, but I was unable to find any invocations of it (theme('filter_tips_more_info', ...)) anywhere in core.

And comparing the short and long forms for the built-in filters (Filtered HTML, Raw HTML) and some others (Markdown), the long and short forms are practically the same. Do we even need both?

And then, the page itself doesn't seem all that useful. Here's what it looks like to an anonymous visitor to https://backdropcms.org/filter/tips:

compose_tips

So...

  • Do we really need this page (and the associated long form of text filter tips)?
  • If we do, maybe there's a way to get it more easily reachable so that it will serve its intended purpose?
  • If it's intended to be used by site contributors, perhaps it could be customizable so that the site architect could add some explanatory text at the top?
GitHub Issue #: 
5912