Contents

• Description
• Examples

Back to the extension listing.

Webgen::Tag::Sitemap

Summary

The following tag names are registered for this tag class: sitemap

This tag uses the following options:

• common.sitemap.honor_in_menu
• common.sitemap.any_lang
• common.sitemap.used_kinds

Description

This tag is used to display a site map of the current website. The used nodes can be customized by setting the above mentioned configuration options accordingly.

Examples

Usage	Output
{sitemap: }	Overview Getting Started Guide Manual FAQ Extensions Configuration Option Reference Contentprocessor Webgen::ContentProcessor::Blocks Webgen::ContentProcessor::Builder Webgen::ContentProcessor::Erb Webgen::ContentProcessor::Erubis Webgen::ContentProcessor::Fragments Webgen::ContentProcessor::Haml Webgen::ContentProcessor::Head Webgen::ContentProcessor::Kramdown Webgen::ContentProcessor::Less Webgen::ContentProcessor::Maruku Webgen::ContentProcessor::RDiscount Webgen::ContentProcessor::RDoc Webgen::ContentProcessor::RedCloth Webgen::ContentProcessor::Sass Webgen::ContentProcessor::Scss Webgen::ContentProcessor::Tags Webgen::ContentProcessor::Tidy Webgen::ContentProcessor::Xmllint Meta Information Reference Source Webgen::Source::FileSystem Webgen::Source::TarArchive Sourcehandler Webgen::SourceHandler::Copy Webgen::SourceHandler::Directory Webgen::SourceHandler::Feed Webgen::SourceHandler::Metainfo Webgen::SourceHandler::Page Webgen::SourceHandler::Sitemap Webgen::SourceHandler::Template Webgen::SourceHandler::Virtual Tag Webgen::Tag::BreadcrumbTrail Webgen::Tag::Coderay Webgen::Tag::Date Webgen::Tag::ExecuteCommand Webgen::Tag::IncludeFile Webgen::Tag::Langbar Webgen::Tag::Link Webgen::Tag::Menu Webgen::Tag::Metainfo Webgen::Tag::Relocatable Webgen::Tag::Sitemap Webgen::Tag::TikZ Upgrading from 0.4.x Webgen Page Format Website Styles Reference Website styles Style 1024px Style andreas00 Style andreas01 Style andreas03 Style andreas04 Style andreas05 Style andreas06 Style andreas07 Style andreas08 Style andreas09 Style simple
{sitemap: {honor_in_menu: true}}	Overview Getting Started Guide Manual FAQ Extensions
{sitemap: {honor_in_menu: true, used_kinds: []}}	Overview User Documentation Developer Documentation Getting Started Guide Tutorial: Creating a Basic Website Creating the Basic Directories Adding Content Adding Dynamic Content Setting configuration options Manual Introduction The webgen command A webgen Website Extension Directory Configuration File Rakefile All About Paths and Sources Path Types Source Paths Naming Convention Canonical Name (CN) of a File Output Path Name Construction Path Patterns Handling of files in the source directory Path Meta Information webgen Extensions A webgen Run Extending webgen Creating a Website Style Bundle FAQ General Questions How to … … create a website? … set configuration options? … change the default language? … use a different processing pipeline for page files? … set the default meta information for files created by a specific source handler? … ignore files in the source directory? … change the output name style? … modify the template chain? … localize a directory name? … provide additional attributes on links to a file? … add page specific sidebar content? … create XML output? … create a static menu? … use short menu title? Extensions Extension Listing API Configuration Option Reference Configuration Option Reference General Options website.lang website.link_to_current_page website.cache Commonly Used Options common.sitemap.honor_in_menu common.sitemap.any_lang common.sitemap.used_kinds Source and Output Specific Options sources passive_sources output output.do_deletion sourcehandler.patterns sourcehandler.invoke sourcehandler.casefold sourcehandler.use_hidden_files sourcehandler.ignore sourcehandler.default_lang_in_output_path sourcehandler.default_meta_info sourcehandler.template.default_template Content Processor Specific Options contentprocessor.map contentprocessor.erubis.use_pi contentprocessor.erubis.options contentprocessor.kramdown.handle_links contentprocessor.kramdown.options contentprocessor.redcloth.hard_breaks contentprocessor.tags.prefix contentprocessor.tags.map contentprocessor.tidy.options contentprocessor.xmllint.options Tag Specific Options tag.breadcrumbtrail.separator tag.breadcrumbtrail.omit_index_path tag.breadcrumbtrail.start_level tag.breadcrumbtrail.end_level tag.coderay.lang tag.coderay.process_body tag.coderay.wrap tag.coderay.line_numbers tag.coderay.line_number_start tag.coderay.bold_every tag.coderay.tab_width tag.coderay.css tag.date.format tag.executecommand.command tag.executecommand.process_output tag.executecommand.escape_html tag.includefile.filename tag.includefile.process_output tag.includefile.escape_html tag.langbar.separator tag.langbar.show_own_lang tag.langbar.show_single_lang tag.langbar.lang_names tag.link.path tag.link.attr tag.metainfo.escape_html tag.menu.used_nodes tag.menu.start_level tag.menu.min_levels tag.menu.max_levels tag.menu.show_current_subtree_only tag.menu.nested tag.relocatable.path tag.tikz.path tag.tikz.libraries tag.tikz.opts tag.tikz.resolution tag.tikz.transparent tag.tikz.img_attr Contentprocessor Webgen::ContentProcessor::Blocks Description Webgen::ContentProcessor::Builder Description Examples Webgen::ContentProcessor::Erb Description Webgen::ContentProcessor::Erubis Description Webgen::ContentProcessor::Fragments Description Webgen::ContentProcessor::Haml Description Example Webgen::ContentProcessor::Head Description Webgen::ContentProcessor::Kramdown Description Example Webgen::ContentProcessor::Less Description Example Webgen::ContentProcessor::Maruku Description Example Webgen::ContentProcessor::RDiscount Description Example Webgen::ContentProcessor::RDoc Description Example Webgen::ContentProcessor::RedCloth Description Example Webgen::ContentProcessor::Sass Description Example Webgen::ContentProcessor::Scss Description Example Webgen::ContentProcessor::Tags Description Syntax for webgen Tags Webgen::ContentProcessor::Tidy Description Webgen::ContentProcessor::Xmllint Description Meta Information Reference Meta Information Reference author author_url blocks change_freq created_at draft fragments_in_menu index_path in_menu kind lang link link_attrs meta modified_at no_output omit_index_path output_path_style priority routed_title sort_info template title used_nodes Source Webgen::Source::FileSystem Description Examples Webgen::Source::TarArchive Description Examples Sourcehandler Webgen::SourceHandler::Copy Description Webgen::SourceHandler::Directory Description Webgen::SourceHandler::Feed Description Webgen::SourceHandler::Metainfo Description Webgen::SourceHandler::Page Description Webgen::SourceHandler::Sitemap Description Webgen::SourceHandler::Template Description Webgen::SourceHandler::Virtual Description Tag Webgen::Tag::BreadcrumbTrail Description Examples Webgen::Tag::Coderay Description Examples Webgen::Tag::Date Description Examples Webgen::Tag::ExecuteCommand Description Examples Webgen::Tag::IncludeFile Description Examples Webgen::Tag::Langbar Description Examples Webgen::Tag::Link Description Examples Webgen::Tag::Menu Description “Static” Menus Examples Webgen::Tag::Metainfo Description Examples Webgen::Tag::Relocatable Description Examples Webgen::Tag::Sitemap Description Examples Webgen::Tag::TikZ Description Examples Upgrading from 0.4.x Upgrading Webgen Page Format Webgen Page Format Structure Meta Information Block Content Blocks Website Styles Reference Website Styles Reference style-1024px/ style-andreas00/ style-andreas01/ style-andreas03/ style-andreas04/ style-andreas05/ style-andreas06/ style-andreas07/ style-andreas08/ style-andreas09/ style-simple/ Website styles Style 1024px Style Example General Information How to use this style Style Information Style andreas00 Style Example General Information How to use this style Style Information Style andreas01 Style Example General Information How to use this style Style Information Style andreas03 Style Example General Information How to use this style Style Information Style andreas04 Style Example General Information How to use this style Style Information Style andreas05 Style Example General Information How to use this style Style Information Style andreas06 Style Example General Information How to use this style Style Information Style andreas07 Style Example General Information How to use this style Style Information Style andreas08 Style Example General Information How to use this style Style Information Style andreas09 Style Example General Information How to use this style Style Information Style simple Style Example General Information How to use this style Style Information

Back to the extension listing.