Nice module! Very useful.

I use the module to define tokens that are replaced when content editors use them. For example, editors type the token "[director-full-name]" into a document, which is replaced with a string constant on page render.

It would be nice for content editors to be able to see a list of tokens they can use when typing. This can be done by altering the tip text. But that needs to be updated manually when a new token is created, so is prone to error.

Maybe when someone adds a new rule, docs could be updated automatically. Each rule could be described in a table that appears as a collapsed field when the input filter is being used. Click to expand and show the table of defined tokens.

It might not be practical to automate this fully. Another idea is to add some documentation fields to each rule, that will be shown to filter users.

Comments

Anonymous’s picture

Anonymous (not verified) commented
Title: Show rule summary for users editing content » Add the possibility to add a description for each rule
Version: 6.x-1.0-rc2 » 6.x-2.x-dev

Another idea is to add some documentation fields to each rule, that will be shown to filter users.

The problem is that sometimes a group of rules is used to generate the output; in such case, the description given to each single rule would not probably useful to the user. I guess that in these cases, the description should be given only for one of rules.

Using a description for each rule would also allow to have updated tips when the single rules are disabled. As it is now, the tips for the input format need to be edited each time the rules are enabled / disabled, and I understand that it is more work that could be avoided.

Thanks for the report, and the suggestion!

zterry95’s picture

zterry95 commented
Issue summary: View changes
Status: Active » Closed (won't fix)