Sha256: 8e2949910f0bc79864bc8633830f4d9a65ddb7b2222955ae3c748d55af8e7807

Contents?: true

Size: 1.01 KB

Versions: 8

Compression:

Stored size: 1.01 KB

Contents

---
title: Sitemap
inMenu: true
template: /plugin.template
plugin: Tag/Sitemap
---
h2(#description). Description


The SitemapTag is used to display a site map of the current website. There are two operation modi:
if the parameter {param: Tag/Sitemap:honorInMenu} is @true@, then only those pages are shown in the
sitemap for which the @inMenu@ meta information is set. If it is @false@, then all pages are
displayed. The tag also respects the @orderInfo@ meta information!

*Caveat*: Only page files are shown in the sitemap and from those not all, but only the ones in the
language of the page file the sitemap tag is used in (i.e. the tag shows the sitemap for a specific
language).


h2(#examples). Examples


<table class="examples">
<tr>
  <th>Usage</th><th>Output</th>
</tr>
<tr>
  <td><notextile>\{sitemap: }</notextile></td>
  <td><notextile>{sitemap: }</notextile></td>
</tr>
<tr>
  <td><notextile>\{sitemap: {honorInMenu: false}}</notextile></td>
  <td><notextile>{sitemap: {honorInMenu: false}}</notextile></td>
</tr>
</table>

Version data entries

8 entries across 8 versions & 1 rubygems

Version Path
webgen-0.4.0 doc/src/documentation/plugins/tag/sitemap.page
webgen-0.4.1 doc/src/documentation/plugins/tag/sitemap.page
webgen-0.4.2 doc/src/documentation/plugins/tag/sitemap.page
webgen-0.4.5 doc/src/documentation/plugins/tag/sitemap.page
webgen-0.4.4 doc/src/documentation/plugins/tag/sitemap.page
webgen-0.4.3 doc/src/documentation/plugins/tag/sitemap.page
webgen-0.4.6 doc/src/documentation/plugins/tag/sitemap.page
webgen-0.4.7 doc/src/documentation/plugins/tag/sitemap.page