Migrating from $macros to Velocimacros

Because Velocity does not support macro overloading (more than one macro with the same name, but different parameters) it was necessary to come up with names to differentiate the velocimacros from each other where Macros.java was able to use overloading. The following is a mapping of the Macros methods to Velocimacros that perform the same function. Other than changing the "method" where necessary, simply replace "$macros." with "#". In addition, you can "override" a velocimacro in your template by defining a new macro with the same name and parameters. To this end, some macros are listed which do not have $macros equivalents. More information on the Velocimacros can be found in the Velocimacro API
Note: It is vital that you remove the commas (,) from the old $macros when moving to the new Velocimacros!! If you do not, Velocity will not parse your page correctly!
Macros.java Velocimacro
includePage(String pageName) includePage( $pageName )
showAllNewsfeeds(boolean desc, int max, boolean expandingFolder) showNewsfeeds($showDescription $maxItems $expandingFolders)
showAllNewsfeeds(boolean desc, int max)
showNewsfeed(String name, boolean desc, int max, boolean expandingFolder) showNewsfeed($name $showDescription $maxItems $expandingFolders)
showNewsfeed(String name, boolean desc, int max)
showBigWeblogCalendar() showBigWeblogCalendar()
showBookmarks(String folderName, boolean showFolderName, boolean expandingFolder) showBookmarks($folderName $showFolderName $expandingFolder )
showBookmarks(String folderName, boolean showFolderName)
showBookmarks(String folderName, String title)
showEditorNavBar(boolean vertical) showEditorNavBar($vertical )
showNavBar(boolean vertical) showBasicNavBar($vertical )
showNavBar(boolean vertical, String delimiter) showNavBar($vertical $delimiter )
showPageDescription() showPageDescription()
showPageName() showPageName()
showPageUpdateTime() showPageUpdateTime()
showReferers(int max, int maxWidth) showReferers($max $maxWidth)
showReferers()
showReferers(int max)
showResourceImage(String fileName, String linkUrl, String alt, int border, String halign, String valign) showResourceImage($fileName $linkUrl $alt $border $halign $valign)
showResourcePath() showResourcePath()
showRSSAutodiscoveryLink() showRSSAutodiscoveryLink()
showRSSBadge() showRSSBadge()
showRSSLinks() showRSSLinks()
showThemeImage(String theme, String imageName) showThemeImage($theme $imageName)
showThemeImagePath(String theme, String imageName) showThemeImagePath($theme $imageName)
showThemePath(String theme) showThemePath($theme)
showThemeScript(String theme, String scriptFile) showThemeScript($theme $scriptFile)
showThemeScriptPath(String theme, String scriptFile) showThemeScriptPath($theme $scriptFile)
showThemeStyle(String theme, String stylesheet, boolean useImport) showThemeStyle($theme $stylesheet $useImport)
showThemeStyleImport(String theme, String stylesheet) showThemeStyleImport($theme $stylesheet)
showThemeStylePath(String theme, String stylesheet) showThemeStylePath($theme $stylesheet)
showVersion() showVersion()
showWeblogCalendar() showWeblogCalendar()
showWeblogCategoryChooser() showWeblogCategoryChooser()
showWeblogEntries(String dayTemplate, int maxEntries) showWeblogEntries( $pageName $maxEntries )
showWeblogEntries(String dayTemplate)
showWeblogEntries(int maxEntries)
showWeblogEntries()
showWebsiteDescription() showWebsiteDescription()
showWebsiteTitle() showWebsiteTitle()
New Velocimacros
formatDate($dateFormat $date )
refererDisplayUrl($ref $maxWidth $includeHits)
showComments( $entry )
showCommentForm $entry )
showCommentsLink($entry)
showCommentsPageLink($entry)
showDayPermalink( $day )
showEntryDate( $day )
showEntryPermalink( $entry )
showLinkbacks( $day )
showPageUpdateTime()
showTrackbackURL( $entry )