[tools/view] Update new BreadcrumbTool doc
diff --git a/src/content/tools/3.1/apidocs/org/apache/velocity/tools/view/BreadcrumbTool.html b/src/content/tools/3.1/apidocs/org/apache/velocity/tools/view/BreadcrumbTool.html
index 5b12b03..684b55a 100644
--- a/src/content/tools/3.1/apidocs/org/apache/velocity/tools/view/BreadcrumbTool.html
+++ b/src/content/tools/3.1/apidocs/org/apache/velocity/tools/view/BreadcrumbTool.html
@@ -145,7 +145,7 @@
'<code>_</code>' replaced by spaces, transformed to lowercase.</p>
<p>You can customize this displayed name and the URL of every path element using tools properties:</p>
<pre><code>
- <tool key="breadcrumb" colors.name="My Colors" colors.url="/colors/all.vhtml"/>
+ <tool key="breadcrumb" colors.name="My Colors" colors.url="/colors/all.vhtml"/>
</code></pre>
<p>where '<code>colors</code>' refers to the <code>/colors/</code> path element. The name and destination of the
root path element can be changed with '<code>home.name</code>' and '<code>home.url</code>'.</p>
diff --git a/src/content/tools/3.1/tools-summary.mdtext b/src/content/tools/3.1/tools-summary.mdtext
index e5c89a2..0ce5506 100644
--- a/src/content/tools/3.1/tools-summary.mdtext
+++ b/src/content/tools/3.1/tools-summary.mdtext
@@ -26,6 +26,7 @@
#### View Tools
++ [`$breadcrumb` - BreadcrumbTool (beta)](#BreadcrumbTool)
+ [`$browser` - BrowserTool](#BrowserTool),
+ [`$context` - ViewContextTool](#ViewContextTool)
+ [`$cookie` - CookieTool](#CookieTool),
@@ -332,6 +333,15 @@
### View Tools
+#### [**BreadcrumbTool**](apidocs/org/apache/velocity/tools/view/BreadcrumbTool.html) - (beta) Tool helping maintaining a breadcrumbs trail UI component (also called an Ariane thread). {#BreadcrumbTool}
+
+**`$breadcrumb`** |
+--|--
+**scope** | session
+`config.`*segment*`.name` [ = `null` ] | an optional custom displayed name for the specific URI segment
+`config.`*segment*`.url` [ = `null` ] | an optional custom displayed URL for the specific URI segment
+`$breadcrumb.iterator()` | Iterate on URI elements, like in `#foreach($elem in $breadcrumb)`. Usefull if you want to customize the default displayed breadcrumbs trail rendered with `$breadcrumb`.
+
#### [**BrowserTool**](apidocs/org/apache/velocity/tools/view/BrowserTool.html) - browser-sniffing tool; it defines properties that are used to test the client browser, operating system, device, language... apart from properties related to browser version and language, all properties are booleans.{#BrowserTool}
**`$browser`** |
diff --git a/src/content/tools/devel/tools-summary.mdtext b/src/content/tools/devel/tools-summary.mdtext
index e5c89a2..0ce5506 100644
--- a/src/content/tools/devel/tools-summary.mdtext
+++ b/src/content/tools/devel/tools-summary.mdtext
@@ -26,6 +26,7 @@
#### View Tools
++ [`$breadcrumb` - BreadcrumbTool (beta)](#BreadcrumbTool)
+ [`$browser` - BrowserTool](#BrowserTool),
+ [`$context` - ViewContextTool](#ViewContextTool)
+ [`$cookie` - CookieTool](#CookieTool),
@@ -332,6 +333,15 @@
### View Tools
+#### [**BreadcrumbTool**](apidocs/org/apache/velocity/tools/view/BreadcrumbTool.html) - (beta) Tool helping maintaining a breadcrumbs trail UI component (also called an Ariane thread). {#BreadcrumbTool}
+
+**`$breadcrumb`** |
+--|--
+**scope** | session
+`config.`*segment*`.name` [ = `null` ] | an optional custom displayed name for the specific URI segment
+`config.`*segment*`.url` [ = `null` ] | an optional custom displayed URL for the specific URI segment
+`$breadcrumb.iterator()` | Iterate on URI elements, like in `#foreach($elem in $breadcrumb)`. Usefull if you want to customize the default displayed breadcrumbs trail rendered with `$breadcrumb`.
+
#### [**BrowserTool**](apidocs/org/apache/velocity/tools/view/BrowserTool.html) - browser-sniffing tool; it defines properties that are used to test the client browser, operating system, device, language... apart from properties related to browser version and language, all properties are booleans.{#BrowserTool}
**`$browser`** |
