svn commit: r792496 - /websites/staging/openofficeorg/trunk/content/openofficeorg/website-local.html

[bu...@apache.org]

Author: buildbot
Date: Sun Jul 10 21:41:38 2011
New Revision: 792496

Log:
Staging update by buildbot

Modified:
    websites/staging/openofficeorg/trunk/content/openofficeorg/website-local.html

Modified: websites/staging/openofficeorg/trunk/content/openofficeorg/website-local.html
==============================================================================
--- websites/staging/openofficeorg/trunk/content/openofficeorg/website-local.html (original)
+++ websites/staging/openofficeorg/trunk/content/openofficeorg/website-local.html Sun Jul 10 21:41:38 2011
@@ -79,6 +79,7 @@ repository</a> in your web browser.</p>
 <p>This page gives instructions on doing website development on your local computer.</p>
 <ul>
 <li><a href="#setup">Setup</a> - How to download the OOo project site repos and setup the Apache CMS.</li>
+<li><a href="#directory_layout">Directory Layout</a> - Where to find the content, templates, and scripts.</li>
 <li><a href="#local_development">Local Development</a> - How to build and test locally.</li>
 <li><a href="#submitting_your_results">Submitting Your Results</a> - How to contribute your edits.</li>
 </ul>
@@ -101,20 +102,43 @@ repository</a> in your web browser.</p>
 
 <h3 id="install_python_dependencies">Install Python dependencies.</h3>
 <p>Adapted from the <a href="http://www.apache.org/dev/cmsref.html#local-build">Apache CMS Reference</a></p>
-<p>The easiest easiest way to install the dependencies is to use Python setuptools.
-Check your version of Python</p>
+<p>The easiest way to install the dependencies is to use Python setuptools.</p>
+<h4 id="check_your_version_of_python">Check your version of Python</h4>
 <div class="codehilite"><pre><span class="n">python</span> <span class="o">--</span><span class="n">version</span>
 </pre></div>
 
 
-<p>Follow the installation instructions for <a href="http://pypi.python.org/pypi/setuptools">setuptools</a>.</p>
-<p>Install dependencies</p>
+<h4 id="follow_the_installation_instructions_for_setuptools4">Follow the installation instructions for <a href="http://pypi.python.org/pypi/setuptools">setuptools</a>.</h4>
+<h4 id="install_dependencies">Install dependencies</h4>
 <div class="codehilite"><pre><span class="n">sudo</span> <span class="n">easy_install</span> <span class="n">Pygments</span>
 <span class="n">sudo</span> <span class="n">easy_install</span> <span class="n">ElementTree</span>
 <span class="n">sudo</span> <span class="n">easy_install</span> <span class="n">Markdown</span>
 </pre></div>
 
 
+<h2 id="directory_layout">Directory Layout</h2>
+<h4 id="content_directory">Content directory</h4>
+<p>The <code>site/content/openofficeorg</code> directory contains web content - markdown, html, javascript, css, images and other files. Files that do not fit recognized patterns from <code>site/lib/path.pm</code> are copied as is to the web site during the build.</p>
+<h4 id="templates_directory">Templates directory</h4>
+<p>The <code>site/templates</code> directory contains the html skeletons used during the site build.</p>
+<ul>
+<li><code>skeleton.html</code> - our current html page template.</li>
+<li><code>sidenav.mdtext</code> - markdown of the side navigation panel.</li>
+</ul>
+<h4 id="lib_directory">Lib directory</h4>
+<p>The <code>site/lib</code> directory contains two python modules that determine how content files are processed during the site build.</p>
+<ul>
+<li><code>path.pm</code> - maps file patterns like <code>.mdtext</code> into the view building routines. We can expand to cover other patterns.</li>
+<li><code>view.pm</code> - a set of python subroutines for converting content into web pages.</li>
+</ul>
+<h4 id="build_tools">Build tools</h4>
+<p>You can find the CMS build tools in the <code>cms</code> directory.</p>
+<ul>
+<li><code>cms/build/</code> - perl scripts for building the site and markdown extensions.</li>
+<li><code>cms/conversion-utilities/</code> - scripts used by various projects for conversion including <code>cwiki</code> conversion.</li>
+<li><code>cms/webgui/</code> - the webgui behind the <code>bookmarklet</code>.</li>
+</ul>
+<p>These can be extended locally. Before any changes become part of our process they will need to be cleared with Apache Infrastructure. We'll need to submit patches. These should be additive or be bug fixes.</p>
 <h2 id="local_development">Local Development</h2>
 <h3 id="edit_the_site">Edit the site</h3>
 <p>Using your favorite editors edit the site content, templates, and lib scripts.</p>