diff --git a/Documentation/Concepts/Cache.rst b/Documentation/Concepts/Cache.rst index e06850d..5f65d32 100644 --- a/Documentation/Concepts/Cache.rst +++ b/Documentation/Concepts/Cache.rst @@ -1,6 +1,6 @@ -.. include:: /Includes.rst.txt +.. include:: /Includes.rst.txt -.. _cache: +.. _cache: ===== Cache @@ -8,7 +8,8 @@ Cache Computing a page to be displayed in the frontend requires time and resources. -TYPO3 (and many other CMS) use caching to help reduce the amount of time and resources it takes to generate a page. +TYPO3 (and many other CMS) use caching to help reduce the amount of time and +resources it takes to generate a page. When you display a page in the frontend, TYPO3 first checks if that page can be found in the cache and has already been calculated. If the page @@ -17,7 +18,7 @@ If the page is not found in the cache, it is generated by collecting data from different sources and performing some calculations. The result is then delivered to the visitor and stored for future use. -.. _browser-cache: +.. _browser-cache: Browser cache ============= @@ -32,16 +33,20 @@ browsers cache. On Windows in most browsers you can press :kbd:`Ctrl` + :kbd:`F5` to clear the browser cache. +.. _cache-automatic: + Automatic cache clearing ======================== With TYPO3, the cache of a page is cleared automatically in the following cases: -* You changed something about the page itself like its title -* You changed a content of the page like a text or image on that page -* In certain time intervals, usually once a day -* If content with a starttime or endtime set becomes visible or invisible -* In some other cases that your integrator or developer might have defined +* You changed something about the page itself like its title +* You changed a content of the page like a text or image on that page +* In certain time intervals, usually once a day +* If content with a starttime or endtime set becomes visible or invisible +* In some other cases that your integrator or developer might have defined + +.. _cache-frontend: Scenario: Changes are not visible in the frontend ================================================= @@ -51,19 +56,21 @@ be visible right away in the frontend. Some scenarios in which manual cache clearing might be necessary: -* You changed the title of a page. You view the affected page and everything - looks fine. Now you go to the start page and cannot see your change in the - menu. The following happened: Changing a pages title deletes the cache of the - affected page. It does, however, not delete the cache of other pages like the - start page. +* You changed the title of a page. You view the affected page and everything + looks fine. Now you go to the start page and cannot see your change in the + menu. The following happened: Changing a pages title deletes the cache of the + affected page. It does, however, not delete the cache of other pages like the + start page. -* You added a news record. It does not appear in the news list. Creating a - record does not automatically delete the cache of any page unless the - integrator made some configurations. +* You added a news record. It does not appear in the news list. Creating a + record does not automatically delete the cache of any page unless the + integrator made some configurations. -* You changed content on one page that should also be displayed on other pages. - This is often done with static parts of the page that should be editable - such as the footer, a carousel in the header, etc. +* You changed content on one page that should also be displayed on other pages. + This is often done with static parts of the page that should be editable + such as the footer, a carousel in the header, etc. + +.. _cache-manual: Manual cache clearing ===================== @@ -75,10 +82,10 @@ To clear the cache of that page, go to the module :guilabel:`Web > Page` and click the button representing a lightning bolt with the tooltip :guilabel:`Clear cache for this page`. -.. figure:: /Images/ManualScreenshots/Cache/ClearPageCache.png - :alt: Clear cache for this page +.. figure:: /Images/ManualScreenshots/Cache/ClearPageCache.png + :alt: Clear cache for this page - Clear cache for this page + Clear cache for this page When you reload the affected page, the changes should be visible right away. If the changes are not visible, clear the :ref:`browser-cache`. Or use an @@ -88,18 +95,20 @@ Only editors who have the relevant user rights can flush the cache of all pages. If you cannot see the lightning bolt button beside the help menu button in the toolbar you might not have the rights to carry out this action: -.. figure:: /Images/ManualScreenshots/Cache/ClearAllPageCaches.png - :alt: Flush cache of all pages +.. figure:: /Images/ManualScreenshots/Cache/ClearAllPageCaches.png + :alt: Flush cache of all pages + + Flush cache of **all** pages - Flush cache of **all** pages +.. warning:: After flushing the cache each page has to be generated a new + on the first request for that page. This requires resources on the server + such as processor and hard disc usage. If too many pages have to be + generated at the same time, generating them might take longer (maybe minutes + instead of seconds) or fail all together. Therefore some TYPO3 installations + do not allow manual cache flushing. Talk to you administrator about the + preferred strategy here. -.. warning:: After flushing the cache each page has to be generated a new - on the first request for that page. This requires resources on the server - such as processor and hard disc usage. If too many pages have to be - generated at the same time, generating them might take longer (maybe minutes - instead of seconds) or fail all together. Therefore some TYPO3 installations - do not allow manual cache flushing. Talk to you administrator about the - preferred strategy here. +.. _cache-preview: Previewing a page without clearing the cache ============================================ diff --git a/Documentation/Images/ManualScreenshots/Cache/CacheCleared.png b/Documentation/Images/ManualScreenshots/Cache/CacheCleared.png index dc1b67d..9a3de55 100644 Binary files a/Documentation/Images/ManualScreenshots/Cache/CacheCleared.png and b/Documentation/Images/ManualScreenshots/Cache/CacheCleared.png differ diff --git a/Documentation/Images/ManualScreenshots/Cache/ClearAllPageCaches.png b/Documentation/Images/ManualScreenshots/Cache/ClearAllPageCaches.png index 571b38f..c3d9430 100644 Binary files a/Documentation/Images/ManualScreenshots/Cache/ClearAllPageCaches.png and b/Documentation/Images/ManualScreenshots/Cache/ClearAllPageCaches.png differ diff --git a/Documentation/Images/ManualScreenshots/Cache/ClearPageCache.png b/Documentation/Images/ManualScreenshots/Cache/ClearPageCache.png index f2135e2..526bc60 100644 Binary files a/Documentation/Images/ManualScreenshots/Cache/ClearPageCache.png and b/Documentation/Images/ManualScreenshots/Cache/ClearPageCache.png differ