| 1 |
= sfSimpleForum_PayloadFilterChainPlugin = |
|---|
| 2 |
|
|---|
| 3 |
[[PageOutline]] |
|---|
| 4 |
|
|---|
| 5 |
This behavior enhances the sfSimpleForumPlugin, allowing it to make use of sfPayloadFilterChain capabilities. |
|---|
| 6 |
|
|---|
| 7 |
Integration with [wiki:sfPayloadFilterChain_TextTransformationPlugin] : |
|---|
| 8 |
|
|---|
| 9 |
[[Image(sfbbpfc-screencap.png)]] |
|---|
| 10 |
|
|---|
| 11 |
== Installation == |
|---|
| 12 |
|
|---|
| 13 |
* Install plugin dependencies : |
|---|
| 14 |
|
|---|
| 15 |
Required : |
|---|
| 16 |
{{{ |
|---|
| 17 |
symfony plugin-install http://plugins.symfony-project.com/sfPayloadFilterChainPlugin |
|---|
| 18 |
}}} |
|---|
| 19 |
|
|---|
| 20 |
Optional : you can also install plugin's optional dependency [wiki:sfPayloadFilterChain_TextTransformationPlugin sfPayloadFilterChain_TextTransformationPlugin]. |
|---|
| 21 |
If you want text transformation capabilities (bbcode, markdown, smileys, etc) you need to install it : |
|---|
| 22 |
{{{ |
|---|
| 23 |
symfony plugin-install http://plugins.symfony-project.com/sfPayloadFilterChain_TextTransformationPlugin |
|---|
| 24 |
}}} |
|---|
| 25 |
|
|---|
| 26 |
* Install the plugin |
|---|
| 27 |
{{{ |
|---|
| 28 |
symfony plugin-install http://plugins.symfony-project.com/sfSimpleForum_PayloadFilterChainPlugin |
|---|
| 29 |
}}} |
|---|
| 30 |
|
|---|
| 31 |
* Enable Propel behavior support in `config/propel.ini`: |
|---|
| 32 |
{{{ |
|---|
| 33 |
propel.builder.AddBehaviors = true |
|---|
| 34 |
}}} |
|---|
| 35 |
|
|---|
| 36 |
* Rebuild your model: |
|---|
| 37 |
{{{ |
|---|
| 38 |
symfony propel-build-model |
|---|
| 39 |
}}} |
|---|
| 40 |
|
|---|
| 41 |
== Configuration == |
|---|
| 42 |
|
|---|
| 43 |
=== Filtering profile === |
|---|
| 44 |
|
|---|
| 45 |
You need to define the filtering profile of a post. |
|---|
| 46 |
|
|---|
| 47 |
Create and edit `pfc/profiles.yml` in your appplication's `config` directory. Here's an example profile definition : |
|---|
| 48 |
|
|---|
| 49 |
{{{ |
|---|
| 50 |
sfSimpleForum_post: [pfc_text_to_xhtml, pfc_expand_emoticons] |
|---|
| 51 |
}}} |
|---|
| 52 |
|
|---|
| 53 |
For a comprehensive list of available filters, please refer to [wiki:sfPayloadFilterChain_TextTransformationPlugin sfPayloadFilterChain_TextTransformationPlugin documentation]. |
|---|
| 54 |
|
|---|
| 55 |
Of course, you can also define your own filters. |
|---|
| 56 |
|
|---|
| 57 |
=== Mimetype conversion === |
|---|
| 58 |
|
|---|
| 59 |
If you plan to use the `pfc_text_to_xhtml` filter, you need to specify what is the source mimetype for posts. |
|---|
| 60 |
This is defined by a new sfSimpleForumPlugin configuration directive in `app.yml` : |
|---|
| 61 |
{{{ |
|---|
| 62 |
all: |
|---|
| 63 |
sfSimpleForumPlugin: |
|---|
| 64 |
post_mimetype: text/markdown |
|---|
| 65 |
}}} |
|---|
| 66 |
|
|---|
| 67 |
[wiki:sfPayloadFilterChain_TextTransformationPlugin sfPayloadFilterChain_TextTransformationPlugin] natively supports `text/bbcode` and `text/markdown`. |
|---|
| 68 |
|
|---|
| 69 |
== Roadmap == |
|---|
| 70 |
|
|---|
| 71 |
=== 0.6.1 === |
|---|
| 72 |
|
|---|
| 73 |
* Handle multiple chain profile execution |
|---|
| 74 |
* updated installation docs |
|---|
| 75 |
|
|---|
| 76 |
== Changelog == |
|---|
| 77 |
|
|---|
| 78 |
=== 2007-08-02 | 0.6.0 === |
|---|
| 79 |
|
|---|
| 80 |
* Renamed plugin due to renaming of sfBBPlugin to sfSimpleForumPlugin |
|---|
| 81 |
|
|---|
| 82 |
=== 2006-06-29 | 0.5.1 beta === |
|---|
| 83 |
|
|---|
| 84 |
* updated installation docs |
|---|
| 85 |
* fixed improper mixin registration |
|---|
| 86 |
|
|---|
| 87 |
=== 2006-06-28 | 0.5.0 beta === |
|---|
| 88 |
|
|---|
| 89 |
* fixed typo in README |
|---|
| 90 |
* installation documentation update (since symfony's `plugin-install` does not support pear dependencies) |
|---|
| 91 |
* renamed plugin to sfSimpleForum_PayloadFilterChainPlugin |
|---|
| 92 |
* removed sfSimpleForumPlugin patch (as it's been commited in [4463]) |
|---|
| 93 |
* moved sfSimpleForumPostPayload class to sfSimpleForumPlugin |
|---|
| 94 |
|
|---|
| 95 |
Thanks to François for his fast and enlightning feedback. |
|---|
| 96 |
|
|---|
| 97 |
=== 2006-06-27 | 0.4.0 beta === |
|---|
| 98 |
|
|---|
| 99 |
* Initial public release. |
|---|
