[DOXIASITETOOLS-185] add helpers to traverse custom skin parameters

• Type: Improvement
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.7.5
• Fix Version/s: 1.8
• Component/s: Site model
• Assignee: Herve Boutemy
• Reporter: Herve Boutemy
• Created: 17/Dec/17 18:40
• Updated: 28/Dec/17 16:45
• Resolved: 21/Dec/17 12:57

Description

custom field is an open XML element, that Velocity has to traverse to find expected data: on each traversal, a test has to be added.
That leads to code like in Fluido skin:

#if ( $decoration.custom.getChild( 'fluidoSkin' ) && $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'skipGenerationDate' )
           && $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'skipGenerationDate' ).getValue() == 'true' )

or

#if ( $decoration.custom.getChild('fluidoSkin')
           && $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'navBarStyle' ) )
  #set ( $navBarStyle = $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'navBarStyle' ).getValue() )

or

#if ( $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'breadcrumbDivider' ) )
  #set ( $breadcrumbDivider = $decoration.custom.getChild( 'fluidoSkin' ).getChild( 'breadcrumbDivider' ).getValue() )
#else
  #set ( $breadcrumbDivider = '/' )
#end

Adding 3 methods to decoration:

• getCustomChild( "fluidoSkin.navBarStyle" )
• getCustomChildValue( "fluidoSkin.navBarStyle" )
• getCustomChildValue( "fluidoSkin.breadcrumbDivider", "/" )

would permit to simplify:

#if ( $decoration.getCustomChildValue( 'fluidoSkin.skipGenerationDate' ) == 'true' )

and

#if ( $decoration.getCustomChild('fluidoSkin.navBarStyle' ) )
  #set ( $navBarStyle = $decoration.getCustomChild('fluidoSkin.navBarStyle' ).getValue() )

and

#set ( $breadcrumbDivider = $decoration.getCustomValue( 'fluidoSkin.breadcrumbDivider', '/' ) )

Issue Links

• is depended upon by: MSKINS-141 simplify custom skin configuration code