Skip to content

Commit

Permalink
Refining docs entry and its formatting about the cache clearing funct…
Browse files Browse the repository at this point in the history
…ionality
  • Loading branch information
BenedekFarkas committed Oct 9, 2023
1 parent a2181da commit 9102731
Showing 1 changed file with 20 additions and 12 deletions.
32 changes: 20 additions & 12 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,18 +37,26 @@ An Orchard CMS module that combines and minifies external stylesheets and javasc
- Define resource sets
- Enable/disable for admin site
- Empty cache
- The Combinator cache can be emptied on Activated Orchard shell event if:
- A marker text file with the name **_ClearCache.txt** is present under the **~\Orchard.Web\App_Data\Sites\\<tenant_name>\\_PiedoneModules\Combinator** folder
- The CombinatorCacheClearingShellEventHandler class's IsDisabled property is set to false (default is true). This can be modified from the HostComponents.config file under the **~\Orchard.Web\Config** folder by modifying the property value. For example:
```
<Component Type="Piedone.Combinator.EventHandlers.CombinatorCacheClearingShellEventHandler" xdt:Transform="Insert">
<Properties>
<Property Name="IsDisabled" Value="false" xdt:Transform="Insert" />
</Properties>
</Component>
```
The module is also available for [DotNest](http://dotnest.com/) sites.
- The Combinator cache can be emptied when the Activated shell event fires if:
- A marker file with the name *_ClearCache.txt* is present in the *Orchard.Web/App_Data/Sites/<tenant_name>/_PiedoneModules/Combinator* folder. This file will then be deleted to have the cache cleared only on the first shell start, e.g. after a new deployment.
- The `CombinatorCacheClearingShellEventHandler` class's `IsDisabled` property is set to `false` (default is `true`) by adding the following section to *Orchard.Web/Config/HostComponents.config*:
```
<Component Type="Piedone.Combinator.EventHandlers.CombinatorCacheClearingShellEventHandler">
<Properties>
<Property Name="IsDisabled" Value="false"/>
</Properties>
</Component>
```
Alternatively, the same can be achieved through a file transformation ([see this for details](https://learn.microsoft.com/en-us/aspnet/web-forms/overview/deployment/visual-studio-web-deployment/web-config-transformations)) to only activate this feature for a given build configuration, e.g., by adding the following to *HostComponents.Release.config* for `Release` mode.
```
<Component Type="Piedone.Combinator.EventHandlers.CombinatorCacheClearingShellEventHandler" xdt:Transform="Insert">
<Properties>
<Property Name="IsDisabled" Value="false" xdt:Transform="Insert" />
</Properties>
</Component>
```
The module is also available for [DotNest](https://dotnest.com) sites.
You can download an install the module from the [Orchard Gallery](http://orchardproject.net/gallery/List/Modules/Orchard.Module.Piedone.Combinator).
For known issues and future plans please see the [Issue Tracker](https://github.com/Lombiq/Combinator/issues).
Expand Down

0 comments on commit 9102731

Please sign in to comment.