diff --git a/modules/flowable-ui-modeler/flowable-ui-modeler-logic/src/main/resources/stencilset_cmmn.json b/modules/flowable-ui-modeler/flowable-ui-modeler-logic/src/main/resources/stencilset_cmmn.json index 3cf20ab5abca89ad2af25c777413793824d22121..0cb1b44cc9d3a1bb87b9bd5de5251340c18d24b3 100644 --- a/modules/flowable-ui-modeler/flowable-ui-modeler-logic/src/main/resources/stencilset_cmmn.json +++ b/modules/flowable-ui-modeler/flowable-ui-modeler-logic/src/main/resources/stencilset_cmmn.json @@ -539,7 +539,7 @@ "hide" : true, "propertyPackages" : [ "overrideidpackage", "namepackage", "documentationpackage" ], "hiddenPropertyPackages" : [ ], - "roles" : [ "StageActivity", "all" ] + "roles" : [ "StageActivity", "all", "association_start", "association_end" ] }, { "type" : "node", "id" : "Task", diff --git a/userguide-cmmn/src/en/ch01-Introduction.adoc b/userguide-cmmn/src/en/ch01-Introduction.adoc new file mode 100644 index 0000000000000000000000000000000000000000..eb554da0e2da6c6c4ad933243c884a707dcfd52a --- /dev/null +++ b/userguide-cmmn/src/en/ch01-Introduction.adoc @@ -0,0 +1,50 @@ + +== Introduction + +[[license]] + +=== License + +Flowable is distributed under link:$$http://www.apache.org/licenses/LICENSE-2.0.html$$[the Apache V2 license]. + +[[download]] + +=== Download + +link:$$http://flowable.org/downloads.html$$[http://flowable.org/downloads.html] + +[[sources]] + +=== Sources + +The distribution contains most of the sources as JAR files. The source code of Flowable can be found on link:$$https://github.com/flowable/flowable-engine$$[https://github.com/flowable/flowable-engine] + +[[experimental]] + +=== Experimental Release + +This is the first release of Flowable containing the CMMN engine, which is currently marked as experimental. +Similar to experimental features in the other engines, this means that no stability guarantees are given with regards to backwards compatibility (packages, classes, data), +as we want to use this release to gather feedback from the community before making the API's fully final. However, future release notes will describe the changes if any such changes are made. + +In the next releases, we will enhance and expand on the CMMN 1.1 support and continue to add more features. + +[[required.software]] + +=== Required software + +Flowable runs on a JDK higher than or equal to version 7. Go to link:$$http://www.oracle.com/technetwork/java/javase/downloads/index.html$$[Oracle Java SE downloads] and click on button "Download JDK". There are installation instructions on that page as well. To verify that your installation was successful, run +java -version+ on the command line. That should print the installed version of your JDK. + + +[[reporting.problems]] + +=== Reporting problems + + +Questions and comments can be discussed on the on link:$$https://forum.flowable.org$$[the Flowable forum]. Issues can be created in link:$$https://github.com/flowable/flowable-engine/issues$$[our Github issue tracker]. + +[[internal]] + +=== Internal implementation classes + +In the JAR file, all classes in packages that have +.impl.+ in them are implementation classes and should be considered internal. No stability guarantees are given on classes or interfaces that are in implementation classes. diff --git a/userguide-cmmn/src/en/clean.sh b/userguide-cmmn/src/en/clean.sh new file mode 100755 index 0000000000000000000000000000000000000000..93a5f0d0321d3a8d537b2c879c5d851118fe51d6 --- /dev/null +++ b/userguide-cmmn/src/en/clean.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +rm -rf output \ No newline at end of file diff --git a/userguide-cmmn/src/en/docinfo.html b/userguide-cmmn/src/en/docinfo.html new file mode 100644 index 0000000000000000000000000000000000000000..e2eb8a85cc349b779dee4c8684f22c6371f0023b --- /dev/null +++ b/userguide-cmmn/src/en/docinfo.html @@ -0,0 +1,73 @@ + + + diff --git a/userguide-cmmn/src/en/flowable.css b/userguide-cmmn/src/en/flowable.css new file mode 100644 index 0000000000000000000000000000000000000000..15c3afeacbc9966b2becfc4c1c5ea7021fea22f2 --- /dev/null +++ b/userguide-cmmn/src/en/flowable.css @@ -0,0 +1,217 @@ + +/* normalize.css */ + +button,hr,input{overflow:visible}audio,canvas,progress,video{display:inline-block}progress,sub,sup{vertical-align:baseline}html{font-family:sans-serif;line-height:1.15;-ms-text-size-adjust:100%;-webkit-text-size-adjust:100%}body{margin:0} menu,article,aside,details,footer,header,nav,section{display:block}h1{font-size:2em;margin:.67em 0}figcaption,figure,main{display:block}figure{margin:1em 40px}hr{box-sizing:content-box;height:0}code,kbd,pre,samp{font-family:monospace,monospace;font-size:1em}a{background-color:transparent;-webkit-text-decoration-skip:objects}a:active,a:hover{outline-width:0}abbr[title]{border-bottom:none;text-decoration:underline;text-decoration:underline dotted}b,strong{font-weight:bolder}dfn{font-style:italic}mark{background-color:#ff0;color:#000}small{font-size:80%}sub,sup{font-size:75%;line-height:0;position:relative}sub{bottom:-.25em}sup{top:-.5em}audio:not([controls]){display:none;height:0}img{border-style:none}svg:not(:root){overflow:hidden}button,input,optgroup,select,textarea{font-family:sans-serif;font-size:100%;line-height:1.15;margin:0}button,input{}button,select{text-transform:none}[type=submit], [type=reset],button,html [type=button]{-webkit-appearance:button}[type=button]::-moz-focus-inner,[type=reset]::-moz-focus-inner,[type=submit]::-moz-focus-inner,button::-moz-focus-inner{border-style:none;padding:0}[type=button]:-moz-focusring,[type=reset]:-moz-focusring,[type=submit]:-moz-focusring,button:-moz-focusring{outline:ButtonText dotted 1px}fieldset{border:1px solid silver;margin:0 2px;padding:.35em .625em .75em}legend{box-sizing:border-box;color:inherit;display:table;max-width:100%;padding:0;white-space:normal}progress{}textarea{overflow:auto}[type=checkbox],[type=radio]{box-sizing:border-box;padding:0}[type=number]::-webkit-inner-spin-button,[type=number]::-webkit-outer-spin-button{height:auto}[type=search]{-webkit-appearance:textfield;outline-offset:-2px}[type=search]::-webkit-search-cancel-button,[type=search]::-webkit-search-decoration{-webkit-appearance:none}::-webkit-file-upload-button{-webkit-appearance:button;font:inherit}summary{display:list-item}[hidden],template{display:none}/*# sourceMappingURL=normalize.min.css.map */ + +/* tocbot 2.1.4 */ + +.toc{overflow-y:auto}.toc>ul{overflow:hidden;position:relative}.toc-list{margin:0;padding-left:10px}a.toc-link{color:currentColor;height:100%}.is-collapsible{max-height:1000px;overflow:hidden;transition:all 300ms ease-in-out}.is-collapsed{max-height:0}.is-position-fixed{position:fixed !important;top:0}.is-active-link{font-weight:700}.toc-link::before{background-color:#f9f9fb;content:' ';display:inline-block;height:inherit;left:8px;margin-top:-1px;position:absolute;width:2px}.is-active-link::before{background-color:#54BC4B} + +body { + color: #494d55; + font-size: 16px; + -webkit-font-smoothing: antialiased; + -moz-osx-font-smoothing: grayscale; +} + +html, body { + height: 100%; + width: 100%; + background: #f9f9f9; + font-family: "Helvetica Neue",Helvetica,Roboto,Arial,sans-serif; + color: #484848 +} + +.page-wrapper { + min-height: 100%; + /* equal to footer height */ + margin-bottom: -50px; +} + +.page-wrapper:after { + content: ""; + display: block; + height: 50px; +} + +#header { + position:fixed; + top:0px; + z-index:100000; + width:100%; +} + +#header > h1 { + background: #a0cc47; + color: #f9f9f9; + border-bottom: 2px solid #042944; + padding: 20px 0 20px 20px; + font-size: 40px; + font-weight: 800; + line-height: 1.1; + margin: 0; +} + +#header > h1:before { + background:url('images/logo.png'); + background-size: 337px 54px; background-repeat: no-repeat; + width: 337px; + height: 54px; + display:inline-block; + content:''; + margin-right: 30px; +} + +#author { + margin-left: 25%; + font-size: 40px; +} + +#content { + margin: 129px 0 0 27%; + padding: 10px 40px 0 20px; + padding-right: 40px; + line-height: 1.7; + width: 65%; + overflow-x: auto; +} + +h2, h3, h4 { + color: #00345a; +} + +h2 { + font-size: 26px; + margin-top: 0; + margin-bottom: 20px; + font-weight: bold; + padding-bottom: 10px; + border-bottom: 1px solid #d7d7d7; +} + +h3 { + font-size: 18px; + margin-top: 0; + margin-bottom: 0; + font-weight: bold; + padding-bottom: 10px; + /*border-bottom: 1px solid #d7d7d7;*/ +} + +.sect1, .sect2 { + margin-bottom: 20px; +} + +.clear +{ + clear: both; +} + +.note, .listingblock{ + padding-left: 8px; + padding-right: 8px; + margin-bottom: 14px; + background-color: #f7f7f9; + border: 1px solid #e1e1e8; + border-radius: 4px; + color: #808080; +} + +table.tableblock { + width: 100%; + max-width: 100%; + margin-bottom: 20px; + background-color: transparent; + border-spacing: 0; + border-collapse: collapse; + border: 1px solid #ddd; + table-layout: fixed; +} + +table.tableblock>caption+thead>tr:first-child>td, table.tableblock>caption+thead>tr:first-child>th, table.tableblock>colgroup+thead>tr:first-child>td, table.tableblock>colgroup+thead>tr:first-child>th, table.tableblock>thead:first-child>tr:first-child>td, table.tableblock>thead:first-child>tr:first-child>th { + border-top: 0; +} + +table.tableblock > thead > tr > th { + border-bottom-color: #8bd6d8; +} + +table.tableblock>thead>tr>th { + vertical-align: bottom; + border-bottom: 1px solid #ddd; +} + +table.tableblock>tbody>tr>td, table.tableblock>tbody>tr>th, table.tableblock>tfoot>tr>td, table.tableblock>tfoot>tr>th, table.tableblock>thead>tr>td, table.tableblock>thead>tr>th { + padding: 8px; + line-height: 1.42857143; + vertical-align: top; + border-top: 1px solid #ddd; +} + +th { + text-align: left; +} + +table.tableblock > tbody > tr:nth-of-type(odd) { + background-color: #f5f5f5; +} + +table.tableblock > tbody > tr:nth-of-type(odd) { + background-color: #f9f9f9; +} + +td > p { + margin:0; +} + +td.content { + white-space: normal; +} + +pre, td, th { + white-space: pre-wrap; + white-space: -moz-pre-wrap; + white-space: -pre-wrap; + white-space: -o-pre-wrap; + word-wrap: break-word; +} + +img { + max-width: 100%; +} + +a { + color: #007387; +} + +a:hover { + color: #004c59; +} + +#toc-parent { + width: 25%; + float: left; + height: 100%; + overflow-y: auto; + position: fixed; + padding: 10px; + border-right: 1px solid #ccc; +} + +#generated-toc { + width: 100%; + height: 100%; + font-size: 16px; +} + +.toc-link { + text-decoration: none; +} + +.toc-list { + margin: 0 20px 0 10px; +} + +.toc-list-item { + padding: 4px 0 4px 0; +} diff --git a/userguide-cmmn/src/en/generate-all.sh b/userguide-cmmn/src/en/generate-all.sh new file mode 100755 index 0000000000000000000000000000000000000000..155bca2e71ffeb2633e3ce2e2fc39be7c262a070 --- /dev/null +++ b/userguide-cmmn/src/en/generate-all.sh @@ -0,0 +1,7 @@ +#!/bin/bash +./clean.sh +echo "Generating HTML" +./generate-html.sh +echo "Generating PDF" +./generate-pdf.sh +echo "Done" diff --git a/userguide-cmmn/src/en/generate-html.sh b/userguide-cmmn/src/en/generate-html.sh new file mode 100755 index 0000000000000000000000000000000000000000..4a89000cfde14ba20834f8d99b75cf7e9a3c6482 --- /dev/null +++ b/userguide-cmmn/src/en/generate-html.sh @@ -0,0 +1,7 @@ +#!/bin/bash + +asciidoctor -a stylesheet=flowable.css -o output/index.html index-html.adoc + +rm -rf output/images +mkdir output/images +cp -r images output diff --git a/userguide-cmmn/src/en/generate-pdf.sh b/userguide-cmmn/src/en/generate-pdf.sh new file mode 100755 index 0000000000000000000000000000000000000000..4f222a0d514fc055603a765c0c6760f6b5afbaec --- /dev/null +++ b/userguide-cmmn/src/en/generate-pdf.sh @@ -0,0 +1,3 @@ +#!/bin/bash +rm -rf output/flowable-cmmn-userguide.pdf +asciidoctor-pdf -o output/flowable-cmmn-userguide.pdf index-pdf.adoc diff --git a/userguide-cmmn/src/en/index-common.adoc b/userguide-cmmn/src/en/index-common.adoc new file mode 100644 index 0000000000000000000000000000000000000000..a08d492b373fef8b1af910f0de128ebcaf121c41 --- /dev/null +++ b/userguide-cmmn/src/en/index-common.adoc @@ -0,0 +1 @@ +include::ch01-Introduction.adoc[] diff --git a/userguide-cmmn/src/en/index-html.adoc b/userguide-cmmn/src/en/index-html.adoc new file mode 100644 index 0000000000000000000000000000000000000000..b03e044b5ecaa144ed1253380f5419b3cde79965 --- /dev/null +++ b/userguide-cmmn/src/en/index-html.adoc @@ -0,0 +1,14 @@ += Flowable CMMN DOCS (v 6.2.0-SNAPSHOT) +:doctype: book +:docinfo1: header +:icons: font +:numbered: +:source-highlighter: pygments +:pygments-css: class +:pygments-linenums-mode: table +:compat-mode: +:pdf-page-size: A4 +:nofooter: + + +include::index-common.adoc[] diff --git a/userguide-cmmn/src/en/index-pdf.adoc b/userguide-cmmn/src/en/index-pdf.adoc new file mode 100644 index 0000000000000000000000000000000000000000..bad665691ec56ba0a98af01ad9daa1d917c7b10c --- /dev/null +++ b/userguide-cmmn/src/en/index-pdf.adoc @@ -0,0 +1,14 @@ += Flowable CMMN DOCS (v 6.2.0-SNAPSHOT) +:doctype: book +:toc: left +:toclevels: 4 +:icons: font +:numbered: +:source-highlighter: pygments +:pygments-css: class +:pygments-linenums-mode: table +:compat-mode: +:pdf-page-size: A4 +:nofooter: + +include::index-common.adoc[] diff --git a/userguide-dmn/pom.xml b/userguide-dmn/pom.xml deleted file mode 100644 index 4769722ba09dfaffb72c245c2bef5f8c75591ffb..0000000000000000000000000000000000000000 --- a/userguide-dmn/pom.xml +++ /dev/null @@ -1,39 +0,0 @@ - - 4.0.0 - - Flowable - DMN - Userguide - org.flowable - flowable-dmn-userguide - 1.0 - - - - org.flowable - flowable-docbook-tool - 1.0 - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - - unpack-dependencies - compile - - unpack-dependencies - - - target - - - - - - - - diff --git a/userguide-dmn/src/en/ch01-Introduction.adoc b/userguide-dmn/src/en/ch01-Introduction.adoc index e6b8c9a17c27e6583e4deaa1c2f7f48d579973f3..0a17acaf85288e28596efb57dcfacb44534983d4 100644 --- a/userguide-dmn/src/en/ch01-Introduction.adoc +++ b/userguide-dmn/src/en/ch01-Introduction.adoc @@ -45,7 +45,7 @@ Further in this user guide, there is a section on < - 4.0.0 - - Flowable - Forn - Userguide - org.flowable - flowable-form-userguide - 1.0 - - - - org.flowable - flowable-docbook-tool - 1.0 - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - - unpack-dependencies - compile - - unpack-dependencies - - - target - - - - - - - - diff --git a/userguide-form/src/en/ch01-Introduction.adoc b/userguide-form/src/en/ch01-Introduction.adoc index 98e12aa423ef36b8d02fdaa2a34d66183f2eca75..930443c01163a5972e4a4cdce1644a0233109765 100644 --- a/userguide-form/src/en/ch01-Introduction.adoc +++ b/userguide-form/src/en/ch01-Introduction.adoc @@ -45,7 +45,7 @@ Further in this user guide, there is a section on < - 4.0.0 - - Flowable - Userguide - org.flowable - flowable-userguide - 1.0 - - - - org.flowable - flowable-docbook-tool - 1.0 - - - - - - - org.apache.maven.plugins - maven-dependency-plugin - - - unpack-dependencies - compile - - unpack-dependencies - - - target - - - - - - - - diff --git a/userguide/src/en/ch01-Introduction.adoc b/userguide/src/en/ch01-Introduction.adoc index f55e864f2675bc7855d2e7379facddc286cc7487..a75278c7235898094ddb8f9d4cd6ddb42aa2835f 100644 --- a/userguide/src/en/ch01-Introduction.adoc +++ b/userguide/src/en/ch01-Introduction.adoc @@ -44,7 +44,7 @@ Further on in this guide, there is a section on <