compiling docs, and updated docs

nitrogen · Aug 11, 2011 · b737667 · b737667
1 parent 0cb3815
commit b737667
Show file tree

Hide file tree

Showing 75 changed files with 1,810 additions and 847 deletions.
diff --git a/DOCS.txt b/DOCS.txt
@@ -0,0 +1,19 @@
+COMPILING THE DOCUMENTATION
+
+
+Compiling the documentation uses Org-mode for Emacs.
+
+Editing the HTML is not recommended, as the org-mode compiler just overwrites all HTML anyway.
+
+Instead, edit the org-mode files found in doc/org-mode.
+
+Make sure you have emacs installed, with the htmlize[1] (version 1.34 or later), erlang-mode, and org-mode installed.
+
+On Ubuntu, these packages can all be installed with:
+
+sudo apt-get install emacs erlang-mode org-mode emacs-goodies-el
+
+
+Once this is done, you can compile the docs from the command line with:
+
+$ make docs
diff --git a/Makefile b/Makefile
@@ -5,3 +5,8 @@ compile:
 
 clean:
 	./rebar clean
+
+docs:  
+	./make_docs.el
+
+doc: docs
diff --git a/doc/html/about.html b/doc/html/about.html
@@ -7,7 +7,7 @@
 <title>Nitrogen 2.x Documentation</title>
 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
 <meta name="generator" content="Org-mode"/>
-<meta name="generated" content="2011-02-01 08:21:50 EST"/>
+<meta name="generated" content="2011-08-11 07:26:46 CDT"/>
 <meta name="author" content="Rusty Klophaus (@rklophaus)"/>
 <meta name="description" content=""/>
 <meta name="keywords" content=""/>
@@ -21,6 +21,9 @@
   .target { }
   .timestamp { color: #bebebe; }
   .timestamp-kwd { color: #5f9ea0; }
+  .right  {margin-left:auto; margin-right:0px;  text-align:right;}
+  .left   {margin-left:0px;  margin-right:auto; text-align:left;}
+  .center {margin-left:auto; margin-right:auto; text-align:center;}
   p.verse { margin-left: 3% }
   pre {
 	border: 1pt solid #AEBDCC;
@@ -31,7 +34,13 @@
         overflow:auto;
   }
   table { border-collapse: collapse; }
-  td, th { vertical-align: top; }
+  td, th { vertical-align: top;  }
+  th.right  { text-align:center;  }
+  th.left   { text-align:center;   }
+  th.center { text-align:center; }
+  td.right  { text-align:right;  }
+  td.left   { text-align:left;   }
+  td.center { text-align:center; }
   dt { font-weight: bold; }
   div.figure { padding: 0.5em; }
   div.figure p { text-align: center; }
@@ -68,6 +77,7 @@
  }
 /*]]>*///-->
 </script>
+
 </head>
 <body>
 <div id="content">
@@ -117,9 +127,10 @@ <h2 id="sec-1"><span class="section-number-2">1</span> Resources </h2>
 </li>
 <li>
 Bugs and Issues - <a href="http://nitrogen.lighthouseapp.com">http://nitrogen.lighthouseapp.com</a>
-
 </li>
 </ul>
+
+
 </div>
 
 </div>
@@ -192,9 +203,10 @@ <h2 id="sec-2"><span class="section-number-2">2</span> Versions </h2>
 </li>
 <li>
 <b>Live Validation 1.3</b> - <a href="http://livevalidation.com/">http://livevalidation.com/</a>
-
 </li>
 </ul>
+
+
 </div>
 
 </div>
@@ -209,7 +221,7 @@ <h2 id="sec-3"><span class="section-number-2">3</span> Thanks </h2>
 </p>
 <ul>
 <li>
-Rusty Klophaus (@rklophaus)
+Rusty Klophaus (@rustyio)
 </li>
 <li>
 Chris Williams (@voodootikigod)
@@ -261,11 +273,24 @@ <h2 id="sec-3"><span class="section-number-2">3</span> Thanks </h2>
 </li>
 <li>
 Ville Koivula
-
+</li>
+<li>
+Jesse Gumm
+</li>
+<li>
+Andreas Hasselberg 
+</li>
+<li>
+Jonas Adahl
+</li>
+<li>
+Susan Potter
 </li>
 </ul>
 
-<p>Roughly sorted by date of contribution. Send your twitter handles to @rklophaus
+
+<p>
+Roughly sorted by date of contribution. Send your twitter handles to @rustyio or @jessegumm
 </p>
 </div>
 
@@ -278,16 +303,16 @@ <h2 id="sec-4"><span class="section-number-2">4</span> Documentation </h2>
 
 <p>
 This documentation is created using org-mode. To contribute updates
-or corrections, contact Rusty Klophaus (@rklophaus) or fork and
+or corrections, contact Rusty Klophaus (@rustyio) or fork and
 update the code in <a href="http://github.com/nitrogen/nitrogen">http://github.com/nitrogen/nitrogen</a> under the
 <code>./docs/org-mode</code> directory
 </p></div>
 </div>
 <div id="postamble">
 <p class="author"> Author: Rusty Klophaus (@rklophaus)
 </p>
-<p class="date"> Date: 2011-02-01 08:21:50 EST</p>
-<p class="creator">HTML generated by org-mode 7.01h in emacs 24</p>
+<p class="date"> Date: 2011-08-11 07:26:46 CDT</p>
+<p class="creator">HTML generated by org-mode 7.4 in emacs 23</p>
 </div>
 </div>
 </body>

diff --git a/doc/html/actions.html b/doc/html/actions.html
@@ -7,7 +7,7 @@
 <title>Nitrogen 2.x Documentation</title>
 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
 <meta name="generator" content="Org-mode"/>
-<meta name="generated" content="2011-02-01 08:02:43 EST"/>
+<meta name="generated" content="2011-08-11 07:26:24 CDT"/>
 <meta name="author" content="Rusty Klophaus (@rklophaus)"/>
 <meta name="description" content=""/>
 <meta name="keywords" content=""/>
@@ -21,6 +21,9 @@
   .target { }
   .timestamp { color: #bebebe; }
   .timestamp-kwd { color: #5f9ea0; }
+  .right  {margin-left:auto; margin-right:0px;  text-align:right;}
+  .left   {margin-left:0px;  margin-right:auto; text-align:left;}
+  .center {margin-left:auto; margin-right:auto; text-align:center;}
   p.verse { margin-left: 3% }
   pre {
 	border: 1pt solid #AEBDCC;
@@ -31,7 +34,13 @@
         overflow:auto;
   }
   table { border-collapse: collapse; }
-  td, th { vertical-align: top; }
+  td, th { vertical-align: top;  }
+  th.right  { text-align:center;  }
+  th.left   { text-align:center;   }
+  th.center { text-align:center; }
+  td.right  { text-align:right;  }
+  td.left   { text-align:left;   }
+  td.center { text-align:center; }
   dt { font-weight: bold; }
   div.figure { padding: 0.5em; }
   div.figure p { text-align: center; }
@@ -68,6 +77,7 @@
  }
 /*]]>*///-->
 </script>
+
 </head>
 <body>
 <div id="content">
@@ -101,9 +111,10 @@ <h2 id="sec-1"><span class="section-number-2">1</span> Base Action </h2>
 <ul>
 <li>
 <a href="./actions/base.html">Base Action</a> - All actions contain these attributes.
-
 </li>
 </ul>
+
+
 </div>
 
 </div>
@@ -121,9 +132,10 @@ <h2 id="sec-2"><span class="section-number-2">2</span> Page Manipulation </h2>
 </li>
 <li>
 <a href="./actions/validate.html">Validate</a>
-
 </li>
 </ul>
+
+
 </div>
 
 </div>
@@ -159,9 +171,10 @@ <h2 id="sec-3"><span class="section-number-2">3</span> Effects </h2>
 </li>
 <li>
 <a href="./actions/remove_class.html">Remove Class</a>
-
 </li>
 </ul>
+
+
 </div>
 
 </div>
@@ -181,6 +194,7 @@ <h2 id="sec-4"><span class="section-number-2">4</span> Feedback </h2>
 <a href="./actions/other.html">Other</a>
 </li>
 </ul>
+
 </div>
 
 </div>
@@ -194,13 +208,14 @@ <h2 id="sec-5"><span class="section-number-2">5</span> See Also </h2>
 <a href="./paths.html">Nitrogen Element Paths</a>
 </li>
 </ul>
+
 </div>
 </div>
 <div id="postamble">
 <p class="author"> Author: Rusty Klophaus (@rklophaus)
 </p>
-<p class="date"> Date: 2011-02-01 08:02:43 EST</p>
-<p class="creator">HTML generated by org-mode 7.01h in emacs 24</p>
+<p class="date"> Date: 2011-08-11 07:26:24 CDT</p>
+<p class="creator">HTML generated by org-mode 7.4 in emacs 23</p>
 </div>
 </div>
 </body>

diff --git a/doc/html/actions/add_class.html b/doc/html/actions/add_class.html
@@ -7,7 +7,7 @@
 <title>Add Class Action Element</title>
 <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
 <meta name="generator" content="Org-mode"/>
-<meta name="generated" content="2011-02-01 08:02:44 EST"/>
+<meta name="generated" content="2011-08-11 07:26:45 CDT"/>
 <meta name="author" content="Rusty Klophaus (@rklophaus)"/>
 <meta name="description" content=""/>
 <meta name="keywords" content=""/>
@@ -21,6 +21,9 @@
   .target { }
   .timestamp { color: #bebebe; }
   .timestamp-kwd { color: #5f9ea0; }
+  .right  {margin-left:auto; margin-right:0px;  text-align:right;}
+  .left   {margin-left:0px;  margin-right:auto; text-align:left;}
+  .center {margin-left:auto; margin-right:auto; text-align:center;}
   p.verse { margin-left: 3% }
   pre {
 	border: 1pt solid #AEBDCC;
@@ -31,7 +34,13 @@
         overflow:auto;
   }
   table { border-collapse: collapse; }
-  td, th { vertical-align: top; }
+  td, th { vertical-align: top;  }
+  th.right  { text-align:center;  }
+  th.left   { text-align:center;   }
+  th.center { text-align:center; }
+  td.right  { text-align:right;  }
+  td.left   { text-align:left;   }
+  td.center { text-align:center; }
   dt { font-weight: bold; }
   div.figure { padding: 0.5em; }
   div.figure p { text-align: center; }
@@ -68,6 +77,7 @@
  }
 /*]]>*///-->
 </script>
+
 </head>
 <body>
 <div id="content">
@@ -105,7 +115,7 @@ <h3 id="sec-1_1"><span class="section-number-3">1.1</span> Usage </h3>
 
 
 
-<pre class="src src-erlang"><span style="color: #28439B;">wf</span>:<span style="color: #28439B;">wire</span>(myDiv, #<span style="color: #28439B;">add_class</span> { class=selected, speed=1000 })
+<pre class="src src-erlang"><span style="font-weight: bold; text-decoration: underline;">wf</span>:<span style="font-weight: bold; text-decoration: underline;">wire</span>(myDiv, #<span style="font-weight: bold; text-decoration: underline;">add_class</span> { class=selected, speed=1000 })
 </pre>
 
 
@@ -126,9 +136,10 @@ <h3 id="sec-1_2"><span class="section-number-3">1.2</span> Attributes </h3>
 </dd>
 <dt>speed - (<i>integer</i>)</dt><dd>
 Speed of the effect, in milliseconds.
-
 </dd>
 </dl>
+
+
 </div>
 
 </div>
@@ -146,17 +157,17 @@ <h3 id="sec-1_3"><span class="section-number-3">1.3</span> See Also </h3>
 <li>
 <a href="./remove_class.html">Remove Class</a>
 
-
 </li>
 </ul>
+
 </div>
 </div>
 </div>
 <div id="postamble">
 <p class="author"> Author: Rusty Klophaus (@rklophaus)
 </p>
-<p class="date"> Date: 2011-02-01 08:02:44 EST</p>
-<p class="creator">HTML generated by org-mode 7.01h in emacs 24</p>
+<p class="date"> Date: 2011-08-11 07:26:45 CDT</p>
+<p class="creator">HTML generated by org-mode 7.4 in emacs 23</p>
 </div>
 </div>
 </body>