Issue 146 in google-highly-open-participation-drupal: Document the flexifilter module
codesite...@google.com
http://code.google.com/p/google-highly-open-participation-drupal/issues/detail?id=146
Comment #13 by agentrickard:
Some notes. This is a very good start, but the documentation needs some scrubbing.
(You probably know that, from the comment above, so consider this a
practical guide.)
-- At the very start, please define what Drupal filters are.
-- "to further improve" is redundant. Use "to improve."
-- Drupal GHOP has no context here. Link?
-- "Chunk grab on [ and ]" is confusing. The chuck is not defined by
the word AND
in the text string. It is defined by the brackets, right? So this
should be "Chunk
defined by [bracket text]"
-- Please describe the import/export process at the beginning. Where
do I import
files? Through the UI? What is the menu path? Admin > Content > Flexifilter?
-- "If you wish to use them in your module, import them manually with Flexifilter,
and then export them." This is confusing because the first sentence is
about using
Flexifilters as Filters. This is about using them as module code.
There should
probably be two sections of the documentation: Using Flexifilters and Implementing
Flexifilters into Modules.
-- "Link Formatting" is blank.
-- "Swear Filter" is blank.
-- "hook_flexifilters allows modules to define default flexifilters. A
array should
be returned, with each value of the array corresponding to an exported flexifilter
(as an array itself)." I have no idea what this means. What format is
the array in?
What are its keys? Its required elements? Its allowed values?
-- "hook_flexifilter_components" text block needs to be formatted for
easy reading on
this screen. A sample return array should be added.
-- Sample for "hook_flexifilter_conditions" also. What is the
difference between
this hook and the other? Why do I use each one?
-- "Useful API Functions" are not documented meanigfully. What is $op?
-- Page ends in the middle of a sentence.
-- "This is the tree" -- no, this is a page with links on it.
-- How do I find the Flexifilter administration area?
-- Give this list a header, like the related page has.
-- How do I find the Flexifilter administration area?
--
You received this message because you are listed in the owner
or CC fields of this issue, or because you starred this issue.
You may adjust your issue notification preferences at:
http://code.google.com/hosting/settings
codesite...@google.com
http://code.google.com/p/google-highly-open-participation-drupal/issues/detail?id=146
Comment #14 by birdmanx35:
Yep, I have a couple of things to do on the Examples today, and I'll
use your suggestions. Thanks!
codesite...@google.com
http://code.google.com/p/google-highly-open-participation-drupal/issues/detail?id=146
Comment #15 by birdmanx35:
Okay, I implemented some of your suggestions, but not all of them.
I'm almost 98% done with the task- just need to do the link filter (I'm
a tad stuck
without dmitrig01, who is afk atm) and then I'll be done, so CNR.
codesite...@google.com
http://code.google.com/p/google-highly-open-participation-drupal/issues/detail?id=146
Comment #16 by birdmanx35:
This is now 100% done. Feel free to review/close!
codesite...@google.com
http://code.google.com/p/google-highly-open-participation-drupal/issues/detail?id=146
Comment #17 by birdmanx35:
Attached is the work done.
Attachments:
flexifilterdocs.zip 6.3 KB
codesite...@google.com
http://code.google.com/p/google-highly-open-participation-drupal/issues/detail?id=146
Comment #18 by aclight:
Great job. This was +1ed in IRC, so I'm closing it up. Thanks for
your hard work.
Issue attribute updates:
Status: Closed
Labels: AdminChecked