blob: f37d88950d57e6931f1861d0ee7aa46c67476176 [file] [log] [blame]
<div class="titleBig">Documentation</div>
<div class="section-content">
<div class="row-fluid">
<div class="span7">
<p>
We are always trying to keep the documentation up-to-date.
If you find anything outdated, wrong or missing, please do not hesitate to
<a href="contact.html" target="_blank">contact us</a>.
</p>
<h4>Framework User Documentation</h4>
<ul>
<li><strong><a class="link" href="http://eclipsesource.com/blogs/tutorials/getting-started-with-emfstore/" target="_blank">Getting Started</a></strong>
<ul>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/getting-started-with-emfstore/#collab" target="_blank">Collaboration with EMFStore</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/getting-started-with-emfstore/#versioning" target="_blank">Versioning Models/Data with EMFStore</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/getting-started-with-emfstore/#ui" target="_blank">Extensible User Interface</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/getting-started-with-emfstore/#coc" target="_blank">Convention over Configuration</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/getting-started-with-emfstore/#run" target="_blank">Running EMFStore</a>
</li>
</ul>
</li>
<li><strong><a class="link" href="http://eclipsesource.com/blogs/tutorials/emfstore-server-setup/" target="_blank">EMFStore Server Setup</a></strong>
<ul>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-server-setup/#runIDE" target="_blank">Running an EMFStore Server and Clients in the Eclipse IDE</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-server-setup/#configure" target="_blank">Configure the EMFStore Server</a>
<ul>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-server-setup/#es.properties" target="_blank">Configuring server properties in es.properties</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-server-setup/#ssl" target="_blank">Configuring SSL</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-server-setup/#authentication" target="_blank">Configuring Authentication</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-server-setup/#docs-internal-guid-55b90b98-19f3-11db-ffff-6d07986a96e3"
target="_blank">
Configuring Authorization
</a>
</li>
</ul>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-server-setup/#product">Building a server product</a>
</li>
</ul>
</li>
<li><strong><a class="link" href="https://eclipsesource.com/blogs/tutorials/emfstore-versioning-history-and-branching/" target="_blank">How it works: EMFStore Versioning, History and Branching</a></strong>
<ul>
<li>
<a href="https://eclipsesource.com/blogs/tutorials/emfstore-versioning-history-and-branching/#history" target="_blank">Version History</a>
</li>
<li>
<a href="https://eclipsesource.com/blogs/tutorials/emfstore-versioning-history-and-branching/#versioning" target="_blank">Change-based Versioning</a>
</li>
<li>
<a href="https://eclipsesource.com/blogs/tutorials/emfstore-versioning-history-and-branching/#merging" target="_blank">Merging Changes</a>
</li>
<li>
<a href="https://eclipsesource.com/blogs/tutorials/emfstore-versioning-history-and-branching/#branching" target="_blank">Branching</a>
</li>
</ul>
</li>
<li><strong><a class="link" href="http://eclipsesource.com/blogs/tutorials/emfstore-api-basics/" target="_blank">EMFStore API Documentation</a></strong>
<ul>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-api-basics/#installation" target="_blank">Installing the Examples</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-api-basics/#helloworld" target="_blank">Helloworld Example</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-api-basics/#merging" target="_blank">Merging and Conflict Resolution Example</a>
</li>
<li>
<a href="http://eclipsesource.com/blogs/tutorials/emfstore-api-basics/#api" target="_blank">External API and Internal API</a>
</li>
<li>
<a href="http://download.eclipse.org/emf-store/releases_19/javadoc/index.html" target="_blank">Javadoc</a>
</li>
</ul>
</li>
<li><strong><a class="link" href="http://eclipsesource.com/blogs/tutorials/how-to-run-ecp-rap-on-tomcat/" target="_blank">How to run ECP + RAP on Tomcat</a></strong>
</ul>
</div>
<div class="span5 text-center">
<img style="border: 1px solid #1d1d1d; border-radius: 0.4em;" src="public/images/book.jpg"/>
<div style="font-size: 0.8em">
Photo from <a href="http://www.flickr.com/photos/horiavarlan/">horiavarlan Flickr</a>
</div>
</div>
</div>
<h4 class="row-fluid">FAQ</h4>
<ul>
<li>Why does EMFStore fail with <strong>org.eclipse.emf.ecore.xmi.PackageNotFoundException</strong>: Package with uri 'http://xxx.ecore' not found?</li>
<p>This most likely happens because you forgot to add your model plugin to the running/product config of EMFStore.
Make sure to always include your model plugin in your running config, otherwise EMFStore is not able to serialize and de-serialize your data.</p>
<li>Why do I get an <code>java.lang.ClassNotFoundException</code> for the <code>LoginDialog</code> class?</li>
<p>You most likely did not include <code>org.eclipse.emf.emfstore.client.ui.rcp</code> or <code>org.eclipse.emf.emfstore.client.ui.rcp</code>
in your running config.
</p>
<li>Why do I get checksum errors if the client and the server are in different timezones?</li>
<p>
Because the checksum is computed based on a serialization of the respective project states. In order to sync the
client and the server you can pass the <code>user.timezome</code> system property to the application as in
<code>-Duser.timezone=MYTIMEZONE</code>.
</p>
</ul>
</div>