Commits

Dimitris Zenios committed a35dc15

More wiki

Comments (0)

Files changed (1)

 == Description ==
-Tapestry-zbreadcrumbs is a yet another bread crumb trail implementation for Tapestry 5.
+Tapestry-zbreadcrumbs is a yet another bread crumb trail implementation  [[http://tapestry.apache.org|Tapestry 5]].
 
 Even though it was inspired from [[https://github.com/argoyle/tapestry-breadcrumbs/|tapestry-breadcrumbs]] it has many differences.Two main differences are
 
-#It uses a PageRenderRequestFilter instead of a dispatcher.
-#It does not need an annotation in order to add pages to the trail.
+#It uses a PageRenderRequestFilter instead of a dispatcher
+#It does not need an annotation in order to add pages to the trail
 
 === Features ===
 *Configuration through contributions and annotations
 
 == Configuration ==
 === Module Configuration ===
-Many properties of the module can be overriden by contributing to application defaults:
+Many properties of the module can be overridden by contributing to application defaults:
 
 |=Property Name |=Default Value |=Description |
 |BreadCrumbsConstants.BREADCRUMBS_MAX_CRUMBS_TO_SAVE  | 10 | Number of breadcrumbs to save.If exceeded the list will wrap around.|
 |BreadCrumbsConstants.BREADCRUMBS_DEFAULT_STYLESHEET | classpath:.../Assets/default.css | The default breadcrumbs stylesheet automatically injected into every rendered HTML page.|
 
 === BreadCrumbs configuration ===
-In many cases user needs to exclude a page from beeing added to the breadcrumbs list or even reset the whole list.There are two options to configure suck operations:
+In many cases user needs to exclude a page from beeing added to the breadcrumbs list or even reset the whole list.There are two options to configure such operations:
 #Using annotations 
 #Using contribution
 
 }}}
 
 ====Using contributions====
-By contributing to BreadCrumbsService you can control breadCrumb behavior on each page.Configuration though contribution, takes a list of BreadCrumbRule
+By contributing to BreadCrumbsService you can control breadcrumb behavior on each page.Configuration though contribution, takes a list of BreadCrumbRule
 elements.Each BreadCrumbRule element contains a path pattern and a BreadCrumbAttribute (Ignore, Reset)
 
 The mapping matches URLs using the following rules:
 == BreadCrumb titles==
 
 BreadCrumb titles are extracted with the following order
-*Using an event BreadCrumbsEventConstants.GET_TITLE. The component event handler will be passed the activationContext
-*Using message catalogs
-*Using logical page name
+#Using an event BreadCrumbsEventConstants.GET_TITLE. The component event handler will be passed the activation context
+#Using message catalogs
+#Using logical page name
 
 === Using an event ===
 An event with name BreadCrumbsEventConstants.GET_TITLE will be triggered on the appropriate component. The component event handler will be passed the activationContext.
 }}}
 
 === Using message catalogs ===
-If there is not event handler for the event mentioned above then the title will be extracted from the components message catalog.The key for the message
- will be extracted from logical page name and append BreadCrumbsConstants.BREADCRUMBS_TITLE_SUFFIX
+If there is no event handler for the event mentioned above then the title will be extracted from the components message catalog.The key for the message
+ will be extracted from the logical page name and then append BreadCrumbsConstants.BREADCRUMBS_TITLE_SUFFIX
 
 {{{
 Index-crumb = Index page
 If there is no event handler and no message then the logical page name will be user as breadcrumb title
 
 == BreadCrumbs trail component
-Breadcrumbs trail component, is the component responsible for renderind the list of breadCrubs.Main features of the component are
-*Add block before each brad crumb
+Breadcrumbs trail component, is the component responsible for rendering the list of breadcrubs.Main features of the component are
+*Add block before each breadcrumb
 *Add block after each breadcrumb
-*Override the default breadCrumb block
+*Override the default breadcrumb block
 
 {{{
 #!java
 	private BreadCrumbElement breadCrumb
 	
 	@Property
-	private  int index;
+	private int index;
 
 	public String getCrumbClass() {
 		return getTitle() + "-class";
 	}
 
 	public String getTitle() {
-		return breadCrumb.getLogicalPageName()
+		return breadCrumb.getLogicalPageName();
 	}
 }
 }}}
 </t:zcrumb.BreadCrumbsTrail>	
 }}}
 
-//**Have in mind that by overriding the default breadCrumb block the methods for getting breadcrumb title mentioned above will not be used.You
+//**Have in mind that by overridding the default breadCrumb block the methods for getting breadcrumb title mentioned above will not be used.You
 will be responsible for the rendering of the actual breadcrumb.//