tonyair/silverstripe-framework
1
0
Fork 0
mirror of https://github.com/silverstripe/silverstripe-framework synced 2024-10-22 14:05:37 +02:00
Code Issues Projects Releases Wiki Activity

Merge pull request #38 from oddnoc/feature/breadcrumb-doc-fix

Browse Source 
MINOR: Rewrite documentation of Breadcrumbs to conform to actual behaviour
This commit is contained in:
Will Rossiter 2011-06-10 19:56:20 -07:00
commit 428d1d2846
1 changed files with 10 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
docs/en/reference/built-in-page-controls.md
View File

@ -84,20 +84,22 @@ This will return the parent page. The $ variable format lets us reference an at
### Site Navigation - Breadcrumbs ### Site Navigation - Breadcrumbs
#### <% control Breadcrumbs %> #### $Breadcrumbs
This will return a breadcrumbs widgets for the given page. You can call this on any data-object, so, for example, you This will return a breadcrumbs widget for the current page. You can call this on any SiteTree descendant, so, for
could display the breadcrumbs of every search result if you wanted. It has a few options. example, you could display the breadcrumbs of every search result if you wanted. The Breadcrumbs method returns a string
of text, so this can't be used as a control block (that is, you can't usefully say "<% control Breadcrumbs %>"). You can
limit the number of items in the breadcrumbs, as well as whether the breadcrumb items are links.
#### <% control Breadcrumbs(3) %> #### $Breadcrumbs(3)
Will return a maximum of 3 pages in the breadcrumb list, this can be handy if you're wanting to put breadcrumbs in a This returns a maximum of 3 pages in the breadcrumb list, which can be handy if you want to limit the size of your
place without spilling breadcrumbs to conform to your page design.
#### <% control Breadcrumbs(3, true) %> #### <% control Breadcrumbs(3, true) %>
Will return the same, but without any links. This is handy if you're wanting to put the breadcrumb list into another This returns the same, but without any links. This is handy if you want to put the breadcrumb list into another link
link tag. tag.
### Links and Classes ### Links and Classes