[
http://jira.magnolia-cms.com/browse/DOCU-26?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]
Antti Hietala updated DOCU-26:
------------------------------
Summary: Document missing filters (was: Add documentation for Login
and Security filter)
Issue Type: Task (was: Bug)
Assignee: Ruth Stocks (was: Antti Hietala)
Priority: Neutral (was: Major)
Description:
Update filter documentation:
* Move filter reference documentation one level up from
{{/reference/request-handling/filters}} to {{/reference/filters}}.
* Add more obvious links from the conceptual documentation at [Request
processing and
filters|http://documentation.magnolia-cms.com/technical-guide/request-processing-and-filters.html]
to the filter reference. The current link at the bottom is hard to spot. Add
reverse links too.
* In filter reference, drop the trailing word "filter" from the subheadings.
Pretty obvious that these are filters.
* Document missing filters. Look in Javadoc and code for short descriptions.
** {{info.magnolia.cms.filters.UnicodeNormalizationFilter}} normalizes the
current URI to the NFC form which is used internally.
** {{info.magnolia.enterprise.registration.RegistrationFilter}} checks the
validity of the registration of an enterprise installation.
** {{info.magnolia.module.extendedtemplatingkit.filters.MultiSiteFilter}}
initializes the multidomain support and makes domain-related properties
available in the aggregation state.
** {{info.magnolia.module.templating.ModelExecutionFilter}} executes the model
for a component before template rendering.
** {{info.magnolia.module.softlocking.filters.SoftLockingFilter}} checks
whether this is an AJAX request to interact with server-side soft locking
support and which returns JSON results.
* Match the order of filters in the filter chain. The order of nodes is
significant, cannot be reordered randomly.
was:
Administrator docs - explaining all possible login and callback handlers
Developers docs - concept / example
Component/s: content
> Document missing filters
> ------------------------
>
> Key: DOCU-26
> URL: http://jira.magnolia-cms.com/browse/DOCU-26
> Project: Documentation
> Issue Type: Task
> Components: content
> Reporter: Sameer Charles
> Assignee: Ruth Stocks
>
> Update filter documentation:
> * Move filter reference documentation one level up from
> {{/reference/request-handling/filters}} to {{/reference/filters}}.
> * Add more obvious links from the conceptual documentation at [Request
> processing and
> filters|http://documentation.magnolia-cms.com/technical-guide/request-processing-and-filters.html]
> to the filter reference. The current link at the bottom is hard to spot. Add
> reverse links too.
> * In filter reference, drop the trailing word "filter" from the subheadings.
> Pretty obvious that these are filters.
> * Document missing filters. Look in Javadoc and code for short descriptions.
> ** {{info.magnolia.cms.filters.UnicodeNormalizationFilter}} normalizes the
> current URI to the NFC form which is used internally.
> ** {{info.magnolia.enterprise.registration.RegistrationFilter}} checks the
> validity of the registration of an enterprise installation.
> ** {{info.magnolia.module.extendedtemplatingkit.filters.MultiSiteFilter}}
> initializes the multidomain support and makes domain-related properties
> available in the aggregation state.
> ** {{info.magnolia.module.templating.ModelExecutionFilter}} executes the
> model for a component before template rendering.
> ** {{info.magnolia.module.softlocking.filters.SoftLockingFilter}} checks
> whether this is an AJAX request to interact with server-side soft locking
> support and which returns JSON results.
> * Match the order of filters in the filter chain. The order of nodes is
> significant, cannot be reordered randomly.
--
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators:
http://jira.magnolia-cms.com/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira
----------------------------------------------------------------
For list details, see: http://www.magnolia-cms.com/community/mailing-lists.html
Alternatively, use our forums: http://forum.magnolia-cms.com/
To unsubscribe, E-mail to: <[email protected]>
----------------------------------------------------------------
