Skip to content

Commit

Permalink
Item11549: add a little docco for non-foswiki updating of topics
Browse files Browse the repository at this point in the history
git-svn-id: http://svn.foswiki.org/branches/Release01x01@15695 0b4bb1d4-4e5a-0410-9cc4-b2b747904278
  • Loading branch information
SvenDowideit authored and SvenDowideit committed Oct 24, 2012
1 parent 18a97b7 commit 130adbc
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 1 deletion.
2 changes: 1 addition & 1 deletion core/data/System/CommandAndCGIScripts.txt
Expand Up @@ -53,7 +53,7 @@ All the scripts accept a number of common parameters. The first two components o
| =foswikioriginalquery= | The original query that was being made before a redirect for user confirmation was required. | |
| =foswiki_redirect_cache= | Foswiki sometimes caches long lists of parameters that must survive over a sequence of browser redirects. This parameter identifies one of these caches. The parameter value is a "magic number" that uniquely idenitifies a file in the =working/tmp= directory. These files have a very short lifetime, and are destroyed when the cache is read. | |
| =logout= | requests the !LoginManager to log the current user out (this happens at the begining of the request so will terminate any other operation requested) | |
| =refresh= | If the Foswiki page cache is in use, setting this parameter will invalidate the cache. Valid values are =on= and =all=. See PageCaching for more information on the page cache. | |
| =refresh= | If the Foswiki page cache is in use, setting this parameter will invalidate the cache. Valid values are =cache=, =on= and =all=. See PageCaching for more information on the page cache. | |
| =response= | Used as part of the request validation process. | |
| =skin= | Overrides the default skin path (see [[Skins]]) | _value of the =SKIN= preference_ |
| =t= | While the =t= parameter is not actively used by any scripts, it is used when building links to scripts such as =edit=, to ensure that each edit link is unique. This stops the browser from trying to use a cached reply from a previous call to the script. | _generally set to current time, in seconds_ |
Expand Down
11 changes: 11 additions & 0 deletions core/data/System/PageCaching.txt
Expand Up @@ -105,6 +105,17 @@ The complete cache for all topics can be cleared using =refresh=all=.
%T% The cache should be refreshed after installing a Foswiki upgrade, or after installing updates to any plugins that would change the output of macros.
</blockquote>

---++++ Command line cache refresh

If you have topics that are updated externally to foswiki, which do not use the recomended =Foswiki::Func::saveTopic= API, you can
(carefully) call update from the commandline:

eg. =sudo -u www ./view /Tasks/Item12035 -refresh=cache=.

__NOTE__ it is very important that you run this as the same user that the web server uses to access foswiki (and the cache).

see CommandAndCGIScripts

---+++ Caching SEARCH results
When you enable the Foswiki page cache, all SEARCH results will automatically
be cached. As a consequence a SEARCH on a page will not be performed again as long as this
Expand Down

0 comments on commit 130adbc

Please sign in to comment.