You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@etch.apache.org by fi...@apache.org on 2011/07/29 18:10:06 UTC
svn commit: r1152290 - in /incubator/etch/site/trunk:
content/etch/css/layout.css content/etch/documentation.mdtext
content/etch/getting-started.mdtext content/etch/presentations.mdtext
templates/navigation.mdtext
Author: fitzner
Date: Fri Jul 29 16:10:05 2011
New Revision: 1152290
URL: http://svn.apache.org/viewvc?rev=1152290&view=rev
Log:
ETCH-130 Website update
Added Getting Started and Presentation page
Added link to the documentation of the old website
Removed Manual and FAQ menu entries temporarily due to no content
Modified:
incubator/etch/site/trunk/content/etch/css/layout.css
incubator/etch/site/trunk/content/etch/documentation.mdtext
incubator/etch/site/trunk/content/etch/getting-started.mdtext
incubator/etch/site/trunk/content/etch/presentations.mdtext
incubator/etch/site/trunk/templates/navigation.mdtext
Modified: incubator/etch/site/trunk/content/etch/css/layout.css
URL: http://svn.apache.org/viewvc/incubator/etch/site/trunk/content/etch/css/layout.css?rev=1152290&r1=1152289&r2=1152290&view=diff
==============================================================================
--- incubator/etch/site/trunk/content/etch/css/layout.css (original)
+++ incubator/etch/site/trunk/content/etch/css/layout.css Fri Jul 29 16:10:05 2011
@@ -247,6 +247,7 @@ table {
width:100%;
border:1px solid #bbb;
margin-bottom:10px;
+ font-size:1.2em;
}
col.colC {
width:8em;
@@ -257,7 +258,9 @@ th, td {
}
thead th {
border-bottom:2px solid #888;
- background:#bbb;
+ border:1px solid #3e4f90;
+ background:#3e4f90;
+ color: #fff;
padding:.4em 1em .2em;
}
thead th.table-head {
@@ -265,14 +268,14 @@ thead th.table-head {
font-weight:normal;
text-transform:uppercase;
color:#fff;
- background:#555;
- border:1px solid #555;
+ background:#3e4f90;
+ border:1px solid #bbb;
}
tbody th,
tbody td {
border-top:1px solid #bbb;
border-bottom:1px solid #bbb;
- background:#eee;
+ background:#fff;
}
tbody tr.odd th,
tbody tr.odd td {
Modified: incubator/etch/site/trunk/content/etch/documentation.mdtext
URL: http://svn.apache.org/viewvc/incubator/etch/site/trunk/content/etch/documentation.mdtext?rev=1152290&r1=1152289&r2=1152290&view=diff
==============================================================================
--- incubator/etch/site/trunk/content/etch/documentation.mdtext (original)
+++ incubator/etch/site/trunk/content/etch/documentation.mdtext Fri Jul 29 16:10:05 2011
@@ -1 +1,5 @@
# Documentation
+
+We are currently working on a restructuring and expansion of the Etch documentation. In the meanwhile you can use the existing documentation pages available at [https://cwiki.apache.org/ETCH/documentation.html](https://cwiki.apache.org/ETCH/documentation.html).
+
+
Modified: incubator/etch/site/trunk/content/etch/getting-started.mdtext
URL: http://svn.apache.org/viewvc/incubator/etch/site/trunk/content/etch/getting-started.mdtext?rev=1152290&r1=1152289&r2=1152290&view=diff
==============================================================================
--- incubator/etch/site/trunk/content/etch/getting-started.mdtext (original)
+++ incubator/etch/site/trunk/content/etch/getting-started.mdtext Fri Jul 29 16:10:05 2011
@@ -1,19 +1,149 @@
# Getting Started
-Following steps give you an introduction how to configure, build and work with the Apache Incubator Etch sources. At the the moment we support Windows and Linux builds.
+The following steps give you an introduction how to configure, build and work with the Apache Incubator Etch sources. At the the moment we support Windows and Linux builds.
-1. Preconditions
-2. Get the source code
-3. Build sources
+1. [Preconditions](#Preconditions)
+2. [Get the source code](#getSourceCode)
+3. [Build sources](#buildSources)
+
+After your build of Apache Incubator Etch was successful, you will be able to run the examples in the example directory.
+
+### Preconditions {#Preconditions}
+The tools and libraries mentioned in the following listing must be available on your development machine in order to be able to work with Etch.
+It is a good practice to set up a folder containing the external dependencies of all the bindings you would like to build. This folder will be called <strong>ETCH_EXTERNAL_DEPENDS</strong> later on.
+
+You can use the workspace contents of our continous integration server as a reference
+for your machine:
+
+* Win32: [https://builds.apache.org/job/etch-trunk-windows-x86/ws/externals/](https://builds.apache.org/job/etch-trunk-windows-x86/ws/externals/)
+* Linux: [https://builds.apache.org/job/etch-trunk-linux-x86/ws/externals/](https://builds.apache.org/job/etch-trunk-linux-x86/ws/externals/)
+
+<table style="width:99%;">
+ <thead>
+ <tr>
+ <th>Component</th>
+ <th>Prerequisites and dependencies</th>
+ </tr>
+ </thead>
+ <tbody>
+ <tr>
+ <td style="vertical-align:middle; width:200px">Etch compiler/code generator <br/><b>[mandatory for each binding]</b></td>
+ <td>
+ <ul>
+ <li>Java JDK version 1.5_011 or higher</li>
+ <li>Apache Ant 1.8.2 or higher</li>
+ <li>JavaCC 4.0</li>
+ <li>JUnit 4.3.1</li>
+ <li> Velocity 1.5</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>
+ Binding Java
+ </td>
+ <td>
+ no additional dependencies
+ </td>
+ </tr>
+ <tr>
+ <td>Binding C#</td>
+ <td>
+ <ul>
+ <li>Apache Ant DotNet 1.0</li>
+ <li>.NET Framework 2.0 (Visual Studio 2005)</li>
+ <li>(Mono 1.9 support is experimental)</li>
+ <li>NUnit 2.5.9.10348</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>Binding C</td>
+ <td>
+ <ul>
+ <li>Apache APR 1.3.12</li>
+ <li>Apache APR Util 1.3.12</li>
+ <li>Apache APR iconv</li>
+ <li>Cunit 2.1</li>
+ <li>Apache Ant CMake 1.0 (cmakeant.jar)</li>
+ </ul>
+ </td>
+ </tr>
+ </tbody>
+</table>
+
+
+After the download of all the dependencies mentioned above you should now have the following structure (if you want to compile and build for all language bindings):
+
+ ETCH_EXTERNAL_DEPENDS/
+ javacc/
+ 4.0/
+ javacc.jar
+ junit /
+ 4.3.1/
+ junit-4.3.1.jar
+ nunit/
+ 2.4.7/
+ [contents of nunit 2.4.7 release tgz/zip]
+ 2.5.9.10348/
+ [contents of nunit 2.5.9.10348 release tgz/zip]
+ velocity/
+ 1.5/
+ velocity-dep-1.5.jar
+ apache-ant/
+ 1.8.2/
+ [contents of apache ant 1.8.2 release tgz/zip]
+ apache-ant-cmake/
+ 1.0/
+ cmakeant.jar
+ apache-ant-dotnet/
+ 1.0/
+ [contents of apache ant dotnet 1.0 release tgz/zip]
+ apr/
+ 1.3.2/
+ [apr binary installation, see above]
+ cmake/
+ 2.8.2/
+ [contents of cmake standalone 2.8.2 release tgz/zip]
+ cunit/
+ 2.1/
+ [built cunit version,
+ on linux: you can skip this and use system libraries on your machine, e.g. apt-get install libcunit1 libcunit1-dev
+ on win32: see binding-c/runtime/c/README.txt for instructions on building cunit on Win32]
+ nsis/ (WINDOWS ONLY)
+ 2.23/
+ [skip if you want no installer built, else: contents of nsis 2.23 standalone zip/tgz]
+
+### Get the source code {#getSourceCode}
+You can checkout the source tree by using the following SVN command:
+
+ svn co http://svn.apache.org/repos/asf/incubator/etch/trunk/
+
+If you prefer to use Git you can use git-svn:
+
+ git svn clone http://svn.apache.org/repos/asf/incubator/etch/trunk/
+
+### Build sources {#buildSources}
+As soon as all the required dependencies and the source is available on your machine, you are able to build Etch.
+
+##### Ant Build
+
+1. Open the `scripts/antSetup.bat` (Windows) or `scripts/antSetup.sh` (Linux) with your favourite text editor
+
+2. Check if every environment variable set by the script points to the right location
+
+3. Run the antSetup script to prepare your build environment
+
+ Win32:
+ `scripts/antSetup.bat`
-### Preconditions
-Information about Preconditions
+ Linux:
+ `source scripts/antSetup.sh`
+4. Check the correctness of the paths to the jar archives Etch depends on in the `build.dependencies` file inside the root folder.
-### Get the source code
-Information how to get the source code
+5. Start build by executeing `ant debug` at the shell prompt
+
-### Build sources
-Information how to build the sources
Modified: incubator/etch/site/trunk/content/etch/presentations.mdtext
URL: http://svn.apache.org/viewvc/incubator/etch/site/trunk/content/etch/presentations.mdtext?rev=1152290&r1=1152289&r2=1152290&view=diff
==============================================================================
--- incubator/etch/site/trunk/content/etch/presentations.mdtext (original)
+++ incubator/etch/site/trunk/content/etch/presentations.mdtext Fri Jul 29 16:10:05 2011
@@ -1,2 +1,16 @@
# Presentations
+The Etch middleware has been introduced on several events. Please find the slides and corresponding videos below:
+
+* FOSDEM 2011
+ * Slides at [Slideshare](http://www.slideshare.net/grandyho/apache-etch-introduction-fosdem-2011)
+ * Video at [Youtube](http://www.youtube.com/watch?v=1h76ch2-G-M)
+
+* Cisco Unified Application Environment Developer Conference
+ * Slides can be found [here](http://developer.cisco.com/c/document_library/get_file?groupId=13403&folderId=63902&name=DLFE-8208.pdf)
+ * Video is available [here](http://developer.cisco.com/web/cuae/devconf2008_session_3)
+
+
+
+
+
Modified: incubator/etch/site/trunk/templates/navigation.mdtext
URL: http://svn.apache.org/viewvc/incubator/etch/site/trunk/templates/navigation.mdtext?rev=1152290&r1=1152289&r2=1152290&view=diff
==============================================================================
--- incubator/etch/site/trunk/templates/navigation.mdtext (original)
+++ incubator/etch/site/trunk/templates/navigation.mdtext Fri Jul 29 16:10:05 2011
@@ -18,8 +18,6 @@
# Documentation
- [Overview](documentation.html)
- - [Manual](documentation-manual.html)
- - [FAQ](documentation-faq.html)
- [Presentations](presentations.html)
# Foundation