diff --git a/docs/src/site/apt/about.apt b/docs/src/site/apt/about.apt index 22fe6fb32..084c1052e 100644 --- a/docs/src/site/apt/about.apt +++ b/docs/src/site/apt/about.apt @@ -17,18 +17,18 @@ About OpenEngSB In engineering environments a lot of different tools are used. Most of these operate on the same domain, but often interoperability is the limiting factor. - For each new project and team memeber tool integration has to be repreated again. + For each new project and team member tool integration has to be repeated again. In general, this ends up with numerous point-to-point connectors between tools - which are neither stabe solutions nor flexible ones. + which are neither stable solutions nor flexible ones. This is the point where the Open (Software) Engineering Service Bus (OpenEngSB) - comes into play. It simplyfies design and implementation of workflows in an + comes into play. It simplifies design and implementation of workflows in an engineering team. The engineering team itself (or a process administrator) is able to design workflows between different tools. The entire description process happens on the layer of generic domains instead of specific tool properties. This provides an out of the box solution which allows typical engineering teams to optimize their processes and make their workflows very flexible and easy to - change. Also, OpenEngSB simlyfies the replacement of individual tools and allows + change. Also, OpenEngSB simplifies the replacement of individual tools and allows interdepartmental tool integration. Project management is set to a new level since its possible to clearly guard @@ -39,10 +39,10 @@ About OpenEngSB Although this concept is very powerful it cannot solve every problem. The OpenEngSB is not designed as a general graphical layer over an Enterprise Service Bus (ESB) which allows you to design ALL of your processes out of the - box. As long as you work in the designed domains of the EngSB you have a lot + box. As long as you work in the designed domains of the OpenEngSB you have a lot of graphical support and other tools available making your work extremely easy. But when leaving the common engineering domains you also leave the core scope - of the sevice bus. OpenEngSB still allows you to connect your own integration + of the service bus. OpenEngSB still allows you to connect your own integration projects, use services and react on events, but you have to keep in mind that you're working outside the OpenEngSB and "falling back" to classical Enterprise Application Integration (EAI) patterns and tools. @@ -59,4 +59,4 @@ Further Information See the {{{reference/index.html}Userguide}}, participate in the {{{mail-lists.html}Mailing lists}} or directly dive into the - {{{source-repository.html}Source Code}}. \ No newline at end of file + {{{source-repository.html}Source Code}}. diff --git a/docs/src/site/apt/architecture.apt b/docs/src/site/apt/architecture.apt index 74fbc0393..895c9f581 100644 --- a/docs/src/site/apt/architecture.apt +++ b/docs/src/site/apt/architecture.apt @@ -15,13 +15,13 @@ ~~ (Actual) Architecture - This page gives an overview over the actual architecture of the EngSB project. Since the EngSB is actually in quite + This page gives an overview over the actual architecture of the OpenEngSB project. Since the OpenEngSB is actually in quite a very early stage only outlines of the architecture are presented which should be refined in the next weeks and fixed in a detailed architectural description of the system. Because the images are too big for the browser only the link on them is given here. The following pictures presents an overview over the entire system, the core components, the domains and the - communication between two EngSBs via a gateway module. + communication between two OpenEngSBs via a gateway module. {{{architecture/overview.png}overview.png}} @@ -30,22 +30,9 @@ {{{architecture/domain.png}domain.png}} - The workflow descriptions gives a textual overview over the typical workflow in the EngSB between core components + The workflow descriptions gives a textual overview over the typical workflow in the OpenEngSB between core components and additional components. Further more also the workflow component, the complex event processing component and additional core components and domains are included. {{{architecture/workflow.png}workflow.png}} -(Legacy) Architektur - - - Im folgenden Diagramm sieht man die interne Struktur des ASB. Alle Nachrichten werden auf einen - bestimmten Eingang gelegt. Der Dispatcher gibt diese einerseits an den Logger als auch an den - Validation Service weiter. Im Service wird die Nachricht basierend - auf Typ und etwaigen Nachrichtendetails an die richtigen Queues weitergereicht. - - Bullet points Texte zeigen die Nachrichten die in Richtung der Services geschickt werden. - - Die im Grafik gezeigte LDAP Anbindung wurde in den Use Cases fuer Iteration 2 nicht umgesetzt. - -[images/eip_arch.png] \ No newline at end of file diff --git a/docs/src/site/apt/contribute/codingstyle.apt b/docs/src/site/apt/contribute/codingstyle.apt index 4f3c48824..8063dc8d5 100644 --- a/docs/src/site/apt/contribute/codingstyle.apt +++ b/docs/src/site/apt/contribute/codingstyle.apt @@ -18,7 +18,7 @@ Java Coding Style * Sun Coding Guidelines - The openEngSB Coding Guidelines are based upon the + The OpenEngSB Coding Guidelines are based upon the {{{http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html}Code Conventions for the Java Programming Language}}. There are some additions and deviations for this project. @@ -30,7 +30,7 @@ size and resolution a length of 120 is more reasonable. ** 4.2 Wrapping - Use the autoformatter of your IDE. Import the + Use the auto-formatter of your IDE. Import the {{{http://dev.openengsb.org/resources/eclipse/formatter.xml}Eclipse Formatter file}}. ** 6.1 Number of declarations per line @@ -51,7 +51,7 @@ size and resolution a length of 120 is more reasonable. ** File Format Every Java file has to be UTF-8 encoded and has to use UNIX line endings. - Indentations consist of four spaces, tabstops are not allowed. + Indentations consist of four spaces, tab-stops are not allowed. ** Header @@ -248,7 +248,7 @@ be acceptable but you should try to annotate the problematic statements instead. * Use runtime exceptions where possible. - * Wrap exeptions in a RuntimeException if you don't want to specify the Exception in + * Wrap exceptions in a RuntimeException if you don't want to specify the Exception in your method signature and you can't handle it. * Write meaningful exception message. diff --git a/docs/src/site/apt/contribute/eclipse.apt b/docs/src/site/apt/contribute/eclipse.apt index aebf138a4..3167985f2 100644 --- a/docs/src/site/apt/contribute/eclipse.apt +++ b/docs/src/site/apt/contribute/eclipse.apt @@ -13,7 +13,7 @@ ~~ See the License for the specific language governing permissions and ~~ limitations under the License. ~~ -Setup Eclipse for the EngSB +Setup Eclipse for the OpenEngSB The following page describes how to setup the actual code as an eclipse project with two different focuses. One directly on the core development team and how @@ -73,4 +73,4 @@ Setup Eclipse for the EngSB ... -+----------------------------------+ \ No newline at end of file ++----------------------------------+ diff --git a/docs/src/site/apt/contribute/proposals.apt b/docs/src/site/apt/contribute/proposals.apt index b73e99fb0..756776ce7 100644 --- a/docs/src/site/apt/contribute/proposals.apt +++ b/docs/src/site/apt/contribute/proposals.apt @@ -18,7 +18,7 @@ Proposals A main directive of OpenEngSB is its continuous extension. Most ideas are discussed in the mailinglist first, but at some point a more consistent way of specification is required. For the OpenEngSB project this should be done via written proposals in the proposals - section. This articel explains in more details what this means and how it should be handled. + section. This article explains in more details what this means and how it should be handled. *General @@ -30,7 +30,7 @@ Proposals *Domain Description This section describes what should be contained in the proposal for an interface description. - The structure of the documents themself should be done in the following form: + The structure of the documents themselves should be done in the following form: [[1]] Which tools exist for the domain diff --git a/docs/src/site/apt/howto/howto_cit.apt b/docs/src/site/apt/howto/howto_cit.apt index 78a1d35e8..123bd17d4 100755 --- a/docs/src/site/apt/howto/howto_cit.apt +++ b/docs/src/site/apt/howto/howto_cit.apt @@ -89,7 +89,7 @@ HowTo - Continuous Integration and Test Workflow * The Subversion Stomp Commit Hook - The third step from the list in the section 'Running the example' can be accomplished by usinng a commit hook in the SCM tool. + The third step from the list in the section 'Running the example' can be accomplished by using a commit hook in the SCM tool. A small Perl program was developed which sends a JMS message using the Stomp protocol into a queue. A specialized JMS consumer of the tool connector reads from this queue and informs the Subversion tool connector that a check in has happened. The tool connector creates the ScmCheckInEvent and sends it to the OpenEngSB. The Perl script can be found in domains/scm/subversion/hooks/stomp-client. diff --git a/docs/src/site/apt/howto/howto_embedded.apt b/docs/src/site/apt/howto/howto_embedded.apt index 9c1122d74..feeff2c9b 100644 --- a/docs/src/site/apt/howto/howto_embedded.apt +++ b/docs/src/site/apt/howto/howto_embedded.apt @@ -18,7 +18,7 @@ Web Configuration Interface The embedded web app adds the possibility to create, configure and monitor service assemblies through a web interface. - Configuration of anservice assembly for an JBI-compliant ESB is mainly + Configuration of an service assembly for an JBI-compliant ESB is mainly done by editing xml-files. Build tools like maven help by providing support for building the deployment file. Still, writing the xml files manually is a time consuming task. diff --git a/docs/src/site/apt/index.apt b/docs/src/site/apt/index.apt index ba06c4e1c..7fc991908 100644 --- a/docs/src/site/apt/index.apt +++ b/docs/src/site/apt/index.apt @@ -16,7 +16,7 @@ Welcome to OpenEngSB! The Open Engineering Service Bus (OpenEngSB) project provides an easy-to-use - plattform for engineering tool integration. It offers domain-based workflow + platform for engineering tool integration. It offers domain-based workflow design for reoccurring integration tasks, freeing an engineer's time for creative work. @@ -52,4 +52,4 @@ OpenEngSB Community * {{{contribute/mailinglists.html}Mailing lists}} - * {{{http://www.facebook.com/group.php?gid=208312030232}OpenEngSB on facebook}} \ No newline at end of file + * {{{http://www.facebook.com/group.php?gid=208312030232}OpenEngSB on facebook}} diff --git a/docs/src/site/apt/presentation.apt b/docs/src/site/apt/presentation.apt index b56fbae15..d1ea800a4 100644 --- a/docs/src/site/apt/presentation.apt +++ b/docs/src/site/apt/presentation.apt @@ -16,14 +16,15 @@ Presentation Material This page contains all material which can be used to present - the openEngSB to the public. This includes actual presentation material, logos, + the OpenEngSB to the public. This includes actual presentation material, logos, pictures and so on. The material is provided by supporters of the project and - can be reused for representing the openEngSB. - If you have created your own material and want to provide it to the community, - please contact us by the {{{http://www.googlegroups.com/group/engsb-user}mailing list}}. + can be reused for representing the OpenEngSB. + + If you have created your own material and want to provide it to the community, + please contact us by the developer mailing list}}. - * {{{http://www.openengsb.org/svn/engsb/engsb/documents/architecturalSlides/trunk/engsb-full.ppt}Long presentation about the EngSB}} - Stefan Biffl, et al. (Vienna University of Technology) +~~ * {{{http://www.openengsb.org/svn/engsb/engsb/documents/architecturalSlides/trunk/engsb-full.ppt}Long presentation about the EngSB}} - Stefan Biffl, et al. (Vienna University of Technology) - * {{{http://www.openengsb.org/svn/engsb/engsb/documents/architecturalSlides/trunk/engsb-short.ppt}Short presentation about the EngSB}} - Stefan Biffl, et al. (Vienna University of Technology) +~~ * {{{http://www.openengsb.org/svn/engsb/engsb/documents/architecturalSlides/trunk/engsb-short.ppt}Short presentation about the EngSB}} - Stefan Biffl, et al. (Vienna University of Technology) - * {{{http://www.openengsb.org/svn/engsb/engsb/additionalMaterial/eip.vss}VSS for EIP according to Hohpe}} \ No newline at end of file + ~~ * {{{http://www.openengsb.org/svn/engsb/engsb/additionalMaterial/eip.vss}VSS for EIP according to Hohpe}}