All Downloads are FREE. Search and download functionalities are using the official Maven repository.
  • Log In
  • Register

    • META-INF.maven.site.vm Maven / Gradle / Ivy

    There is a newer version: 5.0.0
    Show newest version
    

##
##
## Special processing:
## - allows relative URLs to be processed by the template by removing http://dummy.invalid/ from the start of any URL
## - resolves $relativePath in banner and head elements
## - allows absolute URLs in banner elements by removing '.remove.invalid' from hrefs
## - adds 
     content after Copyright, replacing @project.name@ with current ${project.name}
##   i.e. delays resolution of the Maven variable so it is processed in the current site context, not wherever
##   site.xml is located.
## - add trademark overlay if the POM property banner[Left|Right]TradePos is defined - should be a style value.
##Following is currently disabled:
## - add trademark overlay if  is defined, using the value as the style
##
## Resolve relativePath in context of current project
#set ( $dummy = 'http://dummy.invalid/' )
#set ( $dummylen = $dummy.length() )
#macro ( relreplace $text )
## Workround to allow site.xml to use $relativePath in URLs
#if ( $text.startsWith($dummy) )#set ( $text = $text.substring($dummylen) )#end
$StringUtils.replace( $text, '$relativePath', $relativePath )##
#end
##
## Remove extraneous header from custom entries
## See DOXIA-150
#set ( $documentHeader = '' )
#macro ( removeheader $text )
#set ( $text = $StringUtils.replace( $text, $documentHeader, '' ) )
#end
##
#macro ( removeDuplicateApacheName $text )
#set ( $text = $StringUtils.replace( $text, 'Apache Apache', 'Apache' ) )
#end
##
#macro ( link $href $name $target $img $position $alt $border $width $height )
  #set ( $linkTitle = ' title="' + $name + '"' )
  #if( $target )
    #set ( $linkTarget = ' target="' + $target + '"' )
  #else
    #set ( $linkTarget = "" )
  #end
  #if ( $href.toLowerCase().startsWith("http:/") || $href.toLowerCase().startsWith("https:/") ||
    $href.toLowerCase().startsWith("ftp:/") || $href.toLowerCase().startsWith("mailto:") ||
    $href.toLowerCase().startsWith("file:/") || ($href.toLowerCase().indexOf("://") != -1) )
    #set ( $linkClass = ' class="externalLink"' )
  #else
    #set ( $linkClass = "" )
  #end
  #if ( $img )
    #if ( $position == "left" )
      #image($img $alt $border $width $height)$name
    #else
      $name #image($img $alt $border $width $height)
    #end
  #else
    
    $name
  #end
#end
##
#macro ( image $img $alt $border $width $height )
  #if( $img )
    #if ( ! ( $img.toLowerCase().startsWith("http:/") || $img.toLowerCase().startsWith("https:/") ||
            $img.toLowerCase().startsWith("ftp:/") || $img.toLowerCase().startsWith("mailto:") ||
            $img.toLowerCase().startsWith("file:/") || ($img.toLowerCase().indexOf("://") != -1) ) )
      #set ( $imgSrc = $PathTool.calculateLink( $img, $relativePath ) )
      #set ( $imgSrc = $imgSrc.replaceAll( '\\', '/' ) )
      #set ( $imgSrc = ' src="' + $imgSrc + '"' )
    #else
      #set ( $imgSrc = ' src="' + $img + '"' )
    #end
    #if( $alt )
      #set ( $imgAlt = ' alt="' + $alt + '"' )
    #else
      #set ( $imgAlt = ' alt=""' )
    #end
    #if( $border )
      #set ( $imgBorder = ' border="' + $border + '"' )
    #else
      #set ( $imgBorder = "" )
    #end
    #if( $width )
      #set ( $imgWidth = ' width="' + $width + '"' )
    #else
      #set ( $imgWidth = "" )
    #end
    #if( $height )
      #set ( $imgHeight = ' height="' + $height + '"' )
    #else
      #set ( $imgHeight = "" )
    #end
    
  #end
#end
#macro ( banner $banner $id $class )
  #if ( $banner )
    #if( $banner.href )
      #set ( $hrf = $banner.href.replace('.remove.invalid' ,'') )
      #if ( ! ( $hrf.toLowerCase().startsWith("http:/") || $hrf.toLowerCase().startsWith("https:/") ||
        $hrf.toLowerCase().startsWith("ftp:/") || $hrf.toLowerCase().startsWith("mailto:") ||
        $hrf.toLowerCase().startsWith("file:/") || ($hrf.toLowerCase().indexOf("://") != -1) ) )
        #set ( $hrf = $PathTool.calculateLink( $hrf, $relativePath ) )
        #set ( $hrf = $hrf.replaceAll( '\\', '/' ) )
        #if ( ( $hrf == '' ) )
          #set ( $hrf = './' )
        #end
      #end
      
    #else
        
    #end
  #end
#end
##
#macro ( links $links )
  
      
  #set ( $counter = 0 )
  #foreach( $item in $links )
    #set ( $counter = $counter + 1 )
    #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) )
    #set ( $currentItemHref = $currentItemHref.replaceAll( '\\', '/' ) )
    #set ( $activeClass = "" )
    #if ( $alignedFileName == $currentItemHref)
      #set ( $activeClass = ' class="active"' )
    #end
    
    #link( $currentItemHref $item.name $item.target $item.img $item.position $item.alt $item.border $item.width $item.height )
    
  #end
  
    
#end
##
#macro ( breadcrumbs $breadcrumbs $cssClass )
  #foreach( $item in $breadcrumbs )
    #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) )
    #set ( $currentItemHref = $currentItemHref.replaceAll( '\\', '/' ) )
    #if ( ( $currentItemHref == '' ) )
      #set ( $currentItemHref = './' )
    #end
##
      
  • 
      #link( $currentItemHref $item.name $item.target $item.img $item.position $item.alt $item.border $item.width $item.height )
      
    • 
      
  • /
    • 
  #end
  #if ( $shortTitle )
    
  • $shortTitle
    • 
  #else
    
  • $title
    • 
  #end
#end
##
#macro ( displayTree $display $item )
  #if ( $item && $item.items && $item.items.size() > 0 )
    #foreach( $subitem in $item.items )
      #set ( $subitemHref = $PathTool.calculateLink( $subitem.href, $relativePath ) )
      #set ( $subitemHref = $subitemHref.replaceAll( '\\', '/' ) )
##
      #if ( $alignedFileName == $subitemHref )
        #set ( $display = true )
      #end
##
      #displayTree( $display $subitem )
    #end
  #end
#end
##
#macro ( menuItem $item $isComponentDocumentation )
  #set ( $collapse = "none" )
  #set ( $currentItemHref = $PathTool.calculateLink( $item.href, $relativePath ) )
  #set ( $currentItemHref = $currentItemHref.replaceAll( '\\', '/' ) )
##
  #if ( $item && $item.items && $item.items.size() > 0 )
    #if ( $item.collapse == false )
      #set ( $collapse = "expanded" )
    #else
      ## By default collapsed
      #set ( $collapse = "collapsed" )
    #end
##
    #set ( $display = false )
    #displayTree( $display $item )
##
    #if ( $alignedFileName == $currentItemHref || $display )
      #set ( $collapse = "expanded" )
    #end
  #end
  #set ( $active = "" )
  #if ( $alignedFileName == $currentItemHref )
  #set ($active = " active")
  #end
  #set ( $thisProjectDir = "  /${project.artifactId}" )
  #if ($thisProjectDir == $PathTool.getDirectoryComponent( $item.href ))
  #set ($active = " active")
  #end
  #if (${project.artifactId} != "log4j" && $isComponentDocumentation &&
        ($item.href == "team-list.html" || $item.href == "mail-lists.html"
        || $item.href == "issue-tracking.html" || $item.href == "license.html"
        || $item.href == "source-repository.html"))
  
  #else
    
  • 
    #link($currentItemHref $item.name $item.target $item.img $item.position $item.alt $item.border $item.width $item.height )
    #if ( $item && $item.items && $item.items.size() > 0 )
      #if ( $collapse == "expanded" )
        
      
          #foreach( $subitem in $item.items )
            #menuItem( $subitem $isComponentDocumentation )
          #end
        
    
      #end
    #end
    
    • 
   #end
#end
##
#macro ( mainMenu $menus )
  #foreach( $menu in $menus )
    
      
    #set ($isComponentDocumentation = false)
     #if ( $menu.name )
      #set ( $menuName = $menu.name )
            #if ( $menuName == $title )
              #set ( $menu.img = "icon-home" )
      #elseif ( $menuName == "Project Documentation" )
              #set ( $menu.img = "icon-info-sign" )
      #elseif ( $menuName == "Development" )
              #set ( $menu.img = "icon-cog" )
      #elseif ( $menuName == "User Guide" )
              #set ( $menu.img = "icon-book" )
      #end
      #if ( $menu.img )
       
    • $menuName
      • 
      #else
       
    • $menuName
      • 
      #end
    #end
    #if ( $menu.items && $menu.items.size() > 0 )
      #foreach( $item in $menu.items )
        #menuItem( $item $isComponentDocumentation )
      #end
    #end
    
    
  #end
#end
##
#macro ( copyright )
  #if ( $project )
    #if ( ${project.organization} && ${project.organization.name} )
      #set ( $period = "" )
    #else
      #set ( $period = "." )
   #end
##
   #set ( $currentYear = ${currentDate.year} + 1900 )
##
    #if ( ${project.inceptionYear} && ( ${project.inceptionYear} != ${currentYear.toString()} ) )
      ${project.inceptionYear}-${currentYear}${period}
    #else
      ${currentYear}${period}
    #end
##
    #if ( ${project.organization} )
      #if ( ${project.organization.name} && ${project.organization.url} )
          ${project.organization.name}.
      #elseif ( ${project.organization.name} )
        ${project.organization.name}.
      #end
    #end
  #end
#end
##
#macro ( publishDate $position $decorationPublishDate $version )
  #if ( $decorationPublishDate && $decorationPublishDate.format )
    #set ( $format = $decorationPublishDate.format )
  #else
    #set ( $format = "yyyy-MM-dd" )
  #end
##
  $dateFormat.applyPattern( $format )
##
  #if ( $publishDate )
    #set ( $dateValue = $dateFormat.format( $publishDate ) )
  #elseif ( $decoration.custom.getChild( 'publishDate' ) )
    #set ( $dateValue = $decoration.custom.getChild( 'publishDate' ).getValue() )
  #else
    #set ( $dateValue = $dateFormat.format( $currentDate ) )
  #end
##
  #if ( $decorationPublishDate && $decorationPublishDate.position )
    #set ( $datePosition = $decorationPublishDate.position )
  #else
    #set ( $datePosition = "left" )
  #end
##
  #if ( $version )
    #if ( $version.position )
      #set ( $versionPosition = $version.position )
    #else
      #set ( $versionPosition = "left" )
    #end
  #else
    #set ( $version = "" )
    #set ( $versionPosition = "left" )
  #end
##
  #set ( $breadcrumbs = $decoration.body.breadcrumbs )
  #set ( $links = $decoration.body.links )

  #if ( $datePosition.equalsIgnoreCase( "right" ) && $versionPosition.equalsIgnoreCase( "right" ) )
    #set ( $prefix = '
  • |
    • ' )
  #else
    #set ( $prefix = "" )
  #end
##
  #if ( ( $datePosition.equalsIgnoreCase( "right" ) ) || ( $datePosition.equalsIgnoreCase( "bottom" ) ) )
      
  • $i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateValue
    •  $prefix
      
  • $i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}
    • 
  #elseif ( ( $datePosition.equalsIgnoreCase( "navigation-bottom" ) ) || ( $datePosition.equalsIgnoreCase( "navigation-top" ) ) )
    
    
      $i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateValue
      | $i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}
    
    
  #elseif ( $datePosition.equalsIgnoreCase("left") )
      
  • $i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateValue
    • 
      
  • |
    •  
  • $i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}
    • 
  #end
#end
##
#macro ( builtByLogo $poweredBy )
  #if( $poweredBy )
    #foreach ($item in $poweredBy)
      #if( $item.href )
        #set ( $href = $PathTool.calculateLink( $item.href, $relativePath ) )
        #set ( $href = $href.replaceAll( '\\', '/' ) )
      #else
        #set ( $href="http://maven.apache.org/" )
      #end
##
      #if( $item.name )
        #set ( $name = $item.name )
      #else
        #set ( $name = $i18n.getString( "site-renderer", $locale, "template.builtby" )  )
        #set ( $name = "${name} Maven"  )
      #end
##
      #if( $item.img )
        #set ( $img = $item.img )
      #else
        #set ( $img = "images/logos/maven-feather.png" )
      #end
##
      #if ( ! ( $img.toLowerCase().startsWith("http:/") || $img.toLowerCase().startsWith("https:/") ||
            $img.toLowerCase().startsWith("ftp:/") || $img.toLowerCase().startsWith("mailto:") ||
            $img.toLowerCase().startsWith("file:/") || ($img.toLowerCase().indexOf("://") != -1) ) )
        #set ( $img = $PathTool.calculateLink( $img, $relativePath ) )
        #set ( $img = $img.replaceAll( '\\', '/' ) )
      #end
##
      #if( $item.alt )
        #set ( $alt = ' alt="' + $item.alt + '"' )
      #else
        #set ( $alt = ' alt="' + $name + '"' )
      #end
##
      #if( $item.border )
        #set ( $border = ' border="' + $item.border + '"' )
      #else
        #set ( $border = "" )
      #end
##
      #if( $item.width )
        #set ( $width = ' width="' + $item.width + '"' )
      #else
        #set ( $width = "" )
      #end
      #if( $item.height )
        #set ( $height = ' height="' + $item.height + '"' )
      #else
        #set ( $height = "" )
      #end
##
      
        
      
    #end
    #if( $poweredBy.isEmpty() )
      
        $i18n.getString( 
      
    #end
  #else
    
      $i18n.getString( 
    
  #end
#end
##
#macro ( forkMeOnGitHub )
  #if ( $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'gitHub' )
            && $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'gitHub' ).getChild( 'projectId' ) )

    #set ( $gitHubProjectId = $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'gitHub' ).getChild( 'projectId' ).getValue() )

    #set ( $leftRibbon = { "red" : "forkme_left_red_aa0000.png", "green" : "forkme_left_green_007200.png", "black" : "forkme_left_darkblue_121621.png", "darkblue" : "forkme_left_darkblue_121621.png", "orange" : "forkme_left_orange_ff7600.png", "gray" : "forkme_left_gray_6d6d6d.png" } )
    #set ( $rightRibbon = { "red" : "forkme_right_red_aa0000.png", "green" : "forkme_right_green_007200.png", "black" : "forkme_right_darkblue_121621.png", "darkblue" : "forkme_right_darkblue_121621.png", "orange" : "forkme_right_orange_ff7600.png", "gray" : "forkme_right_gray_6d6d6d.png" } )

    #set ( $ribbon = $leftRibbon )
    #set ( $ribbonOrientation = 'left' )
    #set ( $definedRibbonOrientation = $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'gitHub' ).getChild( 'ribbonOrientation' ) )
    #if ( $definedRibbonOrientation && $definedRibbonOrientation.getValue().equalsIgnoreCase( "right" ) )
      #set ( $ribbonOrientation = 'right' )
      #set ( $ribbon = $rightRibbon )
    #end

    #set ( $ribbonColor = 'red' )
    #set ( $definedRibbonColor = $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'gitHub' ).getChild( 'ribbonColor' ) )

    #if ( $definedRibbonColor
            && ( $definedRibbonColor.getValue().equalsIgnoreCase( "red" )
            || $definedRibbonColor.getValue().equalsIgnoreCase( "green" )
            || $definedRibbonColor.getValue().equalsIgnoreCase( "black" )
            || $definedRibbonColor.getValue().equalsIgnoreCase( "orange" )
            || $definedRibbonColor.getValue().equalsIgnoreCase( "gray" ) ) )
      #set ( $ribbonColor = $definedRibbonColor.getValue().toLowerCase() )
    #end

    
      Fork me on GitHub
    
  #end
#end
##

  
    
    
## put meta together
#foreach( $author in $authors )
    
#end
#if ( $dateCreation )
    
#end
#if ( $dateRevision )
    
#end
#if ( $locale )
    
#end
    $title

  
  
    

  
  
  
  

    #if ( $decoration.body.head )
      #foreach( $item in $decoration.body.head.getChildren() )
        #set ( $head = $item.toString().trim() )
        #set ( $documentHeader = '' )
        #if ( $item.name == "script" )
          #relreplace( $StringUtils.replace( $item.toUnescapedString(), $documentHeader, "" ) )
        #else
          #relreplace( $StringUtils.replace( $item.toString(), $documentHeader, "" ) )
        #end
      #end
    #end

    #if( $headContent )$headContent#end
  

  
        #banner( $decoration.bannerLeft "bannerLeft" "logo-left" )
        #banner( $decoration.bannerRight "bannerRight" "logo-right" )
    
    

    
    
      
    
        
    
          $project.name ™
          
      #publishDate( "navigation-top" $decoration.publishDate $decoration.version )
    
                    
    #links( $decoration.body.links )
    
        
    
      
    
    
    

    
    
      
    
        
    
          
            
    
              #mainMenu( $decoration.body.menus )
            
    
            
    
              #builtByLogo( $decoration.poweredBy )
            
    
              		
          
            $bodyContent
          
        
    
      
    
    
    

    
    
      
    Copyright ©#copyright()All Rights Reserved.
    
            #if ( $decoration.custom.getChild("footer") )
              #foreach( $item in $decoration.custom.getChild("footer").getChildren() )
                #set ( $foot = $item.toString().trim() )
                #removeheader ( $foot )
        #set ( $foot = $StringUtils.replace( $foot, '@project.name@', ${project.name} ) )
                #removeDuplicateApacheName ( $foot )
        $foot
              #end
            #end




    © 2015 - 2025 Weber Informatics LLC | Privacy Policy