Menu Tag
========


In this article:
    - `Introduction`_
    - `Use in template`_

Introduction
------------
Well-known, an integral part of the page is menu. It navigate users overall web-site, and describe what kind of content
was presented on. Since ImCMS based on document-presented pages each menu item can be present as specific document link

Use in template
---------------

There are several important part configure menu fully:

* HTML structure such as ``ul-li`` list or ``div-div`` list
* Information about menu-nesting

Default 2-level structured menu shows below:

.. code-block:: jsp

    <imcms:menu no='1' docId="1001">
        <ul>
            <imcms:menuloop>
                <imcms:menuitem>
                    <li>
                        <imcms:menuitemlink>
                            ${menuitem.document.headline}
                        </imcms:menuitemlink>
                        <!-- sub menu definition -->
                        <imcms:menuloop>
                            <imcms:menuitem>
                                <div>
                                    <imcms:menuitemlink>
                                        ${menuitem.document.headline}
                                    </imcms:menuitemlink>
                                </div>
                            </imcms:menuitem>
                        </imcms:menuloop>
                    </li>
                </imcms:menuitem>
            </imcms:menuloop>
        </ul>
    </imcms:menu>



Available list of tag attributes:
"""""""""""""""""""""""""""""""""

+--------------------+--------------+--------------------------------------------------+
| Attribute          | Type         | Description                                      |
+====================+==============+==================================================+
| no                 | Integer      | Identifier for current menu                      |
+--------------------+--------------+--------------------------------------------------+
| docId              | Integer      | Identify the linked document (default            |
|                    |              | - current document)                              |
+--------------------+--------------+--------------------------------------------------+
| pre                | String       | Text or html tag that would be added before      |
|                    |              | menu tag                                         |
+--------------------+--------------+--------------------------------------------------+
| post               | String       | Text or html tag that would be added after menu  |
|                    |              | tag                                              |
+--------------------+--------------+--------------------------------------------------+
| label              | String       | Text label that is connected to current menu tag |
|                    |              | only if showlabel will - true!                   |
+--------------------+--------------+--------------------------------------------------+
| showlabel          | Boolean      | Set true if you want to see text label near menu |
|                    |              | tag content in admin edit mode                   |
+--------------------+--------------+--------------------------------------------------+
| nested             | Boolean      | boolean value means disable nested in menu. So,  |
|                    |              | show menuItem without nested,like just list links|
+--------------------+--------------+--------------------------------------------------+
| wrap               | String       | wrapper for menu item html content               |
+--------------------+--------------+--------------------------------------------------+
| attributes         | String       | list attributes in menu item html                |
+--------------------+--------------+--------------------------------------------------+
| treeKey            | String       | identifier specific locations in the menu        |                                 |
+--------------------+--------------+--------------------------------------------------+

Example:
""""""""
.. code-block:: jsp

    <%@taglib prefix="imcms" uri="imcms" %>

    <!DOCTYPE html>
    <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
    <head>
        <title>Template</title>
        <meta charset="utf-8"/>
    </head>
    <body>
        <imcms:menu no='1' docId="1001">
            <ul>
                <imcms:menuloop>
                    <imcms:menuitem>
                        <li>
                            <imcms:menuitemlink>
                                ${menuitem.title}
                            </imcms:menuitemlink>
                            <!-- sub menu definition -->
                            <imcms:menuloop>
                                <imcms:menuitem>
                                    <div>
                                        <imcms:menuitemlink>
                                            ${menuitem.title}
                                        </imcms:menuitemlink>
                                    </div>
                                </imcms:menuitem>
                            </imcms:menuloop>
                        </li>
                    </imcms:menuitem>
                </imcms:menuloop>
            </ul>
        </imcms:menu>
    </body>
    </html>

Second example: with use nested, disable nested in the menu and in each menuItem
""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""""


.. code-block:: jsp

     <imcms:menu no='1' docId="1001" pre="<div><ul>" post="</ul></div>" nested="true" label="something" showlabel="true">
                    <li><imcms:menuitemlink>${menuitem.title}</imcms:menuitemlink></li>
     </imcms:menu>





Third example: generate automatic html menu items
""""""""""""""""""""""""""""""""""""""""""""""""""

.. code-block:: jsp

     <imcms:menu index='1' nested="true" wrap="span, b, i" attributes="wcag, data, class", treeKey="20"/>