Document the flexifilter module

cwgordon7 - January 13, 2008 - 18:47
Project:Google Highly Open Participation Contest (GHOP)
Component:Task idea
Category:task
Priority:normal
Assigned:Unassigned
Status:reviewed & tested by the community
Description

The flexifilter module is a key module for site builders who want to create highly custom filters. However, there are no documentation pages on it in the Drupal handbooks, potentially making it difficult to use for new users. Your task will be to create three documentation pages for it. You should checkout CVS HEAD from the repository and become familiar with the module. These are the five desired pages:

Page 1: Overview

On this page, you should give an overview of the module: what it does, how it's useful, etc.

Page 2: Terminology

Here, you will define the basic terms of flexifilter, such as components, conditions, flexifilters, and chunks.

Page 3: Step-through tutorial

Here, you will give a step-by-step tutorial on how to create a flexifilter. You should assume that the user has absolutely no idea on how filters work or anything of the sort. You should mention ways to keep flexifilter-defined input formats secure.

Page 4: Example flexifilters

Here, you should give at least five examples of filters you can make with the flexifilter module, and at least two step-by-step explanations of how, exactly, to create them. If this spills out onto some sub-pages, that's fine.

Page 5: API documentation

Here, you will list useful API functions that the flexifilter module provides, and will show module writers how to code for flexifilter. You should mention flexifilter's hooks and at least three nice API functions to use.

Note:

You should be working off Drupal 6 HEAD, as this contains the latest API features, etc.

Resources:

Flexifilter module (http://drupal.org/project/flexifilter)
Article on the introduction of flexifilter (http://cwgordon.com/introducing-flexifilter)
Dojo lesson on flexifilter (http://drupaldojo.com/lesson/flexifilter-module)

Mentor:

TBTO

Deliverables:

5 (or more) handbook pages, posted here first, and approved by the mentor.

#1

aclight - January 14, 2008 - 02:43
Status:needs review» needs work

A.) You say "Your task will be to create three documentation pages for it" but then give 5 pages.

B.) You still need a mentor, of course.

C.) I wouldn't say they should post the work here first, since that's a little cumbersome to post in two separate places.

D.) I'm a bit worried that this module is still in a lot of flux and that a lot of what's written might change in the near future. But you're in a better position to estimate this than I am.

Other than these, this looks pretty good.

#2

cwgordon7 - January 14, 2008 - 03:18

The flexifilter module is a key module for site builders who want to create highly custom filters. However, there are no documentation pages on it in the Drupal handbooks, potentially making it difficult to use for new users. Your task will be to create five documentation pages for it. You should checkout CVS HEAD from the repository and become familiar with the module. These are the five desired pages:

Page 1: Overview

On this page, you should give an overview of the module: what it does, how it's useful, etc.

Page 2: Terminology

Here, you will define the basic terms of flexifilter, such as components, conditions, flexifilters, and chunks.

Page 3: Step-through tutorial

Here, you will give a step-by-step tutorial on how to create a flexifilter. You should assume that the user has absolutely no idea on how filters work or anything of the sort. You should mention ways to keep flexifilter-defined input formats secure.

Page 4: Example flexifilters

Here, you should give at least five examples of filters you can make with the flexifilter module, and at least two step-by-step explanations of how, exactly, to create them. If this spills out onto some sub-pages, that's fine.

Page 5: API documentation

Here, you will list useful API functions that the flexifilter module provides, and will show module writers how to code for flexifilter. You should mention flexifilter's hooks and at least three nice API functions to use.

Note:

You should be working off Drupal 6 HEAD, as this contains the latest API features, etc.

Resources:

Flexifilter module (http://drupal.org/project/flexifilter)
Article on the introduction of flexifilter (http://cwgordon.com/introducing-flexifilter)
Dojo lesson on flexifilter (http://drupaldojo.com/lesson/flexifilter-module)

Mentor:

dmitrig01

Deliverables:

5 (or more) handbook pages, approved by the mentor, dmitrig01.

#3

aclight - January 14, 2008 - 03:27
Status:needs work» reviewed & tested by the community

looks good to me

#4

gilbertdelyon - December 1, 2009 - 09:30

I just spent 1 or 2 hours in testing and trying to understand how to use Flexifilter (poor documentation) and at the end it seams to me as must have module, very flexible, and that can be used for many useful purposes.

Before more intensive use I worry about the future of this module:
- No update for nearly 2 years, while bugs have been reported
- No dev release for D7
- No significant buzz on Drupal.org
- Will it be integrated in D7 core as I read somewhere?

Would someone have some news about this module?

 
 

Drupal is a registered trademark of Dries Buytaert.