You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@esme.apache.org by bu...@apache.org on 2011/06/27 15:55:31 UTC
svn commit: r791676 [8/8] - /websites/staging/esme/trunk/content/
Added: websites/staging/esme/trunk/content/web-ui-help.html
==============================================================================
--- websites/staging/esme/trunk/content/web-ui-help.html (added)
+++ websites/staging/esme/trunk/content/web-ui-help.html Mon Jun 27 13:55:28 2011
@@ -0,0 +1,213 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/css/esme.css" rel="stylesheet" type="text/css">
+ <title>Apache ESME - Web UI Help</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/images/esme-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <img alt="Apache ESME" width="220" height="101" src="/images/esme-logo/esme-powerd.gif"/>
+ <h1 id="esme_links">ESME links</h1>
+<ul>
+<li><a href="/index.html">Home</a></li>
+<li><a href="/team.html">Project Team</a></li>
+<li><a href="/docs/buildfromSVN.html">Building ESME</a></li>
+<li><a href="/docs/faq.html">FAQ</a></li>
+<li><a href="/docs/actions.html">Actions</a></li>
+<li><a href="/docs/apis.html">APIs</a></li>
+<li><a href="/docs/clients.html">Clients</a></li>
+<li><a href="/docs/collaboration.html">Collaboration</a></li>
+<li><a href="/docs/install.html">Installation Guides</a></li>
+<li><a href="/docs/yql.html">YQL</a><br />
+</li>
+</ul>
+<h1 id="asf_links">ASF links</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Web UI Help</h1>
+ <p><a name="WebUIHelp-Login"></a></p>
+<h4 id="login">Login</h4>
+<p>In the current version, you need an OpenID to login into ESME. You get your
+OpenID either via external OpenID providers or internal OpenID providers.</p>
+<p><a name="WebUIHelp-MainUI:MessageBox"></a></p>
+<h4 id="main_ui_message_box">Main UI: Message Box</h4>
+<p>Here you can enter the message that you wish to send. If you use "@" then
+the mesage will be automaically sent to the that person's personal timeline
+(as long as they are following you). You can also enter URLs in this
+message and the URLs will be shortened automatically.</p>
+<p><em>BUG: Currently, the current version of the Web UI doesn't shorten the
+URLs. Since there is no limit to the message length, shortening of URLs
+isn't critical"</em></p>
+<p>h14. Main UI: Tags</p>
+<p>Here you can enter tags for your messages. Please separate your tags with
+commas. Tags are not required.</p>
+<p>This is optional but assists during searches for information.</p>
+<p><a name="WebUIHelp-MainUI:TagCloud"></a></p>
+<h4 id="main_ui_tag_cloud">Main UI: Tag Cloud</h4>
+<p>The tag cloud shows which tags are currently the most heavily used. The
+larger the tag, the more often it has been used.</p>
+<p>If you click on a tag, you are taken to a page where recent posts using
+this tag are displayed</p>
+<p><a name="WebUIHelp-MainUI:WordCloud"></a></p>
+<h4 id="main_ui_word_cloud">Main UI: Word Cloud</h4>
+<p>The tag cloud shows which words are currently the most heavily used. The
+larger the word, the more often it has been used.</p>
+<p>If you click on a word, you are taken to a page where recent posts using
+this worsdare displayed</p>
+<p><a name="WebUIHelp-MainUI:Search"></a></p>
+<h4 id="main_ui_search">Main UI: Search</h4>
+<p>Search allows you to search for words in messages. A new screen is
+displayed with all messages with words that meet the search term.</p>
+<p><em>Note: Words not tags are searched</em></p>
+<p><a name="WebUIHelp-MainUI:Tabs"></a></p>
+<h4 id="main_ui_tabs">Main UI: Tabs</h4>
+<p><a name="WebUIHelp-Messages"></a></p>
+<h5 id="messages">Messages</h5>
+<p>This a list of messages that you have created and from those people who are
+following. If you click on the user name in this message area, you will be
+sent to that user's page where you can all the most recent messages that
+they have created. If a message has tags assocaited with it, then these
+tags are on the left hand side of the message. The date under the message
+is associated with when the message was created.</p>
+<p>By clicking on the tags, you can see recent messages which have been tagged
+with this particular tag.</p>
+<p>If you click on "reply", then you can create a message in response and join
+in the conversation.</p>
+<p>If you click on "conversation", you will see a page with all messages that
+were part of this conversation.</p>
+<p><em>BUG: In the current UI, if you click on "reply" the user identifier
+"@User" is not auotmatically added to message. You must do this manually.</em></p>
+<p><em>BUG: In the current UI, it is not possible to look at older messages. If
+you wish to look at older messages, then you must use the search
+functionality.</em></p>
+<p><em>BUG: In the current UI, the window width is displayed incorrectly, when
+longer URLs are displayed.</em></p>
+<p><a name="WebUIHelp-Timeline"></a></p>
+<h5 id="timeline">Timeline</h5>
+<p>This is the public timeline with all messages that have been sent on ESME.
+There are also messages from people whom you don't follow.</p>
+<p>If you see messages from individuals whose messages are of interest, you
+can click on the name and are sent to a page displaying the user' messages</p>
+<p>The functionality is the same as that of the <em>Messages</em> Tab.</p>
+<p><a name="WebUIHelp-Contacts"></a></p>
+<h5 id="contacts">Contacts</h5>
+<p>This tab shows two lists. Those individuals who are following you and those
+individuals who you are following. By clicking on user, you can go to
+that's page and see his/her most recent messages.</p>
+<p><a name="WebUIHelp-MainUI:ContactsPage"></a></p>
+<h4 id="main_ui_contacts_page">Main UI: Contacts Page</h4>
+<p>Here you can see the messages from a particular user. Click on the
+"Messages" tab to see recent messages from this user.</p>
+<p>You can click on "follow" to receive messages from this user in your
+personal timeline.</p>
+<p>If you are already following a user, you can click on "unfollow" to no
+longer receive messages from this user in your personal timeline.</p>
+<p><a name="WebUIHelp-MainUI:UpperRightHandMenus"></a></p>
+<h4 id="main_ui_upper_right_hand_menus">Main UI: Upper Right Hand Menus</h4>
+<p><a name="WebUIHelp-Profile"></a></p>
+<h5 id="profile">Profile</h5>
+<p>This screen allows you to change the details regarding your user.
+Currently, the following attributes are editable:
+<em> Nickname: This is the name that appears on your your messages
+</em> First Name: First Name
+<em> Last Name: Last Name
+</em> imageurl : This is the URL to the image that will appear next to your
+messages. <em>Make sure you use a valid URL for your image URL</em>
+<em> timezone : select the timezone ich which are you located
+</em> Locale: In what langauge to which to see the UI. <em>Note: This currently
+has no effect.</em></p>
+<p>Select "Edit" or "Messages" to return to the messages</p>
+<p><a name="WebUIHelp-About"></a></p>
+<h5 id="about">About</h5>
+<p>This screen provides you with background details about ESME.</p>
+<p><a name="WebUIHelp-ManageTokens"></a></p>
+<h5 id="manage_tokens">Manage Tokens</h5>
+<p>One of the advantges with ESME is that you can use various clients to
+integrate with the application. In order for you to access ESME via the
+REST API, you need to create a token. This screen allows you to create and
+revoke tokens for these applications.</p>
+<p>Select a name for your token and then create your token with "Add". You may
+also revoke tokens that you have already created by clicking the "Revoke"
+button.</p>
+<p>Via <em>Cut and Paste</em>, you are able to paste the created tokens into your
+client applications (for example, the ESMEDesktop)</p>
+<p>You may create as many tokens as you wish.</p>
+<p><a name="WebUIHelp-Logout"></a></p>
+<h5 id="logout">Logout</h5>
+<p>This link logs you out of the application. The next time you start the
+application you must login again.</p>
+<p><a name="WebUIHelp-MainUI:LowerLeftHandMenus"></a></p>
+<h4 id="main_ui_lower_left_hand_menus">Main UI: Lower Left Hand Menus</h4>
+<p><a name="WebUIHelp-Listusers"></a></p>
+<h4 id="list_users">List users</h4>
+<p>This screen depicts all users that are currently stored in the system. You
+can click on a user to see his/her messages</p>
+<p><a name="WebUIHelp-ItemTracking"></a></p>
+<h4 id="item_tracking">Item Tracking</h4>
+<p>When using ESME, you see messages that are currently being created. With
+"Tracks", you have the ability to search for older messages.</p>
+<p><a name="WebUIHelp-ActionManagement"></a></p>
+<h4 id="action_management">Action Management</h4>
+<p>Actions allow individual users to influence message handling in ESME.
+Usually, users just receive messages. What if they wish to view only
+certain types of messages or must receive emails when certain messages have
+particular tags. ESME actions allow for this functionality.</p>
+<p>Actions are to be distinguished from tracks in that tracks are based on the
+primitive searches of message contents (including tags). Tracks just
+provide another perspective on existing timelines. This is obvious in the
+ESME Desktop client where each search creates a new track and a new window
+to display the contents in a new panel.</p>
+<p>Regarding actions, there are certain steps that must be taken.
+1. Name your action. This step enables a user to create a unique name that
+allows you to ascertain what the action does.
+1. Set for your filter: This step determines which messages will be selected
+for the action.
+1. Set your action: This determines what should happen with those messages
+meeting the filter criterion.</p>
+<p>It is also possible to enable, disable and delete actions. Thus, you may
+have action that you've created but currently do not what to use. You can
+disable the action and use this later.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, ESME and the Apache feather and ESME logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/esme/trunk/content/windows-vista-installation-guide.cwiki
==============================================================================
--- websites/staging/esme/trunk/content/windows-vista-installation-guide.cwiki (added)
+++ websites/staging/esme/trunk/content/windows-vista-installation-guide.cwiki Mon Jun 27 13:55:28 2011
@@ -0,0 +1,51 @@
+{info:title=Useful Information}
+This setup instruction is mainly based on Windows (Vista) & Apache Tomcat (version 6.0.18).
+You will find the complete "Installation & Deployment Guide" attatched to this page.
+{info}
+
+h2. Installation of Java
+
+# You need a current installation of a Java Runtime Environment (JRE) on your machine; I used version 1.6.0_07-b06, which works well. You can get the Java binary from http://java.sun.com/javase.
+# Your setup is successful, when you can afterwards open a commandline (-->start menu --> execute or search for "cmd.exe" ), issue a "java -version" command and see an output similar to the following:
+
+
+h2. Installation of Apache Tomcat
+
+# Download the current Apache Tomcat binary from http://tomcat.apache.org/download-60.cgi.
+# The best option on the Windows Platform is the Windows Service Installer. Download it and execute the installer.
+# You can follow the recommended install parameters: the only exception is the installation path: Tomcat recommends (along with MS-Windows settings) to be installed in c:\Program Files\Apache\... As this path includes spaces, some Java programs and configuration files have trouble starting files with path information (with spaces included): it is more safe (and better to keep the overview) to use an own folder high in the drive hierarchy without spaces. (e.g. take something like d:\tomcat_60)
+# Tomcat recommends the port 8080 for development needs: however if port 80 is not used otherwise, you will have less trouble (e.g. related to firewall issues), when you use port 80 for your deployment.(Another reason for port 80 is that browsers by default use port 80, for any other port setting the user needs to be aware of the fact, as he/she has to include this in the URL.)
+# Your setup is successful, when you can reach afterwards the following page:
+
+{note:title=Be Careful}For all further examples I assume Tomcat to be installed in d:\tomcat_60.{note}
+
+h2. Deployment of the ESME Application
+
+* You can either build the current version directly from the source code repository (SVN)or setup the application from existing (but outdated) binary packages.
+
+* Steps to deploy the current SVN version
+*# Make sure, that you have a working installation of the Apache Maven tool (at [http://maven.apache.org/]). You can test this by issuing a "mvn --version" command on a command line.
+*# Get the source of the ESME application with any subv ersion (SVN)-compatilbe client: [Wikipedia|http://en.wikipedia.org/wiki/Comparison_of_Subversion_clients] has a list with many clients and their features.
+*# Issue a "svn checkout http://svn.apache.org/repos/asf/incubator/esme" command (preferably in an own directory).
+*# Issue a "mvn install" in the directory, where you stored the SVN files. This creates a esme*.war file (most likely in the "target"-subdirectory).
+
+* Steps to implement the precompiled binary packages
+*# Download the binary files from Google code page (at [http://code.google.com/p/esmeproject/downloads/list]).
+*# You will see the following list:
+*For hosting an ESME pilot or for the testing, the last three files are needed: Download them with a right mouse click to a temporary folder on your computer.
+*# For deployment you need to the contents of the WAR-file and the two jar-files to the right locations. For this to work, you have to stop the Apache Tomcat service via the service console.
+*# Create a directory called esme under d:\tomcat_60\webapps.(I recommend not to take over the naming of the WAR file - with the complete date, as this requires the later user to remember also the ESME build date)-
+*# Extract the content of the WAR file to d:\tomcat_60\webapps\esme.
+*# Now take the the two other Jar-files from your download (lift*.jar and scala*.jar) and put them to d:\tomcat_60\webapps\esme\WEB-INF\lib.
+
+# You are now ready to start the tomcat server (via the service console) and to see your application running.
+# Open your browser, and enter the following link: http://localhost:8080/esme.
+
+Your setup was successful, when you can see a similar screen:
+From now on you can enter the ESME world and try out everything.
+
+h2. Further options for ESME deployment
+As I also need to figure out further options for deployment, I just list my ideas here (knowing that these partly need further descriptions).
+* Enabling HTTPS-Encryption on Tomcat (--> http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html) Even some intranets require this nowadays.
+
+
Added: websites/staging/esme/trunk/content/windows-vista-installation-guide.html
==============================================================================
--- websites/staging/esme/trunk/content/windows-vista-installation-guide.html (added)
+++ websites/staging/esme/trunk/content/windows-vista-installation-guide.html Mon Jun 27 13:55:28 2011
@@ -0,0 +1,168 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/css/esme.css" rel="stylesheet" type="text/css">
+ <title>Apache ESME - Windows Vista Installation Guide</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/images/esme-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <img alt="Apache ESME" width="220" height="101" src="/images/esme-logo/esme-powerd.gif"/>
+ <h1 id="esme_links">ESME links</h1>
+<ul>
+<li><a href="/index.html">Home</a></li>
+<li><a href="/team.html">Project Team</a></li>
+<li><a href="/docs/buildfromSVN.html">Building ESME</a></li>
+<li><a href="/docs/faq.html">FAQ</a></li>
+<li><a href="/docs/actions.html">Actions</a></li>
+<li><a href="/docs/apis.html">APIs</a></li>
+<li><a href="/docs/clients.html">Clients</a></li>
+<li><a href="/docs/collaboration.html">Collaboration</a></li>
+<li><a href="/docs/install.html">Installation Guides</a></li>
+<li><a href="/docs/yql.html">YQL</a><br />
+</li>
+</ul>
+<h1 id="asf_links">ASF links</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Windows Vista Installation Guide</h1>
+ <p>{info:title=Useful Information}
+This setup instruction is mainly based on Windows (Vista) & Apache Tomcat
+(version 6.0.18).
+You will find the complete "Installation & Deployment Guide" attatched to
+this page.
+{info}</p>
+<p><a name="WindowsVistaInstallationGuide-InstallationofJava"></a></p>
+<h2 id="installation_of_java">Installation of Java</h2>
+<ol>
+<li>You need a current installation of a Java Runtime Environment (JRE) on
+your machine; I used version 1.6.0_07-b06, which works well. You can get
+the Java binary from http://java.sun.com/javase.</li>
+<li>Your setup is successful, when you can afterwards open a commandline
+(-->start menu --> execute or search for "cmd.exe" ), issue a "java
+-version" command and see an output similar to the following:</li>
+</ol>
+<p><a name="WindowsVistaInstallationGuide-InstallationofApacheTomcat"></a></p>
+<h2 id="installation_of_apache_tomcat">Installation of Apache Tomcat</h2>
+<ol>
+<li>Download the current Apache Tomcat binary from
+http://tomcat.apache.org/download-60.cgi.</li>
+<li>The best option on the Windows Platform is the Windows Service Installer.
+Download it and execute the installer.</li>
+<li>You can follow the recommended install parameters: the only exception is
+the installation path: Tomcat recommends (along with MS-Windows settings)
+to be installed in c:Program FilesApache... As this path includes
+spaces, some Java programs and configuration files have trouble starting
+files with path information (with spaces included): it is more safe (and
+better to keep the overview) to use an own folder high in the drive
+hierarchy without spaces. (e.g. take something like d:tomcat_60)</li>
+<li>Tomcat recommends the port 8080 for development needs: however if port 80
+is not used otherwise, you will have less trouble (e.g. related to firewall
+issues), when you use port 80 for your deployment.(Another reason for port
+80 is that browsers by default use port 80, for any other port setting the
+user needs to be aware of the fact, as he/she has to include this in the
+URL.)</li>
+<li>Your setup is successful, when you can reach afterwards the following
+page:</li>
+</ol>
+<p>{note:title=Be Careful}For all further examples I assume Tomcat to be
+installed in d:tomcat_60.{note}</p>
+<p><a name="WindowsVistaInstallationGuide-DeploymentoftheESMEApplication"></a></p>
+<h2 id="deployment_of_the_esme_application">Deployment of the ESME Application</h2>
+<ul>
+<li>
+<p>You can either build the current version directly from the source code
+repository (SVN)or setup the application from existing (but outdated)
+binary packages.</p>
+</li>
+<li>
+<p>Steps to deploy the current SVN version
+<em># Make sure, that you have a working installation of the Apache Maven tool
+(at <a href="http://maven.apache.org/">http://maven.apache.org/</a>
+). You can test this by issuing a "mvn --version" command on a command
+line.
+</em># Get the source of the ESME application with any subv ersion
+(SVN)-compatilbe client: <a href="http://en.wikipedia.org/wiki/Comparison_of_Subversion_clients">Wikipedia</a>
+ has a list with many clients and their features.
+<em># Issue a "svn checkout http://svn.apache.org/repos/asf/incubator/esme"
+command (preferably in an own directory).
+</em># Issue a "mvn install" in the directory, where you stored the SVN files.
+This creates a esme*.war file (most likely in the "target"-subdirectory).</p>
+</li>
+<li>
+<p>Steps to implement the precompiled binary packages
+<em># Download the binary files from Google code page (at <a href="http://code.google.com/p/esmeproject/downloads/list">http://code.google.com/p/esmeproject/downloads/list</a>
+).
+</em># You will see the following list:
+<em>For hosting an ESME pilot or for the testing, the last three files are
+needed: Download them with a right mouse click to a temporary folder on
+your computer.
+</em># For deployment you need to the contents of the WAR-file and the two
+jar-files to the right locations. For this to work, you have to stop the
+Apache Tomcat service via the service console.
+<em># Create a directory called esme under d:tomcat_60webapps.(I recommend
+not to take over the naming of the WAR file - with the complete date, as
+this requires the later user to remember also the ESME build date)-
+</em># Extract the content of the WAR file to d:tomcat_60webappsesme.
+<em># Now take the the two other Jar-files from your download (lift</em>.jar and
+scala*.jar) and put them to d:tomcat_60webappsesmeWEB-INFlib.</p>
+</li>
+<li>
+<p>You are now ready to start the tomcat server (via the service console)
+and to see your application running.</p>
+</li>
+<li>Open your browser, and enter the following link:
+http://localhost:8080/esme.</li>
+</ul>
+<p>Your setup was successful, when you can see a similar screen:
+From now on you can enter the ESME world and try out everything.</p>
+<p><a name="WindowsVistaInstallationGuide-FurtheroptionsforESMEdeployment"></a></p>
+<h2 id="further_options_for_esme_deployment">Further options for ESME deployment</h2>
+<p>As I also need to figure out further options for deployment, I just list my
+ideas here (knowing that these partly need further descriptions).
+* Enabling HTTPS-Encryption on Tomcat (-->
+http://tomcat.apache.org/tomcat-6.0-doc/ssl-howto.html) Even some intranets
+require this nowadays.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, ESME and the Apache feather and ESME logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/esme/trunk/content/windows-xp-installation-guide-(revision-885445).cwiki
==============================================================================
--- websites/staging/esme/trunk/content/windows-xp-installation-guide-(revision-885445).cwiki (added)
+++ websites/staging/esme/trunk/content/windows-xp-installation-guide-(revision-885445).cwiki Mon Jun 27 13:55:28 2011
@@ -0,0 +1,94 @@
+{info:title=Useful Information}This setup instruction is mainly based on Windows XP & Apache Tomcat.
+You will find the complete "ESME Windows Installation Guide for Dummies" attatched to this page.
+{info}
+
+h2. JRE6
+
+Get the latest JRE 6 from Sun: [http://java.sun.com/javase/downloads/index.jsp]
+Follow the installation instructions
+Check if the JAVA_HOME environment variable is set correctly
+* Start > Control Panel > System > Advanced > Environment Variables
+* Under "System variables" you should see a JAVA_HOME entry
+** If there is such a variable click on "Edit" and check if the path lead to the corresponding JRE 6 path (e.g. C:\Program Files\Java\jre6)
+** If the variable is missing click on "New", set the "Variable name" to JAVA_HOME and the "Variable value" to the right path (e.g. C:\Program Files\Java\jre6)
+
+In case you have a proxy for your internet connection you should check the Java network settings
+* Start > Control Panel > Java > Network settings
+* If the default setting is not correct (use browser settings) enter your proxy settings directly
+
+
+
+h2. Apache Tomcat
+
+Get the latest Tomcat release: [http://tomcat.apache.org/download-55.cgi] (the "Windows Service Installer" is the best choice), install and start it. Remember your port number.
+During the installation procedure you can take the default (*port 8080*) or *port 80*.
+
+
+h2. Maven
+
+Get the latest Maven release: [http://maven.apache.org/download.html]
+Unzip the file on your machine (preferably with no blanks in the path name, e.g. c:\maven)
+Some environment variables need to be set.
+* Start > Control Panel > System > Advanced > Environment Variables
+* Add the following system variables with the corresponding values
+* Variable: M2_HOME Value: <path you've unzipped maven> (e.g. c:\maven)
+* Variable: M2 Value: %M2_HOME%\bin
+* Variable: MAVEN_OPTS Value: \-Xms256m \-Xmx512m
+
+In case you have a proxy for your internet connection you need to change the settings.xml file in the conf directory.
+{quote}
+<proxies>
+ <proxy>
+ <active>true</active>
+ <protocol>http</protocol>
+ <host>proxy</host>
+ <port>8080</port>
+ </proxy>
+ </proxies>
+{quote}
+On windows, the file can be found at C:\Documents and Settings\<user>\.m2
+
+
+h2. Get the ESME source
+
+Get the latest source at [http://svn.apache.org/repos/asf/incubator/esme/trunk/site/build/site/en/download/download.html]
+Be aware that the source code might have errors/bugs. Therefore you can try out the following revisions that I've tried out and build successfully:
+* Rev. 885445
+
+Ideally you should have a subversion client installed on your machine (e.g. Tortoise SVN: [http://tortoisesvn.net/downloads]).
+
+The next steps describe how you can download the code with the Tortoise svn client:
+
+* In case you have a proxy for your internet connection you need to change the Tortoise SVN settings. After changing click on "OK".
+\\
+\\ !TortoiseSettings.png|align=left!\\ !TortoiseProxy.png|align=left!\\
+\\
+* Start the checkout with the SVN client (right-click mouse on an empty directory).
+\\ !SVNCheckout.png|align=left!\\
+\\
+* Enter the URL to the ESME repository. In case you want to have the most current sources select "HEAD revision". If you want to be on the safe side take one of the revisions listed above.
+\\
+\\ !SvnUrl.png|align=left!\\
+\\
+* After clicking "OK" the code should start downloading.
+
+
+h2. Building ESME
+
+Start the command line: press the <windows > and <R> key.
+Change to the trunk\server directory of the downloaded ESME code (with *cd xxxxx*).
+Start the build with *mvn install*.
+If no errors appeared you can find a .WAR file in the trunk\server\target directory.
+
+
+h2. Deploying ESME
+
+Ensure that the Tomcat service is running.
+Take the .war file and rename it to esme.war.
+Copy the file to the tomcat webapps directory (e.g. C:\tomcat60\webapps). Tomcat will expand the war file automatically.
+Now you've deployed ESME on the tomcat server.
+
+
+h2. Starting ESME
+
+Go to your browser and call the address [http://localhost:<tomcat port you've selected>/esme]
\ No newline at end of file
Added: websites/staging/esme/trunk/content/yql.cwiki
==============================================================================
--- websites/staging/esme/trunk/content/yql.cwiki (added)
+++ websites/staging/esme/trunk/content/yql.cwiki Mon Jun 27 13:55:28 2011
@@ -0,0 +1,22 @@
+This is a heads up that the [YQL|http://developer.yahoo.com/yql/] wrapper for the ESME API is starting to take shape. The structure of the YQL abstraction mirrors the conceptual [API design on the cwiki|http://cwiki.apache.org/confluence/display/ESME/API+2.0+-+Design] wherever possible
+The Open data tables definitions are available at [http://github.com/esjewett/yql-tables/tree/master|http://github.com/esjewett/yql-tables/tree/master] under the "esme" folder.
+To quickly get it working, take the following steps:
+# Set up a token on the Stax deployment at [http://esmecloudserverapache.dickhirsch.staxapps.net/|http://esmecloudserverapache.dickhirsch.staxapps.net/]
+# Go to the YQL console at [http://developer.yahoo.com/yql/console/|http://developer.yahoo.com/yql/console/]
+# Paste the following into the console to set up a session where "token_value" is your token:
+use "[http://github.com/esjewett/yql-tables/raw/9a9071d92ad6d7b6908703c05acbf3cb3e5ea45b/esme/esme.sessions.xml|http://github.com/esjewett/yql-tables/raw/9a9071d92ad6d7b6908703c05acbf3cb3e5ea45b/esme/esme.sessions.xml]";
+insert into esme.sessions (esme_api_endpoint,token) VALUES ("[http://esmecloudserverapache.dickhirsch.staxapps.net/api/|http://esmecloudserverapache.dickhirsch.staxapps.net/api/]","token_value")
+# Copy the session cookie out of the result. It looks something like the following and is between XML tags "<set-cookie>" and "</set-cookie>".
+JSESSIONID=BF04121669016B36B6FD9; Path=/
+# Paste the following into the console to grab a list of all messages, replacing "cookie_value" with the session cookie you copied in step 4:
+use "[http://github.com/esjewett/yql-tables/raw/9a9071d92ad6d7b6908703c05acbf3cb3e5ea45b/esme/esme.messages.xml|http://github.com/esjewett/yql-tables/raw/9a9071d92ad6d7b6908703c05acbf3cb3e5ea45b/esme/esme.messages.xml]";
+select * from esme.messages WHERE
+esme_api_endpoint="[http://esmecloudserverapache.dickhirsch.staxapps.net/api|http://esmecloudserverapache.dickhirsch.staxapps.net/api]"
+AND cookie="cookie_value"
+
+*Some notes:*
+# This will work with any API endpoint.
+# The open data table files contain examples of all functions. It supports setting and destroying sessions, listing and sending message, listing all users, listing followers, listing followed, and following.
+# Unfollowing is mysteriously not working (it is timing out after 30000 ms). I'd love it if someone knew why this was happening, but otherwise I'll investigate further myself.
+# I'll be adding other API functions as I am able.
+# This is more of a conceptual exercise than anything else. I don't anticipate that it will significantly increase the usability of the API for developers, but it does expose a sort of command-line access to the API to more casual developers.
\ No newline at end of file
Added: websites/staging/esme/trunk/content/yql.html
==============================================================================
--- websites/staging/esme/trunk/content/yql.html (added)
+++ websites/staging/esme/trunk/content/yql.html Mon Jun 27 13:55:28 2011
@@ -0,0 +1,110 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/css/esme.css" rel="stylesheet" type="text/css">
+ <title>Apache ESME - YQL</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/images/esme-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <img alt="Apache ESME" width="220" height="101" src="/images/esme-logo/esme-powerd.gif"/>
+ <h1 id="esme_links">ESME links</h1>
+<ul>
+<li><a href="/index.html">Home</a></li>
+<li><a href="/team.html">Project Team</a></li>
+<li><a href="/docs/buildfromSVN.html">Building ESME</a></li>
+<li><a href="/docs/faq.html">FAQ</a></li>
+<li><a href="/docs/actions.html">Actions</a></li>
+<li><a href="/docs/apis.html">APIs</a></li>
+<li><a href="/docs/clients.html">Clients</a></li>
+<li><a href="/docs/collaboration.html">Collaboration</a></li>
+<li><a href="/docs/install.html">Installation Guides</a></li>
+<li><a href="/docs/yql.html">YQL</a><br />
+</li>
+</ul>
+<h1 id="asf_links">ASF links</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">YQL</h1>
+ <p>This is a heads up that the <a href="http://developer.yahoo.com/yql/">YQL</a>
+ wrapper for the ESME API is starting to take shape. The structure of
+the YQL abstraction mirrors the conceptual [API design on the cwiki|http://cwiki.apache.org/confluence/display/ESME/API+2.0+-+Design]
+ wherever possible
+The Open data tables definitions are available at <a href="http://github.com/esjewett/yql-tables/tree/master">http://github.com/esjewett/yql-tables/tree/master</a>
+ under the "esme" folder.
+To quickly get it working, take the following steps:
+1. Set up a token on the Stax deployment at <a href="http://esmecloudserverapache.dickhirsch.staxapps.net/">http://esmecloudserverapache.dickhirsch.staxapps.net/</a>
+1. Go to the YQL console at <a href="http://developer.yahoo.com/yql/console/">http://developer.yahoo.com/yql/console/</a>
+1. Paste the following into the console to set up a session where
+"token_value" is your token:
+use "<a href="http://github.com/esjewett/yql-tables/raw/9a9071d92ad6d7b6908703c05acbf3cb3e5ea45b/esme/esme.sessions.xml">http://github.com/esjewett/yql-tables/raw/9a9071d92ad6d7b6908703c05acbf3cb3e5ea45b/esme/esme.sessions.xml</a>
+";
+insert into esme.sessions (esme_api_endpoint,token) VALUES ("<a href="http://esmecloudserverapache.dickhirsch.staxapps.net/api/">http://esmecloudserverapache.dickhirsch.staxapps.net/api/</a>
+","token_value")
+1. Copy the session cookie out of the result. It looks something like the
+following and is between XML tags "<set-cookie>" and "</set-cookie>".
+JSESSIONID=BF04121669016B36B6FD9; Path=/
+1. Paste the following into the console to grab a list of all messages,
+replacing "cookie_value" with the session cookie you copied in step 4:
+use "<a href="http://github.com/esjewett/yql-tables/raw/9a9071d92ad6d7b6908703c05acbf3cb3e5ea45b/esme/esme.messages.xml">http://github.com/esjewett/yql-tables/raw/9a9071d92ad6d7b6908703c05acbf3cb3e5ea45b/esme/esme.messages.xml</a>
+";
+select * from esme.messages WHERE
+esme_api_endpoint="<a href="http://esmecloudserverapache.dickhirsch.staxapps.net/api">http://esmecloudserverapache.dickhirsch.staxapps.net/api</a>
+"
+AND cookie="cookie_value"</p>
+<p><em>Some notes:</em>
+1. This will work with any API endpoint.
+1. The open data table files contain examples of all functions. It supports
+setting and destroying sessions, listing and sending message, listing all
+users, listing followers, listing followed, and following.
+1. Unfollowing is mysteriously not working (it is timing out after 30000
+ms). I'd love it if someone knew why this was happening, but otherwise I'll
+investigate further myself.
+1. I'll be adding other API functions as I am able.
+1. This is more of a conceptual exercise than anything else. I don't
+anticipate that it will significantly increase the usability of the API for
+developers, but it does expose a sort of command-line access to the API to
+more casual developers.</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, ESME and the Apache feather and ESME logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>
Added: websites/staging/esme/trunk/content/zoho-creator.cwiki
==============================================================================
--- websites/staging/esme/trunk/content/zoho-creator.cwiki (added)
+++ websites/staging/esme/trunk/content/zoho-creator.cwiki Mon Jun 27 13:55:28 2011
@@ -0,0 +1,22 @@
+We have created a [Zoho Creator|http://www.zoho.com/creator/] application that creates Apache ESME messages. [The application|http://creator.zoho.com/richardhirsch/esmeclient4zoho/#Form:SendMessage] includes a very rudimentary UI to create the message.
+
+Note: Please remember that currently, the information entered in the form is also be stored in the internal application database so that anyone can see the tokens that are being used. It would be pretty easy to add a small routine to the script to delete the data after it has been sent to Apache ESME.
+
+
+!zohocreator11.jpg|border=1!
+
+
+The code to create the Apache ESME message is very simple and is linked to the submit button.
+
+ MyMap = map(); Response = postUrl(âhttp://api.esme.us/esme/api/login?token=â + input.Token, MyMap);
+
+ Response = postUrl(âhttp://api.esme.us/esme/api/send_msg?message=â + input.Message + â&tags=â + input.Tags + â&via=zohoâ, MyMap);
+
+ Response = getUrl(âhttp://api.esme.us/esme/api/logoutâ);
+
+What is cool is that there is also the possibility to use the âout-of-the-boxâ functionality of ZohoCreator applications to import information from Excel to fill internal database tables. Thus, you can rapidly create a series of Apache ESME messages.
+
+
+!zohocreator22.jpg|border=1!
+
+
Added: websites/staging/esme/trunk/content/zoho-creator.html
==============================================================================
--- websites/staging/esme/trunk/content/zoho-creator.html (added)
+++ websites/staging/esme/trunk/content/zoho-creator.html Mon Jun 27 13:55:28 2011
@@ -0,0 +1,103 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<html>
+<head>
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE- 2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+ <link href="/css/esme.css" rel="stylesheet" type="text/css">
+ <title>Apache ESME - Zoho Creator</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
+ <link rel="icon" type="image/png" href="/images/esme-logo/stanbol-favicon.png"/>
+</head>
+
+<body>
+ <div id="navigation">
+ <img alt="Apache ESME" width="220" height="101" src="/images/esme-logo/esme-powerd.gif"/>
+ <h1 id="esme_links">ESME links</h1>
+<ul>
+<li><a href="/index.html">Home</a></li>
+<li><a href="/team.html">Project Team</a></li>
+<li><a href="/docs/buildfromSVN.html">Building ESME</a></li>
+<li><a href="/docs/faq.html">FAQ</a></li>
+<li><a href="/docs/actions.html">Actions</a></li>
+<li><a href="/docs/apis.html">APIs</a></li>
+<li><a href="/docs/clients.html">Clients</a></li>
+<li><a href="/docs/collaboration.html">Collaboration</a></li>
+<li><a href="/docs/install.html">Installation Guides</a></li>
+<li><a href="/docs/yql.html">YQL</a><br />
+</li>
+</ul>
+<h1 id="asf_links">ASF links</h1>
+<ul>
+<li><a href="http://www.apache.org">Apache Software Foundation</a></li>
+<li><a href="http://www.apache.org/licenses/LICENSE-2.0">License</a></li>
+<li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li>
+<li><a href="http://www.apache.org/foundation/sponsorship.html">Become a Sponsor</a></li>
+<li><a href="http://www.apache.org/security/">Security</a></li>
+</ul>
+ </div>
+
+ <div id="content">
+ <h1 class="title">Zoho Creator</h1>
+ <p>We have created a <a href="http://www.zoho.com/creator/">Zoho Creator</a>
+ application that creates Apache ESME messages. [The application|http://creator.zoho.com/richardhirsch/esmeclient4zoho/#Form:SendMessage]
+ includes a very rudimentary UI to create the message. </p>
+<p>Note: Please remember that currently, the information entered in the form
+is also be stored in the internal application database so that anyone can
+see the tokens that are being used. It would be pretty easy to add a small
+routine to the script to delete the data after it has been sent to Apache
+ESME.</p>
+<p>!zohocreator11.jpg|border=1!</p>
+<p>The code to create the Apache ESME message is very simple and is linked to
+the submit button.</p>
+<div class="codehilite"><pre><span class="n">MyMap</span> <span class="o">=</span> <span class="nb">map</span><span class="p">();</span> <span class="n">Response</span> <span class="o">=</span>
+</pre></div>
+
+
+<p>postUrl(âhttp://api.esme.us/esme/api/login?token=â + input.Token,
+MyMap);</p>
+<div class="codehilite"><pre><span class="n">Response</span> <span class="o">=</span> <span class="n">postUrl</span><span class="p">(</span><span class="err">â</span><span class="n">http:</span><span class="sr">//</span><span class="n">api</span><span class="o">.</span><span class="n">esme</span><span class="o">.</span><span class="n">us</span><span class="sr">/esme/</span><span class="n">api</span><span class="o">/</span><span class="n">send_msg</span><span class="p">?</span><span class="n">message</span><span class="o">=</span><span class="err">â</span>
+</pre></div>
+
+
+<ul>
+<li>
+<p>input.Message + â&tags=â + input.Tags + â&via=zohoâ, MyMap);</p>
+<p>Response = getUrl(âhttp://api.esme.us/esme/api/logoutâ);</p>
+</li>
+</ul>
+<p>What is cool is that there is also the possibility to use the
+âout-of-the-boxâ functionality of ZohoCreator applications to import
+information from Excel to fill internal database tables. Thus, you can
+rapidly create a series of Apache ESME messages. </p>
+<p>!zohocreator22.jpg|border=1!</p>
+ </div>
+
+ <div id="footer">
+ <div class="copyright">
+ <p>
+ Copyright © 2010 The Apache Software Foundation, Licensed under
+ the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.
+ <br />
+ Apache, ESME and the Apache feather and ESME logos are trademarks of The Apache Software Foundation.
+ </p>
+ </div>
+ </div>
+
+</body>
+</html>