summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2012-10-26 00:32:08 -0400
committerChris McDonough <chrism@plope.com>2012-10-26 00:32:08 -0400
commitc25a8fd5d2895a117d8eb77162ed8388f0482674 (patch)
tree6eeb21a5805c33407818a108e0a6d582d1e67382 /docs/narr
parentc773a62030c6a183ce82278433b93d3c9b545746 (diff)
downloadpyramid-c25a8fd5d2895a117d8eb77162ed8388f0482674.tar.gz
pyramid-c25a8fd5d2895a117d8eb77162ed8388f0482674.tar.bz2
pyramid-c25a8fd5d2895a117d8eb77162ed8388f0482674.zip
- New ``physical_path`` view predicate. If specified, this value should be a
string or a tuple representing the physical traversal path of the context found via traversal for this predicate to match as true. For example: ``physical_path='/'`` or ``physical_path='/a/b/c'`` or ``physical_path=('', 'a', 'b', 'c')``. This is not a path prefix match or a regex, it's a whole-path match. It's useful when you want to always potentially show a view when some object is traversed to, but you can't be sure about what kind of object it will be, so you can't use the ``context`` predicate. The individual path elements inbetween slash characters or in tuple elements should be the Unicode representation of the name of the resource and should not be encoded in any way.
Diffstat (limited to 'docs/narr')
-rw-r--r--docs/narr/viewconfig.rst14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/narr/viewconfig.rst b/docs/narr/viewconfig.rst
index 3c7897969..752e6ad72 100644
--- a/docs/narr/viewconfig.rst
+++ b/docs/narr/viewconfig.rst
@@ -417,6 +417,20 @@ configured view.
.. versionadded:: 1.4a2
+``physical_path``
+ If specified, this value should be a string or a tuple representing the
+ :term:`physical path` of the context found via traversal for this predicate
+ to match as true. For example: ``physical_path='/'`` or
+ ``physical_path='/a/b/c'`` or ``physical_path=('', 'a', 'b', 'c')``. This is
+ not a path prefix match or a regex, it's a whole-path match. It's useful
+ when you want to always potentially show a view when some object is traversed
+ to, but you can't be sure about what kind of object it will be, so you can't
+ use the ``context`` predicate. The individual path elements inbetween slash
+ characters or in tuple elements should be the Unicode representation of the
+ name of the resource and should not be encoded in any way.
+
+ .. versionadded:: 1.4a3
+
``custom_predicates``
If ``custom_predicates`` is specified, it must be a sequence of references
to custom predicate callables. Use custom predicates when no set of