You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@deltacloud.apache.org by lu...@apache.org on 2010/07/09 01:49:29 UTC
svn commit: r962361 [6/8] - in /incubator/deltacloud/trunk/client/doc: ./
DeltaCloud/ DeltaCloud/Documentation/ DeltaCloud/HWP/
DeltaCloud/InstanceState/ DeltaCloud/PlainFormatter/
DeltaCloud/PlainFormatter/FormatObject/ css/ js/
Added: incubator/deltacloud/trunk/client/doc/class_list.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/class_list.html?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/class_list.html (added)
+++ incubator/deltacloud/trunk/client/doc/class_list.html Thu Jul 8 23:49:28 2010
@@ -0,0 +1,36 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+ <head>
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+ <base id="base_target" target="_parent" />
+ </head>
+ <body>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) {
+ document.getElementById('base_target').target = 'main';
+ document.body.className = 'frames';
+ }
+ </script>
+ <div id="content">
+ <h1 id="full_list_header">Class List</h1>
+ <div id="nav">
+ <a target="_self" href="class_list.html">Classes</a> |
+ <a target="_self" href="method_list.html">Methods</a> |
+ <a target="_self" href="file_list.html">Files</a>
+ </div>
+ <div id="search">Search: <input type="text" /></div>
+
+ <ul id="full_list" class="class">
+ <li><a href="top-level-namespace.html" title=" (root)">Top Level Namespace</a></li>
+<li><a class='toggle'></a> <a href="DeltaCloud.html" title="DeltaCloud (module)">DeltaCloud</a><small class='search_info'>Top Level Namespace</small></li><ul><li><a href="DeltaCloud/API.html" title="DeltaCloud::API (class)">API</a> < Object<small class='search_info'>DeltaCloud</small></li><li><a class='toggle'></a> <a href="DeltaCloud/Documentation.html" title="DeltaCloud::Documentation (class)">Documentation</a> < Object<small class='search_info'>DeltaCloud</small></li><ul><li><a href="DeltaCloud/Documentation/OperationParameter.html" title="DeltaCloud::Documentation::OperationParameter (class)">OperationParameter</a> < Object<small class='search_info'>DeltaCloud::Documentation</small></li></ul><li><a class='toggle'></a> <a href="DeltaCloud/HWP.html" title="DeltaCloud::HWP (module)">HWP</a><small class='search_info'>DeltaCloud</small></li><ul><li><a href="DeltaCloud/HWP/FloatProperty.html" title="DeltaCloud::HWP::FloatProperty (class)">FloatProperty</a> < Proper
ty<small class='search_info'>DeltaCloud::HWP</small></li><li><a href="DeltaCloud/HWP/Property.html" title="DeltaCloud::HWP::Property (class)">Property</a> < Object<small class='search_info'>DeltaCloud::HWP</small></li></ul><li><a href="DeltaCloud/HardwareProfile.html" title="DeltaCloud::HardwareProfile (class)">HardwareProfile</a> < Object<small class='search_info'>DeltaCloud</small></li><li><a href="DeltaCloud/Image.html" title="DeltaCloud::Image (class)">Image</a> < Object<small class='search_info'>DeltaCloud</small></li><li><a href="DeltaCloud/Instance.html" title="DeltaCloud::Instance (class)">Instance</a> < Object<small class='search_info'>DeltaCloud</small></li><li><a class='toggle'></a> <a href="DeltaCloud/InstanceState.html" title="DeltaCloud::InstanceState (module)">InstanceState</a><small class='search_info'>DeltaCloud</small></li><ul><li><a href="DeltaCloud/InstanceState/State.html" title="DeltaCloud::InstanceState::State (class)">State</a> < Object
<small class='search_info'>DeltaCloud::InstanceState</small></li><li><a href="DeltaCloud/InstanceState/Transition.html" title="DeltaCloud::InstanceState::Transition (class)">Transition</a> < Object<small class='search_info'>DeltaCloud::InstanceState</small></li></ul><li><a class='toggle'></a> <a href="DeltaCloud/PlainFormatter.html" title="DeltaCloud::PlainFormatter (module)">PlainFormatter</a><small class='search_info'>DeltaCloud</small></li><ul><li><a class='toggle'></a> <a href="DeltaCloud/PlainFormatter/FormatObject.html" title="DeltaCloud::PlainFormatter::FormatObject (module)">FormatObject</a><small class='search_info'>DeltaCloud::PlainFormatter</small></li><ul><li><a href="DeltaCloud/PlainFormatter/FormatObject/Base.html" title="DeltaCloud::PlainFormatter::FormatObject::Base (class)">Base</a> < Object<small class='search_info'>DeltaCloud::PlainFormatter::FormatObject</small></li><li><a href="DeltaCloud/PlainFormatter/FormatObject/HardwareProfile.html" title="Del
taCloud::PlainFormatter::FormatObject::HardwareProfile (class)">HardwareProfile</a> < Base<small class='search_info'>DeltaCloud::PlainFormatter::FormatObject</small></li><li><a href="DeltaCloud/PlainFormatter/FormatObject/Image.html" title="DeltaCloud::PlainFormatter::FormatObject::Image (class)">Image</a> < Base<small class='search_info'>DeltaCloud::PlainFormatter::FormatObject</small></li><li><a href="DeltaCloud/PlainFormatter/FormatObject/Instance.html" title="DeltaCloud::PlainFormatter::FormatObject::Instance (class)">Instance</a> < Base<small class='search_info'>DeltaCloud::PlainFormatter::FormatObject</small></li><li><a href="DeltaCloud/PlainFormatter/FormatObject/Realm.html" title="DeltaCloud::PlainFormatter::FormatObject::Realm (class)">Realm</a> < Base<small class='search_info'>DeltaCloud::PlainFormatter::FormatObject</small></li><li><a href="DeltaCloud/PlainFormatter/FormatObject/StorageSnapshot.html" title="DeltaCloud::PlainFormatter::FormatObject::Sto
rageSnapshot (class)">StorageSnapshot</a> < Base<small class='search_info'>DeltaCloud::PlainFormatter::FormatObject</small></li><li><a href="DeltaCloud/PlainFormatter/FormatObject/StorageVolume.html" title="DeltaCloud::PlainFormatter::FormatObject::StorageVolume (class)">StorageVolume</a> < Base<small class='search_info'>DeltaCloud::PlainFormatter::FormatObject</small></li></ul></ul><li><a href="DeltaCloud/Realm.html" title="DeltaCloud::Realm (class)">Realm</a> < Object<small class='search_info'>DeltaCloud</small></li><li><a href="DeltaCloud/StorageSnapshot.html" title="DeltaCloud::StorageSnapshot (class)">StorageSnapshot</a> < Object<small class='search_info'>DeltaCloud</small></li><li><a href="DeltaCloud/StorageVolume.html" title="DeltaCloud::StorageVolume (class)">StorageVolume</a> < Object<small class='search_info'>DeltaCloud</small></li></ul><li><a href="Kernel.html" title="Kernel (module)">Kernel</a><small class='search_info'>Top Level Namespace</small><
/li><li><a href="String.html" title="String (class)">String</a> < Object<small class='search_info'>Top Level Namespace</small></li>
+
+ </ul>
+ </div>
+ </body>
+</html>
+
Added: incubator/deltacloud/trunk/client/doc/css/common.css
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/css/common.css?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/css/common.css (added)
+++ incubator/deltacloud/trunk/client/doc/css/common.css Thu Jul 8 23:49:28 2010
@@ -0,0 +1 @@
+/* Override this file with custom rules */
\ No newline at end of file
Added: incubator/deltacloud/trunk/client/doc/css/full_list.css
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/css/full_list.css?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/css/full_list.css (added)
+++ incubator/deltacloud/trunk/client/doc/css/full_list.css Thu Jul 8 23:49:28 2010
@@ -0,0 +1,50 @@
+body {
+ margin: 0;
+ font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+ font-size: 13px;
+ height: 101%;
+ overflow-x: hidden;
+}
+
+h1 { padding: 12px 10px; padding-bottom: 0; margin: 0; font-size: 1.4em; }
+.clear { clear: both; }
+#search { position: absolute; right: 5px; top: 9px; }
+#full_list { padding: 0; list-style: none; margin-left: 0; }
+#full_list ul { padding: 0; }
+#full_list li { padding: 5px; padding-left: 12px; margin: 0; font-size: 1.1em; list-style: none; }
+#noresults { display: none; padding: 7px 12px; }
+ul.collapsed ul, ul.collapsed li { display: none; }
+li a.toggle { cursor: default; position: relative; left: -5px; top: 4px; text-indent: -999px; width: 10px; height: 9px; margin-left: -10px; display: block; float: left; background: url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABQAAAASCAYAAABb0P4QAAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAK8AAACvABQqw0mAAAABx0RVh0U29mdHdhcmUAQWRvYmUgRmlyZXdvcmtzIENTM5jWRgMAAAAVdEVYdENyZWF0aW9uIFRpbWUAMy8xNC8wOeNZPpQAAAE2SURBVDiNrZTBccIwEEXfelIAHUA6CZ24BGaWO+FuzZAK4k6gg5QAdGAq+Bxs2Yqx7BzyL7Llp/VfzZeQhCTc/ezuGzKKnKSzpCxXJM8fwNXda3df5RZETlIt6YUzSQDs93sl8w3wBZxCCE10GM1OcWbWjB2mWgEH4Mfdyxm3PSepBHibgQE2wLe7r4HjEidpnXMYdQPKEMJcsZ4zs2POYQOcaPfwMVOo58zsAdMt18BuoVDPxUJRacELbXv3hUIX2vYmOUvi8C8ydz/ThjXrqKqqLbDIAdsCKBd+Wo7GWa7o9qzOQHVVVXeAbs+yHHCH4aTsaCOQqunmUy1yBUAXkdMIfMlgF5EXLo2OpV/c/Up7jG4hhHcYLgWzAZXUc2b2ixsfvc/RmNNfOXD3Q/oeL9axJE1yT9IOoUu6MGUkAAAAAElFTkSuQmCC) no-repeat bottom left; }
+li.collapsed a.toggle { opacity: 0.5; cursor: default; background-position: top left; }
+li { color: #888; cursor: pointer; }
+li.deprecated { text-decoration: line-through; font-style: italic; }
+li.r1 { background: #f0f0f0; }
+li.r2 { background: #fafafa; }
+li:hover { background: #ddd; }
+li small:before { content: "("; }
+li small:after { content: ")"; }
+li small.search_info { display: none; }
+a:link, a:visited { text-decoration: none; color: #05a; }
+li.clicked { background: #05a; color: #ccc; }
+li.clicked a:link, li.clicked a:visited { color: #eee; }
+li.clicked a.toggle { opacity: 0.5; background-position: bottom right; }
+li.collapsed.clicked a.toggle { background-position: top right; }
+#search input { border: 1px solid #bbb; -moz-border-radius: 3px; -webkit-border-radius: 3px; }
+#nav { margin-left: 10px; font-size: 0.9em; display: none; color: #aaa; }
+#nav a:link, #nav a:visited { color: #358; }
+#nav a:hover { background: transparent; color: #5af; }
+
+.frames #content h1 { margin-top: 0; }
+.frames li { white-space: nowrap; cursor: normal; }
+.frames li small { display: block; font-size: 0.8em; }
+.frames li small:before { content: ""; }
+.frames li small:after { content: ""; }
+.frames li small.search_info { display: none; }
+.frames #search { position: static; margin: 3px; margin-left: 10px; font-size: 0.9em; color: #888; }
+.frames #search input { width: 110px; }
+.frames #nav { display: block; }
+
+#full_list.insearch li { display: none; }
+#full_list.insearch li.found { display: list-item; padding-left: 10px; }
+#full_list.insearch li a.toggle { display: none; }
+#full_list.insearch li small.search_info { display: block; }
Added: incubator/deltacloud/trunk/client/doc/css/style.css
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/css/style.css?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/css/style.css (added)
+++ incubator/deltacloud/trunk/client/doc/css/style.css Thu Jul 8 23:49:28 2010
@@ -0,0 +1,277 @@
+body {
+ padding: 0 20px;
+ font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+ font-size: 13px;
+}
+body.frames { padding: 0 5px; }
+h1 { font-size: 25px; margin: 1em 0 0.5em; padding-top: 4px; border-top: 1px dotted #d5d5d5; }
+h1.noborder { border-top: 0px; margin-top: 0; padding-top: 4px; }
+h1.title { margin-bottom: 10px; }
+h1.alphaindex { margin-top: 0; font-size: 22px; }
+h2 {
+ padding: 0;
+ padding-bottom: 3px;
+ border-bottom: 1px #aaa solid;
+ font-size: 1.4em;
+ margin: 1.8em 0 0.5em;
+}
+h2 small { font-weight: normal; font-size: 0.7em; display: block; float: right; }
+.clear { clear: both; }
+.inline { display: inline; }
+.inline p:first-child { display: inline; }
+.docstring h1, .docstring h2, .docstring h3, .docstring h4 { padding: 0; border: 0; border-bottom: 1px dotted #bbb; }
+.docstring h1 { font-size: 1.2em; }
+.docstring h2 { font-size: 1.1em; }
+.docstring h3, .docstring h4 { font-size: 1em; border-bottom: 0; padding-top: 10px; }
+
+.note {
+ color: #222;
+ -moz-border-radius: 3px; -webkit-border-radius: 3px;
+ background: #e3e4e3; border: 1px solid #d5d5d5; padding: 7px 10px;
+}
+.note.todo { background: #ffffc5; border-color: #ececaa; }
+.note.returns_void { background: #efefef; }
+.note.deprecated { background: #ffe5e5; border-color: #e9dada; }
+.note.private { background: #ffffc5; border-color: #ececaa; }
+.note.title { text-transform: lowercase; padding: 1px 5px; margin-left: 5px; font-size: 0.9em; font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif; }
+h1 .note.title { font-size: 0.5em; font-weight: normal; padding: 3px 5px; position: relative; top: -3px; text-transform: capitalize; }
+.note.title.constructor { color: #fff; background: #6a98d6; border-color: #6689d6; }
+.note.title.writeonly { color: #fff; background: #45a638; border-color: #2da31d; }
+.note.title.readonly { color: #fff; background: #6a98d6; border-color: #6689d6; }
+.note.title.private { background: #d5d5d5; border-color: #c5c5c5; }
+
+h3.inherited {
+ font-style: italic;
+ font-family: "Lucida Sans", "Lucida Grande", Verdana, Arial, sans-serif;
+ font-weight: normal;
+ padding: 0;
+ margin: 0;
+ margin-top: 12px;
+ margin-bottom: 3px;
+ font-size: 13px;
+}
+p.inherited {
+ padding: 0;
+ margin: 0;
+ margin-left: 25px;
+}
+
+dl.box {
+ width: 520px;
+ font-size: 1em;
+}
+dl.box dt {
+ float: left;
+ display: block;
+ width: 100px;
+ margin: 0;
+ text-align: right;
+ font-weight: bold;
+ border: 1px solid #aaa;
+ border-width: 1px 0px 0px 1px;
+ padding: 6px 0;
+ padding-right: 10px;
+}
+dl.box dd {
+ float: left;
+ display: block;
+ width: 380px;
+ margin: 0;
+ padding: 6px 0;
+ padding-right: 20px;
+ border: 1px solid #aaa;
+ border-width: 1px 1px 0 0;
+}
+dl.box .last {
+ border-bottom: 1px solid #aaa;
+}
+dl.box .r1 { background: #eee; }
+
+ul.toplevel { list-style: none; padding-left: 0; font-size: 1.1em; }
+#files { padding-left: 15px; font-size: 1.1em; }
+
+#files { padding: 0; }
+#files li { list-style: none; display: inline; padding: 7px 12px; line-height: 35px; }
+
+dl.constants { margin-left: 40px; }
+dl.constants dt { font-weight: bold; font-size: 1.1em; margin-bottom: 5px; }
+dl.constants dd { width: 75%; white-space: pre; font-family: monospace; margin-bottom: 18px; }
+
+.summary_desc { margin-left: 32px; display: block; font-family: sans-serif; }
+.summary_desc tt { font-size: 0.9em; }
+dl.constants .docstring { margin-left: 32px; font-size: 0.9em; font-weight: normal; }
+dl.constants .discussion *:first-child { margin-top: 0; }
+dl.constants .discussion *:last-child { margin-bottom: 0; }
+
+.method_details { border-top: 1px dotted #aaa; margin-top: 15px; padding-top: 0; }
+.method_details.first { border: 0; }
+p.signature {
+ font-size: 1.1em; font-weight: normal; font-family: Monaco, Consolas, Courier, monospace;
+ padding: 6px 10px; margin-top: 18px;
+ background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
+}
+p.signature tt { font-family: Monaco, Consolas, Courier, monospace; }
+p.signature .overload { display: block; }
+p.signature .extras { font-weight: normal; font-family: sans-serif; color: #444; font-size: 1em; }
+p.signature .aliases { display: block; font-weight: normal; font-size: 0.9em; font-family: sans-serif; margin-top: 0px; color: #555; }
+p.signature .aliases .names { font-family: Monaco, Consolas, Courier, monospace; font-weight: bold; color: #000; font-size: 1.2em; }
+
+.tags h3 { font-size: 1em; margin-bottom: 0; }
+.tags ul { margin-top: 5px; padding-left: 30px; list-style: square; }
+.tags ul li { margin-bottom: 3px; }
+.tags ul .name { font-family: monospace; font-weight: bold; }
+.tags ul .note { padding: 3px 6px; }
+.tags { margin-bottom: 12px; }
+
+.tags .examples h3 { margin-bottom: 10px; }
+.tags .examples h4 { padding: 0; margin: 0; margin-left: 15px; font-weight: bold; font-size: 0.9em; }
+
+.tags .overload .overload_item { list-style: none; margin-bottom: 25px; }
+.tags .overload .overload_item .signature {
+ padding: 2px 8px;
+ background: #e5e8ff; border: 1px solid #d8d8e5; -moz-border-radius: 3px; -webkit-border-radius: 3px;
+}
+.tags .overload .signature { margin-left: -15px; font-family: monospace; display: block; font-size: 1.1em; }
+.tags .overload .docstring { margin-top: 15px; }
+
+.defines { display: none; }
+
+#method_missing_details .notice.this { position: relative; top: -8px; color: #888; padding: 0; margin: 0; }
+
+.showSource { font-size: 0.9em; }
+.showSource a:link, .showSource a:visited { text-decoration: none; color: #666; }
+
+#content a:link, #content a:visited { text-decoration: none; color: #05a; }
+#content a:hover { background: #ffffa5; }
+.docstring { margin-right: 6em; }
+
+ul.summary {
+ list-style: none;
+ font-family: monospace;
+ font-size: 1em;
+ line-height: 1.5em;
+}
+ul.summary a:link, ul.summary a:visited {
+ text-decoration: none; font-size: 1.1em;
+}
+ul.summary li { margin-bottom: 5px; }
+.summary .summary_signature {
+ padding: 1px 10px;
+ background: #eaeaff; border: 1px solid #dfdfe5;
+ -moz-border-radius: 3px; -webkit-border-radius: 3px;
+}
+.summary_signature:hover { background: #eeeeff; cursor: pointer; }
+ul.summary.compact li { display: inline; margin-right: 5px; line-height: 2.6em;}
+ul.summary.compact .summary_signature { padding: 5px 7px; padding-right: 4px; }
+#content .summary_signature:hover a:link,
+#content .summary_signature:hover a:visited {
+ background: transparent;
+ color: #48f;
+}
+
+p.inherited a { font-family: monospace; font-size: 0.9em; }
+p.inherited { word-spacing: 5px; font-size: 1.2em; }
+
+p.children { font-size: 1.2em; }
+p.children a { font-size: 0.9em; }
+p.children strong { font-size: 0.8em; }
+p.children strong.modules { padding-left: 5px; }
+
+ul.fullTree { display: none; padding-left: 0; list-style: none; margin-left: 0; margin-bottom: 10px; }
+ul.fullTree ul { margin-left: 0; padding-left: 0; list-style: none; }
+ul.fullTree li { text-align: center; }
+ul.fullTree li.next:before { font-size: 1.2em; content: '\2B06'; color: #bbb; display: block; margin-top: 3px; }
+
+#search { position: absolute; right: 14px; top: 0px; }
+#search a:link, #search a:visited {
+ display: block; float: left; margin-right: 4px;
+ padding: 8px 10px; text-decoration: none; color: #05a; background: #eaeaff;
+ border: 1px solid #d8d8e5;
+ -moz-border-radius-bottomleft: 3px; -moz-border-radius-bottomright: 3px;
+ -webkit-border-bottom-left-radius: 3px; -webkit-border-bottom-right-radius: 3px;
+}
+#search a:hover { background: #eef; color: #06b; }
+#search a.active {
+ background: #568; padding-bottom: 20px; color: #fff; border: 1px solid #457;
+ -moz-border-radius-topleft: 5px; -moz-border-radius-topright: 5px;
+ -webkit-border-top-left-radius: 5px; -webkit-border-top-right-radius: 5px;
+}
+#search a.inactive { color: #999; }
+.frames #search { display: none; }
+.inheritanceTree, .toggleDefines { float: right; }
+
+#menu { font-size: 1.3em; color: #bbb; top: -5px; position: relative; }
+#menu .title, #menu a { font-size: 0.7em; }
+#menu .title a { font-size: 1em; }
+#menu .title { color: #555; }
+#menu a:link, #menu a:visited { color: #333; text-decoration: none; border-bottom: 1px dotted #bbd; }
+#menu a:hover { color: #05a; }
+#menu .noframes { display: none; }
+.frames #menu .noframes { display: inline; float: right; }
+
+#footer { margin-top: 15px; border-top: 1px solid #ccc; text-align: center; padding: 7px 0; color: #999; }
+#footer a:link, #footer a:visited { color: #444; text-decoration: none; border-bottom: 1px dotted #bbd; }
+#footer a:hover { color: #05a; }
+
+#listing ul.alpha { font-size: 1.1em; }
+#listing ul.alpha { margin: 0; padding: 0; padding-bottom: 10px; list-style: none; }
+#listing ul.alpha li.letter { font-size: 1.4em; padding-bottom: 10px; }
+#listing ul.alpha ul { margin: 0; padding-left: 15px; }
+#listing ul small { color: #666; font-size: 0.7em; }
+
+li.r1 { background: #f0f0f0; }
+li.r2 { background: #fafafa; }
+
+#search_frame {
+ background: #fff;
+ display: none;
+ position: absolute;
+ top: 36px;
+ right: 18px;
+ width: 500px;
+ height: 80%;
+ overflow-y: scroll;
+ border: 1px solid #999;
+ border-collapse: collapse;
+ -webkit-box-shadow: -7px 5px 25px #aaa;
+ -moz-box-shadow: -7px 5px 25px #aaa;
+ -moz-border-radius: 2px;
+ -webkit-border-radius: 2px;
+}
+
+#content ul.summary li.deprecated a:link,
+#content ul.summary li.deprecated a:visited { text-decoration: line-through; font-style: italic; }
+
+/* syntax highlighting */
+.source_code { display: none; padding: 3px 8px; border-left: 8px solid #ddd; margin-top: 5px; }
+#filecontents pre.code, .docstring pre.code, .source_code pre { font-family: monospace; }
+#filecontents pre.code, .docstring pre.code { display: block; }
+.source_code .lines { padding-right: 12px; color: #555; text-align: right; }
+#filecontents pre.code, .docstring pre.code,
+.tags .example { padding: 5px 12px; margin-top: 4px; border: 1px solid #eef; background: #f5f5ff; }
+pre.code { color: #000; }
+pre.code .info.file { color: #555; }
+pre.code .val { color: #036A07; }
+pre.code .tstring_content,
+pre.code .heredoc_beg, pre.code .heredoc_end,
+pre.code .qwords_beg, pre.code .qwords_end,
+pre.code .tstring, pre.code .dstring { color: #036A07; }
+pre.code .fid, pre.code .id.new, pre.code .id.to_s,
+pre.code .id.to_sym, pre.code .id.to_f,
+pre.code .dot + pre.code .id,
+pre.code .id.to_i pre.code .id.each { color: #0085FF; }
+pre.code .comment { color: #0066FF; }
+pre.code .const, pre.code .constant { color: #585CF6; }
+pre.code .symbol { color: #C5060B; }
+pre.code .kw,
+pre.code .label,
+pre.code .id.require,
+pre.code .id.extend,
+pre.code .id.include { color: #0000FF; }
+pre.code .ivar { color: #318495; }
+pre.code .gvar,
+pre.code .id.backref,
+pre.code .id.nth_ref { color: #6D79DE; }
+pre.code .regexp, .dregexp { color: #036A07; }
+pre.code a { border-bottom: 1px dotted #bbf; }
+
Added: incubator/deltacloud/trunk/client/doc/file.README.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/file.README.html?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/file.README.html (added)
+++ incubator/deltacloud/trunk/client/doc/file.README.html Thu Jul 8 23:49:28 2010
@@ -0,0 +1,184 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
+<title>Deltacloud Client Library</title>
+<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+ relpath = '';
+ if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+ </head>
+ <body>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="_index.html" title="Index">Index</a> »
+ <span class="title">File: README</span>
+
+
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+ <div id="search">
+ <a id="class_list_link" href="#">Class List</a>
+ <a id="method_list_link" href="#">Method List</a>
+ <a id ="file_list_link" href="#">File List</a>
+</div>
+
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><div id='filecontents'><h1 id='deltacloud_client_ruby'>Deltacloud Client (Ruby)</h1>
+
+<p>The Deltacloud project includes a Ruby client. Other language-bindings are possible and will be supported soon. The client aims to insulate users from having to deal with HTTP and REST directly.</p>
+
+<p>Each resource type has an associated model to ease usage. Where resource reference other resources, natural navigation across the object model is possible.</p>
+
+<p>For example</p>
+
+<pre class="code"><span class='puts identifier id'>puts</span> <span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='dot token'>.</span><span class='name identifier id'>name</span>
+<span class='puts identifier id'>puts</span> <span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='hardware_profile identifier id'>hardware_profile</span><span class='dot token'>.</span><span class='architecture identifier id'>architecture</span>
+</pre>
+
+<h2 id='basics'>Basics</h2>
+
+<p>To use the client, you must require <code>deltacloud</code>.</p>
+
+<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'deltacloud'</span>
+</pre>
+
+<h2 id='connecting_to_a_deltacloud_provider'>Connecting to a Deltacloud provider</h2>
+
+<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'deltacloud'</span>
+
+<span class='api_url identifier id'>api_url</span> <span class='assign token'>=</span> <span class='string val'>'http://localhost:3001/api'</span>
+<span class='api_name identifier id'>api_name</span> <span class='assign token'>=</span> <span class='string val'>'mockuser'</span>
+<span class='api_password identifier id'>api_password</span> <span class='assign token'>=</span> <span class='string val'>'mockpassword'</span>
+
+<span class='client identifier id'>client</span> <span class='assign token'>=</span> <span class='DeltaCloud constant id'>DeltaCloud</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span> <span class='api_name identifier id'>api_name</span><span class='comma token'>,</span> <span class='api_password identifier id'>api_password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span> <span class='rparen token'>)</span>
+
+<span class='comment val'># work with client here</span>
+</pre>
+
+<p>In addition to creating a client, operations may occur within a block included on the initialization</p>
+
+<pre class="code"><span class='DeltaCloud constant id'>DeltaCloud</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span> <span class='api_name identifier id'>api_name</span><span class='comma token'>,</span> <span class='api_password identifier id'>api_password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span> <span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='client identifier id'>client</span><span class='bitor op'>|</span>
+ <span class='comment val'># work with client here</span>
+<span class='end end kw'>end</span>
+</pre>
+
+<p>In the event of a failure, any underlying HTTP transport exceptions will be thrown all the way out to the caller.</p>
+
+<h2 id='listing_realms'>Listing realms</h2>
+
+<p>You may retrieve a complete list of realms available to you</p>
+
+<pre class="code"><span class='realms identifier id'>realms</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='realms identifier id'>realms</span>
+</pre>
+
+<p>You may retrieve a specific realm by its identifier</p>
+
+<pre class="code"><span class='realm identifier id'>realm</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='realm identifier id'>realm</span><span class='lparen token'>(</span> <span class='string val'>'us'</span> <span class='rparen token'>)</span>
+</pre>
+
+<h2 id='listing_hardware_profiles'>Listing hardware profiles</h2>
+
+<p>You may retrieve a complete list of hardware profiles available for launching machines</p>
+
+<pre class="code"><span class='hwp identifier id'>hwp</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profiles identifier id'>hardware_profiles</span>
+</pre>
+
+<p>You may filter hardware profiles by architecture</p>
+
+<pre class="code"><span class='flavors identifier id'>flavors</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profiles identifier id'>hardware_profiles</span><span class='lparen token'>(</span> <span class='symbol val'>:architecture=</span><span class='gt op'>></span><span class='string val'>'x86_64'</span> <span class='rparen token'>)</span>
+</pre>
+
+<p>You may retrieve a specific hardware profile by its identifier</p>
+
+<pre class="code"><span class='flavor identifier id'>flavor</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profile identifier id'>hardware_profile</span><span class='lparen token'>(</span> <span class='string val'>'m1-small'</span> <span class='rparen token'>)</span>
+</pre>
+
+<h2 id='listing_images'>Listing images</h2>
+
+<p>You may retrieve a complete list of images</p>
+
+<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span>
+</pre>
+
+<p>You may retrieve a list of images owned by the currently authenticated user</p>
+
+<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='lparen token'>(</span> <span class='symbol val'>:owner_id=</span><span class='gt op'>></span><span class='symbol val'>:self</span> <span class='rparen token'>)</span>
+</pre>
+
+<p>You may retrieve a list of images visible to you but owned by a specific user</p>
+
+<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='lparen token'>(</span> <span class='symbol val'>:owner_id=</span><span class='gt op'>></span><span class='string val'>'daryll'</span> <span class='rparen token'>)</span>
+</pre>
+
+<p>You may retrieve a specific image by its identifier</p>
+
+<pre class="code"><span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='lparen token'>(</span> <span class='string val'>'ami-8675309'</span> <span class='rparen token'>)</span>
+</pre>
+
+<h2 id='listing_instances'>Listing instances</h2>
+
+<p>You may retrieve a list of all instances visible to you</p>
+
+<pre class="code"><span class='instances identifier id'>instances</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='instances identifier id'>instances</span>
+</pre>
+
+<p>You may retrieve a specific instance by its identifier</p>
+
+<pre class="code"><span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='instance identifier id'>instance</span><span class='lparen token'>(</span> <span class='string val'>'i-90125'</span> <span class='rparen token'>)</span>
+</pre>
+
+<h2 id='launching_instances'>Launching instances</h2>
+
+<p>An instance may be launched using just an image identifier</p>
+
+<pre class="code"><span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='lparen token'>(</span> <span class='string val'>'ami-8675309'</span> <span class='rparen token'>)</span>
+<span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='create_instance identifier id'>create_instance</span><span class='lparen token'>(</span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='id identifier id'>id</span> <span class='rparen token'>)</span>
+</pre>
+
+<p>Optionally, a flavor or realm may be specified</p>
+
+<pre class="code"><span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='create_instance identifier id'>create_instance</span><span class='lparen token'>(</span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='id identifier id'>id</span><span class='comma token'>,</span> <span class='symbol val'>:flavor=</span><span class='gt op'>></span><span class='string val'>'m1-small'</span><span class='comma token'>,</span> <span class='symbol val'>:realm=</span><span class='gt op'>></span><span class='string val'>'us'</span> <span class='rparen token'>)</span>
+</pre>
+
+<h2 id='manipulating_instances'>Manipulating instances</h2>
+
+<p>Given an instance, depending on its state, various actions <em>may</em> be available.</p>
+
+<p>To determine what’s available, the <code>instance#actions</code> method may be used.</p>
+
+<pre class="code"><span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='actions identifier id'>actions</span> <span class='comment val'># [ 'reboot', 'stop' ]</span>
+</pre>
+
+<p>For a valid action, the method matching the action with an exclamation point may be called.</p>
+
+<pre class="code"><span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='reboot! fid id'>reboot!</span>
+</pre>
+
+<p>Upon invoking an action, the instance will refresh its contents, in case the state has changed. To determine later if the state has changed again, the instance must be refetched using the <code>client.instance(...)</code> method.</p></div></div>
+
+ <div id="footer">
+ Generated on Mon Jun 28 11:12:51 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+ 0.5.6 (ruby-1.8.7).
+</div>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/deltacloud/trunk/client/doc/file_list.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/file_list.html?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/file_list.html (added)
+++ incubator/deltacloud/trunk/client/doc/file_list.html Thu Jul 8 23:49:28 2010
@@ -0,0 +1,38 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+ <head>
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
+ <link rel="stylesheet" href="css/full_list.css" type="text/css" media="screen" charset="utf-8" />
+ <link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+ <script type="text/javascript" charset="utf-8" src="js/full_list.js"></script>
+ <base id="base_target" target="_parent" />
+ </head>
+ <body>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) {
+ document.getElementById('base_target').target = 'main';
+ document.body.className = 'frames';
+ }
+ </script>
+ <div id="content">
+ <h1 id="full_list_header">File List</h1>
+ <div id="nav">
+ <a target="_self" href="class_list.html">Classes</a> |
+ <a target="_self" href="method_list.html">Methods</a> |
+ <a target="_self" href="file_list.html">Files</a>
+ </div>
+ <div id="search">Search: <input type="text" /></div>
+
+ <ul id="full_list" class="files">
+
+
+ <li class="r1"><a href="index.html" title="README">README</a></li>
+
+
+ </ul>
+ </div>
+ </body>
+</html>
+
Added: incubator/deltacloud/trunk/client/doc/frames.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/frames.html?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/frames.html (added)
+++ incubator/deltacloud/trunk/client/doc/frames.html Thu Jul 8 23:49:28 2010
@@ -0,0 +1,13 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Frameset//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-frameset.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
+ <title>Deltacloud Client Library</title>
+</head>
+<frameset cols="20%,*">
+ <frame name="list" src="class_list.html" />
+ <frame name="main" src="index.html" />
+</frameset>
+</html>
Added: incubator/deltacloud/trunk/client/doc/index.html
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/index.html?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/index.html (added)
+++ incubator/deltacloud/trunk/client/doc/index.html Thu Jul 8 23:49:28 2010
@@ -0,0 +1,184 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+ <head>
+ <meta name="Content-Type" content="text/html; charset=utf-8" />
+<title>Deltacloud Client Library</title>
+<link rel="stylesheet" href="css/style.css" type="text/css" media="screen" charset="utf-8" />
+<link rel="stylesheet" href="css/common.css" type="text/css" media="screen" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+ relpath = '';
+ if (relpath != '') relpath += '/';
+</script>
+<script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+ </head>
+ <body>
+ <script type="text/javascript" charset="utf-8">
+ if (window.top.frames.main) document.body.className = 'frames';
+ </script>
+
+ <div id="header">
+ <div id="menu">
+
+ <a href="_index.html" title="Index">Index</a> »
+ <span class="title">File: README</span>
+
+
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+ <div id="search">
+ <a id="class_list_link" href="#">Class List</a>
+ <a id="method_list_link" href="#">Method List</a>
+ <a id ="file_list_link" href="#">File List</a>
+</div>
+
+ <div class="clear"></div>
+ </div>
+
+ <iframe id="search_frame"></iframe>
+
+ <div id="content"><div id='filecontents'><h1 id='deltacloud_client_ruby'>Deltacloud Client (Ruby)</h1>
+
+<p>The Deltacloud project includes a Ruby client. Other language-bindings are possible and will be supported soon. The client aims to insulate users from having to deal with HTTP and REST directly.</p>
+
+<p>Each resource type has an associated model to ease usage. Where resource reference other resources, natural navigation across the object model is possible.</p>
+
+<p>For example</p>
+
+<pre class="code"><span class='puts identifier id'>puts</span> <span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='dot token'>.</span><span class='name identifier id'>name</span>
+<span class='puts identifier id'>puts</span> <span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='hardware_profile identifier id'>hardware_profile</span><span class='dot token'>.</span><span class='architecture identifier id'>architecture</span>
+</pre>
+
+<h2 id='basics'>Basics</h2>
+
+<p>To use the client, you must require <code>deltacloud</code>.</p>
+
+<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'deltacloud'</span>
+</pre>
+
+<h2 id='connecting_to_a_deltacloud_provider'>Connecting to a Deltacloud provider</h2>
+
+<pre class="code"><span class='require identifier id'>require</span> <span class='string val'>'deltacloud'</span>
+
+<span class='api_url identifier id'>api_url</span> <span class='assign token'>=</span> <span class='string val'>'http://localhost:3001/api'</span>
+<span class='api_name identifier id'>api_name</span> <span class='assign token'>=</span> <span class='string val'>'mockuser'</span>
+<span class='api_password identifier id'>api_password</span> <span class='assign token'>=</span> <span class='string val'>'mockpassword'</span>
+
+<span class='client identifier id'>client</span> <span class='assign token'>=</span> <span class='DeltaCloud constant id'>DeltaCloud</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span> <span class='api_name identifier id'>api_name</span><span class='comma token'>,</span> <span class='api_password identifier id'>api_password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span> <span class='rparen token'>)</span>
+
+<span class='comment val'># work with client here</span>
+</pre>
+
+<p>In addition to creating a client, operations may occur within a block included on the initialization</p>
+
+<pre class="code"><span class='DeltaCloud constant id'>DeltaCloud</span><span class='dot token'>.</span><span class='new identifier id'>new</span><span class='lparen token'>(</span> <span class='api_name identifier id'>api_name</span><span class='comma token'>,</span> <span class='api_password identifier id'>api_password</span><span class='comma token'>,</span> <span class='api_url identifier id'>api_url</span> <span class='rparen token'>)</span> <span class='do do kw'>do</span> <span class='bitor op'>|</span><span class='client identifier id'>client</span><span class='bitor op'>|</span>
+ <span class='comment val'># work with client here</span>
+<span class='end end kw'>end</span>
+</pre>
+
+<p>In the event of a failure, any underlying HTTP transport exceptions will be thrown all the way out to the caller.</p>
+
+<h2 id='listing_realms'>Listing realms</h2>
+
+<p>You may retrieve a complete list of realms available to you</p>
+
+<pre class="code"><span class='realms identifier id'>realms</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='realms identifier id'>realms</span>
+</pre>
+
+<p>You may retrieve a specific realm by its identifier</p>
+
+<pre class="code"><span class='realm identifier id'>realm</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='realm identifier id'>realm</span><span class='lparen token'>(</span> <span class='string val'>'us'</span> <span class='rparen token'>)</span>
+</pre>
+
+<h2 id='listing_hardware_profiles'>Listing hardware profiles</h2>
+
+<p>You may retrieve a complete list of hardware profiles available for launching machines</p>
+
+<pre class="code"><span class='hwp identifier id'>hwp</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profiles identifier id'>hardware_profiles</span>
+</pre>
+
+<p>You may filter hardware profiles by architecture</p>
+
+<pre class="code"><span class='flavors identifier id'>flavors</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profiles identifier id'>hardware_profiles</span><span class='lparen token'>(</span> <span class='symbol val'>:architecture=</span><span class='gt op'>></span><span class='string val'>'x86_64'</span> <span class='rparen token'>)</span>
+</pre>
+
+<p>You may retrieve a specific hardware profile by its identifier</p>
+
+<pre class="code"><span class='flavor identifier id'>flavor</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='hardware_profile identifier id'>hardware_profile</span><span class='lparen token'>(</span> <span class='string val'>'m1-small'</span> <span class='rparen token'>)</span>
+</pre>
+
+<h2 id='listing_images'>Listing images</h2>
+
+<p>You may retrieve a complete list of images</p>
+
+<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span>
+</pre>
+
+<p>You may retrieve a list of images owned by the currently authenticated user</p>
+
+<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='lparen token'>(</span> <span class='symbol val'>:owner_id=</span><span class='gt op'>></span><span class='symbol val'>:self</span> <span class='rparen token'>)</span>
+</pre>
+
+<p>You may retrieve a list of images visible to you but owned by a specific user</p>
+
+<pre class="code"><span class='images identifier id'>images</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='images identifier id'>images</span><span class='lparen token'>(</span> <span class='symbol val'>:owner_id=</span><span class='gt op'>></span><span class='string val'>'daryll'</span> <span class='rparen token'>)</span>
+</pre>
+
+<p>You may retrieve a specific image by its identifier</p>
+
+<pre class="code"><span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='lparen token'>(</span> <span class='string val'>'ami-8675309'</span> <span class='rparen token'>)</span>
+</pre>
+
+<h2 id='listing_instances'>Listing instances</h2>
+
+<p>You may retrieve a list of all instances visible to you</p>
+
+<pre class="code"><span class='instances identifier id'>instances</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='instances identifier id'>instances</span>
+</pre>
+
+<p>You may retrieve a specific instance by its identifier</p>
+
+<pre class="code"><span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='instance identifier id'>instance</span><span class='lparen token'>(</span> <span class='string val'>'i-90125'</span> <span class='rparen token'>)</span>
+</pre>
+
+<h2 id='launching_instances'>Launching instances</h2>
+
+<p>An instance may be launched using just an image identifier</p>
+
+<pre class="code"><span class='image identifier id'>image</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='image identifier id'>image</span><span class='lparen token'>(</span> <span class='string val'>'ami-8675309'</span> <span class='rparen token'>)</span>
+<span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='create_instance identifier id'>create_instance</span><span class='lparen token'>(</span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='id identifier id'>id</span> <span class='rparen token'>)</span>
+</pre>
+
+<p>Optionally, a flavor or realm may be specified</p>
+
+<pre class="code"><span class='instance identifier id'>instance</span> <span class='assign token'>=</span> <span class='client identifier id'>client</span><span class='dot token'>.</span><span class='create_instance identifier id'>create_instance</span><span class='lparen token'>(</span> <span class='image identifier id'>image</span><span class='dot token'>.</span><span class='id identifier id'>id</span><span class='comma token'>,</span> <span class='symbol val'>:flavor=</span><span class='gt op'>></span><span class='string val'>'m1-small'</span><span class='comma token'>,</span> <span class='symbol val'>:realm=</span><span class='gt op'>></span><span class='string val'>'us'</span> <span class='rparen token'>)</span>
+</pre>
+
+<h2 id='manipulating_instances'>Manipulating instances</h2>
+
+<p>Given an instance, depending on its state, various actions <em>may</em> be available.</p>
+
+<p>To determine what’s available, the <code>instance#actions</code> method may be used.</p>
+
+<pre class="code"><span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='actions identifier id'>actions</span> <span class='comment val'># [ 'reboot', 'stop' ]</span>
+</pre>
+
+<p>For a valid action, the method matching the action with an exclamation point may be called.</p>
+
+<pre class="code"><span class='instance identifier id'>instance</span><span class='dot token'>.</span><span class='reboot! fid id'>reboot!</span>
+</pre>
+
+<p>Upon invoking an action, the instance will refresh its contents, in case the state has changed. To determine later if the state has changed again, the instance must be refetched using the <code>client.instance(...)</code> method.</p></div></div>
+
+ <div id="footer">
+ Generated on Mon Jun 28 11:12:51 2010 by
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool">yard</a>
+ 0.5.6 (ruby-1.8.7).
+</div>
+
+ </body>
+</html>
\ No newline at end of file
Added: incubator/deltacloud/trunk/client/doc/js/app.js
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/js/app.js?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/js/app.js (added)
+++ incubator/deltacloud/trunk/client/doc/js/app.js Thu Jul 8 23:49:28 2010
@@ -0,0 +1,138 @@
+function createSourceLinks() {
+ $('.method_details_list .source_code').
+ before("<span class='showSource'>[<a href='#' class='toggleSource'>View source</a>]</span>");
+ $('.toggleSource').toggle(function() {
+ $(this).parent().next().slideDown(100);
+ $(this).text("Hide source");
+ },
+ function() {
+ $(this).parent().next().slideUp(100);
+ $(this).text("View source");
+ });
+}
+
+function createDefineLinks() {
+ var tHeight = 0;
+ $('.defines').after(" <a href='#' class='toggleDefines'>more...</a>");
+ $('.toggleDefines').toggle(function() {
+ tHeight = $(this).parent().prev().height();
+ $(this).prev().show();
+ $(this).parent().prev().height($(this).parent().height());
+ $(this).text("(less)");
+ },
+ function() {
+ $(this).prev().hide();
+ $(this).parent().prev().height(tHeight);
+ $(this).text("more...")
+ });
+}
+
+function createFullTreeLinks() {
+ var tHeight = 0;
+ $('.inheritanceTree').toggle(function() {
+ tHeight = $(this).parent().prev().height();
+ $(this).prev().prev().hide();
+ $(this).prev().show();
+ $(this).text("(hide)");
+ $(this).parent().prev().height($(this).parent().height());
+ },
+ function() {
+ $(this).prev().prev().show();
+ $(this).prev().hide();
+ $(this).parent().prev().height(tHeight);
+ $(this).text("show all")
+ });
+}
+
+function fixBoxInfoHeights() {
+ $('dl.box dd.r1, dl.box dd.r2').each(function() {
+ $(this).prev().height($(this).height());
+ });
+}
+
+function searchFrameLinks() {
+ $('#method_list_link').click(function() {
+ toggleSearchFrame(this, relpath + 'method_list.html');
+ });
+
+ $('#class_list_link').click(function() {
+ toggleSearchFrame(this, relpath + 'class_list.html');
+ });
+
+ $('#file_list_link').click(function() {
+ toggleSearchFrame(this, relpath + 'file_list.html');
+ });
+}
+
+function toggleSearchFrame(id, link) {
+ var frame = $('#search_frame');
+ $('#search a').removeClass('active').addClass('inactive');
+ if (frame.attr('src') == link && frame.css('display') != "none") {
+ frame.slideUp(100);
+ $('#search a').removeClass('active inactive');
+ }
+ else {
+ $(id).addClass('active').removeClass('inactive');
+ frame.attr('src', link).slideDown(100);
+ }
+}
+
+function linkSummaries() {
+ $('.summary_signature').click(function() {
+ document.location = $(this).find('a').attr('href');
+ });
+}
+
+function framesInit() {
+ if (window.top.frames.main) {
+ document.body.className = 'frames';
+ $('#menu .noframes a').attr('href', document.location);
+ }
+}
+
+function keyboardShortcuts() {
+ if (window.top.frames.main) return;
+ $(document).keypress(function(evt) {
+ if (evt.altKey || evt.ctrlKey || evt.metaKey || evt.shiftKey) return;
+ if (evt.originalTarget.nodeName == "INPUT" ||
+ evt.originalTarget.nodeName == "TEXTAREA") return;
+ switch (evt.charCode) {
+ case 67: case 99: $('#class_list_link').click(); break; // 'c'
+ case 77: case 109: $('#method_list_link').click(); break; // 'm'
+ case 70: case 102: $('#file_list_link').click(); break; // 'f'
+ }
+ });
+}
+
+function summaryToggle() {
+ $('.summary_toggle').click(function() {
+ $(this).text($(this).text() == "collapse" ? "expand" : "collapse");
+ var next = $(this).parent().parent().next();
+ if (next.hasClass('compact')) {
+ next.toggle();
+ next.next().toggle();
+ }
+ else if (next.hasClass('summary')) {
+ var list = $('<ul class="summary compact" />');
+ list.html(next.html());
+ list.find('.summary_desc, .note').remove();
+ list.find('a').each(function() {
+ $(this).html($(this).find('strong').html());
+ $(this).parent().html($(this)[0].outerHTML);
+ });
+ next.before(list);
+ next.toggle();
+ }
+ return false;
+ })
+}
+
+$(framesInit);
+$(createSourceLinks);
+$(createDefineLinks);
+$(createFullTreeLinks);
+$(fixBoxInfoHeights);
+$(searchFrameLinks);
+$(linkSummaries);
+$(keyboardShortcuts);
+$(summaryToggle);
Added: incubator/deltacloud/trunk/client/doc/js/full_list.js
URL: http://svn.apache.org/viewvc/incubator/deltacloud/trunk/client/doc/js/full_list.js?rev=962361&view=auto
==============================================================================
--- incubator/deltacloud/trunk/client/doc/js/full_list.js (added)
+++ incubator/deltacloud/trunk/client/doc/js/full_list.js Thu Jul 8 23:49:28 2010
@@ -0,0 +1,117 @@
+function fullListSearch() {
+ $('#search input').keyup(function() {
+ var value = this.value.toLowerCase();
+ if (value == "") {
+ $('#full_list').removeClass('insearch');
+ $('#full_list li').each(function() {
+ var link = $(this).children('a:last');
+ link.text(link.text());
+ });
+ if (clicked) {
+ clicked.parents('ul').each(function() {
+ $(this).removeClass('collapsed').prev().removeClass('collapsed');
+ });
+ }
+ highlight();
+ }
+ else {
+ $('#full_list').addClass('insearch');
+ $('#full_list li').each(function() {
+ var link = $(this).children('a:last');
+ var text = link.text();
+ if (text.toLowerCase().indexOf(value) == -1) {
+ $(this).removeClass('found');
+ link.text(link.text());
+ }
+ else {
+ $(this).css('padding-left', '10px').addClass('found');
+ link.html(link.text().replace(new RegExp("(" +
+ value.replace(/([\/.*+?|()\[\]{}\\])/g, "\\$1") + ")", "ig"),
+ '<strong>$1</strong>'));
+ }
+ });
+ highlight(true);
+ }
+
+ if ($('#full_list li:visible').size() == 0) {
+ $('#noresults').fadeIn();
+ }
+ else {
+ $('#noresults').hide();
+ }
+ });
+
+ $('#search input').focus();
+ $('#full_list').after("<div id='noresults'>No results were found.</div>")
+}
+
+clicked = null;
+function linkList() {
+ $('#full_list li, #full_list li a:last').click(function(evt) {
+ if ($(this).hasClass('toggle')) return true;
+ if (this.tagName.toLowerCase() == "li") {
+ var toggle = $(this).children('a.toggle');
+ if (toggle.size() > 0 && evt.pageX < toggle.offset().left) {
+ toggle.click();
+ return false;
+ }
+ }
+ if (clicked) clicked.removeClass('clicked');
+ var win = window.parent;
+ if (window.top.frames.main) {
+ win = window.top.frames.main;
+ var title = $('html head title', win.document).text();
+ $('html head title', window.parent.document).text(title);
+ }
+ if (this.tagName.toLowerCase() == "a") {
+ clicked = $(this).parent('li').addClass('clicked');
+ win.location = this.href;
+ }
+ else {
+ clicked = $(this).addClass('clicked');
+ win.location = $(this).find('a:last').attr('href');
+ }
+ return false;
+ });
+}
+
+function collapse() {
+ if (!$('#full_list').hasClass('class')) return;
+ $('#full_list.class a.toggle').click(function() {
+ $(this).parent().toggleClass('collapsed').next().toggleClass('collapsed');
+ highlight();
+ return false;
+ });
+ $('#full_list.class ul').each(function() {
+ $(this).addClass('collapsed').prev().addClass('collapsed');
+ });
+ $('#full_list.class').children().removeClass('collapsed');
+ highlight();
+}
+
+function highlight(no_padding) {
+ var n = 1;
+ $('#full_list li:visible').each(function() {
+ var next = n == 1 ? 2 : 1;
+ $(this).removeClass("r" + next).addClass("r" + n);
+ if (!no_padding && $('#full_list').hasClass('class')) {
+ $(this).css('padding-left', (10 + $(this).parents('ul').size() * 15) + 'px');
+ }
+ n = next;
+ });
+}
+
+function escapeShortcut() {
+ $(document).keydown(function(evt) {
+ if (evt.which == 27) {
+ $('#search_frame', window.top.document).slideUp(100);
+ $('#search a', window.top.document).removeClass('active inactive')
+ $(window.top).focus();
+ }
+ });
+}
+
+$(escapeShortcut);
+$(fullListSearch);
+$(linkList);
+$(collapse);