Uploaded image for project: 'Documentation'
  1. Documentation
  2. DOCU-26

Document missing filters

    XMLWordPrintable

Details

    • Task
    • Resolution: Fixed
    • Neutral
    • None
    • None
    • content
    • None

    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.

      Checklists

        Acceptance criteria

        Attachments

          Activity

            People

              ahietala Antti Hietala
              scharles Sameer Charles
              Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Checklists

                  Task DoR