Skip to content

Commit

Permalink
[TASK] Overhaul HMENU directory page (#1182)
Browse files Browse the repository at this point in the history
* Use confvals
* Correct indentation
* Overhaul example

releases: main, 12.4, 11.5

Co-authored-by: lina.wolf <[email protected]>
  • Loading branch information
github-actions[bot] and linawolf authored Apr 3, 2024
1 parent b1f00ad commit 9efd58c
Showing 1 changed file with 23 additions and 35 deletions.
58 changes: 23 additions & 35 deletions Documentation/ContentObjects/Hmenu/Directory.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
.. include:: /Includes.rst.txt
.. index:: HMENU; special = directory
.. _hmenu-special-directory:
.. include:: /Includes.rst.txt
.. index:: HMENU; special = directory
.. _hmenu-special-directory:

==================================
Directory menu - menu of subpages
Expand All @@ -16,61 +16,49 @@ page as meta menu or footer menu.

Mount pages are supported.

.. contents::
:local:
.. contents::
:local:

.. _hmenu-special-directory-properties:

Properties
==========

.. ### BEGIN~OF~TABLE ###
.. _hmenu-special-directory-value:
.. _hmenu-special-directory-value:

special.value
-------------

.. container:: table-row

Property
special.value

Data type
list of page ids /:ref:`stdWrap <stdwrap>`
.. confval:: special.value
:name: hmenu-directory-special-value
:type: Comma separated list of page IDs /:ref:`stdWrap <stdwrap>`
:Default: current page ID

Default
current page id
This will generate a menu of all pages with pid = 35 and pid = 56.

Description
This will generate a menu of all pages with pid = 35 and pid = 56.
.. code-block:: typoscript
:caption: EXT:site_package/Configuration/TypoScript/setup.typoscript
.. code-block:: typoscript
:caption: EXT:site_package/Configuration/TypoScript/setup.typoscript
lib.metaMenu = HMENU
lib.metaMenu {
lib.metaMenu = HMENU
lib.metaMenu {
special = directory
special.value = 35, 56
// render the menu
}
.. ###### END~OF~TABLE ######
[tsref:(cObject).HMENU.special = directory]
}
Example
=======
.. _hmenu-special-directory-example:

Menu of all subpages
--------------------
Example: Menu of all subpages
=============================

The content element :guilabel:`Menu > Subpages` provided by the system
extension EXT:fluid_styled_content is configured with a :php:`MenuProcessor`
which is based on the options of the :ref:`HMENU <cobj-hmenu>` and provides
all its properties:

.. include:: /CodeSnippets/Menu/TypoScript/MenuSubpages.rst.txt
.. include:: /CodeSnippets/Menu/TypoScript/MenuSubpages.rst.txt

The following Fluid template can be used to style the menu:

.. include:: /CodeSnippets/Menu/Template/MenuSubpages.rst.txt
.. include:: /CodeSnippets/Menu/Template/MenuSubpages.rst.txt

0 comments on commit 9efd58c

Please sign in to comment.