Use SiteMesh as module for snippet injection (MSITEMESH-8)

[MSITEMESH-1] Integrate SiteMesh 3 Created: 18/Nov/14  Updated: 15/Dec/14  Resolved: 15/Dec/14

Status: Closed
Project: SiteMesh
Component/s: None
Affects Version/s: None
Fix Version/s: 1.0

Type: Sub-task Priority: Neutral
Reporter: Roman Kovařík Assignee: Roman Kovařík
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified

Issue Links:
dependency
is depended upon by MSITEMESH-3 Implement injection rule and tags Closed
Template:
Date of First Response:

 Comments   
Comment by Jan Haderka [ 06/Dec/14 ]
  1. RuleConfig says "// drop this" ... so why don't you?
  2. pom.xml should extend enterprise parent. Then you can also get rid of the whole <build/> section in the pom.
  3. Not sure if InjectAdmincentralButtonTag should be integral part of the module. In here it serves only as a sample no? Might be better to keep it separate or in the very least change the package to make it clear what this is for.
  4. AbstractRule would benefit from some java doc. What is it for? What is includeInContent flag enabling? When do I likely want to use it? ...
  5. MagnoliaContentProcessor - javadoc again. The " * Magnolia specific implementation of {@link TagBasedContentProcessor}

    which offers possibility of configuration via Magnolia admincentral config tree." doesn't really say anything unless I already know what TBCP does at which point I most likely don't need to read the javadoc for MCP.

  6. TagRuleBundle - ditto. Javadoc can use some love.
  7. In SiteMeshModuleVersionHandler remove commented out code ... or uncomment.
  8. MagnoliaHttpServletRequestFilterable
    • not clear what this is for from the javadoc and
    • contains some commented out code
  9. MagnoliaSiteMeshFilter - commented out code
  10. MagnoliaWebAppContext - commented out code & javadoc should explain how/when is this context used
    ... didn't review templates and tests in first round.
  11. In general, is this module a SiteMesh integration that has side effect of allowing us doing snippet caching or is main purpose of the module snippet caching and the fact that we use SiteMesh to achieve that is just implementation detail that might change in the future? Answer to this question might have impact on the name of the module.
  12. Why do we need MagnoliaTagRuleBundle and TagRuleBundleWrapper? Can't they be merged in one?
Comment by Roman Kovařík [ 08/Dec/14 ]
  1. Solved by MSITEMESH-10.
  2. Solved by MSITEMESH-4
  3. To be addressed by MSITEMESH-11.
  4. The TagRuleBundlesWrapper can be used for wrapping of useful TagRuleBundles provided by SiteMesh3 out of the box (without ability to add/remove hardcoded rules from the bundle).
    MagnoliaTagRuleBundle is able to add/remove rules at runtime.
Comment by Evzen Fochr [ 15/Dec/14 ]

1 /server/filters/sitemesh/decoratedFilter/contentProcessor/tagRuleBundles/magnolia/rules/injectAdminCentralButtonRule/tag@class broken path.
2 Button got to admincentral, should be disabled by default.

Generated at Mon Feb 12 10:56:50 CET 2024 using Jira 9.4.2#940002-sha1:46d1a51de284217efdcb32434eab47a99af2938b.