[DOCU-26] Document missing filters Created: 17/May/07  Updated: 12/Nov/14  Resolved: 30/Jan/12

Status: Closed
Project: Documentation
Component/s: content
Affects Version/s: None
Fix Version/s: None

Type: Task Priority: Neutral
Reporter: Sameer Charles Assignee: Antti Hietala
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Template:
Acceptance criteria:
Empty
Task DoR:
Empty
Date of First Response:

 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 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.


 Comments   
Comment by Giancarlo Berner [ 06/Jun/07 ]

Sameer, can you please add your comments to the /docs section, administrator and developer? This will save me some time!
Thanks!

Comment by Ruth Stocks [ 28/Jan/12 ]

Updated page at - http://docuauthor.magnolia-cms.com/reference/filters.html

  • Documented missing filters per instructions above. Also added RangeSupportFilter (included in 4.4.6 but not 4.4.5) and matched the sequence to 4.4.6.
  • Added second link in Technical Guide > Request processing and filters to Magnolia CMS filter chain section.
  • For 4.5 added a page at Pages for the new structure > Reference > Filters in the correct sequence for 4.5 (based on beta4). The content duplicates and amends only the Magnolia core filters section.
  • The javadoc macro works for the ‘main’ project and cannot be used concurrently for different content. The 4.5 links use ‘full’ links to the 4.5-beta4 javadocs and will need to be changed if the content is used.
Generated at Mon Feb 12 01:05:12 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.