This is an automated email from the ASF dual-hosted git repository. freeandnil pushed a commit to branch Feature/146-add-installation-page in repository https://gitbox.apache.org/repos/asf/logging-log4net.git
commit 2b5f3b939ab71e0c1337cf84ddf5498443102b1b Author: Jan Friedrich <freeand...@apache.org> AuthorDate: Fri May 24 13:16:54 2024 +0200 #146 add installation page --- src/site/resources/doap_log4net.rdf | 2 +- src/site/site.vm | 684 +++++++++++++------------- src/site/site.xml | 3 +- src/site/xdoc/release/download.xml | 49 ++ src/site/xdoc/release/manual/installation.xml | 43 ++ 5 files changed, 437 insertions(+), 344 deletions(-) diff --git a/src/site/resources/doap_log4net.rdf b/src/site/resources/doap_log4net.rdf index c4420b34..f9e1a4e9 100644 --- a/src/site/resources/doap_log4net.rdf +++ b/src/site/resources/doap_log4net.rdf @@ -29,7 +29,7 @@ <homepage rdf:resource="http://logging.apache.org/log4net/" /> <asfext:pmc rdf:resource="http://logging.apache.org" /> <shortdesc>Apache log4net provides logging services for .NET.</shortdesc> - <download-page rdf:resource="https://logging.apache.org/download.html" /> + <download-page rdf:resource="https://logging.apache.org/log4net/download.html" /> <programming-language>C#</programming-language> <category rdf:resource="http://projects.apache.org/category/library" /> <repository> diff --git a/src/site/site.vm b/src/site/site.vm index 3dc2549b..f971db5c 100644 --- a/src/site/site.vm +++ b/src/site/site.vm @@ -17,34 +17,34 @@ --> <!-- Generated by Apache Maven Doxia at $dateFormat.format( $currentDate ) --> #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="external" target="_blank"' ) + #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="external" target="_blank"' ) - #if ( $linkTarget ) - #else - #set ( $linkTarget = "_blank" ) - #end + #if ( $linkTarget ) + #else + #set ( $linkTarget = "_blank" ) + #end - #else - #set ( $linkClass = "" ) - #end - #if ( $img ) - #if ( $position == "left" ) - <a href="$href"$linkClass$linkTarget$linkTitle>#image($img $alt $border $width $height)$name</a> - #else - <a href="$href"$linkClass$linkTarget$linkTitle>$name #image($img $alt $border $width $height)</a> - #end - #else - <a href="$href"$linkClass$linkTarget$linkTitle>$name</a> - #end + #else + #set ( $linkClass = "" ) + #end + #if ( $img ) + #if ( $position == "left" ) + <a href="$href"$linkClass$linkTarget$linkTitle>#image($img $alt $border $width $height)$name</a> + #else + <a href="$href"$linkClass$linkTarget$linkTitle>$name #image($img $alt $border $width $height)</a> + #end + #else + <a href="$href"$linkClass$linkTarget$linkTitle>$name</a> + #end #end ## #macro ( image $img $alt $border $width $height ) @@ -126,128 +126,128 @@ #end ## #macro ( links $links ) - <ul class="nav"> - #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 - <li$activeClass> - #link( $currentItemHref $item.name $item.target $item.img $item.position $item.alt $item.border $item.width $item.height ) - </li> - #end - </ul> + <ul class="nav"> + #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 + <li$activeClass> + #link( $currentItemHref $item.name $item.target $item.img $item.position $item.alt $item.border $item.width $item.height ) + </li> + #end + </ul> #end ## #macro ( breadcrumbs $breadcrumbs ) - #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 ) - <span class="divider">></span> - #end - $title + #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 ) + <span class="divider">></span> + #end + $title #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 + #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} != "log4net" && $isComponentDocumentation && - ($item.href == "team-list.html" || $item.href == "license.html" - || $item.href == "source-repository.html")) - <!-- Removing overall project item $item.name from component-specific menu --> - #else - #set ($thisItemName = $item.name) - #if (${project.artifactId} != "log4net" && $isComponentDocumentation ) - #set ($thisItemName = $item.name.replace("Project Information", "Component Project")) - #set ($thisItemName = $item.name.replace("Project", "Component")) - #end - <li class="$collapse$active"> - #link($currentItemHref $thisItemName $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" ) - <ul> - #foreach( $subitem in $item.items ) - #menuItem( $subitem $isComponentDocumentation ) - #end - </ul> - #end - #end - </li> - #end + #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} != "log4net" && $isComponentDocumentation && + ($item.href == "team-list.html" || $item.href == "license.html" + || $item.href == "source-repository.html")) + <!-- Removing overall project item $item.name from component-specific menu --> + #else + #set ($thisItemName = $item.name) + #if (${project.artifactId} != "log4net" && $isComponentDocumentation ) + #set ($thisItemName = $item.name.replace("Project Information", "Component Project")) + #set ($thisItemName = $item.name.replace("Project", "Component")) + #end + <li class="$collapse$active"> + #link($currentItemHref $thisItemName $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" ) + <ul> + #foreach( $subitem in $item.items ) + #menuItem( $subitem $isComponentDocumentation ) + #end + </ul> + #end + #end + </li> + #end #end ## #macro ( mainMenu $menus ) - #foreach( $menu in $menus ) - <ul class="nav nav-list"> - #set ($isComponentDocumentation = false) - #if ( $menu.name ) - #set ( $menuName = $menu.name ) - #if ( $menuName == "Project Documentation" ) - #set ( $menuName = "Component Documentation" ) - #set ($isComponentDocumentation = true) - #end - #if ( $menu.img ) - <li class="nav-header"><i class="$menu.img"></i>$menuName</li> - #else - <li class="nav-header">$menuName</li> - #end - #end - #if ( $menu.items && $menu.items.size() > 0 ) - #foreach( $item in $menu.items ) - #menuItem( $item $isComponentDocumentation ) - #end - #end - </ul> - #end + #foreach( $menu in $menus ) + <ul class="nav nav-list"> + #set ($isComponentDocumentation = false) + #if ( $menu.name ) + #set ( $menuName = $menu.name ) + #if ( $menuName == "Project Documentation" ) + #set ( $menuName = "Component Documentation" ) + #set ($isComponentDocumentation = true) + #end + #if ( $menu.img ) + <li class="nav-header"><i class="$menu.img"></i>$menuName</li> + #else + <li class="nav-header">$menuName</li> + #end + #end + #if ( $menu.items && $menu.items.size() > 0 ) + #foreach( $item in $menu.items ) + #menuItem( $item $isComponentDocumentation ) + #end + #end + </ul> + #end #end ## #macro ( copyright ) @@ -277,183 +277,183 @@ #end ## #macro ( publishDate $position $publishDate $version ) - #if ( $publishDate && $publishDate.format ) - #set ( $format = $publishDate.format ) - #else - #set ( $format = "yyyy-MM-dd" ) - #end -## - $dateFormat.applyPattern( $format ) -## - #set ( $dateToday = $dateFormat.format( $currentDate ) ) -## - #if ( $publishDate && $publishDate.position ) - #set ( $datePosition = $publishDate.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 ( $publishDate && $publishDate.format ) + #set ( $format = $publishDate.format ) + #else + #set ( $format = "yyyy-MM-dd" ) + #end +## + $dateFormat.applyPattern( $format ) +## + #set ( $dateToday = $dateFormat.format( $currentDate ) ) +## + #if ( $publishDate && $publishDate.position ) + #set ( $datePosition = $publishDate.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( $position ) ) - #if ( ( $datePosition.equalsIgnoreCase( "right" ) ) || ( $datePosition.equalsIgnoreCase( "bottom" ) ) ) - <span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateToday</span> - #if ( $versionPosition.equalsIgnoreCase( $position ) ) - <span class="divider">|</span> <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> - #end - #elseif ( ( $datePosition.equalsIgnoreCase( "navigation-bottom" ) ) || ( $datePosition.equalsIgnoreCase( "navigation-top" ) ) ) - <div id="lastPublished"> - <span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateToday</span> - #if ( $versionPosition.equalsIgnoreCase( $position ) ) - <span class="divider">|</span> <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> - #end - </div> - #elseif ( $datePosition.equalsIgnoreCase("left") ) - <div class="pull-left"> - <span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateToday</span> - #if ( $versionPosition.equalsIgnoreCase( $position ) ) - <span class="divider">|</span> <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> - #end - #if ( $breadcrumbs && $breadcrumbs.size() > 0 ) - <span class="divider">|</span> #breadcrumbs( $breadcrumbs ) - #end - </div> - #end - #elseif ( $versionPosition.equalsIgnoreCase( $position ) ) - #if ( ( $versionPosition.equalsIgnoreCase( "right" ) ) || ( $versionPosition.equalsIgnoreCase( "bottom" ) ) ) - $prefix <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> - #elseif ( ( $versionPosition.equalsIgnoreCase( "navigation-bottom" ) ) || ( $versionPosition.equalsIgnoreCase( "navigation-top" ) ) ) - <div id="lastPublished"> - <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> - </div> - #elseif ( $versionPosition.equalsIgnoreCase("left") ) - <div class="pull-left"> - <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> - #if ( $breadcrumbs && $breadcrumbs.size() > 0 ) - <span class="divider">|</span> #breadcrumbs( $breadcrumbs ) - #end - </div> - #end - #elseif ( $position.equalsIgnoreCase( "left" ) ) - #if ( $breadcrumbs && $breadcrumbs.size() > 0 ) - <div class="pull-left"> - #breadcrumbs( $breadcrumbs ) - </div> - #end - #end + #if ( $datePosition.equalsIgnoreCase( $position ) ) + #if ( ( $datePosition.equalsIgnoreCase( "right" ) ) || ( $datePosition.equalsIgnoreCase( "bottom" ) ) ) + <span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateToday</span> + #if ( $versionPosition.equalsIgnoreCase( $position ) ) + <span class="divider">|</span> <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> + #end + #elseif ( ( $datePosition.equalsIgnoreCase( "navigation-bottom" ) ) || ( $datePosition.equalsIgnoreCase( "navigation-top" ) ) ) + <div id="lastPublished"> + <span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateToday</span> + #if ( $versionPosition.equalsIgnoreCase( $position ) ) + <span class="divider">|</span> <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> + #end + </div> + #elseif ( $datePosition.equalsIgnoreCase("left") ) + <div class="pull-left"> + <span id="publishDate">$i18n.getString( "site-renderer", $locale, "template.lastpublished" ): $dateToday</span> + #if ( $versionPosition.equalsIgnoreCase( $position ) ) + <span class="divider">|</span> <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> + #end + #if ( $breadcrumbs && $breadcrumbs.size() > 0 ) + <span class="divider">|</span> #breadcrumbs( $breadcrumbs ) + #end + </div> + #end + #elseif ( $versionPosition.equalsIgnoreCase( $position ) ) + #if ( ( $versionPosition.equalsIgnoreCase( "right" ) ) || ( $versionPosition.equalsIgnoreCase( "bottom" ) ) ) + $prefix <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> + #elseif ( ( $versionPosition.equalsIgnoreCase( "navigation-bottom" ) ) || ( $versionPosition.equalsIgnoreCase( "navigation-top" ) ) ) + <div id="lastPublished"> + <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> + </div> + #elseif ( $versionPosition.equalsIgnoreCase("left") ) + <div class="pull-left"> + <span id="projectVersion">$i18n.getString( "site-renderer", $locale, "template.version" ): ${project.version}</span> + #if ( $breadcrumbs && $breadcrumbs.size() > 0 ) + <span class="divider">|</span> #breadcrumbs( $breadcrumbs ) + #end + </div> + #end + #elseif ( $position.equalsIgnoreCase( "left" ) ) + #if ( $breadcrumbs && $breadcrumbs.size() > 0 ) + <div class="pull-left"> + #breadcrumbs( $breadcrumbs ) + </div> + #end + #end #end ## #macro ( poweredByLogo $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/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 -## - <a href="$href" title="$name" class="poweredBy"> - <img class="poweredBy" $alt src="$img" $border $width $height /> - </a> - #end - #if( $poweredBy.isEmpty() ) - <a href="http://maven.apache.org/" title="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" class="poweredBy"> - <img class="poweredBy" alt="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" src="$relativePath/images/maven-feather.png" /> - </a> - #end - #else - <a href="http://maven.apache.org/" title="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" class="poweredBy"> - <img class="poweredBy" alt="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" src="$relativePath/images/maven-feather.png" /> - </a> - #end + #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/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 +## + <a href="$href" title="$name" class="poweredBy"> + <img class="poweredBy" $alt src="$img" $border $width $height /> + </a> + #end + #if( $poweredBy.isEmpty() ) + <a href="http://maven.apache.org/" title="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" class="poweredBy"> + <img class="poweredBy" alt="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" src="$relativePath/images/maven-feather.png" /> + </a> + #end + #else + <a href="http://maven.apache.org/" title="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" class="poweredBy"> + <img class="poweredBy" alt="$i18n.getString( "site-renderer", $locale, "template.builtby" ) Maven" src="$relativePath/images/maven-feather.png" /> + </a> + #end #end ## #macro ( googleAnalytics $accountId ) - #if( $accountId && $accountId != "" ) - <!-- Google Analytics --> - <script type="text/javascript"> + #if( $accountId && $accountId != "" ) + <!-- Google Analytics --> + <script type="text/javascript"> - var _gaq = _gaq || []; - _gaq.push(['_setAccount', '$accountId']); - _gaq.push (['_gat._anonymizeIp']); - _gaq.push(['_trackPageview']); + var _gaq = _gaq || []; + _gaq.push(['_setAccount', '$accountId']); + _gaq.push (['_gat._anonymizeIp']); + _gaq.push(['_trackPageview']); - (function() { - var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; - ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; - var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); - })(); + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); - </script> - #end + </script> + #end #end ## <html xmlns="http://www.w3.org/1999/xhtml"#if ( $locale ) xml:lang="$locale.language" lang="$locale.language"#end> - <head> - <meta http-equiv="Content-Type" content="text/html; charset=${outputEncoding}" /> - <title>$title - $project.name</title> - <link rel="stylesheet" href="$relativePath/css/bootstrap.min.css" type="text/css" /> - <link rel="stylesheet" href="$relativePath/css/site.css" type="text/css" /> - <script type="text/javascript" src="$relativePath/js/jquery.min.js"></script> - <script type="text/javascript" src="$relativePath/js/bootstrap.min.js"></script> - <script type="text/javascript" src="$relativePath/js/prettify.min.js"></script> - <script type="text/javascript" src="$relativePath/js/site.js"></script> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=${outputEncoding}" /> + <title>$title - $project.name</title> + <link rel="stylesheet" href="$relativePath/css/bootstrap.min.css" type="text/css" /> + <link rel="stylesheet" href="$relativePath/css/site.css" type="text/css" /> + <script type="text/javascript" src="$relativePath/js/jquery.min.js"></script> + <script type="text/javascript" src="$relativePath/js/bootstrap.min.js"></script> + <script type="text/javascript" src="$relativePath/js/prettify.min.js"></script> + <script type="text/javascript" src="$relativePath/js/site.js"></script> #foreach( $author in $authors ) <meta name="author" content="$author" /> #end @@ -466,49 +466,49 @@ #if ( $locale ) <meta http-equiv="Content-Language" content="$locale.language" /> #end - $headContent - #googleAnalytics( $decoration.googleAnalyticsAccountId ) - </head> - <body class="composite"> - <a href="https://logging.apache.org/"> - <img class="logo-left" src="$relativePath/images/ls-logo.jpg" alt="Apache logging services logo" /> - </a> - <!--img class="logo-right" src="$relativePath/images/logo.png" alt="Apache log4net logo" /--> - <div class="clear"></div> + $headContent + #googleAnalytics( $decoration.googleAnalyticsAccountId ) + </head> + <body class="composite"> + <a href="https://logging.apache.org/"> + <img class="logo-left" src="$relativePath/images/ls-logo.jpg" alt="Apache logging services logo" /> + </a> + <!--img class="logo-right" src="$relativePath/images/logo.png" alt="Apache log4net logo" /--> + <div class="clear"></div> - <div class="navbar"> - <div class="navbar-inner"> - <div class="container-fluid"> - <a class="brand" href="$project.url">$project.name ™</a> - #links( $decoration.body.links ) - </div> - </div> - </div> + <div class="navbar"> + <div class="navbar-inner"> + <div class="container-fluid"> + <a class="brand" href="$project.url">$project.name ™</a> + #links( $decoration.body.links ) + </div> + </div> + </div> - <div class="container-fluid"> - <table class="layout-table"> - <tr> - <td class="sidebar"> - <div class="well sidebar-nav"> - #mainMenu( $decoration.body.menus ) - </div> - <div id="poweredBy"> - #poweredByLogo( $decoration.poweredBy ) - </div> - </td> - <td class="content"> - $bodyContent - </td> - </tr> - </table> - </div> + <div class="container-fluid"> + <table class="layout-table"> + <tr> + <td class="sidebar"> + <div class="well sidebar-nav"> + #mainMenu( $decoration.body.menus ) + </div> + <div id="poweredBy"> + #poweredByLogo( $decoration.poweredBy ) + </div> + </td> + <td class="content"> + $bodyContent + </td> + </tr> + </table> + </div> - <div class="footer"> - #set ( $currentYear = ${currentDate.year} + 1900 ) - <p>Copyright © ${project.inceptionYear}-${currentYear} <a class="external" href="$project.organization.url">${project.organization.name}</a>. All Rights Reserved.</p> - <p>Apache log4net, Apache, log4net, the Apache feather logo, the Apache Logging Services project logo and the Built by Maven logo are trademarks of The Apache Software Foundation.</p> - <p>Site powered by <a class="external" href="http://getbootstrap.com/">Twitter Bootstrap</a>. Icons from <a class="external" href="http://glyphicons.com/">Glyphicons Free</a>.</p> - </div> - </div> - </body> + <div class="footer"> + #set ( $currentYear = ${currentDate.year} + 1900 ) + <p>Copyright © ${project.inceptionYear}-${currentYear} <a class="external" href="$project.organization.url">${project.organization.name}</a>. All Rights Reserved.</p> + <p>Apache log4net, Apache, log4net, the Apache feather logo, the Apache Logging Services project logo and the Built by Maven logo are trademarks of The Apache Software Foundation.</p> + <p>Site powered by <a class="external" href="http://getbootstrap.com/">Twitter Bootstrap</a>. Icons from <a class="external" href="http://glyphicons.com/">Glyphicons Free</a>.</p> + </div> + </div> + </body> </html> diff --git a/src/site/site.xml b/src/site/site.xml index 90405c1b..ebe6e7a3 100644 --- a/src/site/site.xml +++ b/src/site/site.xml @@ -28,7 +28,7 @@ <menu name="Apache log4net" inherit="top" img="icon-home"> <item name="About" href="/index.html"/> - <item name="Download" href="https://logging.apache.org/download.html"/> + <item name="Download" href="/release/download.html"/> <item name="Support" href="https://logging.apache.org/support.html" /> <item name="Release Notes" href="/release/release-notes.html"/> <item name="License" href="/license.html"/> @@ -45,6 +45,7 @@ <menu name="Manual" inherit="top" img="icon-book"> <item name="Introduction" href="/release/manual/introduction.html"/> + <item name="Installation" href="/release/manual/installation.html"/> <item name="Configuration" href="/release/manual/configuration.html"/> <item name="Contexts" href="/release/manual/contexts.html"/> <item name="Plugins" href="/release/manual/plugins.html"/> diff --git a/src/site/xdoc/release/download.xml b/src/site/xdoc/release/download.xml new file mode 100644 index 00000000..469fb49c --- /dev/null +++ b/src/site/xdoc/release/download.xml @@ -0,0 +1,49 @@ +<?xml version="1.0"?> +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> +<document> + <properties> + <title>Download Apache log4net</title> + </properties> + + <body> + <section name="Download Apache log4net™"> + + <div class="paragraph"> + <p> + You can manually download all published log4net distributions, verify them, and see their licensing information by following the instructions in <a href="https://logging.apache.org/download.html">the Download page</a> of <a href="https://logging.apache.org">Logging Services</a>. + </p> + </div> + + <div class="ulist"> + <ul> + <li> + <p> + Are you looking for <strong>the log4net installation instructions</strong>? Proceed to <a href="manual/installation.html" class="xref page">Installation</a>. + </p> + </li> + <li> + <p> + Are you looking for the list of changes associated with a particular release? Proceed to <a href="release-notes.html" class="xref page">Release Notes</a>. + </p> + </li> + </ul> + </div> + + </section> + </body> +</document> \ No newline at end of file diff --git a/src/site/xdoc/release/manual/installation.xml b/src/site/xdoc/release/manual/installation.xml new file mode 100644 index 00000000..94738fe0 --- /dev/null +++ b/src/site/xdoc/release/manual/installation.xml @@ -0,0 +1,43 @@ +<?xml version="1.0"?> +<!-- +Licensed to the Apache Software Foundation (ASF) under one or more +contributor license agreements. See the NOTICE file distributed with +this work for additional information regarding copyright ownership. +The ASF licenses this file to You under the Apache License, Version 2.0 +(the "License"); you may not use this file except in compliance with +the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. +--> +<document> + <properties> + <title>Install Apache log4net</title> + </properties> + + <body> + <section name="Install Apache log4net™"> + + <p>The preferred way to install log4net is to use our <a href="https://www.nuget.org/packages/log4net">nuget package</a></p> + + <p> + Just add the following lines in your project file. + <pre class="code"><ItemGroup> + <PackageReference Include="log4net" Version="*" /> +</ItemGroup></pre> + Now you can use log4net. See our <a href="https://github.com/apache/logging-log4net/tree/master/examples">examples</a>. + </p> + <p/> + <p> + Alternatively you can use the dotnet tool. + <pre class="code">dotnet add package log4net</pre> + </p> + + </section> + </body> +</document> \ No newline at end of file