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/28 10:53:47 UTC
svn commit: r791729 - /websites/staging/esme/trunk/content/docs/clients/
Author: buildbot
Date: Tue Jun 28 08:53:46 2011
New Revision: 791729
Log:
Staging update by buildbot
Added:
websites/staging/esme/trunk/content/docs/clients/
websites/staging/esme/trunk/content/docs/clients/adobe-air.html
websites/staging/esme/trunk/content/docs/clients/ant-client.html
websites/staging/esme/trunk/content/docs/clients/apache-esme-clients.html
websites/staging/esme/trunk/content/docs/clients/esme-desktop-client-server-config.html
websites/staging/esme/trunk/content/docs/clients/pure-javascript-client.html
websites/staging/esme/trunk/content/docs/clients/vba.html
websites/staging/esme/trunk/content/docs/clients/web-client.html
websites/staging/esme/trunk/content/docs/clients/web-ui-help.html
websites/staging/esme/trunk/content/docs/clients/zoho-creator.html
Added: websites/staging/esme/trunk/content/docs/clients/adobe-air.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/clients/adobe-air.html (added)
+++ websites/staging/esme/trunk/content/docs/clients/adobe-air.html Tue Jun 28 08:53:46 2011
@@ -0,0 +1,72 @@
+<!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 - Adobe Air</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="/faq.html">FAQ</a></li>
+<li><a href="/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">Adobe Air</h1>
+
+ </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/docs/clients/ant-client.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/clients/ant-client.html (added)
+++ websites/staging/esme/trunk/content/docs/clients/ant-client.html Tue Jun 28 08:53:46 2011
@@ -0,0 +1,226 @@
+<!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 - Ant Client</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="/faq.html">FAQ</a></li>
+<li><a href="/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">Ant Client</h1>
+ <p>We have an integration with <a href="http://ant.apache.org/">Apache Ant</a>
+ which is âa Java-based build toolâ. It is now possible to send
+messages to Apache ESME that describe the progress of your build steps.
+This is especially useful when Apache ESME is being in development projects
+where individual developers can be made aware of the status of
+various-build related actions. For example, a development team could be
+informed that a build is broken or if it is successful.</p>
+<p><a name="AntClient-Setup"></a></p>
+<h4 id="setup">Setup</h4>
+<ol>
+<li>Install Apache Ant</li>
+<li>Install Apache Maven</li>
+<li>Download the Apache Commons packages <a href="http://commons.apache.org/codec/">"Codec"</a>
+ and [Logger|http://commons.apache.org/logging/download_logging.cgi]
+. We also need [Apache "Httpclient|http://hc.apache.org/] .
+Please note that we are currently using the legacy 3.1 version of the
+HTTP Client. </li>
+<li>Check-out the ESME java client: _<a href="https://svn.apache.org/repos/asf/esme/trunk/esme-java-client_">https://svn.apache.org/repos/asf/esme/trunk/esme-java-client_</a></li>
+<li>Perform a maven build in this directory with the following command "<em>mvn
+compile package -Dmaven.test.skip=true</em>" . This will create a jar file
+"esme-rest-api-0.1.jar" in the target directory. </li>
+<li>Create _lib _directory and copy "rest-api-0.1-SNAPSHOT.jar",
+"commons-codec-1.2.jar", "commons-httpclient-3.1.jar" into this
+directory. </li>
+<li>Create <em>src</em> directory and copy the "EsmeAntTask.java" file to this
+directory</li>
+<li>Change the build.xml file to point to the appropriate directories</li>
+<li>Change the token in the "esme" target in the build.xml file to a correct
+token.</li>
+<li>Change the proxy in the "esme" target in the build.xml file to a correct
+proxy.</li>
+<li>call <em>ant dist esme</em> to test the application</li>
+</ol>
+<p><a name="AntClient-Build.xml"></a></p>
+<h4 id="buildxml">Build.xml</h4>
+<p>{code:lang=xml}
+<project name="EsmeViaAnt" default="dist" basedir=".">
+ <!-- set global properties for this build -->
+ <property name="src" location="src"/>
+ <property name="build" location="build"/>
+ <property name="dist" location="dist"/></p>
+<div class="codehilite"><pre><span class="o"><</span><span class="n">path</span> <span class="n">id</span><span class="o">=</span><span class="s">"project.class.path"</span><span class="o">></span>
+<span class="o"><</span><span class="n">pathelement</span>
+</pre></div>
+
+
+<p>path="./dist/lib/EsmeViaAnt.jar:./lib/esme-rest-api-0.1.jar:./lib/commons-codec-1.4.jar:./lib/commons-logging-1.1.1.jar:./lib/commons-httpclient-3.1.jar"/>
+ </path></p>
+<p><target name="init">
+ <!-- Create the time stamp -->
+ <tstamp/>
+ <!-- Create the build directory structure used by compile -->
+ <mkdir dir="${build}"/>
+ </target></p>
+<p><target name="compile" depends="init"
+ description="compile the source " >
+ <!-- Compile the java code from ${src} into ${build} -->
+ <javac srcdir="${src}" destdir="${build}">
+ <classpath refid="project.class.path"/>
+ </javac>
+ </target></p>
+<p><target name="dist" depends="compile"
+ description="generate the distribution" >
+ <!-- Create the distribution directory -->
+ <mkdir dir="${dist}/lib"/></p>
+<div class="codehilite"><pre><span class="c"><!-- Put everything in </span><span class="cp">${</span><span class="n">build</span><span class="cp">}</span><span class="c"> into the jar file --></span>
+<span class="nt"><jar</span> <span class="na">jarfile=</span><span class="s">"</span><span class="cp">${</span><span class="n">dist</span><span class="cp">}</span><span class="s">/lib/EsmeViaAnt.jar"</span> <span class="na">basedir=</span><span class="s">"</span><span class="cp">${</span><span class="n">build</span><span class="cp">}</span><span class="s">"/</span><span class="nt">></span>
+</pre></div>
+
+
+</target>
+
+<p><target name="esme"
+ description="Send Esme" >
+ <java fork="true"
+ classname="EsmeAntTask">
+ <arg
+value="http://esmecloudserverapache.dickhirsch.staxapps.net/api"/>
+ <arg value="31EL0R0M15NTD2LSOS0BKC5Y0P5JOVAC"/>
+ <arg value="myproxy:81"/>
+ <arg value="A message from the ant build process"/>
+ <classpath>
+ <pathelement
+path="./dist/lib/EsmeViaAnt.jar:./lib/esme-rest-api-0.1.jar:./lib/commons-codec-1.4.jar:./lib/commons-logging-1.1.1.jar:./lib/commons-httpclient-3.1.jar"/>
+ </classpath></p>
+<div class="codehilite"><pre> <span class="sr"></java></span>
+</pre></div>
+
+
+</target>
+
+</project>
+
+<div class="codehilite"><pre><span class="n">h4</span><span class="o">.</span> <span class="n">EsmeAntTask</span> <span class="n">java</span> <span class="n">class</span>
+</pre></div>
+
+
+<p>import org.apache.esme.api.EsmeRestApi;
+import org.apache.esme.model.Message;</p>
+<p>public class EsmeAntTask
+{</p>
+<p>public static void main (String<a href=".html" />
+ args) {</p>
+<p>String apiUrl;
+ String authToken;
+ String localProxy;
+ String message;
+ EsmeRestApi esme;</p>
+<p>apiUrl = args<a href="0.html">0</a>
+;
+ authToken = args<a href="1.html">1</a>
+;
+ localProxy = args<a href="2.html">2</a>
+;
+ message = args<a href="3.html">3</a>
+;</p>
+<p>try {</p>
+<div class="codehilite"><pre> <span class="n">esme</span> <span class="o">=</span> <span class="k">new</span> <span class="n">EsmeRestApi</span><span class="p">(</span><span class="n">apiUrl</span><span class="p">);</span>
+
+ <span class="k">if</span> <span class="p">((</span><span class="n">localProxy</span> <span class="o">!=</span> <span class="n">null</span><span class="p">)</span> <span class="o">&&</span> <span class="o">!</span><span class="p">(</span><span class="s">""</span><span class="o">.</span><span class="n">equals</span><span class="p">(</span><span class="n">localProxy</span><span class="p">)))</span>
+ <span class="p">{</span>
+ <span class="sr">//</span> <span class="n">Split</span> <span class="n">proxyHost:port</span> <span class="n">into</span> <span class="n">two</span> <span class="n">parts</span>
+ <span class="n">String</span><span class="o">[]</span><span class="p">(</span><span class="o">.</span><span class="n">html</span><span class="p">)</span>
+</pre></div>
+
+
+<p>proxy = localProxy.split(":");
+ esme.setProxy(proxy<a href="0.html">0</a>
+, Integer.parseInt(proxy[1]));
+ }</p>
+<div class="codehilite"><pre> <span class="n">esme</span><span class="o">.</span><span class="n">login</span><span class="p">(</span><span class="n">authToken</span><span class="p">);</span>
+
+ <span class="n">Message</span> <span class="n">esmeMsg</span> <span class="o">=</span> <span class="k">new</span> <span class="n">Message</span><span class="p">();</span>
+
+ <span class="n">esmeMsg</span><span class="o">.</span><span class="n">setBody</span><span class="p">(</span><span class="n">message</span><span class="p">);</span>
+
+ <span class="n">String</span><span class="o">[]</span><span class="p">(</span><span class="o">.</span><span class="n">html</span><span class="p">)</span>
+</pre></div>
+
+
+<p>tags = new String[1];
+ tags<a href="0.html">0</a>
+ = "Ant Task";</p>
+<div class="codehilite"><pre> <span class="n">esmeMsg</span><span class="o">.</span><span class="n">setTags</span><span class="p">(</span><span class="n">tags</span><span class="p">);</span>
+
+ <span class="n">esmeMsg</span><span class="o">.</span><span class="n">setSource</span><span class="p">(</span><span class="s">"Ant"</span><span class="p">);</span>
+
+ <span class="n">esme</span><span class="o">.</span><span class="n">sendMsg</span><span class="p">(</span><span class="n">esmeMsg</span><span class="p">);</span>
+</pre></div>
+
+
+<p>}
+ catch (Exception e) {}
+ }
+}</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/docs/clients/apache-esme-clients.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/clients/apache-esme-clients.html (added)
+++ websites/staging/esme/trunk/content/docs/clients/apache-esme-clients.html Tue Jun 28 08:53:46 2011
@@ -0,0 +1,126 @@
+<!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 - Apache ESME Clients</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="/faq.html">FAQ</a></li>
+<li><a href="/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">Apache ESME Clients</h1>
+ <ul>
+<li>h5. {color:#000000}<a href="web-client.html">Web Client</a>
+{color}</li>
+</ul>
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="" />
+<ul>
+<li>h5. <a href="http://code.google.com/p/esmeproject/source/browse/#svn/tags/teched08_vegas_demo_jam/esme-abap">ABAP Web Dynpro</a>
+ (Google Code project)</li>
+</ul>
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="_1" />
+<ul>
+<li>h5. <a href="adobe-air.html">Adobe AIR</a></li>
+</ul>
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="_2" />
+<ul>
+<li>h5. <a href="ant-client.html">Ant Client</a></li>
+</ul>
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="_3" />
+<ul>
+<li>h5. <a href="apache-james-(email-integration).html">Apache James</a>
+ (Email integration)</li>
+</ul>
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="_4" />
+<ul>
+<li>h5. <a href="http://svn.apache.org/viewvc/esme/trunk/esme-java-client/">Java Client</a></li>
+</ul>
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="_5" />
+<ul>
+<li>h5. <a href="pl-sql-client.html">PL SQL Client</a></li>
+</ul>
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="_6" />
+<ul>
+<li>h5. <a href="pure-javascript-client.html">Pure JavaScript Client</a></li>
+</ul>
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="_7" />
+<ul>
+<li>h5. <a href="vba.html">VBA Client</a></li>
+</ul>
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="_8" />
+<ul>
+<li>h5. <a href="zoho-creator.html">Zoho Creator</a></li>
+</ul>
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="_9" />
+<p><a name="ApacheESMEClients-"></a></p>
+<h4 id="_10" />
+ </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/docs/clients/esme-desktop-client-server-config.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/clients/esme-desktop-client-server-config.html (added)
+++ websites/staging/esme/trunk/content/docs/clients/esme-desktop-client-server-config.html Tue Jun 28 08:53:46 2011
@@ -0,0 +1,72 @@
+<!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 - ESME Desktop Client Server Config</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="/faq.html">FAQ</a></li>
+<li><a href="/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">ESME Desktop Client Server Config</h1>
+
+ </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/docs/clients/pure-javascript-client.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/clients/pure-javascript-client.html (added)
+++ websites/staging/esme/trunk/content/docs/clients/pure-javascript-client.html Tue Jun 28 08:53:46 2011
@@ -0,0 +1,293 @@
+<!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 - Pure JavaScript Client</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="/faq.html">FAQ</a></li>
+<li><a href="/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">Pure JavaScript Client</h1>
+ <p>This is a message-receiving client for Apache ESME that is written
+entirely in Javascript. This very first cut of a client was created as a
+proof-of-concept to show that a very simple client was possible without
+any dependence on the server-side programming language. Based on the
+current implementation, it could be embedded in Java, C#, etc. It could
+run in a variety of environments including SharePoint, SAP Portal, etc.</p>
+<p>This first version offers:
+<em> Long-polling
+</em> Flexible design
+* The client uses XSL transformation to create HTML from the XML that
+originates from Apache ESMEâs REST-API.</p>
+<p><a name="PureJavaScriptClient-HTMLpage"></a></p>
+<h4 id="html_page">HTML page</h4>
+<p>{code:lang=javascript}<script type="text/javascript" language="javascript">
+var http_request = false;
+var xslDoc = false;
+function getFirstRequest() {</p>
+<p>//Load XSL File
+Â Â Â xslTest();
+Â Â
+Â Â
+Â Â http_request = GetXmlHttpObject();
+Â Â
+Â Â if (!http_request) {
+Â Â Â Â alert('Cannot create XMLHTTP instance');
+Â Â Â Â return false;
+Â Â }
+Â Â
+Â Â login();
+Â Â
+Â Â getMessages ("http://api.esme.us/esme/api/get_msgs")
+Â Â
+}</p>
+<p>function login () {
+Â Â
+Â Â var url = "http://api.esme.us/esme/api/login";
+Â Â var params =
+"token="+encodeURIComponent("NSCPIKQ0QZ0GO2PJXMXGTKRL1O");
+Â Â http_request.open("POST", url, false);
+Â Â //Send the proper header information along with the request
+Â Â http_request.setRequestHeader("Content-type",
+"application/x-www-form-urlencoded");
+Â Â http_request.setRequestHeader("Content-length", params.length);
+Â Â http_request.setRequestHeader("Connection", "close");
+Â Â
+Â Â http_request.send(params);
+Â Â
+}</p>
+<p>function getMessages(rest_type) {
+Â Â
+Â Â http_request.open('GET', rest_type, true);
+Â Â http_request.onreadystatechange = pageUpdate;
+Â Â http_request.send(null);
+}</p>
+<p>function getNextRequest() {
+Â Â
+Â Â http_request = GetXmlHttpObject();
+Â Â
+Â Â if (!http_request) {
+Â Â Â Â alert('Cannot create XMLHTTP instance');
+Â Â Â Â return false;
+Â Â }
+Â Â
+Â Â login();
+Â Â
+Â Â getMessages ("http://api.esme.us/esme/api/wait_for_msgs")
+Â Â
+}</p>
+<p>function GetXmlHttpObject() {
+Â Â var xmlHttp = null;
+Â Â try {
+Â Â Â Â // Firefox, Opera 8.0+, Safari
+Â Â Â Â xmlHttp = new XMLHttpRequest();
+Â Â }
+Â Â catch(e) {
+Â Â Â Â // Internet Explorer
+Â Â Â Â try {
+Â Â Â Â Â Â xmlHttp = new ActiveXObject("Msxml2.XMLHTTP");
+Â Â Â Â }
+Â Â Â Â catch(e) {
+Â Â Â Â Â Â xmlHttp = new ActiveXObject("Microsoft.XMLHTTP");
+Â Â Â Â }
+Â Â }
+Â Â return xmlHttp;
+}</p>
+<p>function pageUpdate() {
+Â Â if (http_request.readyState == 0) {
+Â Â Â Â document.getElementById('resultbox').innerHTML = "Sending
+Request...";
+Â Â }
+Â Â if (http_request.readyState == 1) {
+Â Â Â Â document.getElementById('resultbox').innerHTML = "Loading
+Response...";
+Â Â }
+Â Â if (http_request.readyState == 2) {
+Â Â Â Â document.getElementById('resultbox').innerHTML = "Response
+Loaded...";
+Â Â }
+Â Â if (http_request.readyState == 3) {
+Â Â Â Â document.getElementById('resultbox').innerHTML = "Response
+Ready...";
+Â Â }
+Â Â if (http_request.readyState == 4) {
+Â Â Â Â //alert(http_request.responseText);
+Â Â Â Â //addText (http_request.responseText);
+Â Â Â Â loadXML (http_request.responseText);
+Â Â Â Â
+Â Â Â Â http_request.open('GET', "http://api.esme.us/esme/api/logout",
+true);
+Â Â Â Â http_request.send(null);
+Â Â Â Â
+Â Â Â Â getNextRequest();
+Â Â }
+Â Â
+}</p>
+<p>function addText (text) {
+Â Â var pTag = document.createElement("p");
+Â Â pTag.setAttribute("align","center");
+Â Â pTag.innerHTML = text;
+Â Â var div = Â document.getElementById("details")
+Â Â div.insertBefore(pTag, div.childNodes<a href="0.html">0</a>
+);
+Â Â
+}</p>
+<p>function loadXML (text) {
+Â Â
+Â Â try //Internet Explorer
+Â Â {
+Â Â Â Â xmlDoc=new ActiveXObject("Microsoft.XMLDOM");
+Â Â Â Â xmlDoc.async="false";
+Â Â Â Â xmlDoc.loadXML(text);
+Â Â }
+Â Â catch(e)
+Â Â {
+Â Â Â Â try //Firefox, Mozilla, Opera, etc.
+Â Â Â Â {
+Â Â Â Â Â Â parser=new DOMParser();
+Â Â Â Â Â Â xmlDoc=parser.parseFromString(text,"text/xml");
+Â Â Â Â }
+Â Â Â Â catch(e) {alert(e.message)}
+Â Â }
+Â Â try
+Â Â {
+Â Â Â Â var sResult = xmlDoc.documentElement.transformNode(xslDoc);
+Â Â Â Â //alert (sResult);
+Â Â Â Â addText (sResult);
+Â Â }
+Â Â catch(e) {
+Â Â Â Â alert(e.message)
+Â Â }
+Â Â
+}</p>
+<p>function xslTest () {
+try //Internet Explorer
+{
+Â Â xslDoc=new ActiveXObject("Microsoft.XMLDOM");
+}
+catch(e)
+{
+Â Â try //Firefox, Mozilla, Opera, etc.
+Â Â {
+Â Â Â Â xslDoc=document.implementation.createDocument("","",null);
+Â Â }
+Â Â catch(e) {alert(e.message)}
+}
+try
+{
+Â Â xslDoc.async=false;
+Â Â xslDoc.load("d:/temp/esme.xsl");
+}
+catch(e) {alert(e.message)}
+}</p>
+<p></script>
+<body onload="getFirstRequest()"></p>
+<div id="resultbox"></div>
+<div id="details"><p> </p></div>
+
+</body>
+
+<div class="codehilite"><pre><span class="n">h4</span><span class="o">.</span> <span class="n">XLS</span> <span class="n">File</span>
+
+<span class="p">{</span><span class="n">code:lang</span><span class="o">=</span><span class="n">xml</span><span class="p">}</span><span class="o"><</span><span class="p">?</span><span class="n">xml</span> <span class="n">version</span><span class="o">=</span><span class="s">"1.0"</span><span class="p">?</span><span class="o">></span>
+<span class="o"><</span><span class="n">xsl:stylesheet</span> <span class="n">version</span><span class="o">=</span><span class="s">"1.0"</span>
+</pre></div>
+
+
+<p>xmlns:xsl="http://www.w3.org/1999/XSL/Transform"></p>
+<div class="codehilite"><pre> <span class="o"><</span><span class="n">xsl:output</span> <span class="n">method</span><span class="o">=</span><span class="s">"html"</span> <span class="o">/></span>
+
+ <span class="o"><</span><span class="n">xsl:template</span> <span class="n">match</span><span class="o">=</span><span class="s">"author"</span><span class="o">></span>
+ <span class="sr"><tr></span>
+ <span class="sr"><td></span>
+ <span class="sr"><img></span>
+ <span class="o"><</span><span class="n">xsl:attribute</span> <span class="n">name</span><span class="o">=</span><span class="s">"src"</span><span class="o">><</span><span class="n">xsl:value</span><span class="o">-</span><span class="n">of</span> <span class="nb">select</span><span class="o">=</span><span class="s">"@image"</span>
+</pre></div>
+
+
+<p>/></xsl:attribute>
+ <xsl:attribute name="alt"><xsl:value-of select="@name"
+/></xsl:attribute>
+ </img>
+ From: <xsl:value-of select="@name" />
+ </td>
+ </tr>
+ </xsl:template></p>
+<div class="codehilite"><pre> <span class="k"><xsl:template</span> <span class="na">match=</span><span class="s">"body"</span><span class="nt">></span>
+ <span class="nt"><tr><td></span>
+ Message: <span class="k"><xsl:value-of</span> <span class="na">select=</span><span class="s">"."</span><span class="nt">/></td></tr></span>
+ <span class="k"></xsl:template></span>
+
+ <span class="k"><xsl:template</span> <span class="na">match=</span><span class="s">"esme_api"</span><span class="nt">></span>
+ <span class="nt"><table></span>
+ <span class="k"><xsl:apply-templates</span><span class="nt">/></span>
+ <span class="nt"></table></span>
+ <span class="k"></xsl:template></span>
+
+ <span class="k"><xsl:template</span> <span class="na">match=</span><span class="s">"/"</span><span class="nt">></span>
+ <span class="k"><xsl:apply-templates</span><span class="nt">/></span>
+ <span class="k"></xsl:template></span>
+
+<span class="k"></xsl:stylesheet></span>{code}
+</pre></div>
+ </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/docs/clients/vba.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/clients/vba.html (added)
+++ websites/staging/esme/trunk/content/docs/clients/vba.html Tue Jun 28 08:53:46 2011
@@ -0,0 +1,107 @@
+<!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 - VBA</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="/faq.html">FAQ</a></li>
+<li><a href="/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">VBA</h1>
+ <p>Many people spend most of the day either working on SAP-related systems or
+on Microsoft Office products. We have created a VBA macro that
+creates messages on EMSE for those individuals who work with Excel and
+Word. This macro is based on ESME's <a href="https://cwiki.apache.org/confluence/display/ESME/RESTAPI">REST API</a>
+.</p>
+<p>The macro pops up in your Office tool of choice which allows you to enter a
+quick message for ESME.</p>
+<p>To authenticate themselves, ESME users must replace
+â<em>insert_your_token</em>â with their own authorization token. Tags are
+currently hard-coded as well.</p>
+<p>Sub ESME_sendMessage()</p>
+<p>âHTTP variable
+Dim myHTTP As MSXML2.XMLHTTP</p>
+<p>âHTTP object
+Set myHTTP = CreateObject(âmsxml2.xmlhttpâ)</p>
+<p>âopen the connection
+myHTTP.Open âpostâ, _
+â[http://api.esme.us/esme/api/login?token=<a href="http://api.esme.us/esme/api/login?token=[insert_your_token">insert_your_token</a>
+|http://api.esme.us/esme/api/login?token=[insert_your_token]]â, False</p>
+<p>âsend
+myHTTP.Send</p>
+<p>â Send Message</p>
+<p>Dim message</p>
+<p>message = InputBox(âEnter Messageâ)</p>
+<p>myHTTP.Open âpostâ, _
+â<a href="http://api.esme.us/esme/api/send_msg?message">http://api.esme.us/esme/api/send_msg?message</a>
+=â + message + â&tags=Test,excel&via=excelâ, False</p>
+<p>âsend
+myHTTP.Send</p>
+<p>âLogout
+myHTTP.Open âgetâ, _
+â<a href="http://api.esme.us/esme/api/logout">http://api.esme.us/esme/api/logout</a>
+â, False</p>
+<p>âsend
+myHTTP.Send
+End Sub</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/docs/clients/web-client.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/clients/web-client.html (added)
+++ websites/staging/esme/trunk/content/docs/clients/web-client.html Tue Jun 28 08:53:46 2011
@@ -0,0 +1,95 @@
+<!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 Client</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="/faq.html">FAQ</a></li>
+<li><a href="/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 Client</h1>
+ <p>
+<em>Name</em>: Web</p>
+<p><em>Description</em>: This client is a pure browser-based client</p>
+<p><em>Status</em>: There are currently two versions - an old
+one (original) and the latest one based on the Apache
+code-base</p>
+<p><a name="WebClient-Screenshots"></a></p>
+<h2 id="screenshots">Screenshots</h2>
+<p>
+<em>Old Web UI</em></p>
+<p> !old_esme.jpg|thumbnail!</p>
+<p><em>New UI:</em> </p>
+<p><em>Coming soon</em> </p>
+<p><a name="WebClient-Code"></a></p>
+<h2 id="code">Code</h2>
+<p>See <a href="esme:downloading-source.html">SVN</a></p>
+<p><a name="WebClient-Help"></a></p>
+<h2 id="help">Help</h2>
+<p> Detailed help is located <a href="esme:web-ui-help.html">here</a></p>
+<p><a name="WebClient-Details"></a></p>
+<h2 id="details">Details</h2>
+<p>This was our first client </p>
+<p><a name="WebClient-Supportingmaterials"></a></p>
+<h2 id="supporting_materials">Supporting materials</h2>
+ </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/docs/clients/web-ui-help.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/clients/web-ui-help.html (added)
+++ websites/staging/esme/trunk/content/docs/clients/web-ui-help.html Tue Jun 28 08:53:46 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="/faq.html">FAQ</a></li>
+<li><a href="/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/docs/clients/zoho-creator.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/clients/zoho-creator.html (added)
+++ websites/staging/esme/trunk/content/docs/clients/zoho-creator.html Tue Jun 28 08:53:46 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="/faq.html">FAQ</a></li>
+<li><a href="/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>