Constructor Detail

• SiteMap

  public SiteMap(String encoding,
         org.codehaus.plexus.i18n.I18N i18n)

  Constructor sets default values.

  Parameters:

  encoding - the default encoding to use when writing the output file.

  i18n - the default I18N for translations.

Method Detail

• getI18n

  public org.codehaus.plexus.i18n.I18N getI18n()

  Get the value of i18n.

  Returns:

  the value of i18n.

• setI18n

  public void setI18n(org.codehaus.plexus.i18n.I18N i18n)

  Set the value of i18n.

  Parameters:

  i18n - new value of i18n.

• getEncoding

  public String getEncoding()

  Get the encoding to use when writing the output file.

  Returns:

  the value of encoding.

• setEncoding

  public void setEncoding(String enc)

  Set the encoding to use when writing the output file.

  Parameters:

  enc - new value of encoding.

• generate

  public void generate(org.apache.maven.doxia.site.decoration.DecorationModel model,
              File targetDir,
              Locale locale)
                throws IOException

  Generates a sitemap.xml in targetDir/xdoc/. This is a valid xdoc document that can be processed by a Doxia parser. The file lists all the menus and menu items of the DecorationModel in expanded form.

  Parameters:

  model - the DecorationModel to extract the menus from.

  targetDir - the target output directory. The file will be created in targetDir/xdoc/.

  locale - the Locale for the result.

  Throws:

  IOException - if the file cannot be ceated.