The current README.txt is outdated and inaccurate. Here is a suggested revise to your README.txt, that might help the next admin who is installing and implementing this. See the attachment for my suggested update.

Comments

Screenack’s picture

Just installed token filter for a new project, and I forgot that the README in the package is outdated, as per this issue I submitted. Reading my own note here reminded me of the correct way to implement token filter. I'm curious why this isn't being incorporated?

capynet’s picture

Status: Active » Needs review
StatusFileSize
new1.2 KB

Add patch

capynet’s picture

StatusFileSize
new1.2 KB

I'm sorry, discard previous patch, bad formatted. here is the correct.

phanos’s picture

Issue summary: View changes
Status: Needs review » Reviewed & tested by the community

looks good to me

johnhorning’s picture

Looks like this still needs to be committed.

darvanen’s picture

Category: Bug report » Task
Status: Reviewed & tested by the community » Needs work

If we're going to send people to the help page for tokens instead of listing the ones that are commonly available (global tokens) there needs to be a large notice regarding context.

Users are frequently trying to use tokens out of context, like using a node token inside a block.

osopolar’s picture

FWIW: If the token people want to have access is the current-page content object. issue #919760: Add a [current-page:object:?] dynamic token may help them to achieve what they are looking for. Maybe it's worth to mention that in the README file.

darvanen’s picture

I wasn't aware of that issue, thanks for linking, it would be a HUGE improvement.
It wouldn't stop people using the wrong tokens though, just provide a good alternative.

volkswagenchick’s picture

Issue tags: +sfdug
volkswagenchick’s picture

Issue tags: +dcnj19, +fldc19
volkswagenchick’s picture

Issue tags: +midcamp2019
colorfulcoder’s picture

I noticed that the README.txt was outdated because it tells the user to go to /admin/settings/filters and that didn't work for me.
I wanted to create an issue for it but I see that this one already exists. Lovely!

I saw the patch and I have one thing to say about it, although it is nitpicky:
I would use https instead of http. I know it will get redirected anyways, but it's just good practice.

I would make a new patch and diff, but I find that my diff files always get messed up and don't work :( And since it's such a small difference I thought it'd be ok to just mention it like this.

volkswagenchick’s picture

+++ b/README.txt
@@ -8,35 +8,9 @@ This initial development version only works for global and user token types.
+2) Go to /admin/config/content/formats and enable the token_filter for any of your existing filter type or if you wish, create a new one.

Line breaks at 80 characters, please.

kamalparyani’s picture

StatusFileSize
new715 bytes

Added Line Breaks at 80 characters.

volkswagenchick’s picture

Thanks for updating. The last patch is incomplete.

Please review documentation: https://www.drupal.org/docs/develop/documenting-your-project/readme-temp...

Here is a summary of the preferred format for README.txt:

Headings in all caps.
Headings underlined with ===/--- to the length of the heading, followed by a blank line.
Two lines prior to headings (except the first one).
Bullets denoted by asterisks (*) with hanging indents.
Numbered lists indented 4 spaces.
Bulleted lists indented 1 space.
Text manually word-wrapped within around 80 cols.

Webbeh’s picture

Status: Needs work » Needs review
StatusFileSize
new1.94 KB
new1.83 KB

#14 appeared to ignore the work of #2 and #3, so fixing #3 given the requests on #15. Rerolled patch based on changes and interdiff from 3->16.

volkswagenchick’s picture

Status: Needs review » Reviewed & tested by the community

Thanks @Webbeh for the updated patch and interdiff.

I reviewed the readme file for grammar, spelling, formatting, and readability.
Links are all valid.
The configuration is correct.

Patch applied locally. Marking RTBC

  • Darvanen committed e4beab5 on 7.x-1.x authored by Webbeh
    Issue #1304764 by capynet, Webbeh, kamalparyani, Screenack,...
darvanen’s picture

Status: Reviewed & tested by the community » Fixed

Thanks all :)

Status: Fixed » Closed (fixed)

Automatically closed - issue fixed for 2 weeks with no activity.