META-INF.maven.macros.menu-macros.vm Maven / Gradle / Ivy

Go to download
#*
 * The MIT License (MIT)
 * 
 * Copyright (c) 2015-2021 Bernardo Martínez Garrido
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 *###
#*--------------------------------------------------*###
#*--------------------------------------------------*###
#**
 * Renders a dropdown menu with the received menus as the selection options.
 *
 * Receives:
 *        elements: Doxia decoration menus collection
 *
 *###
#*--------------------------------------------------*###
#macro( dropdownMenu $elements )
#**##foreach( $element in $elements )##
                    
                        $element.name
                        
#*    *##foreach( $item in $element.items )##
                            $item.name
#*    *##end##
                        
                    
#**##end##
#end##
#*



*###
#*--------------------------------------------------*###
#**
 * Renders the icons menu.
 *
 * These are the icons shown in the upper navigation bar.
 *
 *###
#*--------------------------------------------------*###
#macro( iconsMenu $elements )
         
#**##foreach( $element in $elements )##
#*    *##foreach( $item in $element.items )##
              $item.name
#*    *##end##
#**##end##
         
#end##
#*



*###
#*--------------------------------------------------*###
#**
 * Renders the links menu.
 *
 * These are the links shown in the upper navigation bar.
 *
 *###
#*--------------------------------------------------*###
#macro( linksMenu $elements )
#**##if( $elements.size() > 0 )##
                    
                        Links
                        
#*    *##foreach( $item in $elements )##
                            $item.name
#*    *##end##
                        
                    
#**##end##
#end##
#*



*###
#*--------------------------------------------------*###
#**
 * Renders the bottom navigation.
 *
 * Receives:
 *        elements: Doxia decoration menus collection
 *        maxColSize: the maximum size for the columns
 *###
#*--------------------------------------------------*###
#macro( bottomNav $elements )
#**##foreach( $element in $elements )##
#*    *##if( $element.items )##
            
#*        *##linksDictionaryMenu( $element )##
            
#*    *##end##
#**##end##
#end##
#*



*###
#*--------------------------------------------------*###
#**
 * Renders a menu with links.
 *
 * Receives:
 *        element: Doxia decoration menu
 *
 * This will be a definitions list, where each definition is a link.
 *
 *###
#*--------------------------------------------------*###
#macro( linksDictionaryMenu $element )
                
#**##if( $element.name )##
                    $element.name
#**##end##
#**##foreach( $item in $element.items )##
#*    *##if( $item.description )##
                        $item.name $item.description
#*    *##else##
                        $item.name
#*    *##end##
#**##end##
                
#end##
#*



*###