[CMF-checkins] CVS: Products/CMFCore/help - Actions.stx:1.1.2.1 CPMPolicies.stx:1.1.2.1

[Jens Vagelpohl]

Update of /cvs-repository/Products/CMFCore/help
In directory cvs.zope.org:/tmp/cvs-serv31707/CMFCore/help

Added Files:
      Tag: CMF-1_5-branch
	Actions.stx CPMPolicies.stx 
Log Message:
- CMFCore.CachingPolicyManager and CMFCore.ActionInformation: The names
  available to TALES expressions throughout the CMF showed some
  inconsistencies. To prevent confusion the names "content" and
  "content_url" that were used for Cache Policy Manager policies as well
  as the special ActionInformation.oai class are now deprecated and will
  be removed in CMF 1.7. The canonical names to be used are "object" and
  "object_url", which matches all other CMF expression contexts with
  DCWorkflow being the only exception due to its non-CMF roots.
  (http://www.zope.org/Collectors/CMF/328)


=== Added File Products/CMFCore/help/Actions.stx ===
CMFCore - Actions

  Actions generate links to views of content, or to specific methods
  of the site.  They can be filtered via their conditions.

  The 'Actions' tab is the place to add or modify actions. The following
  fields are available to describe an action:

    - 'Title' -- The freely selectable title will show up as the link
      text for the linked action in the portal.

    - 'Id' -- An ID uniquely identifies an action in its action category
      (see below) and thus should be unique among the other action IDs in
      the same category.

    - 'URL (Expression)' -- A TALES expression that is used to construct
      the link target for the action. The following bound names are
      available to your expression:

        - 'object' -- The current object

        - 'object_url' -- The URL for the current object

        - 'folder' -- The current object's containing folder

        - 'folder_url' -- The URL for the current object's containing folder

        - 'portal' -- The portal object

        - 'portal_url' -- The URL for the portal

        - 'isAnonymous' -- A boolean evaluating to a truth value if the
          current user is an anonymous site visitor and false if the user is
          authenticated

        - 'user_id' -- The current user's ID

    - 'Condition (Expression)' -- A TALES expression that determines whether
      the described action should be shown or not. The expression namespace 
      contains the same members as described under 'URL (Expression)'

    - 'Permission' -- Select a permission to limit the action to visitors who
      have the selected permission

    - 'Category' -- The action category, which is used to subdivide the
      available actions into logical groups. The category can be arbitrary or
      one of the commonly-used categories, such as 'object' or 'folder' etc.

    - 'Visible' -- Toggle to enable or disable showing the action link in case
      the Permission and Condition restrictions are met, but the action is not
      supposed to show up at all.



=== Added File Products/CMFCore/help/CPMPolicies.stx ===
Cache Policy Manager - Policies

  A cache policy represent a single class of cachable objects:

    - class membership is defined by 'predicate', a TALES expression
      with access to the following top-level names:

      'object' -- the object itself

      'view' -- the name of the view method

      'keywords' -- keywords passed to the request

      'request' -- the REQUEST object itself

      'member' -- the authenticated member, or None if anonymous

      'modules' -- usual TALES access-with-import

      'nothing' -- None

      'time' -- A DateTime object for the current date and time

    - The "Last-modified" HTTP response header will be set using
      'mtime_func', which is another TALES expression evaluated
      against the same namespace.  If not specified explicitly,
      uses 'object/modified'.

    - The "Expires" HTTP response header and the "max-age" token of
      the "Cache-control" header will be set using 'max_age_secs',
      if passed;  it should be an integer value in seconds.

    - The "Vary" HTTP response headers will be set if a value is
      provided. The Vary header is described in RFC 2616. In essence,
      it instructs caches that respect this header (such as Squid
      after version 2.4) to distinguish between requests not just by
      the request URL, but also by values found in the headers showing
      in the Vary tag. "Vary: Cookie" would force Squid to also take
      Cookie headers into account when deciding what cached object to
      choose and serve in response to a request.

    - The "ETag" HTTP response header will be set if a value is
      provided. The value is a TALES expression and the result
      after evaluation will be used as the ETag header value.

    - Other tokens will be added to the "Cache-control" HTTP response
      header as follows:

       'no_cache=1' argument => "no-cache" token

       'no_store=1' argument => "no-store" token

       'must_revalidate=1' argument => "must-revalidate" token