From 65df3177f88210db31d4f90408e9ceb1f3c05f48 Mon Sep 17 00:00:00 2001 From: Lina Wolf <48202465+linawolf@users.noreply.github.com> Date: Thu, 4 Apr 2024 18:44:46 +0200 Subject: [PATCH] [TASK] Overhaul HMENU updated page (#1186) * [TASK] Overhaul HMENU updated page * Use confvals * Correct indentation Remove the larger part of the example as using this menu type is not recommended anymore. releases: main, 12.4, 11.5 * [TASK] Link to Custom Dataprocessor --- .../ContentObjects/Hmenu/Userfunction.rst | 194 +++--------------- .../Hmenu/ContentObjectsHmenuExampleMenu.png | Bin 4883 -> 0 bytes 2 files changed, 29 insertions(+), 165 deletions(-) delete mode 100644 Documentation/Images/ManualScreenshots/FrontendOutput/Hmenu/ContentObjectsHmenuExampleMenu.png diff --git a/Documentation/ContentObjects/Hmenu/Userfunction.rst b/Documentation/ContentObjects/Hmenu/Userfunction.rst index 82eed139d..a9dec1e6c 100644 --- a/Documentation/ContentObjects/Hmenu/Userfunction.rst +++ b/Documentation/ContentObjects/Hmenu/Userfunction.rst @@ -1,186 +1,50 @@ -.. include:: /Includes.rst.txt -.. index:: HMENU; special = userfunction -.. _hmenu-special-userfunction: +.. include:: /Includes.rst.txt +.. index:: HMENU; special = userfunction +.. _hmenu-special-userfunction: -======================= +================= Userfunction menu -======================= +================= -.. attention:: - It is still possible to create a menu with :typoscript:`special = userfunction` - for backward compatibility reasons. +.. attention:: + It is still possible to create a menu with :typoscript:`special = userfunction` + for backward compatibility reasons. - However we would advise you to write a customized MenuProcessor and style - the output with Fluid instead. + However we would advise you to write a :ref:`customized MenuProcessor ` + and style the output with Fluid instead. Calls a user function/method in class which should return an array with page records for the menu. -.. contents:: - :local: +.. contents:: + :local: + +.. _hmenu-special-userfunction-properties: Properties ========== -.. _hmenu-special-userfunction-userfunc: +.. _hmenu-special-userfunction-userfunc: special.userFunc ---------------- -.. ### BEGIN~OF~TABLE ### - -.. container:: table-row - - Property - special.userFunc - - Data type - string - - Description - Name of the function - - -.. ###### END~OF~TABLE ###### - -[tsref:(cObject).HMENU.special = userfunction] - -Example -======= - -.. _hmenu-special-userfunction-examples: - -Example: Creating hierarchical menus of custom links ----------------------------------------------------- - -By default the HMENU object is designed to create menus from pages in -TYPO3. Such pages are represented by their page-record contents. -Usually the "title" field is used for the title and the "uid" field is -used to create a link to that page in the menu. - -However the HMENU and sub-menu objects are so powerful that it would -be very useful to use these objects for creating menus of links which -do not relate to pages in TYPO3 by their ids. This could be a menu -reflecting a menu structure of a plugin where each link might link to -the same page id in TYPO3 but where the difference would be in some -parameter value. - -First, this listing creates a menu in three levels where the first two -are graphical items: - -.. code-block:: typoscript - :linenos: - - # ************************ - # CUSTOM MENU - # ************************ - lib.custommenu = HMENU - lib.custommenu { - special = userfunction - special.userFunc = Vendor\MyExtension\Userfuncs\CustomMenu->makeMenuArray - - 1 = TMENU - 1.wrap = - 1.NO = 1 - 1.NO { - wrapItemAndSub =
  • |
    • - } - - 2 = TMENU - 2.wrap = - 2.NO = 1 - 2.NO { - wrapItemAndSub =
  • |
    • - } - - 3 = TMENU - 3.wrap = - 3.NO = 1 - 3.NO { - wrapItemAndSub =
  • |
    • - } - } - -The menu looks like this on a web page: - -.. figure:: /Images/ManualScreenshots/FrontendOutput/Hmenu/ContentObjectsHmenuExampleMenu.png - :alt: Output of the example menu. - -The TypoScript code above generates this menu, but the items do not -link straight to pages as usual. This is because the *whole* menu is -generated from this array, which was returned from the function -"makeMenuArray" called in TypoScript line 5+6 : - -.. code-block:: php - :linenos: - - 'Contact', - '_OVERRIDE_HREF' => 'index.php?id=10', - '_SUB_MENU' => [ - [ - 'title' => 'Offices', - '_OVERRIDE_HREF' => 'index.php?id=11', - '_OVERRIDE_TARGET' => '_top', - 'ITEM_STATE' => 'ACT', - '_SUB_MENU' => [ - [ - 'title' => 'Copenhagen Office', - '_OVERRIDE_HREF' => 'index.php?id=11&officeId=cph', - ], - [ - 'title' => 'Paris Office', - '_OVERRIDE_HREF' => 'index.php?id=11&officeId=paris', - ], - [ - 'title' => 'New York Office', - '_OVERRIDE_HREF' => 'https://example.org', - '_OVERRIDE_TARGET' => '_blank', - ] - ] - ], - [ - 'title' => 'Form', - '_OVERRIDE_HREF' => 'index.php?id=10&cmd=showform', - ], - [ - 'title' => 'Thank you', - '_OVERRIDE_HREF' => 'index.php?id=10&cmd=thankyou', - ], - ], - ], - [ - 'title' => 'Products', - '_OVERRIDE_HREF' => 'index.php?id=14', - ] - ]; - } +.. confval:: special.userFunc + :name: hmenu-userfunction-special-userfunc + :type: string - } + Name of the user function -Notice how the array contains "fake" page-records which has *no* uid -field, only a "title" and "\_OVERRIDE\_HREF" as required and some -other fields as it fits. +.. _hmenu-special-userfunction-examples: -- The first level with items "Contact" and "Products" contains "title" - and "\_OVERRIDE\_HREF" fields, but "Contact" extends this by a - "\_SUB\_MENU" array which contains a similar array of items. +Example: Set a userFunc +~~~~~~~~~~~~~~~~~~~~~~~ -- The first item on the second level, "Offices", contains a field called - "\_OVERRIDE\_TARGET". Further the item has its state set to "ACT" - which means it will render as an "active" item (you will have to - calculate such stuff manually when you are not rendering a menu of - real pages!). Finally there is even another sub-level of menu items. +.. code-block:: typoscript + :caption: This is still possible for backward compability reasons but not recommended: + lib.custommenu = HMENU + lib.custommenu { + special = userfunction + special.userFunc = MyVendor\MyExtension\Userfuncs\CustomMenu->makeMenuArray + } diff --git a/Documentation/Images/ManualScreenshots/FrontendOutput/Hmenu/ContentObjectsHmenuExampleMenu.png b/Documentation/Images/ManualScreenshots/FrontendOutput/Hmenu/ContentObjectsHmenuExampleMenu.png deleted file mode 100644 index d9f9c5d54555b8e3586dc15cbdad6212647f9cf3..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 4883 zcmZ8l1yodB+Xd-v5s4ur1OaJ=81R)CLKu)7It78D8>9rJ8zhHDk&+bYZfO|GAym3# zfT6#6<6qzVe|N2W?^^fV^PF|g-Fu(CZxlpBnT+@$F%}jUnF?4z8*?wloF549VXkX* zQ%+b|)Qc(#&vblp_H#)fy0Z@lHhif|?o%RkoIsH>+YLvp?Ld!f>*Puun7?y#cA%iFZZ!dr5@DNh`R{R?Ct-1-6n^s`0blr0!)YBtYhL>siO$w-!j? zyZ|xb)4NY2++j6c{gwqJ^mgB6E_e8pq%H1kUY{{KA>44w< zroXa%MsM0RKK|p7w=K34AIG5FoYlt;Xj$iK#mi&#~3DrW+OJL zi?AKd|2eX~rR8_@%xlmr=tZ{pG5C6jn<>BR-CC8E)ni~LK6$Nu~Nh@_CcA5$U^UF)8VC8>L{dyrCbv9b7FIg zUmHGmkhV`8Bh31GzM|H#u7o8+^-l!!tJ%JiJK>BqUoL)zooZ zp2jR~H^XD3Cqg&G5d6bXsbEWq!bQf&T09fO52 zlOXTxP9D(8$enQNd}V+S&d%<0N`1ta`6#R=<4HkT-a6eirJV&$1UZq0h^WZ;mqtu95v6@2dNsx3nn0! zsFzF7!qZ(}->uW#)?uWjllw63n>!p?4&GruCK6_;UZO7^TOkCFWb6RXwIM+>+nuMb zIypjNu#Q}$WTuQ^lDJl>(#HLmmKVwe?g%3EOYN=dppuIdUxwZOxYS&yUkt@i*xR=Lch znVtsI*RYF*xt5hKcDr$kSWnbasdbz^>?pwLiX6|ecduJ#1{jp%E5W&TKRrL%tU09s z0A)H`6_UjBMS*BHj)#6`IPI_ERCeTLL`(m_gR{w$-ggZMiBIsVv*>6H+ zz4j}+;yYsyyOT6{LCb|PJ+U)ph^l^LjszPDCgj$utX=W@`D3EvR&iXWNAS(P>%|7H z0L2nv20-2P)Yj=dFoe;e_R{M?iNP6P1*I09`pY_SU`U?q#R|Y>mZkj1uiNbc;#fv+ z8~^jE61AOz=M6vo$kk6bBFb?3&==-Alh_CWs^%qt(+D?4P_zNx~`T1P{e z0e}vVZS5p4MXB1obMaQP2t&6^ywluq-9;-e^;_+-_7>Hhf=#n`Ki7KlR1 zv@c;opPm>f)1>luZ-98(<{LiAfxVeUSX#5SGbBz{$5kqKPv>WR(O*^m92v&iJme~+ z=(I&?DweTFrk$YnKYRF}3ODvjtr!Y|^Xv2tyl$}7UVeVEP%86H)FHn2#TC1j5qF=% z>dl_&$nwCdSF*)l&0aZgjmKU|mohK8=Hz-Tre>?Cw}>QJXt(zNs#|gKbT&Ak()+p) z&9tirr#)Z3T8N)Eo|W}AK3Mh@8*Cx=w0y}dm{(2Pac8myx;bG$J?FJSDmzu1tUpa12{m$Ut)SFc`G8#R$QKe;!?VeDjzPue;kDMMXt$j~raqKOGJDDLx76(w1>FtFw)R!;y29 zMr%aZH#d{qt5~boYn|ERPSI76*EgEO!*TxFvk&54+1Pj-J)F6Xg67inOXyE zI^lGMoS;{jj+8F;?Z+3I)t8rKf30FCKbZQ@{O#}bp3 zm3{n}2x$2v(zVHHNv}oX&+prV4I0)F@mASTp_b=c)2db0SZA13!Yu#% z2Q3cPfiyBAB70=}&9AZS&CyI8EJH&>MhTeuix+)#a<1#WqnRQt-iLXKiSlz%`xq3l z3kiM3ppQ}9aq!zWr8JckuG8Il=dFnXoS^u-G$s)`OLeM{kQV_J^(^FF}`9w5a ztU*7A(~xhjDiabYvf|?66y?CGs($FTNCL8lxKq%tSpqNj6R{C({^u-D&9MZe>`ID@ zMIGiGXUlaL$Mx2uNuJ~GVT!Z9LbeCe3z{kj2^A3iSdFYVNZ=Z!h1Qs3qlu;t!- zqV}~;OO30m=BThF4rO+lTvCEu8DHV4EhREWaa{cyVZA`;P#S4xM3UBmdITH}&lbi^ z?_jEAWUVJM==ylz_U0&Sa0B=*^nVQ-CM zmAhBKhukrmC7+;r*{509YuCn`nK_R1(Nl3{Wo3?0B@c1Wotc~*CMQlBeCX#`V{j}| zOG~Q;-4#aA)nY{;x6GY#Qvj@hMLD&B%RvR86)}u5;tm%J1 z1pp*~i3RBUaAlTFV>Tbv*^W_HA&^LbJ^w0opTdaW_b*NHQBiCw&(kpa7e&KeKJb_> z!vb;1Xrkzyzr=R~9aYrs=W3xa6oD@UCgMKIFI=gtE z^kByS7Y{Hz$C$dHJC4s=74|Q0Tm908(~}q6-YT@G7tQ`Y=RWRb1cDv>8&HQGDb<2e zO-)I2#d0~f@~TSKxZ)q)hHKeBHtEpFm6}ZFM;)|?+EZilYleWQxAy&LkfYuifQLWjP(3-V z>3-|n;o7%qF6Hs=_Qv_4MEsNcFa;*?P(CISQY3yGE|fkj#>UwyNU)Ut z8_18#Dyyidi}FTao)$&X0BIImGadT+wJq8CP1W_QmL2cg8;CDH;~pH}B(Jx?k-d6? z!y=nSk{^hQ8cMO>hwe;AviJlq=G%gqdH|9qyn~oTJU^(i+=@ z6&53l;0=9j1K6O!G_n;jtPFH4EuKixoQedvam+P!q#81&Q6Zjg9k$oSRouhb zQ>WQt_lfA^NW`bRAv^90J3C)EM~-)SJ;P2QWaobLRyz6?v{V&HI{R*RGXCp$RRt-u z@eK8R@Sth8zHM;+u=W!tZh!pwuotUIL$%K1f7!A>*@cPHNl$Pp