User Tools

Site Tools


Exclusion of pages and modules

Components, views, parts of uri excluded from caching

Starting with JotCache, ver.1.1 we have available powerfull tool for excluding components from caching process. On the toolbar of Cache Management it is located Exclude button which opens excluding form :

In this form are listed all components installed in Joomla CMS identified by Component Name and internal code (option) which is also one part of page URL.

You can exclude from caching entire component processing with checkbox Excluded checked and empty Views input line.

Excluding only specific views of the component you can do with checkbox Excluded checked and Views input line contains list of excluded views separated by comma. When you want to remove component from Exclude Component list then simply uncheck appropriate checkbox and press Apply or Save button.

Here is also possibility to exclude selected pages based on parameters of URL query string. It is generally known query parameters pairs (name and value) are located in the part of URL starting with ? character and each pair is separated with & character.

For exclusion purposes here is necessary to use parameters pairs of URL query in form as they are shown in mark 'Yes' link on JotCache management view (see previous paragraph). Parameter pairs are simply inserted into given component line in Exclude Views & Query Parameters input box :

This example is using part of URL query string

index.php?page=shop.browse&product_id=1&category_id=1&option=com_virtuemart&Itemid=56'

Multiple parameters pairs are separated with , character and can be intermixed with component views as described in previous section. When inserting or changing text in Exclude Views & Query Parameters input box (events 'click' and 'onchange') then automatic validation check on above described rules is performed. Only fully validated definitions are possible to save in database.

Module positions excluded from page caching

In the Joomla CMS each module is placed to template specific position (see Administrator > Extensions > Module Manager / column Position. For graphical presentation see Administrator > Extensions > Template Manager, click on used template name and then click toolbar button Preview).

In JotCache ver.4.1+ is module exclusion simplified and more reliable as it was in previous versions. It is necessary only to check template positions for which we need to exclude modules from caching. All other informations (style, attributes) are derived in JotMarker plugin internally.

Text marked with left vertical line is for version 4.1+ obsolete.

Starting with JotCache, ver.3.0 module exclusions can be implemented with two different but compatible methods (they can be used each with other in the same time but not on the same template position) :

WARNING Do not use both exclusion method to same template position !

Prefered exclusion method is using <jot..> tags inserted direct into template (method #1).
When such insertion is not possible leave template without <jot..> tags and use exclusions on JotCache Position Exclude page (method #2).
Method #1 - Position exclusions on management form
Template positions excluded from caching can be set on new form :
On the form can be selected any frontend module position which is assigned and enabled in Module Manager.
The position which we like to exclude from caching must have non-empty input Style containing proper style name. The style name is very important because based on given style is used by parsing of modules located on specific template position.
Example for JA template - different styles applied on the same module :
Style names can be derived from template code or got from template designers.
In the input Optional style attributes are listed (when applicable) attributes in following format :
attr1=“value1”,attr2=“value2”,….
Starting with JotCache ver.3.2.2 is used additional JotMarker plugin for precise marking of exclusion areas. For proper operation this plugin have to be enabled and positioned as very first plugin in order of all system plugins.
Method #2 - Positions exclusion on site template
Marking template positions for caching exclusion by means of special comment tags on all Joomla templates which are using standard jdoc:include tags (inclusive Artisteer generated templates).
Templates using non-standard template processing (e.g. Warp system of Yootheme) can be excluded only with method Positions exclusion on management form.
In the Joomla template each module position is tagged with following tag :
<jdoc:include type=“modules” name=“xxx” … />
where xxx is position name.
To exclude specific module position from page caching it is necessary to mark this position in template source (mostly index.php) with special JotCache HTML comment tags - see example :
IMPORTANT CHANGE for JotCache ver.3.2+
jot tags have to be no more inserted into template as comments but as specific tags (please take care for 'space' before '>') :
<td>
<jot user2 s style=“xhtml” ><jdoc:include type=“modules” name=user2“ style=“xhtml” /><jot user2 e >
</td>
Old form of jot tags <!– jot user2 s …>…<!– jot user2 e –> is depreciated.
JotCache 3.2 rewrites on-the-fly old tags to new ones when such case happens for cached pages after JotCache upgrade.
Text in the marking tags is separated with exactly one (1) space starting with word jot followed by name_of_position jot_flag params
where
* name_of_position - name of position as it is used in jdoc tag
* jot_flag - 's' for start marking, 'e' for end marking
* params - any kinds of jdoc parameters separated with space character
Used jot tags have to close embrace the jdoc tag for proper operation.
Mark in your template only module positions which you like to be steady refreshed. When page is cached then all JotCache mark tags are stored with cached content. During recall of cached content the marked positions are replaced with module newest content.