Major update to the documentation look and feel. It is based *very*

heavily on the TWiki.org documentation.
2005-08-14 13:23:39 +00:00 · 2005-08-14 13:23:39 +00:00 · 357adf02b1
parent 2e2047a853
commit 357adf02b1
5 changed files with 457 additions and 160 deletions
--- a/src/xdocs/config_javadoc.xml
+++ b/src/xdocs/config_javadoc.xml
@ -230,9 +230,9 @@
          An example of how to configure the check is:
        </p>

-        <pre>
+        <source>
 &lt;module name=&quot;JavadocMethod&quot;/&gt;
-        </pre>
+        </source>

        <p>
          An example of how to configure the check to check to allow
@ -241,13 +241,13 @@
          param tags is:
        </p>

-        <pre>
+        <source>
 &lt;module name=&quot;JavadocMethod&quot;&gt;
  &lt;property name=&quot;scope&quot; value=&quot;public&quot;/&gt;
  &lt;property name=&quot;allowUndeclaredRTE&quot; value=&quot;true&quot;/&gt;
  &lt;property name=&quot;allowMissingParamTags&quot; value=&quot;true&quot;/&gt;
 &lt;/module&gt;
-        </pre>
+        </source>
      </subsection>

      <subsection name="Properties">
@ -414,20 +414,20 @@ public boolean isSomething()
            com.puppycrawl.tools.checkstyle.Verifier</span> interface,
            then the Javadoc could be done as:

-            <source>
+            <pre>
 /** @see com.puppycrawl.tools.checkstyle.Verifier **/
 public int checkReturnTag(final int aTagIndex,
                          JavadocTag[] aTags,
                          int aLineNo)
-            </source>
+            </pre>

            or:
-            <source>
+            <pre>
 /** {@inheritDoc} */
 public int checkReturnTag(final int aTagIndex,
                          JavadocTag[] aTags,
                          int aLineNo)
-            </source>
+            </pre>

          </li>
        </ul>
--- a/src/xdocs/css/cs-layout.css
+++ b/src/xdocs/css/cs-layout.css
@ -0,0 +1,40 @@
+.csTopBar {
+	height:80px;
+}
+
+.csLeft {
+	float:left;
+	position:relative;
+}
+
+.csRight {
+	position:relative;
+	float:right;
+	display:inline;
+	margin:0;
+	text-align:right;
+}
+
+
+.csMiddleContainer {}
+.csLeftBar {
+	top:80px;
+	position:absolute;
+	left:0;
+	margin:0;
+	padding:0;
+}
+
+/* positioning the left bar (width:13em) */
+.csLeftBar,
+.csLeftBarContents /* needed for Explorer 5.0 */ {
+	width:13em;
+}
+
+.csMain {
+	margin-left:13em;
+}
+
+.csBottomBar {
+	margin:0 0 0 13.5em; /* add small margin for content offset */
+}
--- a/src/xdocs/css/cs-style.css
+++ b/src/xdocs/css/cs-style.css
@ -0,0 +1,278 @@
+/* Derived from Twiki */
+
+/* Top bar */
+.csTopBar {
+	background-color:transparent;
+}
+.csTopBarContents {
+	margin:0;
+	padding:5px 2em 5px 1em;
+}
+.csTopBarContents p {
+	display:inline;
+}
+
+.csBottomBar {
+	margin:0 0 0 13.5em; /* add small margin for content offset */
+}
+
+/* Left bar */
+.csLeftBar {
+	border-top:1px solid #ddd;
+	border-right:1px solid #ddd;
+	border-bottom:1px solid #ddd;
+	color:#800;
+	overflow:hidden;
+	line-height:1.5em;
+	background-color:#FBFAF8;
+}
+.csLeftBar a:link,
+.csLeftBar a:visited {
+	text-decoration:none;
+	padding-bottom:1px; /* to account for hover border */
+	border-bottom:0px;
+}
+.csLeftBar a:hover,
+.csLeftBar a:visited:hover,
+.csLeftBar a:active {
+	text-decoration:none;
+	color:#0029A3; /*C3*/
+	padding-bottom:0;
+	border-bottom:1px solid #0054C0; /*C1*/
+}
+
+.csLeftBar .csWebIndicator a {
+	height:2em;
+}
+.csLeftBar .csWebIndicator a:link,
+.csLeftBar .csWebIndicator a:visited {
+	color:black;
+	text-decoration:none;
+	border-bottom:0px;
+}
+.csLeftBar .csWebIndicator a:hover,
+.csLeftBar .csWebIndicator a:active {
+	color:black;
+	text-decoration:underline;
+	border-bottom:0px;
+	padding-bottom:1px;
+	background-color:transparent;
+}
+.csLeftBar .csLeftBarContents {
+	font-size:95%;
+	font-weight:normal;
+	margin:0;
+	padding:1em 0 1.7em 1em;
+	width:auto;
+	border-top:3px solid #666; /*C4*/
+}
+.csLeftBar ul {
+	padding:0;
+	margin:0;
+}
+.csLeftBar li {
+	display:block;
+	list-style:none;
+	width:100%;
+}
+.csLeftBar li a {
+	display:block;
+	width:98%;
+	padding-right:2%;
+}
+
+.csMain {
+	padding:0 3.5em;
+	background-color:#fff;
+	border-width:1px;
+	border-style:solid;
+	border-color:#ddd #ddd #ddd #ddd;
+}
+
+/* General formatting */
+
+/* HTML elements */
+html body {
+	line-height:1.4em; /*C10*/
+	font-family:"Lucida Grande", verdana, lucida, helvetica, sans-serif;
+	background-color:#F8F4F1; /*C7*/
+	color:#000;
+	margin:0;
+	padding:0;
+	font-size:x-small;
+	voice-family:"\"}\""; 
+	voice-family:inherit;
+	font-size:small;
+}
+html>body {
+	font-size:small;	
+}
+
+/* be kind to netscape 4 that doesn't understand inheritance */
+body, p, li, ul, ol, dl, dt, dd, acronym, h1, h2, h3, h4, h5, h6 {
+	background-color:transparent;
+}
+p {
+	margin:1em 0 0 0;
+}
+
+:link:focus,
+:visited:focus,
+:link,
+:visited,
+:link:active,
+:visited:active {
+	text-decoration:none;
+	color:#0054C0; /*C1*/;
+	background-color:transparent;
+}
+:link:hover,
+:visited:hover {
+	text-decoration:underline;
+	color:#0029A3; /*C3*/
+	background-color:#b4d5ff; /*C2*/
+}
+
+/* Text */
+h1, h2, h3, h4, h5, h6 {
+	font-family:"Lucida Grande", helvetica, lucida, verdana, sans-serif;
+	line-height:104%;
+	padding:0;
+	margin:1em 0 0.1em 0;
+	text-transform: capitalize;
+}
+h1 {
+	font-size:210%;
+	color:#e24628;
+	/* margin:0 0 0.5em 0; */
+}
+h2, h3, h4, h5, h6 {color:#900;} /*C5*/
+h2 {
+	font-size:145%;
+	display:block;
+	background-color:#F3EDE7; /*C8*/
+	padding:0.2em 0.7em;
+	margin:1em -0.7em 0.35em -0.7em;
+	height:auto;
+}
+h3 { font-size:140%;}
+h4 { font-size:125%;}
+h5 { font-size:110%;}
+h6 { font-size:95%;}
+
+/* Original stuff */
+
+/*
+h1 {
+  font-family : monospace;
+  font-size : 28px;
+  font-weight : bold;
+  color : #aaaaaa;
+  background-color: #ffffff;
+  text-transform: capitalize;
+}
+
+h2 {
+  text-transform: capitalize;
+}
+*/
+
+h4.tip {
+  text-transform: capitalize;
+  text-align: center;
+}
+
+td {
+  vertical-align:top;
+}
+
+tr.odd {
+  background-color: #EEEEEE;
+}
+
+tr.even {
+  background-color: #E5E5E5;
+}
+
+th {
+  background-color: Silver;
+  color:Black;
+  font-weight: bolder;
+  text-align: center;
+}
+
+td.navbarHeader {
+  border-top:    1px solid #909090;
+  background-color: #dddddd;
+  color:Black;
+  text-align: left;
+  white-space: nowrap;
+  padding-left : 0.5ex;
+  padding-right: 0.5ex;
+}
+
+
+td.navbarItem {
+  background-color: #eeeeee;
+  color:Black;
+  text-align: left;
+  white-space: nowrap;
+  padding-left : 1ex;
+  padding-right: 1ex;
+}
+
+#navbar ul {
+  padding-left: 0.4em;
+}
+
+#navbar li {
+  list-style-type: none;
+  font-size: smaller;
+}
+
+#navbar ul.sectionquicklink {
+  padding-left: 1em;
+}
+
+td.content {
+  width: 100%;
+}
+
+td#mainContents {
+  padding-left : 1em;
+  padding-right : 1em;
+}
+
+*.body {
+  margin-left : 5%;
+  margin-right : 3%;
+}
+
+img {
+  border: none;
+}
+
+p.copyright {
+  text-align: center;
+}
+
+span.code {
+  white-space: nowrap;
+  font-family: monospace;
+  font-weight: bold
+}
+
+span.default {
+  white-space: nowrap;
+  font-family: monospace;
+}
+
+div.tip {
+  margin-left : 5%;
+  margin-right : 5%;
+  padding-left: 2%;
+  padding-right: 2%;
+  background-color: Silver;
+  color:Black;
+  border: ridge;
+}
--- a/src/xdocs/stylesheets/project.xml
+++ b/src/xdocs/stylesheets/project.xml
@ -24,26 +24,25 @@
        <item name="Command Line" href="/cmdline.html"/>
      </item>

-      <item name="Available Checks" href="/availablechecks.html">
-          <item name="Standard Checks" href="/checks.html">
-              <item name="Javadoc Comments"   href="/config_javadoc.html"/>
-              <item name="Naming Conventions" href="/config_naming.html"/>
-              <item name="Headers"            href="/config_header.html"/>
-              <item name="Imports"            href="/config_imports.html"/>
-              <item name="Size Violations"    href="/config_sizes.html"/>
-              <item name="Whitespace"         href="/config_whitespace.html"/>
-              <item name="Modifiers"          href="/config_modifier.html"/>
-              <item name="Block Checks"       href="/config_blocks.html"/>
-              <item name="Coding"             href="/config_coding.html"/>
-              <item name="Class Design"       href="/config_design.html"/>
-              <item name="Duplicate Code"     href="/config_duplicates.html"/>
-              <item name="Metrics"            href="/config_metrics.html"/>
-              <item name="Miscellaneous"      href="/config_misc.html"/>
-          </item>
+      <item name="Available Checks" href="/availablechecks.html"/>
+      <item name="Standard Checks" href="/checks.html">
+        <item name="Javadoc Comments"   href="/config_javadoc.html"/>
+        <item name="Naming Conventions" href="/config_naming.html"/>
+        <item name="Headers"            href="/config_header.html"/>
+        <item name="Imports"            href="/config_imports.html"/>
+        <item name="Size Violations"    href="/config_sizes.html"/>
+        <item name="Whitespace"         href="/config_whitespace.html"/>
+        <item name="Modifiers"          href="/config_modifier.html"/>
+        <item name="Block Checks"       href="/config_blocks.html"/>
+        <item name="Coding"             href="/config_coding.html"/>
+        <item name="Class Design"       href="/config_design.html"/>
+        <item name="Duplicate Code"     href="/config_duplicates.html"/>
+        <item name="Metrics"            href="/config_metrics.html"/>
+        <item name="Miscellaneous"      href="/config_misc.html"/>
+      </item>

-          <item name="Optional Checks" href="/optional.html">
-            <item name="J2EE Checks" href="/config_j2ee.html"/>
-          </item>
+      <item name="Optional Checks" href="/optional.html">
+        <item name="J2EE Checks" href="/config_j2ee.html"/>
      </item>

      <item name="Extending Checkstyle" href="/extending.html">
--- a/src/xdocs/stylesheets/site.vsl
+++ b/src/xdocs/stylesheets/site.vsl
@ -53,13 +53,16 @@
 #end

 #macro ( td $value $trclass)
+<td class="$!trclass"
 #if ($value.getAttributeValue("colspan"))
-#set ($colspan = $value.getAttributeValue("colspan"))
+    #set ($colspan = $value.getAttributeValue("colspan"))
+    colspan="${value.getAttributeValue("colspan")}"
 #end
 #if ($value.getAttributeValue("rowspan"))
-#set ($rowspan = $value.getAttributeValue("rowspan"))
+    #set ($rowspan = $value.getAttributeValue("rowspan"))
+    rowspan="${value.getAttributeValue("rowspan")}"
 #end
-<td class="$!trclass" colspan="$!colspan" rowspan="$!rowspan">
+>
        #if ($value.getText().length() != 0 || $value.hasChildren())
        $value.getContent()
        #else
@ -69,13 +72,16 @@
 #end

 #macro ( th $value)
+<th valign="top" align="left"
 #if ($value.getAttributeValue("colspan"))
-#set ($colspan = $value.getAttributeValue("colspan"))
+    #set ($colspan = $value.getAttributeValue("colspan"))
+    colspan="${value.getAttributeValue("colspan")}"
 #end
 #if ($value.getAttributeValue("rowspan"))
-#set ($rowspan = $value.getAttributeValue("rowspan"))
+    #set ($rowspan = $value.getAttributeValue("rowspan"))
+    rowspan="${value.getAttributeValue("rowspan")}"
 #end
-<th colspan="$!colspan" rowspan="$!rowspan" valign="top" align="left">
+>
        #if ($value.getText().length() != 0 || $value.hasChildren())
        $value.getContent()
        #else
@ -84,17 +90,17 @@
 </th>
 #end

-#macro ( projectanchor $name $value )
+#macro ( projectanchor $name $value $indent)
 #if ($value.startsWith("http://"))
-    <a href="$value">$name</a>
+    <a href="$value">${indent}$name</a>
 #else
-    <a href="$relativePath$value">$name</a>
+    <a href="$relativePath$value">${indent}$name</a>
 #end
 #end

 #macro ( metaauthor $author $email )
-            <meta name="author" value="$author">
-            <meta name="email" value="$email">
+            <meta name="author" content="$author">
+            <meta name="email" content="$email">
 #end

 #macro ( image $value )
@ -161,7 +167,7 @@
 ##          section macro
 ## ================================
 #macro ( section $section)
-  <a name="$section.getAttributeValue("name")"></a>
+  <a id="$section.getAttributeValue("name")"></a>
  <h2>$section.getAttributeValue("name")</h2>
        #foreach ( $items in $section.getChildren() )
            #if ($items.getName().equals("img"))
@ -182,73 +188,57 @@
 ##  make navigation bar
 ## ===================================

-#macro ( makeNavigationMenu $menu )
-  <ul>
+#macro ( makeNavigationMenu $menu $indentStr)
  #foreach ( $item in $menu.getChildren() )
      #set ($name = $item.getAttributeValue("name"))
      #if ( $name.equalsIgnoreCase($docname) )
-          <li><b>#projectanchor($name $item.getAttributeValue("href"))</b></li>
+          <li><b>#projectanchor($name $item.getAttributeValue("href") ${indentStr})</b></li>
      #else
-          <li>#projectanchor($name $item.getAttributeValue("href"))</li>
+          <li>#projectanchor($name $item.getAttributeValue("href") ${indentStr})</li>
      #end
      #if ( $name.equalsIgnoreCase($docname) )
-          <ul class="sectionquicklink">
          #foreach ( $candidate in $root.getChild("body").getChildren() )
              #if ($candidate.getName().equals("section"))
                  #set ($sectionName = $candidate.getAttributeValue("name"))
-                  <li><a href="#$sectionName">$sectionName</a></li>
+                  <li><a href="#$sectionName">${indentStr}&nbsp;&nbsp;&nbsp;$sectionName</a></li>
              #end
          #end
-          </ul>
      #end
-      #makeNavigationMenu ($item )
+      #makeNavigationMenu ($item "${indentStr}&nbsp;&nbsp;&nbsp;")
  #end
-  </ul>
+
 #end

 #macro ( makeNavigationBar )
  <!-- ============================================================ -->
-  <table id="navbar" border="0" cellspacing="0" cellpadding="0">
-    #set ($menus = $project.getChild("body").getChildren("menu"))
-    #set ($docname = $root.getChild("properties").getChild("title").getText())
+  <!-- start makeNavigationBar -->
+  #set ($menus = $project.getChild("body").getChildren("menu"))
+  #set ($docname = $root.getChild("properties").getChild("title").getText())
+
+  <ul>
    #foreach ( $menu in $menus )
-       <tr >
-       	 <td class="navbarHeader">
-           <strong>$menu.getAttributeValue("name")</strong>
-         </td>
-       </tr>
-       <tr >
-       	 <td class="navbarItem">
-           #makeNavigationMenu ($menu)
-         </td>
-       </tr>
-
+      <li>
+        <strong>$menu.getAttributeValue("name")</strong>
+      </li>
+      #makeNavigationMenu ($menu "")
    #end
-  </table>
+  </ul>

+  <ul>
+    <li>
+      <strong>Hosted by:</strong>
+      <div align="center">
+        <p><a href="http://sourceforge.net">
+        <img src="http://sourceforge.net/sflogo.php?group_id=29721&amp;type=1" width="88" height="31" alt="SourceForge Logo"/></a>
+         </p>
+       </div>
+    </li>
+  </ul>
+
+  <!-- end makeNavigationBar -->
+  <!-- ============================================================ -->
 #end

-## ====================================
-##      getProjectImage
-## ====================================
-#macro (getProjectImage)
-    <td align="left">
-       <h1>$root.getChild("properties").getChild("title").getText()</h1>
-    </td>
-    <td align="right">
-      #set ( $logoString = $project.getChild("logo").getAttributeValue("href") )
-      #if ( $logoString.startsWith("/") )
-      	<a href="$project.getAttributeValue("href")">
-      	  <img src="$logoString"
-      	       alt="$project.getChild("logo").getText()" border="0"/>
-      	</a>
-      #else
-      	<a href="$project.getAttributeValue("href")">
-      	  <img src="$logoString" alt="$project.getChild("logo").getText()" border="0"/>
-      	</a>
-      #end
-    </td>
-#end

 #macro (printMeta $metaElement)
 <meta #set ($attribs = $metaElement.getAttributes())
@ -260,94 +250,84 @@
    <!-- GENERATED FILE, DO NOT EDIT, EDIT THE XML FILE IN xdocs INSTEAD! -->
    <!-- Main Page Section -->
    <!-- ====================================================================== -->
-    <html>
-        <head>
-            <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+<html>
+  <head>
+    <meta content="text/html; charset=ISO-8859-1" http-equiv="content-type" />

-            #set ($authors = $root.getChild("properties").getChildren("author"))
-            #foreach ( $au in $authors )
-                #metaauthor ( $au.getText() $au.getAttributeValue("email") )
-            #end
+    #set ($authors = $root.getChild("properties").getChildren("author"))
+    #foreach ( $au in $authors )
+      #metaauthor ( $au.getText() $au.getAttributeValue("email") )
+    #end

-           #set ($metas = $root.getChildren("meta"))
+    #set ($metas = $root.getChildren("meta"))

-            ##    Parse meta directives such as
-            ##    <meta name="keyword" content="jakarta, java"/>
-            #foreach ($meta in $metas) #printMeta($meta) #end
+    ##    Parse meta directives such as
+    ##    <meta name="keyword" content="jakarta, java"/>
+    #foreach ($meta in $metas) #printMeta($meta) #end

-            ##    Support for <base> tags.
-            #if ($root.getChild("properties").getChild("base"))
-              #set ($url = $root.getChild("properties").getChild("base").getAttributeValue("href"))
-              <base href="$url"/>
-            #end
+    ##    Support for <base> tags.
+    #if ($root.getChild("properties").getChild("base"))
+      #set ($url = $root.getChild("properties").getChild("base").getAttributeValue("href"))
+      <base href="$url"/>
+    #end

-            <link href="$relativePath/css/site.css" rel="stylesheet" type="text/css"/>
+    <title>$project.getChild("title").getText() - $root.getChild("properties").getChild("title").getText()</title>

-            <title>$project.getChild("title").getText() - $root.getChild("properties").getChild("title").getText()</title>
-        </head>
+    <style type="text/css" media="all">
+      @import url("$relativePath/css/cs-layout.css");
+      @import url("$relativePath/css/cs-style.css");
+    </style>
+  </head>

-        <body bgcolor="$bodybg" text="$bodyfg" link="$bodylink">
-           <!-- START Header table -->
-           <table border="0" cellspacing="0" width="98%">
-                <!-- TOP IMAGE -->
-                <tr>
-                    #getProjectImage()
-                </tr>
-            </table>
-           <!-- END Header table -->
+  <body>
+    <div class="csTopBar">
+      <div class="csTopBarContents">
+        <div class="csLeft">
+          <h1>$root.getChild("properties").getChild("title").getText()</h1>
+        </div>
+        <div class="csRight">
+          <a href="http://checkstyle.sourceforge.net/">
+            <img src="images/logo.png" alt="Checkstyle Logo" height="70"/>
+          </a>
+        </div>
+      </div>
+    </div>

-           <!-- START main table -->
-            <table id="main" border="0" width="98%" cellspacing="2" cellpadding="0">
-                <tr><td colspan="2">
-                    <hr noshade="" size="1"/>
-                </td></tr>

-                <tr>
-                    <!-- LEFT SIDE NAVIGATION -->
-                    <td id="navbar" valign="top">
-                    #makeNavigationBar()
+    <div class="csMiddleContainer">
+      <div class="csLeftBar">
+        <div class="csLeftBarContents">
+          #makeNavigationBar()
+        </div>
+      </div>

-  <p>Hosted by:</p>
-  <div align="center">
-    <p><a href="http://sourceforge.net">
-      <img src="http://sourceforge.net/sflogo.php?group_id=29721&amp;type=1" width="88" height="31" alt="SourceForge Logo"/></a>
-    </p>
-  </div>
+      <div class="csMain">
+      #foreach ( $item in $root.getChild("body").getChildren() )
+        #if ($item.getName().equals("img"))
+          #image ($item)
+        #elseif ($item.getName().equals("section"))
+          #section ($item)
+        #elseif ($item.getName().equals("source"))
+          #source ($item)
+        #elseif ($item.getName().equals("table"))
+          #table ($item)
+        #elseif ($item.getName().equals("subsection"))
+          #subsection ($item)
+        #else
+         $item
+        #end
+      #end
+      </div>
+    </div>

-                    </td>
-                    <td id="mainContents" align="left" valign="top">
-	               #foreach ( $item in $root.getChild("body").getChildren() )
-                         #if ($item.getName().equals("img"))
-                           #image ($item)
-                         #elseif ($item.getName().equals("section"))
-                           #section ($item)
-                         #elseif ($item.getName().equals("source"))
-                           #source ($item)
-                         #elseif ($item.getName().equals("table"))
-                           #table ($item)
-                         #elseif ($item.getName().equals("subsection"))
-                           #subsection ($item)
-                         #else
-                          $item
-                         #end
-                       #end
+    <div class="csBottomBar">
+      <div class="csBottomBarContents">
+        Copyright &copy; 2001-2005, Oliver Burn
+      </div>
+    </div>
+  </body>
+</html>

-                    </td>
-                </tr>
-
-                <!-- FOOTER -->
-                <tr><td colspan="2">
-                    <hr noshade="" size="1"/>
-                </td></tr>
-                <tr><td colspan="2">
-                    <div align="center"><font color="$bodylink" size="-1"><em>
-                    Copyright &#169; 2001-2005, Oliver Burn
-                    </em></font></div>
-                </td></tr>
-            </table>
-           <!-- END main table -->
-        </body>
-    </html>
 #end