autoproj 1.0.0

data/doc/guide/src/default.css

@@ -0,0 +1,325 @@
+/* andreas03 - an open source xhtml/css website layout by Andreas Viklund - http://andreasviklund.com . Free to use for any purpose as long as the proper credits are given to the original author.
+
+Version: 1.2
+(Nov 28, 2005)
+
+Screen layout: */
+
+body{
+margin:0;
+padding:30px 0;
+font:76% tahoma,verdana,sans-serif;
+background:#047 url(images/bodybg.png) repeat-x fixed;
+color:#222;
+}
+
+#thetop{
+margin:0;
+}
+
+#container{
+width:720px;
+margin:0 auto;
+padding:20px 20px 0 20px;
+background:#fff url(images/contbg.png) no-repeat;
+color:#222;
+}
+
+a{
+text-decoration:none;
+background-color:inherit;
+color:#26c;
+}
+
+a:hover {
+text-decoration:underline;
+}
+
+a img{
+border:0;
+}
+
+p{
+margin:0 0 15px 0;
+line-height:1.5em;
+}
+
+#main p,#sidebar p{
+padding:0 0 0 10px;
+}
+
+#logo{
+float:left;
+width:240px;
+margin:0 20px 0 0;
+padding:0 0 25px 0;
+background:#eee;
+border:4px solid #dde;
+text-align:center;
+color:#555;
+overflow:auto;
+}
+
+#logo h1{
+margin:50px 5px 1px 5px;
+letter-spacing:-3px;
+}
+
+#logo a{
+background-color:inherit;
+color:#26a;
+text-decoration:none;
+}
+
+#logo a:hover{
+background-color:inherit;
+color:#69e;
+}
+
+#tagline{
+text-align:center;
+font-size:1.2em;
+}
+
+#intro p{
+line-height:1.5em;
+}
+
+#main{
+float:left;
+width:530px;
+margin-right:20px;
+padding:0;
+}
+
+#main h2, .navbar {
+display:block;
+margin:30px 0 10px 0;
+padding:5px 0 5px 8px;
+background:#eee url(images/gradient2.png) repeat-x;
+color:#222;
+border-top:1px solid #ddd;
+border-right:1px solid #bbb;
+border-bottom:1px solid #bbb;
+border-left:1px solid #ddd;
+text-decoration:none;
+}
+
+#sidebar{
+width:155px;
+float:right;
+margin-top:20px;
+font-size:1em;
+line-height:1.3em;
+}
+
+#sidebar p, #sidebar .linklist {
+font-size:0.9em;
+}
+
+#sidebar ul.linklist {
+list-style-type: none;
+margin: 0px;
+padding: 5px 0px 5px 8px;
+}
+
+#sidebar #menu ul, #sidebar #submenu ul {
+list-style-type: none;
+margin: 0px;
+padding: 0px;
+}
+
+ul li ul li {
+    margin-left: -2em;
+    padding-left: 0;
+}
+
+#sidebar #menu li, .sidelink, #sidebar #submenu li, #sidebar #submenu li {
+display:block;
+width:140px;
+margin:3px 10px 2px 0;
+padding:5px 0 5px 8px;
+font-size:1.1em;
+font-weight:bold;
+text-align:left;
+background:#eee url(images/gradient1.png) repeat-x;
+color:#26c;
+border-top:1px solid #ddd;
+border-right:1px solid #bbb;
+border-bottom:1px solid #bbb;
+border-left:1px solid #ddd;
+}
+
+#sidebar #menu a:hover {
+    text-decoration: none;
+}
+
+#sidebar #menu li.webgen-menu-submenu-inhierarchy, .menuheader {
+background:#fff url(images/gradient2.png) repeat-x;
+color:#222;
+border-top:1px solid #ddd;
+border-right:1px solid #888;
+border-bottom:1px solid #888;
+border-left:1px solid #ddd;
+text-decoration:none;
+}
+
+#sidebar #menu li.webgen-menu-item-selected {
+    color: #222;
+}
+#sidebar #menu li.webgen-menu-item-selected:hover {
+    color: #222;
+    background: none;
+    border: none;
+}
+
+.menuheader {
+    font-size: 1.4em;
+    text-align: center;
+    margin-bottom: .4em;
+}
+
+#sidebar #submenu li.webgen-menu-item-selected, #sidebar #submenu li:hover {
+background: none;
+font-size: 1em: 
+}
+
+#sidebar #menu li ul li, #sidebar #submenu li ul li, #sidebar #submenu li ul li.webgen-menu-item-selected {
+display:block;
+width:130px;
+margin:3px 10px 2px 0;
+padding:0px 0 0px 8px;
+font-size:0.8em;
+font-weight:bold;
+text-align:left;
+background: none;
+color:#26c;
+border: none;
+}
+
+
+#footer{
+margin:0 auto 20px auto;
+width:760px;
+background:#fff url(images/footerbg.png) bottom left no-repeat;
+padding:0 0 5px 0;
+font-size:0.9em;
+color:#888;
+text-align:center;
+}
+
+h1,h2,h3,h4{
+margin:0 0 10px 0;
+font-weight:normal;
+}
+
+h1{
+font-size:2.8em;
+margin-top: 5px;
+margin-bottom: 5px;
+}
+
+h2{
+margin:0 0 4px 0;
+font-size:1.8em;
+}
+
+h3{
+margin:20px 0 8px 0;
+font-size:1.4em;
+}
+
+h4{
+margin:10px 0 5px 0;
+font-size:1.2em;
+}
+
+.clear{
+clear:both;
+margin:0;
+}
+
+.right{
+text-align:right;
+}
+
+.internallink{
+font-size:0.9em;
+text-align:center;
+}
+
+.block{
+padding:20px;
+background:#eee;
+color:#222;
+border:2px solid #ddd;
+}
+
+.warning{
+padding:20px;
+background:#fbb;
+color:#222;
+border:2px solid #eaa;
+margin-top: 3em;
+margin-bottom: 3em;
+margin-left: 2em;
+margin-right: 2em;
+
+}
+
+.credit{
+color:#888;
+background-color:inherit;
+}
+
+.hide{
+display:none;
+}
+
+pre .code{
+margin-left: 2.5em;
+}
+pre {
+margin-left: 2.5em;
+}
+
+/* Original open source design by Andreas Viklund - http://andreasviklund.com
+Released through OSWD.org */
+
+.navbar {
+    padding-left: 1em;
+    padding-right: 1em;
+    padding-bottom: 2em;
+}
+.previous .next {
+    margin: 1em;
+    display: inline;
+    font-size: 1.2em;
+}
+.previous {
+    float: left;
+}
+.next {
+    float: right;
+}
+
+.fullfigure {
+    text-align: center;
+}
+.figurecaption {
+    text-align: center;
+    margin-top: -1em;
+    margin-bottom: 4em;
+    margin-left: 10%;
+    margin-right: 10%;
+    background:#eee;
+    color:#222;
+    border:2px solid #ddd;
+}
+.commandline {
+    font: monospace;
+    margin-left: 1em;
+    margin-top: -.6em;
+    margin-bottom: .5em;
+}
+

data/doc/guide/src/default.template

@@ -0,0 +1,74 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{lang:}">
+  <head>
+    <meta http-equiv="content-type" content="text/html; charset=utf-8" />
+    <meta name="description" content="your description goes here" />
+    <meta name="keywords" content="your,keywords,goes,here" />
+    <meta name="author" content="Your Name  / Original design: Andreas Viklund - http://andreasviklund.com/" />
+    <meta name="generator" content="webgen - http://webgen.rubyforge.org" />
+    <link rel="stylesheet" type="text/css" href="{relocatable: default.css}" />
+    <title>{title: }</title>
+  </head>
+
+  <body>
+    <div id="thetop">
+      <a id="top"></a>
+      <p class="hide">Skip to: <a href="#sitemenu" accesskey="2">Site menu</a> | <a href="#maincontent" accesskey="3">Main content</a></p>
+    </div>
+
+    <div id="container">
+      <div id="main">
+
+        <div id="logo">
+          <h1>[<a href="{relocatable: /index.html}" accesskey="4">autoproj</a>]</h1>
+          <span id="tagline">User's guide</span><BR />
+          for v{execute_cmd: ruby -rlib/autoproj/version -e "puts Autoproj::VERSION"}
+        </div>
+
+        <div id="intro">
+          <h2><a id="maincontent"></a>A meta build system</h2>
+          <!--
+          <p>Here could go a description of your website! Or a quick overview of the page!</p>
+          -->
+        </div>
+          <div class="clear">&nbsp;</div>
+
+          <div class="navbar">
+              {breadcrumb_trail: }
+              <div>
+                  <div class="previous">
+                      {previous:: }<b>Previous</b>: %{previous}
+                  </div>
+                  <div class="next">
+                      {next:: }<b>Next</b>: %{next}
+                  </div>
+              </div>
+              <webgen:block name="navbar" notfound="ignore"/>
+          </div>
+
+          <h1>{title: }</h1>
+          <div class="clear">&nbsp;</div>
+            <webgen:block name="content" />
+          <div class="navbar">
+              {breadcrumb_trail: }
+              <webgen:block name="navbar" notfound="ignore"/>
+          </div>
+      </div>
+
+
+      <div id="sidebar">
+
+        <h2 class="sidelink menuheader"><a id="sitemenu"></a>Main Menu</h2>
+        <div id="menu">{menu: {max_levels: 2, show_current_subtree_only: true, nested: true, used_nodes: files}}</div>
+        <br>
+        <a class="hide" href="#top" accesskey="1">Top of page</a>
+
+      </div>
+      <div class="clear">&nbsp;</div>
+    </div>
+
+    <div id="footer"><p>&copy; 2009 Sylvain Joyeux | Generated by <a href="http://webgen.rubyforge.org/">webgen</a> | Design by <a href="http://andreasviklund.com">Andreas Viklund</a></p></div>
+
+  </body>
+</html>

data/doc/guide/src/htmldoc.metainfo

@@ -0,0 +1,4 @@
+/index.page:
+    title: Introduction
+    sort_info: 0
+

data/doc/guide/src/index.page

@@ -0,0 +1,79 @@
+What is Autoproj
+----------------
+Autoproj allows to easily install and maintain software that is under source
+code form (usually from a version control system). It has been designed to support a
+package-oriented development process, where each package can have its own
+version control repository (think "distributed version control"). It also
+provides an easy integration of the local operating system (Debian, Ubuntu,
+Fedora, maybe MacOSX at some point).
+
+This tool has been developped in the frame of the RubyInMotion project
+(http://sites.google.com/site/rubyinmotion), to install robotics-related
+software -- that is often bleeding edge. Unlike [the ROS build
+system](http://ros.org), it is not bound to one build system, one VCS and one
+integration framework. The philosophy behind autoproj
+is:
+ * supports both CMake and autotools, and can be adapted to other tools
+ * supports different VCS: cvs, svn, git, plain tarballs.
+ * software packages are plain packages, meaning that they can be built and
+   installed /outside/ an autoproj tree, and are not tied *at all* to the
+   autoproj build system.
+ * leverage the actual OS package management system. Right now, only Debian-like
+   systems (like Ubuntu) are supported, simply because it is the only one I have
+   access to.
+ * handle code generation properly
+
+It tries as much as possible to follow the lead of Willow Garage on the package
+specification. More specifically, the package manifest files are common between
+ROS package management and autoproj (more details in the following of this
+document).
+
+Components of an Autoproj installation
+-------------------------------------
+A autoproj installation is seeded by _package sets_. A package set is a local or remote
+directory in which there is:
+ * autobuild scripts that describe what can be built and how it should be built.
+   These scripts an also list a set of configuration options that allow to
+   parametrize the build. In general, there should be only a limited number of
+   such options.
+ * a source.yml file which describes the package set itself, and where the software
+   packages are located (what version control system and what URL).
+ * optionally, a file that describe prepackaged dependencies that can be
+   installed by using the operating system package management system.
+
+Bootstrapping
+-------------
+"Bootstrapping" means getting autoproj itself before it can work its magic ...
+The canonical way is the following:
+
+ * install Ruby by yourself. On Debian or Ubuntu, this is done with
+   done with
+
+   sudo apt-get install wget ruby
+   {.cmdline}
+
+ * then, [download this script](autoproj_bootstrap) *in the directory where
+   you want to create an autoproj installation*, and run it. This can be done with
+
+   wget http://doudou.github.com/autoproj/autoproj\_bootstrap <br />
+   ruby autoproj\_bootstrap
+   {.cmdline}
+
+ * follow the instructions printed by the script above :)
+
+Software packages in Autoproj
+-----------------------------
+In the realm of autoproj, a software package should be a self-contained build
+system, that could be built outside of an autoproj tree. In practice, it means
+that the package writer should leverage its build system (for instance, cmake)
+to discover if the package dependencies are installed, and what are the
+appropriate build options that should be given (for instance, include
+directories or library names).
+
+As a guideline, we recommend that inter-package dependencies are managed by
+using pkg-config.
+
+To describe the package, and more importantly to setup cross-package
+dependencies, an optional manifest file can be added. This manifest file is
+named manifest.xml. Its format is described later in this user's guide.
+