Identify tutorial subjects in Modules.
--------------------------------------
Key: DOCU-337
URL: http://jira.magnolia-cms.com/browse/DOCU-337
Project: Documentation
Issue Type: Task
Security Level: Public
Reporter: Gavan Stockdale
Assignee: Antti Hietala
* Identify tutorial subjects in Modules.
* Check existing tutorials list, forum and wiki to see if topic is covered.
* If not make a checknote.
* Where a topic is covered, link to the tutorial from official documentation.
As an example of what could be an area for a tutorial. In the Cache page there
is a section on Excluding content from cache.
Note that while the instructions are clear (They give the reader an aim and
direction), they don't specify exactly how to do the task required. Perhas this
level of detail is not required. Establishing this is part of the tasks.
*Excluding content from cache*
There are multiple reasons for excluding content from cache. The most common is
the existence of components that query some external data source dynamically,
resulting that the rendered HTML may change even if the content of the Magnolia
CMS page has not. By default, all pages containing query arguments are excluded
from the cache.
Dummy URL parameter
The simplest way to exclude content is to link to the page with a dummy query
parameter in the URL. A more subtle solution is to add bypass to the cache
filter. This ensures that no cache filter is executed on particular URLs.
Deny URLs in cash policy
Alternatively, you can add these URLs to the deny list of the cachePolicy.
Entries on the deny list are not cached by Magnolia CMS but are taken through
the entire filter chain, meaning that other policies such as BrowserCachePolicy
can still be applied.
Regular cache flush
A more sophisticated exclusion strategy is to cache the page but flush it from
the cache at regular intervals. This involves reconfiguring the underlying
cache engine (Ehcache). To apply the strategy to a subset of URLs only, the
best way is to deploy a custom implementation of CachePolicy. The cache policy
will then maintain information (directly or by requesting cache entry creation
info from the cache engine) about when each URL has been re-cached last and
will be able to decide when the cache entry needs to be refreshed again.
--
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]>
----------------------------------------------------------------
