De:TSref/HMENU

1 ist die erste zu erzeugende Menü-Ebene, 2 die zweite, 3 die dritte ...

Die 1 muss immer existieren, alle weiteren Ebenen werden nur erzeugt, wenn die Ebene darüber auch existiert. Wenn die zweite Ebene nicht definiert ist, wird auch die dritte nicht mehr erzeugt.

# Beispiel:
temp.sidemenu = HMENU
temp.sidemenu.1 = GMENU  
temp.sidemenu.2 = TMENU
temp.sidemenu.3 = TMENU

Default ist "0", und generiert ein Menü der ersten Seitenebene.

Wenn der Wert negativ ist, wird das entryLevel "hinter" der rootline auswählen. "-1" wird ein Menü von der äußeren Seite aus generieren.

Info: Wirkt auch auf alle Submenüs. Um den Wert für die Menüebenen einzeln einzustellen muss der Wert in den Menüobjekten selbst gesetzt werden. (see “Common properties” table).

Info: Wirkt auch auf alle Submenüs. (siehe "minItems")

# Beispiel:
Dies erzeugt ein Menü, welches die ersten beiden Elemente auslässt und direkt mit dem dritten Element beginnt:
begin = 3  

Info: Wirkt auch auf alle Submenüs. (siehe "minItems")

# Beispiel:
Sowohl die Seiten mit den uid 2 und 34 werden nicht im Menü erscheinen, als auch die jetzige Seite nicht.

excludeUidList = 34,2,current

Der Wert "5" wird einfach von der Eigenschaft "excludeDoktypes" entfernt. (siehe oben).

If set, then for each page in the menu it will be checked if an Alternative Page Language record for the language defined in "config.sys_language_uid" (typically defined via &L) exists for the page. If that is not the case and the pages “Localization settings” have the “Hide page if no translation for current language exists” flag set, then the menu item will link to a non accessible page that will yield an error page to the user. Setting this option will prevent that situation by simply adding “&L=0” for such pages, meaning that they will switch to the default language rather than keeping the current language.

The check is only carried out if a translation is requested ("config.sys_language_uid" is not zero).

Keyword: “all”

When set to “all” the same check is carried out but it will not look if “Hide page if no translation for current language exists” is set - it always reverts to default language if no translation is found.

For these options to make sense, they should only be used when “config.sys_language_mode” is not set to “content_fallback”.

 20 = HMENU
 20.special = directory
 20.special.value = 13, 37

Sollte .value nicht gesetzt sein, wird als default die aktuelle Seite verwendet.

Unterstützt Mount Pages.

 20 = HMENU
 20.special = list
 20.special.value = 13, 37

Sollte .value nicht gesetzt sein, wird als default die .entryLevel uid verwendet.

Unterstützt Mount Pages.

 20 = HMENU
 20.special = updated
 20.special.value = 13, 37
 20.special {
   mode = tstamp
   depth = 2
   maxAge = 3600*24*3
   limit = 8
 }

Als default wird immer anhand des Felds, welches in "mode" definiert wird, rückwärts sortiert (desc). Es kann aber das "alternativeSortingField" (für das Menüobjekt) gesetzt werden, was die andere Sortierung ausser Kraft setzt.

Die Eigenschaften "mode", "depth", "maxAge" und "limit" werden nur mit special="updated" verwendet.

mode: Definiert, welches Feld der Seitentabelle verwendet wird. Default: "SYS_LASTCHANGED" (welches automatisch auf die jüngste tstamp gesetzt wird, wenn eine neue Seite oder ein Element innerhalb angelegt wird). "manual" oder "lastUpdated" wird das Feld "lastUpdated" auslesen, welches manuell in den Seiteneigenschaften bearbeitet wird. "tstamp" wird das Zeitstempelfeld "tstamp" auslesen, welches gesetzt wird, wenn die Seitendatensatz bearbeitet wird. "crdate" wird das Feld "crdate" des Seitendatensatzes auslesen. “starttime” wird das Feld "starttime" auslesen.

Felder deren Wert 0 ist, werden nicht angezeigt werden.

depth: (int) Rekursionstiefe. Werte von 1-20 sind möglich, wobei 1 nur die Start-ID zulässt, 2 die Start-ID + erste Ebene. Default ist 20. Info: "depth" ist relativ zu "beginAtLevel".

beginAtLevel: (int) Startebene für die Seitenbäume die auf .value und .depth basierend erzeugt werden. Default ist 0 und ist die Start-ID. 1 beginnt mit der ersten Ebene der Unterseiten, 2 beginnt mit der zweiten Ebene der Unterseiten. Der Wert "depth" ist relativ zu "beginAtLevel".

maxAge: (int) Sekunden +calc. Seiten, deren Änderungsdatum älter als die jetzige Zeit minus der gesetzten Sekunden sind, werden nicht mehr gezeigt. Wird nicht im Default verwendet (not used). Für die Werte können die primitiven Rechenoperationen ( + - * / ) verwendet werden (3600*24*3 ist also möglich).

limit: (int) Maximale Anzahl der Menüelemente. Default ist 10, Maximum ist 100.

excludeNoSearchPages: Boolean. Ist dieser Wert wahr, werden die Seiten welche "nicht suchen" gesetzt haben, nicht in die Menüs mit aufgenommen.

Unterstützt Mount Pages.

.range = [begin-level] | [end-level] (genau so, wie  .entryLevel für HMENU Objekte gesetzt wird)

.target_[0-x]  Ziel(e)

1. Beispiel:

page.2 = HMENU 
page.2.special = rootline 
page.2.special.range = 1|-2 
page.2.special.targets.3 = page 
page.2.1 = TMENU 
page.2.1.target = _top 
page.2.1.wrap = <HR> | <HR> 
page.2.1.NO { 
 linkWrap = | > 
}

... erzeugt ein Menü wie dieses:

Seite Ebene 1 > Seite Ebene 2 > Seite Ebene 3 > Seite Ebene 4 >

Dieses Menü beginnt in Ebene 1 und verlinkt die aktuelle Seite nicht (-2 ist die Ebene davor). Alle Seiten auf Ebene 3 werden "page" als .target haben, Seiten auf anderen Ebenen "_top".

Unterstützt Mount Pages.

Support for Mount Pages: No! Main properties:

.items  ( "|" separated list of "itemnames")
.[itemnames].target  (target) - optional/alternative target of the item
.[itemnames].uid  (uid of page) - optional/alternative page-uid to link to
.[itemnames].fields.[fieldname]  (string) - override field "fieldname" in pagerecord.
.items.prevnextToSection (boolean) - if set, the "prev" and "next" navigation will jump to the next section when it reaches the end of pages in the current section
.value (page-uid) - default is current page id. Seldomly you might want to override this value with another page-uid which will then act as the basepoint for the menu and the predefined items.

Ordering is by default done in reverse order (desc) with the field specified by “mode” , but setting “alternativeSortingField” for the menu object (eg GMENU, see later) will override that.

Reserved itemnames:

next / prev : links to next page / previous page. Next and previous pages are from the same "pid" as the current page id (or "value") - that is the next item in a menu with the current page. Also referred to as current level.

If ".prevnextToSection" is set then next/prev will link to the first page of next section / last page of previous section.

nextsection / prevsection : links to next section / previous section. A section is defined as the subpages of a page on the same level as the parent (pid) page of the current page. Will not work if parent page of current page is the root page of the site.

nextsection_last | prevsection_last: Where nextsection/prevsection links to the first page in a section, these links to the last pages. If there is only one page in the section that will be both first and last. Will not work if parent page of current page is the root page of the site.

first / last : First / Last page on current level. If there is only one page on the current level that page will be both first and last.

up : Links to the parent (pid) page of the current page. (up 1 level) Will always be available

index : Links to the parent of the parent page of the current page (up 2 levels). May not be available if that page is out of the rootline.

Examples:
If id=20 is current page then:
21= prev and first, 19 = next, 18 = last, 17 = up, 1=index, 10 = nextsection, 11 = nextsection_last

prevsection and prevsection_last is not present because id=3 has no subpages!

TypoScript (only "browse"-part, needs also TMENU/GMENU):

xxx = HMENU 
xxx.special = browse 
xxx.special { 
 items = index|up|next|prev 
 items.prevnextToSection = 1 
 index.target = _blank 
 index.fields.title = INDEX 
 index.uid = 8 
}

.items  ( "|" separated list of "itemnames")
.[itemnames].target  (target) - optional/alternative target of the item
.[itemnames].uid  (uid of page) - optional/alternative page-uid to link to
.[itemnames].fields.[fieldname]  (string) - override field "fieldname" in pagerecord.
.items.prevnextToSection (boolean) - if set, the "prev" and "next" navigation will jump to the next section when it reaches the end of pages in the current section
.value (page-uid) - default is current page id. Seldomly you might want to override this value with another page-uid which will then act as the basepoint for the menu and the predefined items.

Ordering is by default done in reverse order (desc) with the field specified by “mode” , but setting “alternativeSortingField” for the menu object (eg GMENU, see later) will override that.

Reserved itemnames:

next / prev : links to next page / previous page. Next and previous pages are from the same "pid" as the current page id (or "value") - that is the next item in a menu with the current page. Also referred to as current level.

If ".prevnextToSection" is set then next/prev will link to the first page of next section / last page of previous section.

nextsection / prevsection : links to next section / previous section. A section is defined as the subpages of a page on the same level as the parent (pid) page of the current page. Will not work if parent page of current page is the root page of the site.

nextsection_last | prevsection_last: Where nextsection/prevsection links to the first page in a section, these links to the last pages. If there is only one page in the section that will be both first and last. Will not work if parent page of current page is the root page of the site.

first / last : First / Last page on current level. If there is only one page on the current level that page will be both first and last.

up : Links to the parent (pid) page of the current page. (up 1 level) Will always be available

index : Links to the parent of the parent page of the current page (up 2 levels). May not be available if that page is out of the rootline.

Examples:
If id=20 is current page then:
21= prev and first, 19 = next, 18 = last, 17 = up, 1=index, 10 = nextsection, 11 = nextsection_last

prevsection and prevsection_last is not present because id=3 has no subpages!

TypoScript (only "browse"-part, needs also TMENU/GMENU):

xxx = HMENU
xxx.special = browse
xxx.special { 
 items = index|up|next|prev 
 items.prevnextToSection = 1 
 index.target = _blank 
 index.fields.title = INDEX 
 index.uid = 8 
}

.value = page for which keywords to find similar pages.

.mode: Which field in the pages-table to use for sorting. Default is "SYS_LASTCHANGED" (which is updated when a page is generated to the youngest tstamp of the records on the page), "manual" or “lastUpdated” will use the field "lastUpdated" (set manually in the page-record) and "tstamp" will use the "tstamp"-field of the pagerecord, which is set automatically when the record is changed. "crdate" will use "crdate"-field of the pagerecord. “starttime” will use the starttime field.

.entryLevel = where in the rootline the search begins. Standard rootline syntax (-x to x)

.depth, .limit, .excludeNoSearchPages, .beginAtLevel (like "updated" menu)

.setKeywords (+stdWrap) = lets you define the keywords manually by defining them as a commaseparated list. If this property is defined, it overrides the default, which is the keywords of the current page.

.keywordsField = defines the field in the pages-table in which to search for the keywords. Default is the fieldname “keyword”. No check is done to see if the field you enter here exists, so enter an existing field, OK?!

.keywordsField.sourceField = defines the field from the current page from which to take the keywords being matched. The default is “keyword”. (Notice that “.keywordsField” is only setting the page-record field to search in !)

Support for Mount Pages: Yes.

The “language” type will create menu items based on the current page record but with the language record for each language overlaid if available. The items all link to the current page id and only “&L” is changed.

Item states:

When “TSFE->sys_language_uid” matches the sys_language uid for an element the state is set to “ACT”, otherwise “NO”. However, if a page is not available due to the pages “Localization settings” (which can disable translations) or if no Alternative Page Language record was found (can be disabled with “.normalWhenNoLanguage”, see below) the state is set to “USERDEF1” for non-active items and “USERDEF2” for active items. So in total there are four states to create designs for. It is recommended to disable the link on menu items rendered with “USERDEF1” and “USERDEF2” in this case since they are disabled exactly because a page in that language does not exist and might even issue an error if tried accessed (depending on site configuration).

.value = comma list of sys_language uids to construct the menu with. The number of elements in this list determines the number of menu items.

.normalWhenNoLanguage = boolean, which if set will render the button for a language as a non-disabled button even if no translation is found for the language.

Example:

Creates a language menu with flags (notice that some lines break):

lib.langMenu = HMENU
lib.langMenu.special = language
lib.langMenu.special.value = 0,1,2
lib.langMenu.1 = GMENU
lib.langMenu.1.NO {
 XY = [5.w]+4, [5.h]+4
 backColor = white
 5 = IMAGE
 5.file = media/flags/flag_uk.gif  || media/flags/flag_fr.gif  || media/flags/flag_es.gif
 5.offset = 2,2
}

lib.langMenu.1.ACT < lib.langMenu.1.NO
lib.langMenu.1.ACT=1
lib.langMenu.1.ACT.backColor = black
lib.langMenu.1.USERDEF1 < lib.langMenu.1.NO
lib.langMenu.1.USERDEF1=1
lib.langMenu.1.USERDEF1.5.file = media/flags/flag_uk_d.gif  || media/flags/flag_fr_d.gif  || media/flags/flag_es_d.gif
lib.langMenu.1.USERDEF1.noLink = 1

.file [resource] = filename of the php-file to include. (Just like cObject PHP_SCRIPT)

.[any other key] = your own variables to your script. They are all accessible in the array $conf in your script

Howto:

You must populate an array called $menuItemsArray with page-records of the menuitems you want to be in the menu.

It goes like this:

$menuItemsArray[] = pageRow1;
$menuItemsArray[] = pageRow2;
$menuItemsArray[] = pageRow3;

...

A “pageRow” is a record from the table “pages” with all fields selected (SELECT * FROM...)

If you create fake page rows, make sure to add at least “title” and “uid” field values.

Notice:

If you work with mount-points you can set the MP param which should be set for the page by setting the internal field “_MP_PARAM” in the page-record (xxx-xxx).

Overriding URLs:

You can also use the internal field "_OVERRIDE_HREF" to set a custom href-value (eg. "http://www.typo3.org") which will in any case be used rather than a link to the page that the page otherwise might represent. If you use "_OVERRIDE_HREF" then "_OVERRIDE_TARGET" can be used to override the target value as well (See example below).

Other reserved keys:

“_ADD_GETVARS” can be used to add get parameters to the URL, eg. “&L=xxx”.

“_SAFE” can be used to protect the element to make sure it is not filtered out for any reason.

Creating submenus:

You can create submenus for the next level easily by just adding an array of menu items in the internal field "_SUB_MENU" (See example below).

Presetting element state

If you would like to preset an element to be recognized as a SPC, IFSUB, ACT, CUR or USR mode item, you can do so by specifying one of these values in the key “ITEM_STATE” of the page record. This setting will override the natural state-evaluation.

Calls a user function/method in class which should (as with “userdefined” above) return an array with page records for the menu.

.userFunc = function-name