Updated Readme.md - #19
Open
DaRosenberg wants to merge 1 commit into
Open
Conversation
Simplified the readme a bit to a format I think we should employ for all free modules. Rewrote the section on AJAX widgets to make it completely unrelated to caching. Corrected inconsistent license reference (BSD vs. MIT). Added paragraph on how widget output caching feature relates do IDeliverable.Donuts.
DaRosenberg
commented
Dec 17, 2016
| Without changing any code or markup, widgets can be configured to be output cached independently of the surrounding page. The output cache duration can be configured per widget. To enable output caching of individual widgets, **IDeliverable.Widgets** provides a content part named `OutputCachePart`. Simply attach it to any widget content type to be able to control, per widget, whether it should be output cached or not and for how long. | ||
|
|
||
| **IDeliverable.Widgets** solves this problem by providing a content part named `WidgetsContainerPart` which can be added to any (non-widget) content type (such as *Page* for example). With this content part attached, you can now add widgets to a specific content item of that content type, without the need to create a dedicated widget layer for it. | ||
| **NOTE:** This feature is a very rudimentary way to achieve donut hole caching, and it has significant limitations. For a much more robust and complete implementation of donut caching and donut hole caching for Orchard, please refer to the [IDeliverable.Donuts module](http://www.ideliverable.com/products/premium-orchard-modules/ideliverable-donuts) which is more likely to be actively developed going forward. |
Contributor
Author
There was a problem hiding this comment.
@sfmskywalker This is the critical section as discussed. I'm quite happy with the wording, hope you are too.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Simplified the readme a bit to a format I think we should employ for all free modules. Rewrote the section on AJAX widgets to make it completely unrelated to caching. Corrected inconsistent license reference (BSD vs. MIT). Added paragraph on how widget output caching feature relates do IDeliverable.Donuts.