Site registry for breadcrumb definitions¶
Breadcrumbs site registry
Keyword Arguments: initial (dict) – Optional initial dictionnary of crumbs urlname->value
. Default to an empty dict.Return registred crumb url names.
Returns: List of registred crumb url names, sorted with default sorted()
behavior.Return type: list
Return current registry
Returns: Currrent registry. Return type: dict
Get title for given url name.
Parameters: name (string) – Url name. Returns: Crumb title. Return type: string or tuple
Find if given name is registred as a crumb.
Returns: True
if name exists in current registry, elseFalse
.Return type: bool
Register a crumb for given url name.
Parameters: - name (string) – Url name.
- value (string or tuple) – Crumb title to define.
Raises: AlreadyRegistered
if the url name is allready registered incrumbs.
Reset registry to an empty Dict.
Unregister a crumb.
Parameters: name (string) – Url name. Raises: NotRegistered
if given url name is not registred yet.
Update many crumbs
This works like the
Dict.update({..})
method.Parameters: crumbs (dict) – A dict of crumbs ( urlname->value
).
Default breadcrumbs site registry for a Django instance.