If you add the amazon_filter to your input format, in the help it says the following:

Syntax: [amazon title|cover|info asin]

First of all, I have no way to know what this means. It could mean anything. Do I need the word amazon? Or do I just put a title there? Second, there's not even any text that says that this information applies to the amazon filter; it should be pretty clear, but the standard is to explain what you're on about.

If it's supposed to be open bracket, the word amazon, and then title, cover, or info, then the asin, then it would make more sense to say [amazon {title|cover|info} asin] or similar. Those parts of the tag which vary need to be denoted as varying somehow.

CommentFileSizeAuthor
#3 readme_2.txt1.71 KBpeterx
#2 readme_1.txt1.09 KBpeterx

Comments

Prometheus6’s picture

Project: Amazon associate tools » Amazon Filter
Component: Documentation » Code
peterx’s picture

StatusFileSize
new1.09 KB

Here is a readme.txt that explains what I found when using Amazon filter on 5.0 and it appears to be the same for 4.7.

peterx’s picture

StatusFileSize
new1.71 KB

The new expanded enhanced supplemented readme.txt.

peterx’s picture

To help beginners, I changed the syntax message on my site from:

function amazon_filter_filter_tips($delta, $format, $long = FALSE) {
   return t('Syntax: [amazon title|cover|info asin]');
}

to:

function amazon_filter_filter_tips($delta, $format, $long = FALSE) {
   return t('Syntax: [amazon title|cover|info asin] Example: [amazon cover B0007M123K]');
}

petermoulding.com/web_architect

wayland76’s picture

Status: Active » Closed (fixed)

Improved even more in patch attached to http://drupal.org/node/195618