Updated documentation

RallyTools · Jul 11, 2013 · ae7acc2 · ae7acc2
1 parent 28388b6
commit ae7acc2
Show file tree

Hide file tree

Showing 234 changed files with 4,617 additions and 8,301 deletions.
diff --git a/Documentation/CloseSearch.png b/Documentation/CloseSearch.png
diff --git a/Documentation/CollapseAll.bmp b/Documentation/CollapseAll.bmp
diff --git a/Documentation/Collapsed.gif b/Documentation/Collapsed.gif
diff --git a/Documentation/ExpandAll.bmp b/Documentation/ExpandAll.bmp
diff --git a/Documentation/Expanded.gif b/Documentation/Expanded.gif
diff --git a/Documentation/FillNode.aspx b/Documentation/FillNode.aspx
@@ -0,0 +1,90 @@
+<%@ Page Language="C#" EnableViewState="False" %>
+
+<script runat="server">
+//=============================================================================
+// System  : Sandcastle Help File Builder
+// File    : FillNode.aspx
+// Author  : Eric Woodruff  (Eric@EWoodruff.us)
+// Updated : 04/02/2008
+// Note    : Copyright 2007-2008, Eric Woodruff, All rights reserved
+// Compiler: Microsoft C#
+//
+// This file contains the code used to dynamically load a parent node with its
+// child table of content nodes when first expanded.
+//
+// This code is published under the Microsoft Public License (Ms-PL).  A copy
+// of the license should be distributed with the code.  It can also be found
+// at the project website: http://SHFB.CodePlex.com.   This notice, the
+// author's name, and all copyright notices must remain intact in all
+// applications, documentation, and source files.
+//
+// Version     Date     Who  Comments
+// ============================================================================
+// 1.5.0.0  06/21/2007  EFW  Created the code
+//=============================================================================
+
+protected override void Render(HtmlTextWriter writer)
+{
+    StringBuilder sb = new StringBuilder(10240);
+    string id, url, target, title;
+
+    XPathDocument toc = new XPathDocument(Server.MapPath("WebTOC.xml"));
+    XPathNavigator navToc = toc.CreateNavigator();
+
+    // The ID to use should be passed in the query string
+    XPathNodeIterator root = navToc.Select("//HelpTOCNode[@Id='" +
+        this.Request.QueryString["Id"] + "']/*");
+
+    if(root.Count == 0)
+    {
+        writer.Write("<b>TOC node not found!</b>");
+        return;
+    }
+
+    foreach(XPathNavigator node in root)
+    {
+        if(node.HasChildren)
+        {
+            // Write out a parent TOC entry
+            id = node.GetAttribute("Id", String.Empty);
+            title = node.GetAttribute("Title", String.Empty);
+            url = node.GetAttribute("Url", String.Empty);
+
+            if(!String.IsNullOrEmpty(url))
+                target = " target=\"TopicContent\"";
+            else
+            {
+                url = "#";
+                target = String.Empty;
+            }
+
+            sb.AppendFormat("<div class=\"TreeNode\">\r\n" +
+                "<img class=\"TreeNodeImg\" " +
+                "onclick=\"javascript: Toggle(this);\" " +
+                "src=\"Collapsed.gif\"/><a class=\"UnselectedNode\" " +
+                "onclick=\"javascript: return Expand(this);\" " +
+                "href=\"{0}\"{1}>{2}</a>\r\n" +
+                "<div id=\"{3}\" class=\"Hidden\"></div>\r\n</div>\r\n",
+                url, target, HttpUtility.HtmlEncode(title), id);
+        }
+        else
+        {
+            title = node.GetAttribute("Title", String.Empty);
+            url = node.GetAttribute("Url", String.Empty);
+
+            if(String.IsNullOrEmpty(url))
+                url = "about:blank";
+
+            // Write out a TOC entry that has no children
+            sb.AppendFormat("<div class=\"TreeItem\">\r\n" +
+                "<img src=\"Item.gif\"/>" +
+                "<a class=\"UnselectedNode\" " +
+                "onclick=\"javascript: return SelectNode(this);\" " +
+                "href=\"{0}\" target=\"TopicContent\">{1}</a>\r\n" +
+                "</div>\r\n", url, HttpUtility.HtmlEncode(title));
+        }
+    }
+
+    writer.Write(sb.ToString());
+}
+</script>
diff --git a/Documentation/Index.aspx b/Documentation/Index.aspx
@@ -0,0 +1,153 @@
+<%@ Page Language="C#" EnableViewState="False" %>
+
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+
+<head>
+<title>.NET Framework Class Library - Table of Content</title>
+<link rel="stylesheet" href="TOC.css">
+<link rel="shortcut icon" href="favicon.ico"/>
+<script type="text/javascript" src="TOC.js"></script>
+</head>
+
+<body onload="javascript: Initialize();" onresize="javascript: ResizeTree();">
+<form id="IndexForm" runat="server">
+
+<div id="TOCDiv" class="TOCDiv">
+
+<div id="divSearchOpts" class="SearchOpts" style="height: 100px; display: none;">
+<img class="TOCLink" onclick="javascript: ShowHideSearch(false);"
+    src="CloseSearch.png" height="17" width="17" alt="Hide search" style="float: right;"/>
+Keyword(s) for which to search:
+<input id="txtSearchText" type="text" style="width: 100%;"
+  onkeypress="javascript: return OnSearchTextKeyPress(event);" /><br />
+<input id="chkSortByTitle" type="checkbox" /><label for="chkSortByTitle">&nbsp;Sort results by title</label><br />
+<input type="button" value="Search" onclick="javascript: return PerformSearch();" />
+</div>
+
+<div id="divIndexOpts" class="IndexOpts" style="height: 25px; display: none;">
+<img class="TOCLink" onclick="javascript: ShowHideIndex(false);"
+    src="CloseSearch.png" height="17" width="17" alt="Hide index" style="float: right;"/>
+Keyword Index
+</div>
+
+<div id="divNavOpts" class="NavOpts" style="height: 20px;">
+    <img class="TOCLink" onclick="javascript: SyncTOC();" src="SyncTOC.gif"
+        height="16" width="16" alt="Sync to TOC"/>
+    <img class="TOCLink" onclick="javascript: ExpandOrCollapseAll(true);"
+        src="ExpandAll.bmp" height="16" width="16" alt="Expand all "/>
+    <img class="TOCLink" onclick="javascript: ExpandOrCollapseAll(false);"
+        src="CollapseAll.bmp" height="16" width="16" alt="Collapse all" />
+    <img class="TOCLink" onclick="javascript: ShowHideIndex(true);"
+        src="Index.gif" height="16" width="16" alt="Index" />
+    <img class="TOCLink" onclick="javascript: ShowHideSearch(true);"
+        src="Search.gif" height="16" width="16" alt="Search" />
+</div>
+
+<div class="Tree" id="divSearchResults" style="display: none;"
+    onselectstart="javascript: return false;">
+</div>
+
+<div class="Tree" id="divIndexResults" style="display: none;"
+    onselectstart="javascript: return false;">
+</div>
+
+<div class="Tree" id="divTree" onselectstart="javascript: return false;">
+<asp:Literal ID="lcTOC" runat="server" />
+</div>
+
+</div>
+
+<div id="TOCSizer" class="TOCSizer" onmousedown="OnMouseDown(event)" onselectstart="javascript: return false;"></div>
+
+<iframe id="TopicContent" name="TopicContent" class="TopicContent" src="html/N_Rally_RestApi.htm">
+This page uses an IFRAME but your browser does not support it.
+</iframe>
+
+</form>
+
+</body>
+
+</html>
+
+<script runat="server">
+//=============================================================================
+// System  : Sandcastle Help File Builder
+// File    : Index.aspx
+// Author  : Eric Woodruff  (Eric@EWoodruff.us)
+// Updated : 04/10/2008
+// Note    : Copyright 2007-2008, Eric Woodruff, All rights reserved
+// Compiler: Microsoft C#
+//
+// This file contains the code used to display the index page for a website
+// produced by the help file builder.  The root nodes are loaded for the table
+// of content.  Child nodes are loaded dynamically when first expanded using
+// an Ajax call.
+//
+// This code is published under the Microsoft Public License (Ms-PL).  A copy
+// of the license should be distributed with the code.  It can also be found
+// at the project website: http://SHFB.CodePlex.com.   This notice, the
+// author's name, and all copyright notices must remain intact in all
+// applications, documentation, and source files.
+//
+// Version     Date     Who  Comments
+// ============================================================================
+// 1.5.0.0  06/21/2007  EFW  Created the code
+//=============================================================================
+
+protected void Page_Load(object sender, EventArgs e)
+{
+    StringBuilder sb = new StringBuilder(10240);
+    string id, url, target, title;
+
+    XPathDocument toc = new XPathDocument(Server.MapPath("WebTOC.xml"));
+    XPathNavigator navToc = toc.CreateNavigator();
+    XPathNodeIterator root = navToc.Select("HelpTOC/*");
+
+    foreach(XPathNavigator node in root)
+    {
+        if(node.HasChildren)
+        {
+            // Write out a parent TOC entry
+            id = node.GetAttribute("Id", String.Empty);
+            title = node.GetAttribute("Title", String.Empty);
+            url = node.GetAttribute("Url", String.Empty);
+
+            if(!String.IsNullOrEmpty(url))
+                target = " target=\"TopicContent\"";
+            else
+            {
+                url = "#";
+                target = String.Empty;
+            }
+
+            sb.AppendFormat("<div class=\"TreeNode\">\r\n" +
+                "<img class=\"TreeNodeImg\" " +
+                "onclick=\"javascript: Toggle(this);\" " +
+                "src=\"Collapsed.gif\"/><a class=\"UnselectedNode\" " +
+                "onclick=\"javascript: return Expand(this);\" " +
+                "href=\"{0}\"{1}>{2}</a>\r\n" +
+                "<div id=\"{3}\" class=\"Hidden\"></div>\r\n</div>\r\n",
+                url, target, HttpUtility.HtmlEncode(title), id);
+        }
+        else
+        {
+            title = node.GetAttribute("Title", String.Empty);
+            url = node.GetAttribute("Url", String.Empty);
+
+            if(String.IsNullOrEmpty(url))
+                url = "about:blank";
+
+            // Write out a TOC entry that has no children
+            sb.AppendFormat("<div class=\"TreeItem\">\r\n" +
+                "<img src=\"Item.gif\"/>" +
+                "<a class=\"UnselectedNode\" " +
+                "onclick=\"javascript: return SelectNode(this);\" " +
+                "href=\"{0}\" target=\"TopicContent\">{1}</a>\r\n" +
+                "</div>\r\n", url, HttpUtility.HtmlEncode(title));
+        }
+    }
+
+    lcTOC.Text = sb.ToString();
+}
+</script>
diff --git a/Documentation/Index.gif b/Documentation/Index.gif