Auto grouping sitemap and menu¶

Frontend¶

Backend¶

Layout Samples¶

Four examples. Ten layouts are possible.

What does it do?¶

• autositemap generates a sitemap or menu in columns.

• autositemap tries to split menus for the best design. Ten designs are possible.

• For example: Big menus can get two columns.

• If you have more than four menus, the rest will placed in a fifth column.

• The menus in the first four columns has a depth of three levels by default.

• The menus in the fifth column has a depth of two levels by default.

• You can control the behaviour of placements with one of three priorities:

  • Maximum of line breaks
  • One line break only
  • No line break for any menu

  See "Priority" on page 7 below for more details.

• The menus are configured by TypoScript. They are based on the HMENU and TMENU. But you can't use all HMENU properties!

• The used HTML classes by the include static template "+Autositemap YAML (autositemap)" are based on the YAML CSS. But the JavaScript framework YAML isn't needed.

One page only¶

• Install the extension.
• Add the plugin to a page, where you like to use the autositemap.
• Add the TypoScript templates to the static templates of the TypoScript of this page:
  • Autositemap (autositemap)
  • +Autositemap YAML (autositemap)
• Configure autositemap supported by the TypoScript Constant Editor.

Website wide Installation¶

• Install the extension.
• Add a sysfolder "libraries" to your website.
• Add a page "sitemap" into the page "libraries".
• Add the plugin into the page "sitemap"
• Add the TypoScript templates to the static templates of the TypoScript of your root page:
  • Autositemap (autositemap)
  • +Autositemap YAML (autositemap)
• Include the content of the page "sitemap" website wide by TypoScript or TemplaVoilá.
• Configure autositemap supported by the TypoScript Constant Editor.

First of all¶

Maximum of line breaks¶

One line break only¶

No line break for any menu¶

AUTOSITEMAP – MENU CONFIGURATION¶

AUTOSITEMAP – RULES¶

AUTOSITEMAP – DEBUGGING¶

CSS¶

autositemap includes a CSS file while runtime.

page.includeCSS {

tx_autositemap_pi1_yaml = EXT:autositemap/res/pi1/yaml/autositemap_yaml.css

}

If you don't need it, please configure:

page.includeCSS {

tx_autositemap_pi1_yaml >

}

If you need an own CSS file please configure something like this:

page.includeCSS {

tx_autositemap_pi1_yaml >

tx_autositemap_pi1_yaml = fileadmin/my_files/my_own.css

}

Master Template¶

The TypoScript properties are configured by a master template in general.

The parts of the master template are allocated to the autositemap plugin like in the snippet below:

plugin.tx_autositemap_pi1 {

css < plugin.tx_autositemap_pi1.master_templates.yaml.css

html < plugin.tx_autositemap_pi1.master_templates.yaml.html

menu_main < plugin.tx_autositemap_pi1.master_templates.yaml.menus.menu_main

menu_main_last < plugin.tx_autositemap_pi1.master_templates.yaml. menus.menu_main_last

menu_margin < plugin.tx_autositemap_pi1.master_templates.yaml.menus.menu_margin

}

If you like to configure your own layout, please configure your own master template. A good example is the TypoScript of "+Autositemap YAML (autositemap)". See the files:

autositemap/static/pi1/yaml

• constants.txt
• setup.txt

Example: Third level in the menu margin¶

The menu margin renders menus two levels only by default.

If you like to display the third level too, please use this code snippet:

plugin.tx_autositemap_pi1 {menu_margin {3 < plugin.tx_autositemap_pi1.menu_main.3}}

See more supporteed by the TypoScript Object Browser.

More Configuration in Depth¶

There are a lot of properties for customising.

Sorry, that these properties aren't a subject of this manual.

You have the option to inspect the TypoScript only.

Follow the Workflow¶

You can follow the workflow with the DRS – the Development Reporting System.

You need the extension devlog.

HTML Code¶

The autositemap uses some markers for replacement of HTML wraps.

It simplifies to fix bugs, if the markers won't replaced in the HTML code, if there is any unexpected result,

css¶

plugin.tx_autositemap_pi1 {
  css {
      // One menu in a single column
    10 = tx_autositemap_pi1_menus_01
    10 {
        // Class for a single column
      mainSingle = TEXT
      mainSingle {
        value = 100
      }
    }
      // One menu in a double column
    11 = tx_autositemap_pi1_menus_01_wi_01_double
    11 {
        // Class for a double column
      mainDouble = TEXT
      mainDouble {
        value = 100
      }
    }
    ...
  }
}

debugging¶

plugin.tx_autositemap_pi1 {
  debugging {
    dontRemoveHtmlComments = TEXT
    dontRemoveHtmlComments {
      value = 0
    }
  }
}

html¶

plugin.tx_autositemap_pi1 {
  html {
    sitemap = TEXT
    sitemap {
      ...
    }
    menuMainOuterWrap = TEXT
    menuMainOuterWrap {
      ...
    }
    menuMainInnerWrap = TEXT
    menuMainInnerWrap {
      ...
    }
    menuSubOuterWrap = TEXT
    menuSubOuterWrap {
      ...
    }
  }
}

master_templates¶

plugin.tx_autositemap_pi1 {
  master_templates =
  master_templates {
    ...
  }
}

menu_main¶

plugin.tx_autositemap_pi1 {
  menu_main      =
  menu_main_last =
  menu_margin    =
}

rules¶

plugin.tx_autositemap_pi1 {
   // Rules for number of columns and line break
  rules =
  rules {
      // Minimum of submenus and items for a line break
    menuItems =
    menuItems {
      ...
    }
      // Number of columns ...: DON'T TOUCH IT!
    numberOfColumns =
    numberOfColumns {
      ...
    }
      // Priority
    priority = TEXT
    priority {
      ...
    }
  }}

sql¶

plugin.tx_autositemap_pi1 {
  sql {
      // Table
    pages =
    pages {
      andWhere = TEXT
      andWhere {
        value =       AND doktype NOT IN \
 ({$plugin.tx_autositemap_pi1.hmenu.excludeDoktypes})\
                      AND nav_hide = 0
        noTrimWrap  = | ||
      }
    }
  }
}

... version 1.0?¶

Update from < 0.9.x¶

You have to allocate the root page id supported by the TypoScript Constant-Editor. See "Root page id (this is a must!)" on page 11 above.