You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@unomi.apache.org by sh...@apache.org on 2018/09/10 09:30:15 UTC
[1/8] incubator-unomi git commit: Create new manual module and add
master documentation in asciidoc format
Repository: incubator-unomi
Updated Branches:
refs/heads/master 1d5725a12 -> 8a9559ce6
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/DroidSerif_Apache License.txt
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/DroidSerif_Apache License.txt b/manual/src/theme/fonts/DroidSerif_Apache License.txt
new file mode 100644
index 0000000..989e2c5
--- /dev/null
+++ b/manual/src/theme/fonts/DroidSerif_Apache License.txt
@@ -0,0 +1,201 @@
+Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans-Bold.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans-Bold.ttf b/manual/src/theme/fonts/OpenSans-Bold.ttf
new file mode 100644
index 0000000..7b52945
Binary files /dev/null and b/manual/src/theme/fonts/OpenSans-Bold.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans-BoldItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans-BoldItalic.ttf b/manual/src/theme/fonts/OpenSans-BoldItalic.ttf
new file mode 100644
index 0000000..a670e14
Binary files /dev/null and b/manual/src/theme/fonts/OpenSans-BoldItalic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans-ExtraBold.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans-ExtraBold.ttf b/manual/src/theme/fonts/OpenSans-ExtraBold.ttf
new file mode 100644
index 0000000..3660681
Binary files /dev/null and b/manual/src/theme/fonts/OpenSans-ExtraBold.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans-ExtraBoldItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans-ExtraBoldItalic.ttf b/manual/src/theme/fonts/OpenSans-ExtraBoldItalic.ttf
new file mode 100644
index 0000000..8c4c15d
Binary files /dev/null and b/manual/src/theme/fonts/OpenSans-ExtraBoldItalic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans-Italic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans-Italic.ttf b/manual/src/theme/fonts/OpenSans-Italic.ttf
new file mode 100644
index 0000000..e6c5414
Binary files /dev/null and b/manual/src/theme/fonts/OpenSans-Italic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans-Light.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans-Light.ttf b/manual/src/theme/fonts/OpenSans-Light.ttf
new file mode 100644
index 0000000..563872c
Binary files /dev/null and b/manual/src/theme/fonts/OpenSans-Light.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans-LightItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans-LightItalic.ttf b/manual/src/theme/fonts/OpenSans-LightItalic.ttf
new file mode 100644
index 0000000..5ebe2a2
Binary files /dev/null and b/manual/src/theme/fonts/OpenSans-LightItalic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans-Regular.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans-Regular.ttf b/manual/src/theme/fonts/OpenSans-Regular.ttf
new file mode 100644
index 0000000..2e31d02
Binary files /dev/null and b/manual/src/theme/fonts/OpenSans-Regular.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans-SemiBold.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans-SemiBold.ttf b/manual/src/theme/fonts/OpenSans-SemiBold.ttf
new file mode 100644
index 0000000..99db86a
Binary files /dev/null and b/manual/src/theme/fonts/OpenSans-SemiBold.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans-SemiBoldItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans-SemiBoldItalic.ttf b/manual/src/theme/fonts/OpenSans-SemiBoldItalic.ttf
new file mode 100644
index 0000000..8cad4e3
Binary files /dev/null and b/manual/src/theme/fonts/OpenSans-SemiBoldItalic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/OpenSans_LICENSE.txt
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/OpenSans_LICENSE.txt b/manual/src/theme/fonts/OpenSans_LICENSE.txt
new file mode 100644
index 0000000..75b5248
--- /dev/null
+++ b/manual/src/theme/fonts/OpenSans_LICENSE.txt
@@ -0,0 +1,202 @@
+
+ Apache License
+ Version 2.0, January 2004
+ http://www.apache.org/licenses/
+
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+ 1. Definitions.
+
+ "License" shall mean the terms and conditions for use, reproduction,
+ and distribution as defined by Sections 1 through 9 of this document.
+
+ "Licensor" shall mean the copyright owner or entity authorized by
+ the copyright owner that is granting the License.
+
+ "Legal Entity" shall mean the union of the acting entity and all
+ other entities that control, are controlled by, or are under common
+ control with that entity. For the purposes of this definition,
+ "control" means (i) the power, direct or indirect, to cause the
+ direction or management of such entity, whether by contract or
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
+ outstanding shares, or (iii) beneficial ownership of such entity.
+
+ "You" (or "Your") shall mean an individual or Legal Entity
+ exercising permissions granted by this License.
+
+ "Source" form shall mean the preferred form for making modifications,
+ including but not limited to software source code, documentation
+ source, and configuration files.
+
+ "Object" form shall mean any form resulting from mechanical
+ transformation or translation of a Source form, including but
+ not limited to compiled object code, generated documentation,
+ and conversions to other media types.
+
+ "Work" shall mean the work of authorship, whether in Source or
+ Object form, made available under the License, as indicated by a
+ copyright notice that is included in or attached to the work
+ (an example is provided in the Appendix below).
+
+ "Derivative Works" shall mean any work, whether in Source or Object
+ form, that is based on (or derived from) the Work and for which the
+ editorial revisions, annotations, elaborations, or other modifications
+ represent, as a whole, an original work of authorship. For the purposes
+ of this License, Derivative Works shall not include works that remain
+ separable from, or merely link (or bind by name) to the interfaces of,
+ the Work and Derivative Works thereof.
+
+ "Contribution" shall mean any work of authorship, including
+ the original version of the Work and any modifications or additions
+ to that Work or Derivative Works thereof, that is intentionally
+ submitted to Licensor for inclusion in the Work by the copyright owner
+ or by an individual or Legal Entity authorized to submit on behalf of
+ the copyright owner. For the purposes of this definition, "submitted"
+ means any form of electronic, verbal, or written communication sent
+ to the Licensor or its representatives, including but not limited to
+ communication on electronic mailing lists, source code control systems,
+ and issue tracking systems that are managed by, or on behalf of, the
+ Licensor for the purpose of discussing and improving the Work, but
+ excluding communication that is conspicuously marked or otherwise
+ designated in writing by the copyright owner as "Not a Contribution."
+
+ "Contributor" shall mean Licensor and any individual or Legal Entity
+ on behalf of whom a Contribution has been received by Licensor and
+ subsequently incorporated within the Work.
+
+ 2. Grant of Copyright License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ copyright license to reproduce, prepare Derivative Works of,
+ publicly display, publicly perform, sublicense, and distribute the
+ Work and such Derivative Works in Source or Object form.
+
+ 3. Grant of Patent License. Subject to the terms and conditions of
+ this License, each Contributor hereby grants to You a perpetual,
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+ (except as stated in this section) patent license to make, have made,
+ use, offer to sell, sell, import, and otherwise transfer the Work,
+ where such license applies only to those patent claims licensable
+ by such Contributor that are necessarily infringed by their
+ Contribution(s) alone or by combination of their Contribution(s)
+ with the Work to which such Contribution(s) was submitted. If You
+ institute patent litigation against any entity (including a
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
+ or a Contribution incorporated within the Work constitutes direct
+ or contributory patent infringement, then any patent licenses
+ granted to You under this License for that Work shall terminate
+ as of the date such litigation is filed.
+
+ 4. Redistribution. You may reproduce and distribute copies of the
+ Work or Derivative Works thereof in any medium, with or without
+ modifications, and in Source or Object form, provided that You
+ meet the following conditions:
+
+ (a) You must give any other recipients of the Work or
+ Derivative Works a copy of this License; and
+
+ (b) You must cause any modified files to carry prominent notices
+ stating that You changed the files; and
+
+ (c) You must retain, in the Source form of any Derivative Works
+ that You distribute, all copyright, patent, trademark, and
+ attribution notices from the Source form of the Work,
+ excluding those notices that do not pertain to any part of
+ the Derivative Works; and
+
+ (d) If the Work includes a "NOTICE" text file as part of its
+ distribution, then any Derivative Works that You distribute must
+ include a readable copy of the attribution notices contained
+ within such NOTICE file, excluding those notices that do not
+ pertain to any part of the Derivative Works, in at least one
+ of the following places: within a NOTICE text file distributed
+ as part of the Derivative Works; within the Source form or
+ documentation, if provided along with the Derivative Works; or,
+ within a display generated by the Derivative Works, if and
+ wherever such third-party notices normally appear. The contents
+ of the NOTICE file are for informational purposes only and
+ do not modify the License. You may add Your own attribution
+ notices within Derivative Works that You distribute, alongside
+ or as an addendum to the NOTICE text from the Work, provided
+ that such additional attribution notices cannot be construed
+ as modifying the License.
+
+ You may add Your own copyright statement to Your modifications and
+ may provide additional or different license terms and conditions
+ for use, reproduction, or distribution of Your modifications, or
+ for any such Derivative Works as a whole, provided Your use,
+ reproduction, and distribution of the Work otherwise complies with
+ the conditions stated in this License.
+
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
+ any Contribution intentionally submitted for inclusion in the Work
+ by You to the Licensor shall be under the terms and conditions of
+ this License, without any additional terms or conditions.
+ Notwithstanding the above, nothing herein shall supersede or modify
+ the terms of any separate license agreement you may have executed
+ with Licensor regarding such Contributions.
+
+ 6. Trademarks. This License does not grant permission to use the trade
+ names, trademarks, service marks, or product names of the Licensor,
+ except as required for reasonable and customary use in describing the
+ origin of the Work and reproducing the content of the NOTICE file.
+
+ 7. Disclaimer of Warranty. Unless required by applicable law or
+ agreed to in writing, Licensor provides the Work (and each
+ Contributor provides its Contributions) on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+ implied, including, without limitation, any warranties or conditions
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+ PARTICULAR PURPOSE. You are solely responsible for determining the
+ appropriateness of using or redistributing the Work and assume any
+ risks associated with Your exercise of permissions under this License.
+
+ 8. Limitation of Liability. In no event and under no legal theory,
+ whether in tort (including negligence), contract, or otherwise,
+ unless required by applicable law (such as deliberate and grossly
+ negligent acts) or agreed to in writing, shall any Contributor be
+ liable to You for damages, including any direct, indirect, special,
+ incidental, or consequential damages of any character arising as a
+ result of this License or out of the use or inability to use the
+ Work (including but not limited to damages for loss of goodwill,
+ work stoppage, computer failure or malfunction, or any and all
+ other commercial damages or losses), even if such Contributor
+ has been advised of the possibility of such damages.
+
+ 9. Accepting Warranty or Additional Liability. While redistributing
+ the Work or Derivative Works thereof, You may choose to offer,
+ and charge a fee for, acceptance of support, warranty, indemnity,
+ or other liability obligations and/or rights consistent with this
+ License. However, in accepting such obligations, You may act only
+ on Your own behalf and on Your sole responsibility, not on behalf
+ of any other Contributor, and only if You agree to indemnify,
+ defend, and hold each Contributor harmless for any liability
+ incurred by, or claims asserted against, such Contributor by reason
+ of your accepting any such warranty or additional liability.
+
+ END OF TERMS AND CONDITIONS
+
+ APPENDIX: How to apply the Apache License to your work.
+
+ To apply the Apache License to your work, attach the following
+ boilerplate notice, with the fields enclosed by brackets "[]"
+ replaced with your own identifying information. (Don't include
+ the brackets!) The text should be enclosed in the appropriate
+ comment syntax for the file format. We also recommend that a
+ file or class name and description of purpose be included on the
+ same "printed page" as the copyright notice for easier
+ identification within third-party archives.
+
+ Copyright [yyyy] [name of copyright owner]
+
+ Licensed 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.
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-Black.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-Black.ttf b/manual/src/theme/fonts/SourceSansPro-Black.ttf
new file mode 100644
index 0000000..7ea0260
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-Black.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-BlackItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-BlackItalic.ttf b/manual/src/theme/fonts/SourceSansPro-BlackItalic.ttf
new file mode 100644
index 0000000..e1a7482
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-BlackItalic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-Bold.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-Bold.ttf b/manual/src/theme/fonts/SourceSansPro-Bold.ttf
new file mode 100644
index 0000000..f698646
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-Bold.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-BoldItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-BoldItalic.ttf b/manual/src/theme/fonts/SourceSansPro-BoldItalic.ttf
new file mode 100644
index 0000000..5c00b64
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-BoldItalic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-ExtraLight.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-ExtraLight.ttf b/manual/src/theme/fonts/SourceSansPro-ExtraLight.ttf
new file mode 100644
index 0000000..f1da6b2
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-ExtraLight.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-ExtraLightItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-ExtraLightItalic.ttf b/manual/src/theme/fonts/SourceSansPro-ExtraLightItalic.ttf
new file mode 100644
index 0000000..15f7344
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-ExtraLightItalic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-Italic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-Italic.ttf b/manual/src/theme/fonts/SourceSansPro-Italic.ttf
new file mode 100644
index 0000000..82e8762
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-Italic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-Light.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-Light.ttf b/manual/src/theme/fonts/SourceSansPro-Light.ttf
new file mode 100644
index 0000000..ea1104b
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-Light.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-LightItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-LightItalic.ttf b/manual/src/theme/fonts/SourceSansPro-LightItalic.ttf
new file mode 100644
index 0000000..b78f1b0
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-LightItalic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-Regular.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-Regular.ttf b/manual/src/theme/fonts/SourceSansPro-Regular.ttf
new file mode 100644
index 0000000..278ad8a
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-Regular.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-SemiBold.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-SemiBold.ttf b/manual/src/theme/fonts/SourceSansPro-SemiBold.ttf
new file mode 100644
index 0000000..ac3e0d1
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-SemiBold.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro-SemiBoldItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-SemiBoldItalic.ttf b/manual/src/theme/fonts/SourceSansPro-SemiBoldItalic.ttf
new file mode 100644
index 0000000..b0737bb
Binary files /dev/null and b/manual/src/theme/fonts/SourceSansPro-SemiBoldItalic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/SourceSansPro_OFL.txt
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro_OFL.txt b/manual/src/theme/fonts/SourceSansPro_OFL.txt
new file mode 100644
index 0000000..72d81ab
--- /dev/null
+++ b/manual/src/theme/fonts/SourceSansPro_OFL.txt
@@ -0,0 +1,93 @@
+Copyright 2010, 2012, 2014 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name ‘Source’.
+
+This Font Software is licensed under the SIL Open Font License, Version 1.1.
+This license is copied below, and is also available with a FAQ at:
+http://scripts.sil.org/OFL
+
+
+-----------------------------------------------------------
+SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
+-----------------------------------------------------------
+
+PREAMBLE
+The goals of the Open Font License (OFL) are to stimulate worldwide
+development of collaborative font projects, to support the font creation
+efforts of academic and linguistic communities, and to provide a free and
+open framework in which fonts may be shared and improved in partnership
+with others.
+
+The OFL allows the licensed fonts to be used, studied, modified and
+redistributed freely as long as they are not sold by themselves. The
+fonts, including any derivative works, can be bundled, embedded,
+redistributed and/or sold with any software provided that any reserved
+names are not used by derivative works. The fonts and derivatives,
+however, cannot be released under any other type of license. The
+requirement for fonts to remain under this license does not apply
+to any document created using the fonts or their derivatives.
+
+DEFINITIONS
+"Font Software" refers to the set of files released by the Copyright
+Holder(s) under this license and clearly marked as such. This may
+include source files, build scripts and documentation.
+
+"Reserved Font Name" refers to any names specified as such after the
+copyright statement(s).
+
+"Original Version" refers to the collection of Font Software components as
+distributed by the Copyright Holder(s).
+
+"Modified Version" refers to any derivative made by adding to, deleting,
+or substituting -- in part or in whole -- any of the components of the
+Original Version, by changing formats or by porting the Font Software to a
+new environment.
+
+"Author" refers to any designer, engineer, programmer, technical
+writer or other person who contributed to the Font Software.
+
+PERMISSION & CONDITIONS
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of the Font Software, to use, study, copy, merge, embed, modify,
+redistribute, and sell modified and unmodified copies of the Font
+Software, subject to the following conditions:
+
+1) Neither the Font Software nor any of its individual components,
+in Original or Modified Versions, may be sold by itself.
+
+2) Original or Modified Versions of the Font Software may be bundled,
+redistributed and/or sold with any software, provided that each copy
+contains the above copyright notice and this license. These can be
+included either as stand-alone text files, human-readable headers or
+in the appropriate machine-readable metadata fields within text or
+binary files as long as those fields can be easily viewed by the user.
+
+3) No Modified Version of the Font Software may use the Reserved Font
+Name(s) unless explicit written permission is granted by the corresponding
+Copyright Holder. This restriction only applies to the primary font name as
+presented to the users.
+
+4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
+Software shall not be used to promote, endorse or advertise any
+Modified Version, except to acknowledge the contribution(s) of the
+Copyright Holder(s) and the Author(s) or with their explicit written
+permission.
+
+5) The Font Software, modified or unmodified, in part or in whole,
+must be distributed entirely under this license, and must not be
+distributed under any other license. The requirement for fonts to
+remain under this license does not apply to any document created
+using the Font Software.
+
+TERMINATION
+This license becomes null and void if any of the above conditions are
+not met.
+
+DISCLAIMER
+THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
+OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
+COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
+DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
+OTHER DEALINGS IN THE FONT SOFTWARE.
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/images/asf_logo.png
----------------------------------------------------------------------
diff --git a/manual/src/theme/images/asf_logo.png b/manual/src/theme/images/asf_logo.png
new file mode 100644
index 0000000..b20bb7f
Binary files /dev/null and b/manual/src/theme/images/asf_logo.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/images/asf_logo_url.png
----------------------------------------------------------------------
diff --git a/manual/src/theme/images/asf_logo_url.png b/manual/src/theme/images/asf_logo_url.png
new file mode 100644
index 0000000..5ad4544
Binary files /dev/null and b/manual/src/theme/images/asf_logo_url.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/pom.xml
----------------------------------------------------------------------
diff --git a/pom.xml b/pom.xml
index 3ed5ac3..715d1c9 100644
--- a/pom.xml
+++ b/pom.xml
@@ -905,6 +905,7 @@
<module>kar</module>
<module>samples</module>
<module>package</module>
+ <module>manual</module>
</modules>
<dependencies>
[2/8] incubator-unomi git commit: Create new manual module and add
master documentation in asciidoc format
Posted by sh...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/connectors/salesforce-connector.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/connectors/salesforce-connector.adoc b/manual/src/main/asciidoc/connectors/salesforce-connector.adoc
new file mode 100644
index 0000000..23c0a22
--- /dev/null
+++ b/manual/src/main/asciidoc/connectors/salesforce-connector.adoc
@@ -0,0 +1,224 @@
+//
+// Licensed 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.
+//
+=== Apache Unomi Salesforce Connector
+
+This connectors makes it possible to push and pull data to/from the Salesforce CRM. It can copy information between
+Apache Unomi profiles and Salesforce Leads.
+
+==== Getting started
+
+.
+
+Create a new developer account here:
+
+[source]
+----
+https://developer.salesforce.com/signup
+----
+
+.
+
+Create a new Connected App, by going into Setup -> App Manager and click "Create Connected App"
+
+.
+
+In the settings, make sure you do the following:
+
+[source]
+----
+Enable OAuth settings -> Activated
+Enable for device flow -> Activated (no need for a callback URL)
+Add all the selected OAuth scopes you want (or put all of them)
+Make sure Require Secret for Web Server flow is activated
+----
+
+.
+
+Make sure you retrieve the following information once you have created the app in the API (Enable OAuth Settings):
+
+[source]
+----
+Consumer key
+Consumer secret (click to see it)
+----
+
+.
+
+You must also retrieve your user's security token, or create it if you don't have one already. To do this simply
+click on your user at the top right, select "Settings", the click on "Reset my security token". You will receive an email
+with the security token.
+
+.
+
+You are now ready to configure the Apache Unomi Salesforce Connector. In the etc/org.apache.unomi.sfdc.cfg file
+change the following settings:
+
+[source]
+----
+sfdc.user.username=YOUR_USER_NAME
+sfdc.user.password=YOUR_PASSWORD
+sfdc.user.securityToken=YOUR_USER_SECURITY_TOKEN
+sfdc.consumer.key=CONNECTED_APP_CONSUMER_KEY
+sfdc.consumer.secret=CONNECTED_APP_SECRET
+----
+
+.
+
+Connected to the Apache Unomi Karaf Shell using :
+
+[source]
+----
+ssh -p 8102 karaf@localhost (default password is karaf)
+----
+
+.
+
+Deploy into Apache Unomi using the following commands from the Apache Karaf shell:
+
+[source]
+----
+feature:repo-add mvn:org.apache.unomi/unomi-salesforce-connectors-karaf-kar/${project.version}/xml/features
+feature:install unomi-salesforce-connectors-karaf-kar
+----
+
+.
+
+You can then test the connection to Salesforce by accessing the following URLs:
+
+[source]
+----
+https://localhost:9443/cxs/sfdc/version
+https://localhost:9443/cxs/sfdc/limits
+----
+
+The first URL will give you information about the version of the connectors, so this makes it easy to check that the
+plugin is properly deployed, started and the correct version. The second URL will actually make a request to the
+Salesforce REST API to retrieve the limits of the Salesforce API.
+
+Both URLs are password protected by the Apache Unomi (Karaf) password. You can find this user and password information
+in the etc/users.properties file.
+
+.
+
+You can now use the connectors's defined actions in rules to push or pull data to/from the Salesforce CRM. You can
+find more information about rules in the link:concepts.html[Concepts] and the link:getting-started.html[Getting Started] pages.
+
+==== Upgrading the Salesforce connectors
+
+If you followed all the steps in the Getting Started section, you can upgrade the Salesforce connectors by using the following steps:
+
+.
+
+Compile the connectors using:
+
+[source]
+----
+cd extensions/salesforce-connectors
+mvn clean install
+----
+
+.
+
+Login to the Unomi Karaf Shell using:
+
+[source]
+----
+ssh -p 8102 karaf@localhost (password by default is karaf)
+----
+
+.
+
+Execute the following commands in the Karaf shell
+
+[source]
+----
+feature:repo-refresh
+feature:uninstall unomi-salesforce-connectors-karaf-feature
+feature:install unomi-salesforce-connectors-karaf-feature
+----
+
+.
+
+You can then check that the new version is properly deployed by accessing the following URL and checking the build date:
+
+[source]
+----
+https://localhost:9443/cxs/sfdc/version
+----
+
+(if asked for a password it's the same karaf/karaf default)
+
+==== Using the Salesforce Workbench for testing REST API
+
+The Salesforce Workbench contains a REST API Explorer that is very useful to test requests. You may find it here :
+
+[source]
+----
+https://workbench.developerforce.com/restExplorer.php
+----
+
+==== Setting up Streaming Push queries
+
+Using the Salesforce Workbench, you can setting streaming push queries (Queries->Streaming push topics) such as the
+following example:
+
+[source]
+----
+Name: LeadUpdates
+Query : SELECT Id,FirstName,LastName,Email,Company FROM Lead
+----
+
+==== Executing the unit tests
+
+Before running the tests, make sure you have completed all the steps above, including the streaming push queries setup.
+
+By default the unit tests will not run as they need proper Salesforce credentials to run. To set this up create a
+properties file like the following one:
+
+test.properties
+
+[source]
+----
+#
+# 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.
+#
+sfdc.user.username=YOUR_USER_NAME
+sfdc.user.password=YOUR_PASSWORD
+sfdc.user.securityToken=YOUR_USER_SECURITY_TOKEN
+sfdc.consumer.key=CONNECTED_APP_CONSUMER_KEY
+sfdc.consumer.secret=CONNECTED_APP_SECRET
+----
+
+and then use the following command line to reference the file:
+
+[source]
+----
+cd extensions/salesforce-connectors
+mvn clean install -DsfdcProperties=../test.properties
+----
+
+(in case you're wondering the ../ is because the test is located in the services sub-directory)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/consent-api.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/consent-api.adoc b/manual/src/main/asciidoc/consent-api.adoc
new file mode 100644
index 0000000..fad664f
--- /dev/null
+++ b/manual/src/main/asciidoc/consent-api.adoc
@@ -0,0 +1,139 @@
+//
+// Licensed 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.
+//
+=== Consent API
+
+Starting with Apache Unomi 1.3 (still in development), a new API for consent management is now available. This API
+is designed to be able to store/retrieve/update visitor consents in order to comply with new
+privacy regulations such as the https://en.wikipedia.org/wiki/General_Data_Protection_Regulation[GDPR].
+
+==== Profiles with consents
+
+Visitor profiles now contain a new Consent object that contains the following information:
+
+* a scope
+* a type identifier for the consent. This can be any key to reference a consent. Note that Unomi does not manage consent
+definitions, it only stores/retrieves consents for each profile based on this type
+* a status : GRANT, DENY or REVOKED
+* a status date (the date at which the status was updated)
+* a revocation date, in order to comply with GDPR this is usually set at two years
+
+Here is an example of a Profile with a consent attached to it:
+
+[source]
+----
+{
+ "profileId": "8cbe380f-57bb-419d-97bf-24bf30178550",
+ "sessionId": "0d755f4e-154a-45c8-9169-e852e1d706d9",
+ "consents": {
+ "example/newsletter": {
+ "scope": "example",
+ "typeIdentifier": "newsletter",
+ "status": "GRANTED",
+ "statusDate": "2018-05-22T09:44:33Z",
+ "revokeDate": "2020-05-21T09:44:33Z"
+ }
+ }
+}
+----
+
+It is of course possible to have multiple consents defined for a single visitor profile.
+
+==== Consent type definitions
+
+Apache Unomi does not manage consent definitions, it leaves that to an external system (for example a CMS) so that it
+can handle user-facing UIs to create, update, internationalize and present consent definitions to end users.
+
+The only thing that is import to Apache Unomi to manage visitor consents is a globally unique key, that is called the
+consent type.
+
+==== Creating / update a visitor consent
+
+A new built-in event type called "modifyConsent" can be sent to Apache Unomi to update a consent for the current
+profile.
+
+Here is an example of such an event:
+
+[source]
+----
+{
+ "events": [
+ {
+ "scope": "example",
+ "eventType": "modifyConsent",
+ "source": {
+ "itemType": "page",
+ "scope": "example",
+ "itemId": "anItemId"
+ },
+ "target": {
+ "itemType": "anyType",
+ "scope": "example",
+ "itemId": "anyItemId"
+ },
+ "properties": {
+ "consent": {
+ "typeIdentifier": "newsletter",
+ "scope": "example",
+ "status": "GRANTED",
+ "statusDate": "2018-05-22T09:27:09.473Z",
+ "revokeDate": "2020-05-21T09:27:09.473Z"
+ }
+ }
+ }
+ ]
+}
+----
+
+You could send it using the following curl request:
+
+[source]
+----
+curl -H "Content-Type: application/json" -X POST -d '{"source":{"itemId":"homepage","itemType":"page","scope":"example"},"events":[{"scope":"example","eventType":"modifyConsent","source":{"itemType":"page","scope":"example","itemId":"anItemId"},"target":{"itemType":"anyType","scope":"example","itemId":"anyItemId"},"properties":{"consent":{"typeIdentifier":"newsletter","scope":"example","status":"GRANTED","statusDate":"2018-05-22T09:27:09.473Z","revokeDate":"2020-05-21T09:27:09.473Z"}}}]}' http://localhost:8181/context.json?sessionId=1234
+----
+
+==== How it works (internally)
+
+Upon receiving this event, Apache Unomi will trigger the modifyAnyConsent rule that has the following definition:
+
+[source]
+----
+{
+ "metadata" : {
+ "id": "modifyAnyConsent",
+ "name": "Modify any consent",
+ "description" : "Modify any consent and sets the consent in the profile",
+ "readOnly":true
+ },
+
+ "condition" : {
+ "type": "modifyAnyConsentEventCondition",
+ "parameterValues": {
+ }
+ },
+
+ "actions" : [
+ {
+ "type": "modifyConsentAction",
+ "parameterValues": {
+ }
+ }
+ ]
+
+}
+----
+
+As we can see this rule is pretty simple it will simply execute the modifyConsentAction that is implemented by the
+https://github.com/apache/incubator-unomi/blob/9f1bab437fd93826dc54d318ed00d3b2e3161437/plugins/baseplugin/src/main/java/org/apache/unomi/plugins/baseplugin/actions/ModifyConsentAction.java[ModifyConsentAction Java class]
+
+This class will update the current visitor profile to add/update/revoke any consents that are included in the event.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/custom-extensions.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/custom-extensions.adoc b/manual/src/main/asciidoc/custom-extensions.adoc
new file mode 100644
index 0000000..20faa72
--- /dev/null
+++ b/manual/src/main/asciidoc/custom-extensions.adoc
@@ -0,0 +1,419 @@
+//
+// Licensed 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.
+//
+=== Custom extensions
+
+Apache Unomi is a pluggeable server that may be extended in many ways. This document assumes you are familiar with the
+link:concepts.html[Apache Unomi concepts] . This document is mostly a reference document on the different things that may
+be used inside an extension. If you are looking for complete samples, please see the link:samples.html[samples page].
+
+==== Creating an extension
+
+An extension is simply a Maven project, with a Maven pom that looks like this:
+
+[source]
+----
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>org.apache.unomi</groupId>
+ <artifactId>unomi-extensions</artifactId>
+ <version>${project.version}</version>
+ </parent>
+
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>unomi-extension-example</artifactId>
+ <name>Apache Unomi :: Extensions :: Example</name>
+ <description>Service implementation for the Apache Unomi Context Server extension that integrates with the Geonames database</description>
+ <version>${project.version}</version>
+ <packaging>bundle</packaging>
+
+ <dependencies>
+ <!-- This dependency is not required but generally used in extensions -->
+ <dependency>
+ <groupId>org.apache.unomi</groupId>
+ <artifactId>unomi-api</artifactId>
+ <version>${project.version}</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-bundle-plugin</artifactId>
+ <extensions>true</extensions>
+ <configuration>
+ <instructions>
+ <Embed-Dependency>*;scope=compile|runtime</Embed-Dependency>
+ <Import-Package>
+ sun.misc;resolution:=optional,
+ *
+ </Import-Package>
+ </instructions>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+</project>
+----
+
+An extension may contain many different kinds of Apache Unomi objects, as well as custom OSGi services or anything that
+is needed to build your application.
+
+==== Deployment and custom definition
+
+When you deploy a custom bundle with a custom definition (see "Predefined xxx" chapters under) for the first time, the definition will automatically be deployed at your bundle start event *if it does not exist*, after that if you redeploy the same bundle there are two cases:
+1. Your bundle *is a SNAPSHOT* then every time you redeploy it the definition will be redeployed
+2. Your bundle *is NOT a SNAPSHOT* then the definition will not be redeployed, but you can redeploy it manually using the command `unomi:deploy-definition <bundleId> <fileName>`
+
+==== Predefined segments
+
+You may provide pre-defined segments by simply adding a JSON file in the src/main/resources/META-INF/cxs/segments directory of
+your Maven project. Here is an example of a pre-defined segment:
+
+[source]
+----
+{
+ "metadata": {
+ "id": "leads",
+ "name": "Leads",
+ "scope": "systemscope",
+ "description": "You can customize the list below by editing the leads segment.",
+ "readOnly":true
+ },
+ "condition": {
+ "parameterValues": {
+ "subConditions": [
+ {
+ "parameterValues": {
+ "propertyName": "properties.leadAssignedTo",
+ "comparisonOperator": "exists"
+ },
+ "type": "profilePropertyCondition"
+ }
+ ],
+ "operator" : "and"
+ },
+ "type": "booleanCondition"
+ }
+}
+----
+
+Basically this segment uses a condition to test if the profile has a property `leadAssignedTo` that exists. All profiles
+that match this condition will be part of the pre-defined segment.
+
+==== Predefined rules
+
+You may provide pre-defined rules by simply adding a JSON file in the src/main/resources/META-INF/cxs/rules directory of
+your Maven project. Here is an example of a pre-defined rule:
+
+[source]
+----
+{
+ "metadata" : {
+ "id": "evaluateProfileSegments",
+ "name": "Evaluate segments",
+ "description" : "Evaluate segments when a profile is modified",
+ "readOnly":true
+ },
+
+ "condition" : {
+ "type": "profileUpdatedEventCondition",
+ "parameterValues": {
+ }
+ },
+
+ "actions" : [
+ {
+ "type": "evaluateProfileSegmentsAction",
+ "parameterValues": {
+ }
+ }
+ ]
+
+}
+----
+
+In this example we provide a rule that will execute when a predefined composed condition of type
+"profileUpdatedEventCondition" is received. See below to see how predefined composed conditions are declared.
+Once the condition is matched, the actions will be executed in sequence. In this example there is only a single
+action of type "evaluateProfileSegmentsAction" that is defined so it will be executed by Apache Unomi's rule engine.
+You can also see below how custom actions may be defined.
+
+==== Predefined properties
+
+By default Apache Unomi comes with a set of pre-defined properties, but in many cases it is useful to add additional
+predefined property definitions. You can create property definitions for session or profile properties by creating them
+in different directories.
+
+For session properties you must create a JSON file in the following directory in your Maven project:
+
+[source]
+----
+src/main/resources/META-INF/cxs/properties/sessions
+----
+
+For profile properties you must create the JSON file inside the directory in your Maven project:
+
+[source]
+----
+src/main/resources/META-INF/cxs/properties/profiles
+----
+
+Here is an example of a property definition JSON file
+
+[source]
+----
+{
+ "metadata": {
+ "id": "city",
+ "name": "City",
+ "systemTags": ["properties", "profileProperties", "contactProfileProperties"]
+ },
+ "type": "string",
+ "defaultValue": "",
+ "automaticMappingsFrom": [ ],
+ "rank": "304.0"
+}
+----
+
+==== Predefined child conditions
+
+You can define new predefined conditions that are actually conditions inheriting from a parent condition and setting
+pre-defined parameter values. You can do this by creating a JSON file in:
+
+[source]
+----
+src/main/resources/META-INF/cxs/conditions
+----
+
+Here is an example of a JSON file that defines a profileUpdateEventCondition that inherits from a parent condition of
+type eventTypeCondition.
+
+[source]
+----
+{
+ "metadata": {
+ "id": "profileUpdatedEventCondition",
+ "name": "profileUpdatedEventCondition",
+ "description": "",
+ "systemTags": [
+ "event",
+ "eventCondition"
+ ],
+ "readOnly": true
+ },
+ "parentCondition": {
+ "type": "eventTypeCondition",
+ "parameterValues": {
+ "eventTypeId": "profileUpdated"
+ }
+ },
+
+ "parameters": [
+ ]
+}
+----
+
+==== Predefined personas
+
+Personas may also be pre-defined by creating JSON files in the following directory:
+
+[source]
+----
+src/main/resources/META-INF/cxs/personas
+----
+
+Here is an example of a persona definition JSON file:
+
+[source]
+----
+{
+ "persona": {
+ "itemId": "usVisitor",
+ "properties": {
+ "description": "Represents a visitor browsing from inside the continental US",
+ "firstName": "U.S.",
+ "lastName": "Visitor"
+ },
+ "segments": []
+ },
+ "sessions": [
+ {
+ "itemId": "aa3b04bd-8f4d-4a07-8e96-d33ffa04d3d9",
+ "profileId": "usVisitor",
+ "properties": {
+ "operatingSystemName": "OS X 10.9 Mavericks",
+ "sessionCountryName": "United States",
+ "location": {
+ "lat":37.422,
+ "lon":-122.084058
+ },
+ "userAgentVersion": "37.0.2062.120",
+ "sessionCountryCode": "US",
+ "deviceCategory": "Personal computer",
+ "operatingSystemFamily": "OS X",
+ "userAgentName": "Chrome",
+ "sessionCity": "Mountain View"
+ },
+ "timeStamp": "2014-09-18T11:40:54Z",
+ "lastEventDate": "2014-09-18T11:40:59Z",
+ "duration": 4790
+ }
+ ]
+}
+----
+
+You can see that it's also possible to define sessions for personas.
+
+==== Custom actions
+
+Custom actions are a powerful way to integrate with external systems by being able to define custom logic that will
+be executed by an Apache Unomi rule. An action is defined by a JSON file created in the following directory:
+
+[source]
+----
+src/main/resources/META-INF/cxs/actions
+----
+
+Here is an example of a JSON action definition:
+
+[source]
+----
+{
+ "metadata": {
+ "id": "addToListsAction",
+ "name": "addToListsAction",
+ "description": "",
+ "systemTags": [
+ "demographic",
+ "availableToEndUser"
+ ],
+ "readOnly": true
+ },
+ "actionExecutor": "addToLists",
+ "parameters": [
+ {
+ "id": "listIdentifiers",
+ "type": "string",
+ "multivalued": true
+ }
+ ]
+}
+----
+
+The `actionExecutor` identifier refers to a service property that is defined in the OSGi Blueprint service registration.
+Note that any OSGi service registration may be used, but in these examples we use OSGi Blueprint. The definition for the
+above JSON file will be found in a file called `src/main/resources/OSGI-INF/blueprint/blueprint.xml` with the following
+content:
+
+[source]
+----
+<?xml version="1.0" encoding="UTF-8"?>
+<blueprint xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+ xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
+
+ <reference id="profileService" interface="org.apache.unomi.api.services.ProfileService"/>
+ <reference id="eventService" interface="org.apache.unomi.api.services.EventService"/>
+
+ <!-- Action executors -->
+
+ <service interface="org.apache.unomi.api.actions.ActionExecutor">
+ <service-properties>
+ <entry key="actionExecutorId" value="addToLists"/>
+ </service-properties>
+ <bean class="org.apache.unomi.lists.actions.AddToListsAction">
+ <property name="profileService" ref="profileService"/>
+ <property name="eventService" ref="eventService"/>
+ </bean>
+ </service>
+
+</blueprint>
+----
+
+You can note here the `actionExecutorId` that corresponds to the `actionExecutor` in the JSON file.
+
+The implementation of the action is available here : https://github.com/apache/incubator-unomi/blob/master/extensions/lists-extension/actions/src/main/java/org/apache/unomi/lists/actions/AddToListsAction.java[org.apache.unomi.lists.actions.AddToListsAction]
+
+==== Custom conditions
+
+Custom conditions are different from predefined child conditions because they implement their logic using Java classes.
+They are also declared by adding a JSON file into the conditions directory:
+
+[source]
+----
+src/main/resources/META-INF/cxs/conditions
+----
+
+Here is an example of JSON custom condition definition:
+
+[source]
+----
+{
+ "metadata": {
+ "id": "matchAllCondition",
+ "name": "matchAllCondition",
+ "description": "",
+ "systemTags": [
+ "logical",
+ "profileCondition",
+ "eventCondition",
+ "sessionCondition",
+ "sourceEventCondition"
+ ],
+ "readOnly": true
+ },
+ "conditionEvaluator": "matchAllConditionEvaluator",
+ "queryBuilder": "matchAllConditionESQueryBuilder",
+
+ "parameters": [
+ ]
+}
+----
+
+Note the `conditionEvaluator` and the `queryBuilder` values. These reference OSGi service properties that are declared
+in an OSGi Blueprint configuration file (other service definitions may also be used such as Declarative Services or even
+Java registered services). Here is an example of an OSGi Blueprint definition corresponding to the above JSON condition
+definition file.
+
+[source]
+----
+src/main/resources/OSGI-INF/blueprint/blueprint.xml
+
+<blueprint xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+ xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
+
+ <service
+ interface="org.apache.unomi.persistence.elasticsearch.conditions.ConditionESQueryBuilder">
+ <service-properties>
+ <entry key="queryBuilderId" value="matchAllConditionESQueryBuilder"/>
+ </service-properties>
+ <bean class="org.apache.unomi.plugins.baseplugin.conditions.MatchAllConditionESQueryBuilder"/>
+ </service>
+
+ <service interface="org.apache.unomi.persistence.elasticsearch.conditions.ConditionEvaluator">
+ <service-properties>
+ <entry key="conditionEvaluatorId" value="matchAllConditionEvaluator"/>
+ </service-properties>
+ <bean class="org.apache.unomi.plugins.baseplugin.conditions.MatchAllConditionEvaluator"/>
+ </service>
+
+</blueprint>
+----
+
+You can find the implementation of the two classes here :
+
+* https://github.com/apache/incubator-unomi/blob/master/plugins/baseplugin/src/main/java/org/apache/unomi/plugins/baseplugin/conditions/MatchAllConditionESQueryBuilder.java[org.apache.unomi.plugins.baseplugin.conditions.MatchAllConditionESQueryBuilder]
+* https://github.com/apache/incubator-unomi/blob/master/plugins/baseplugin/src/main/java/org/apache/unomi/plugins/baseplugin/conditions/MatchAllConditionEvaluator.java[org.apache.unomi.plugins.baseplugin.conditions.MatchAllConditionEvaluator]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/extending-plugins.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/extending-plugins.adoc b/manual/src/main/asciidoc/extending-plugins.adoc
new file mode 100644
index 0000000..8a29fb1
--- /dev/null
+++ b/manual/src/main/asciidoc/extending-plugins.adoc
@@ -0,0 +1,113 @@
+//
+// Licensed 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.
+//
+Unomi is architected so that users can provided extensions in the form of plugins.
+
+=== Types vs. instances
+
+Several extension points in Unomi rely on the concept of type: the extension defines a prototype for what the actual items will be once parameterized with values known only at runtime. This is similar to the concept of classes in object-oriented programming: types define classes, providing the expected structure and which fields are expected to be provided at runtime, that are then instantiated when needed with actual values.
+
+=== Plugin structure
+
+Being built on top of Apache Karaf, Unomi leverages OSGi to support plugins. A Unomi plugin is, thus, an OSGi bundle specifying some specific metadata to tell Unomi the kind of entities it provides. A plugin can provide the following entities to extend Unomi, each with its associated definition (as a JSON file), located in a specific spot within the `META-INF/cxs/` directory of the bundle JAR file:
+
+|====
+|Entity |Location in `cxs` directory
+
+|ActionType |actions
+|ConditionType |conditions
+|Persona |personas
+|PropertyMergeStrategyType |mergers
+|PropertyType |properties then profiles or sessions subdirectory then `<category name>` directory
+|Rule |rules
+|Scoring |scorings
+|Segment |segments
+|ValueType |values
+|====
+
+http://aries.apache.org/modules/blueprint.html[Blueprint] is used to declare what the plugin provides and inject any required dependency. The Blueprint file is located, as usual, at `OSGI-INF/blueprint/blueprint.xml` in the bundle JAR file.
+
+The plugin otherwise follows a regular maven project layout and should depend on the Unomi API maven artifact:
+
+[source,xml]
+----
+<dependency>
+ <groupId>org.apache.unomi</groupId>
+ <artifactId>unomi-api</artifactId>
+ <version>...</version>
+</dependency>
+----
+
+Some plugins consists only of JSON definitions that are used to instantiate the appropriate structures at runtime while some more involved plugins provide code that extends Unomi in deeper ways.
+
+In both cases, plugins can provide more that one type of extension. For example, a plugin could provide both `ActionType`s and `ConditionType`s.
+
+=== Extension points
+
+==== ActionType
+
+`ActionType`s define new actions that can be used as consequences of Rules being triggered. When a rule triggers, it creates new actions based on the event data and the rule internal processes, providing values for parameters defined in the associated `ActionType`. Example actions include: “Set user property x to value y” or “Send a message to service x”.
+
+==== ConditionType
+
+`ConditionType`s define new conditions that can be applied to items (for example to decide whether a rule needs to be triggered or if a profile is considered as taking part in a campaign) or to perform queries against the stored Unomi data. They may be implemented in Java when attempting to define a particularly complex test or one that can better be optimized by coding it. They may also be defined as combination of other conditions. A simple condition could be: “User is male”, while a more generic condition with parameters may test whether a given property has a specific value: “User property x has value y”.
+
+==== Persona
+
+A persona is a "virtual" profile used to represent categories of profiles, and may also be used to test how a personalized experience would look like using this virtual profile. A persona can define predefined properties and sessions. Persona definition make it possible to “emulate” a certain type of profile, e.g : US visitor, non-US visitor, etc.
+
+==== PropertyMergeStrategyType
+
+A strategy to resolve how to merge properties when merging profile together.
+
+==== PropertyType
+
+Definition for a profile or session property, specifying how possible values are constrained, if the value is multi-valued (a vector of values as opposed to a scalar value). `PropertyType`s can also be categorized using systemTags or file system structure, using sub-directories to organize definition files.
+
+==== Rule
+
+`Rule`s are conditional sets of actions to be executed in response to incoming events. Triggering of rules is guarded by a condition: the rule is only triggered if the associated condition is satisfied. That condition can test the event itself, but also the profile or the session. Once a rule triggers, a list of actions can be performed as consequences. Also, when rules trigger, a specific event is raised so that other parts of Unomi can react accordingly.
+
+==== Scoring
+
+`Scoring`s are set of conditions associated with a value to assign to profiles when matching so that the associated users can be scored along that dimension. Each scoring element is evaluated and matching profiles' scores are incremented with the associated value.
+
+==== Segments
+
+`Segment`s represent dynamically evaluated groups of similar profiles in order to categorize the associated users. To be considered part of a given segment, users must satisfies the segment’s condition. If they match, users are automatically added to the segment. Similarly, if at any given point during, they cease to satisfy the segment’s condition, they are automatically removed from it.
+
+==== Tag
+
+`Tag`s are simple labels that are used to classify all other objects inside Unomi.
+
+==== ValueType
+
+Definition for values that can be assigned to properties ("primitive" types).
+
+=== Other Unomi entities
+
+==== UserList
+
+User list are simple static lists of users. The associated profile stores the lists it belongs to in a specific property.
+
+==== Goal
+
+Goals represent tracked activities / actions that can be accomplished by site (or more precisely scope) visitors. These are tracked in general because they relate to specific business objectives or are relevant to measure site/scope performance.
+
+Goals can be defined at the scope level or in the context of a particular `Campaign`. Either types of goals behave exactly the same way with the exception of two notable differences:
+ - duration: scope-level goals are considered until removed while campaign-level goals are only considered for the campaign duration
+ - audience filtering: any visitor is considered for scope-level goals while campaign-level goals only consider visitors who match the campaign's conditions
+
+==== Campaign
+
+A goal-oriented, time-limited marketing operation that needs to be evaluated for return on investment performance by tracking the ratio of visits to conversions.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/getting-started.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/getting-started.adoc b/manual/src/main/asciidoc/getting-started.adoc
new file mode 100644
index 0000000..b0307a2
--- /dev/null
+++ b/manual/src/main/asciidoc/getting-started.adoc
@@ -0,0 +1,121 @@
+//
+// Licensed 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.
+//
+=== Getting started with Unomi
+
+We will first get you up and running with an example. We will then lift the corner of the cover somewhat and explain in greater details what just happened.
+
+==== Prerequisites
+
+This document assumes that you are already familiar with Unomi's link:concepts.html[concepts]. On the technical side, we also assume working knowledge of https://git-scm.com/[git] to be able to retrieve the code for Unomi and the example. Additionnally, you will require a working Java 7 or above install. Refer to http://www.oracle.com/technetwork/java/javase/[http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 7 or greater.
+
+==== Running Unomi
+
+===== Building Unomi
+
+. Get the code: `git clone https://git-wip-us.apache.org/repos/asf/incubator-unomi.git`
+. Build and install according to the link:building-and-deploying.html[instructions] and install Unomi.
+
+===== Start Unomi
+
+Start Unomi according to the link:building-and-deploying.html#Deploying_the_generated_package[instructions]. Once you have Karaf running,
+ you should wait until you see the following messages on the Karaf console:
+
+[source]
+----
+Initializing user list service endpoint...
+Initializing geonames service endpoint...
+Initializing segment service endpoint...
+Initializing scoring service endpoint...
+Initializing campaigns service endpoint...
+Initializing rule service endpoint...
+Initializing profile service endpoint...
+Initializing cluster service endpoint...
+----
+
+This indicates that all the Unomi services are started and ready to react to requests. You can then open a browser and go to `http://localhost:8181/cxs` to see the list of
+available RESTful services or retrieve an initial context at `http://localhost:8181/context.json` (which isn't very useful at this point).
+
+===== Request examples
+
+====== Retrieving your first context
+
+You can retrieve a context using curl like this :
+
+[source]
+----
+curl http://localhost:8181/context.js?sessionId=1234
+----
+
+This will retrieve a JavaScript script that contains a `cxs` object that contains the context with the current user
+profile, segments, scores as well as functions that makes it easier to perform further requests (such as collecting
+events using the cxs.collectEvents() function).
+
+====== Retrieving a context as a JSON object.
+
+If you prefer to retrieve a pure JSON object, you can simply use a request formed like this:
+
+[source]
+----
+curl http://localhost:8181/context.json?sessionId=1234
+----
+
+====== Accessing profile properties in a context
+
+By default, in order to optimize the amount of data sent over the network, Apache Unomi will not send the content of
+the profile or session properties. If you need this data, you must send a JSON object to configure the resulting output
+of the context.js(on) servlet.
+
+Here is an example that will retrieve all the session and profile properties.
+
+[source]
+----
+curl -H "Content-Type: application/json" -X POST -d '{"source":{"itemId":"homepage","itemType":"page","scope":"example"},"requiredProfileProperties":["*"],"requiredSessionProperties":["*"],"requireSegments":true}' http://localhost:8181/context.json?sessionId=1234
+----
+
+The `requiredProfileProperties` and `requiredSessionProperties` are properties that take an array of property names
+that should be retrieved. In this case we use the wildcard character '*' to say we want to retrieve all the available
+properties. The structure of the JSON object that you should send is a JSON-serialized version of the http://unomi.incubator.apache.org/unomi-api/apidocs/org/apache/unomi/api/ContextRequest.html[ContextRequest]
+Java class.
+
+====== Sending events using the context servlet
+
+At the same time as you are retrieving the context, you can also directly send events in the ContextRequest object as
+illustrated in the following example:
+
+[source]
+----
+curl -H "Content-Type: application/json" -X POST -d '{"source":{"itemId":"homepage","itemType":"page","scope":"example"},"events":[{"eventType":"view","scope": "example","source":{"itemType": "site","scope":"example","itemId": "mysite"},"target":{"itemType":"page","scope":"example","itemId":"homepage","properties":{"pageInfo":{"referringURL":""}}}}]}' http://localhost:8181/context.json?sessionId=1234
+----
+
+Upon received events, Apache Unomi will execute all the rules that match the current context, and return an updated context.
+This way of sending events is usually used upon first loading of a page. If you want to send events after the page has
+finished loading you could either do a second call and get an updating context, or if you don't need the context and want
+to send events in a network optimal way you can use the eventcollector servlet (see below).
+
+====== Sending events using the eventcollector servlet
+
+If you only need to send events without retrieving a context, you should use the eventcollector servlet that is optimized
+respond quickly and minimize network traffic. Here is an example of using this servlet:
+
+[source]
+----
+curl -H "Content-Type: application/json" -X POST -d '{"events":[{"eventType":"view","scope": "example","source":{"itemType": "site","scope":"example","itemId": "mysite"},"target":{"itemType":"page","scope":"example","itemId":"homepage","properties":{"pageInfo":{"referringURL":""}}}}]}' http://localhost:8181/eventcollector?sessionId=1234
+----
+
+Note that the eventcollector executes the rules but does not return a context. If is generally used after a page is loaded
+to send additional events.
+
+===== Where to go from here
+
+* Read the link:twitter-samples.html[Twitter samples] documentation that contains a detailed example of how to integrate with Apache Unomi.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/images/asf_logo_url.png
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/images/asf_logo_url.png b/manual/src/main/asciidoc/images/asf_logo_url.png
new file mode 100644
index 0000000..5ad4544
Binary files /dev/null and b/manual/src/main/asciidoc/images/asf_logo_url.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/images/incubator-logo.png
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/images/incubator-logo.png b/manual/src/main/asciidoc/images/incubator-logo.png
new file mode 100644
index 0000000..714dbd7
Binary files /dev/null and b/manual/src/main/asciidoc/images/incubator-logo.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/images/unomi-request.png
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/images/unomi-request.png b/manual/src/main/asciidoc/images/unomi-request.png
new file mode 100755
index 0000000..fdba277
Binary files /dev/null and b/manual/src/main/asciidoc/images/unomi-request.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/index.adoc b/manual/src/main/asciidoc/index.adoc
new file mode 100644
index 0000000..7008160
--- /dev/null
+++ b/manual/src/main/asciidoc/index.adoc
@@ -0,0 +1,69 @@
+//
+// Licensed 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.
+//
+
+= Apache Unomi 1.x - Documentation
+Apache Software Foundation
+:doctype: article
+:toc: left
+:toclevels: 3
+:toc-position: left
+:toc-title: Table of Contents
+:numbered:
+:homepage: https://unomi.apache.org
+
+image::incubator-logo.png[pdfwidth=35%,align=center]
+
+== Concepts
+
+include::concepts.adoc[]
+
+== Extending Unomi via plugins
+
+include::extending-plugins.adoc[]
+
+== Quick start
+
+include::building-and-deploying.adoc[]
+
+include::getting-started.adoc[]
+
+include::configuration.adoc[]
+
+== Sample
+
+include::samples/samples.adoc[]
+
+include::samples/login-sample.adoc[]
+
+include::samples/twitter-sample.adoc[]
+
+include::samples/weather-update-sample.adoc[]
+
+== Connectors
+
+include::connectors/connectors.adoc[]
+
+include::connectors/salesforce-connector.adoc[]
+
+== Cluster setup
+
+include::clustering.adoc[]
+
+== Custom extensions
+
+include::custom-extensions.adoc[]
+
+== Consent API
+
+include::consent-api.adoc[]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/samples/login-sample.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/samples/login-sample.adoc b/manual/src/main/asciidoc/samples/login-sample.adoc
new file mode 100644
index 0000000..b1664d8
--- /dev/null
+++ b/manual/src/main/asciidoc/samples/login-sample.adoc
@@ -0,0 +1,73 @@
+//
+// Licensed 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.
+//
+=== Login samples
+
+This samples is an example of what is involved in integrated a login with Apache Unomi.
+
+==== Warning !
+
+The example code uses client-side Javascript code to send the login event. This is only
+done this way for the sake of samples simplicity but if should NEVER BE DONE THIS WAY in real cases.
+
+The login event should always be sent from the server performing the actual login since it must
+only be sent if the user has authenticated properly, and only the authentication server can validate this.
+
+==== Installing the samples
+
+.
+
+Login into the Unomi Karaf SSH shell using something like this :
+
+[source]
+----
+ssh -p 8102 karaf@localhost (default password is karaf)
+----
+
+.
+
+Install the login samples using the following command:
+
+[source]
+----
+bundle:install mvn:org.apache.unomi/login-integration-samples/${project.version}
+----
+
+when the bundle is successfully install you will get an bundle ID back we will call it BUNDLE_ID.
+
+.
+
+You can then do:
+
+[source]
+----
+bundle:start BUNDLE_ID
+----
+
+.
+
+If all went well you can access the login samples HTML page here :
+
+[source]
+----
+http://localhost:8181/login/index.html
+----
+
+.
+
+You can fill in the form to test it. Note that the hardcoded password is:
+
+[source]
+----
+test1234
+----
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/samples/samples.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/samples/samples.adoc b/manual/src/main/asciidoc/samples/samples.adoc
new file mode 100644
index 0000000..877a2e4
--- /dev/null
+++ b/manual/src/main/asciidoc/samples/samples.adoc
@@ -0,0 +1,19 @@
+//
+// Licensed 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.
+//
+=== Samples
+
+Apache Unomi provides the following samples:
+
+* link:twitter-samples.html[Twitter integration]
+* link:login-samples.html[Login integration]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/samples/twitter-sample.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/samples/twitter-sample.adoc b/manual/src/main/asciidoc/samples/twitter-sample.adoc
new file mode 100644
index 0000000..f17bc80
--- /dev/null
+++ b/manual/src/main/asciidoc/samples/twitter-sample.adoc
@@ -0,0 +1,432 @@
+//
+// Licensed 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.
+//
+=== Twitter samples
+
+==== Overview
+
+We will examine how a simple HTML page can interact with Unomi to enrich a user's profile. The use case we will follow
+is a rather simple one: we use a Twitter button to record the number of times the visitor tweeted (as a `tweetNb` profile
+integer property) as well as the URLs they tweeted from (as a `tweetedFrom` multi-valued string profile property).
+A javascript script will use the Twitter API to react to clicks on this button
+and update the user profile using a `ContextServlet` request triggering a custom event. This event will, in turn,
+trigger a Unomi action on the server implemented using a Unomi plugin, a standard extension point for the server.
+
+===== Building the tweet button samples
+
+In your local copy of the Unomi repository and run:
+
+[source]
+----
+cd samples/tweet-button-plugin
+mvn clean install
+----
+
+This will compile and create the OSGi bundle that can be deployed on Unomi to extend it.
+
+===== Deploying the tweet button samples
+
+In standard Karaf fashion, you will need to copy the samples bundle to your Karaf `deploy` directory.
+
+If you are using the packaged version of Unomi (as opposed to deploying it to your own Karaf version), you can simply run, assuming your current directory is `samples/tweet-button-plugin` and that you uncompressed the archive in the directory it was created:
+
+[source]
+----
+cp target/tweet-button-plugin-1.0.0-incubating-SNAPSHOT.jar ../../package/target/unomi-1.0.0-incubating-SNAPSHOT/deploy
+----
+
+===== Testing the samples
+
+You can now go to http://localhost:8181/index.html[http://localhost:8181/index.html] to test the samples code. The page is very simple, you will see a Twitter button, which, once clicked, will open a new window to tweet about the current page. The original page should be updated with the new values of the properties coming from Unomi. Additionnally, the raw JSON response is displayed.
+
+We will now explain in greater details some concepts and see how the example works.
+
+==== Interacting with the context server
+
+There are essentially two modalities to interact with the context server, reflecting different types of Unomi users: context server clients and context server integrators.
+
+*Context server clients* are usually web applications or content management systems. They interact with Unomi by providing raw, uninterpreted contextual data in the form of events and associated metadata. That contextual data is then processed by the context server to be fed to clients once actionable. In that sense context server clients are both consumers and producers of contextual data. Context server clients will mostly interact with Unomi using a single entry point called the `ContextServlet`, requesting context for the current user and providing any triggered events along the way.
+
+On the other hand, *context server integrators* provide ways to feed more structured data to the context server either to integrate with third party services or to provide analysis of the uninterpreted data provided by context server clients. Such integration will mostly be done using Unomi's API either directly using Unomi plugins or via the provided REST APIs. However, access to REST APIs is restricted due for security reasons, requiring privileged access to the Unomi server, making things a little more complex to set up.
+
+For simplicity's sake, this document will focus solely on the first use case and will interact only with the context servlet.
+
+==== Retrieving context information from Unomi using the context servlet
+
+Unomi provides two ways to retrieve context: either as a pure JSON object containing strictly context information or as a couple of JSON objects augmented with javascript functions that can be used to interact with the Unomi server using the `<context server base URL>/context.json` or `<context server base URL>/context.js` URLs, respectively.
+
+Below is an example of asynchronously loading the initial context using the javascript version, assuming a default Unomi install running on `http://localhost:8181`:
+
+[source,javascript]
+----
+// Load context from Unomi asynchronously
+(function (document, elementToCreate, id) {
+ var js, fjs = document.getElementsByTagName(elementToCreate)[0];
+ if (document.getElementById(id)) return;
+ js = document.createElement(elementToCreate);
+ js.id = id;
+ js.src = 'http://localhost:8181/context.js';
+ fjs.parentNode.insertBefore(js, fjs);
+}(document, 'script', 'context'));
+
+----
+
+This initial context results in a javascript file providing some functions to interact with the context server from javascript along with two objects: a `cxs` object containing
+information about the context for the current user and a `digitalData` object that is injected into the browser’s `window` object (leveraging the
+http://www.w3.org/2013/12/ceddl-201312.pdf[Customer Experience Digital Data Layer] standard). Note that this last object is not under control of the context server and clients
+ are free to use it or not. Our example will not make use of it.
+
+On the other hand, the `cxs` top level object contains interesting contextual information about the current user:
+
+[source,json]
+----
+{
+ "profileId":<identifier of the profile associated with the current user>,
+ "sessionId":<identifier of the current user session>,
+ "profileProperties":<requested profile properties, if any>,
+ "sessionProperties":<requested session properties, if any>,
+ "profileSegments":<segments the profile is part of if requested>,
+ "filteringResults":<result of the evaluation of personalization filters>,
+ "trackedConditions":<tracked conditions in the source page, if any>
+}
+----
+
+We will look at the details of the context request and response later.
+
+=== Example
+
+==== HTML page
+
+The code for the HTML page with our Tweet button can be found at https://github.com/apache/incubator-unomi/blob/master/wab/src/main/webapp/index.html[https://github.com/apache/incubator-unomi/blob/master/wab/src/main/webapp/index.html].
+
+This HTML page is fairly straightforward: we create a tweet button using the Twitter API while a Javascript script performs the actual logic.
+
+==== Javascript
+
+Globally, the script loads both the twitter widget and the initial context asynchronously (as shown previously). This is accomplished using fairly standard javascript code and we won't look at it here. Using the Twitter API, we react to the `tweet` event and call the Unomi server to update the user's profile with the required information, triggering a custom `tweetEvent` event. This is accomplished using a `contextRequest` function which is an extended version of a classic `AJAX` request:
+
+[source,javascript]
+----
+function contextRequest(successCallback, errorCallback, payload) {
+ var data = JSON.stringify(payload);
+ // if we don't already have a session id, generate one
+ var sessionId = cxs.sessionId || generateUUID();
+ var url = 'http://localhost:8181/context.json?sessionId=' + sessionId;
+ var xhr = new XMLHttpRequest();
+ var isGet = data.length < 100;
+ if (isGet) {
+ xhr.withCredentials = true;
+ xhr.open("GET", url + "&payload=" + encodeURIComponent(data), true);
+ } else if ("withCredentials" in xhr) {
+ xhr.open("POST", url, true);
+ xhr.withCredentials = true;
+ } else if (typeof XDomainRequest != "undefined") {
+ xhr = new XDomainRequest();
+ xhr.open("POST", url);
+ }
+ xhr.onreadystatechange = function () {
+ if (xhr.readyState != 4) {
+ return;
+ }
+ if (xhr.status ==== 200) {
+ var response = xhr.responseText ? JSON.parse(xhr.responseText) : undefined;
+ if (response) {
+ cxs.sessionId = response.sessionId;
+ successCallback(response);
+ }
+ } else {
+ console.log("contextserver: " + xhr.status + " ERROR: " + xhr.statusText);
+ if (errorCallback) {
+ errorCallback(xhr);
+ }
+ }
+ };
+ xhr.setRequestHeader("Content-Type", "text/plain;charset=UTF-8"); // Use text/plain to avoid CORS preflight
+ if (isGet) {
+ xhr.send();
+ } else {
+ xhr.send(data);
+ }
+}
+----
+
+There are a couple of things to note here:
+
+* If we specify a payload, it is expected to use the JSON format so we `stringify` it and encode it if passed as a URL parameter in a `GET` request.
+* We need to make a https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS[`CORS`] request since the Unomi server is most likely not running on the same host than the one from which the request originates. The specific details are fairly standard and we will not explain them here.
+* We need to either retrieve (from the initial context we retrieved previously using `cxs.sessionId`) or generate a session identifier for our request since Unomi currently requires one.
+* We're calling the `ContextServlet` using the default install URI, specifying the session identifier: `http://localhost:8181/context.json?sessionId=' + sessionId`. This URI requests context from Unomi, resulting in an updated `cxs` object in the javascript global scope. The context server can reply to this request either by returning a JSON-only object containing solely the context information as is the case when the requested URI is `context.json`. However, if the client requests `context.js` then useful functions to interact with Unomi are added to the `cxs` object in addition to the context information as depicted above.
+* We don't need to provide any authentication at all to interact with this part of Unomi since we only have access to read-only data (as well as providing events as we shall see later on). If we had been using the REST API, we would have needed to provide authentication information as well.
+
+===== Context request and response structure
+
+The interesting part, though, is the payload. This is where we provide Unomi with contextual information as well as ask for data in return. This allows clients to specify which type of information they are interested in getting from the context server as well as specify incoming events or content filtering or property/segment overrides for personalization or impersonation. This conditions what the context server will return with its response.
+
+Let's look at the context request structure:
+
+[source,json]
+----
+{
+ source: <Item source of the context request>,
+ events: <optional array of triggered events>,
+ requiredProfileProperties: <optional array of property identifiers>,
+ requiredSessionProperties: <optional array of property identifiers>,
+ filters: <optional array of filters to evaluate>,
+ profileOverrides: <optional profile containing segments,scores or profile properties to override>,
+ - segments: <optional array of segment identifiers>,
+ - profileProperties: <optional map of property name / value pairs>,
+ - scores: <optional map of score id / value pairs>
+ sessionPropertiesOverrides: <optional map of property name / value pairs>,
+ requireSegments: <boolean, whether to return the associated segments>
+}
+----
+
+We will now look at each part in greater details.
+
+====== Source
+
+A context request payload needs to at least specify some information about the source of the request in the form of an `Item` (meaning identifier, type and scope plus any additional properties we might have to provide), via the `source` property of the payload. Of course the more information can be provided about the source, the better.
+
+====== Filters
+
+A client wishing to perform content personalization might also specify filtering conditions to be evaluated by the context server so that it can tell the client whether the content associated with the filter should be activated for this profile/session. This is accomplished by providing a list of filter definitions to be evaluated by the context server via the `filters` field of the payload. If provided, the evaluation results will be provided in the `filteringResults` field of the resulting `cxs` object the context server will send.
+
+====== Overrides
+
+It is also possible for clients wishing to perform user impersonation to specify properties or segments to override the proper ones so as to emulate a specific profile, in which case the overridden value will temporarily replace the proper values so that all rules will be evaluated with these values instead of the proper ones. The `segments` (array of segment identifiers), `profileProperties` (maps of property name and associated object value) and `scores` (maps of score id and value) all wrapped in a profileOverrides object and the `sessionPropertiesOverrides` (maps of property name and associated object value) fields allow to provide such information. Providing such overrides will, of course, impact content filtering results and segments matching for this specific request.
+
+====== Controlling the content of the response
+
+The clients can also specify which information to include in the response by setting the `requireSegments` property to true if segments the current profile matches should be returned or provide an array of property identifiers for `requiredProfileProperties` or `requiredSessionProperties` fields to ask the context server to return the values for the specified profile or session properties, respectively. This information is provided by the `profileProperties`, `sessionProperties` and `profileSegments` fields of the context server response.
+
+Additionally, the context server will also returns any tracked conditions associated with the source of the context request. Upon evaluating the incoming request, the context server will determine if there are any rules marked with the `trackedCondition` tag and which source condition matches the source of the incoming request and return these tracked conditions to the client. The client can use these tracked conditions to learn that the context server can react to events matching the tracked condition and coming from that source. This is, in particular, used to implement form mapping (a solution that allows clients to update user profiles based on values provided when a form is submitted).
+
+====== Events
+
+Finally, the client can specify any events triggered by the user actions, so that the context server can process them, via the `events` field of the context request.
+
+====== Default response
+
+If no payload is specified, the context server will simply return the minimal information deemed necessary for client applications to properly function: profile identifier, session identifier and any tracked conditions that might exist for the source of the request.
+
+===== Context request for our example
+
+Now that we've seen the structure of the request and what we can expect from the context response, let's examine the request our component is doing.
+
+In our case, our `source` item looks as follows: we specify a scope for our application (`unomi-tweet-button-samples`), specify that the item type (i.e. the kind of element that is the source of our event) is a `page` (which corresponds, as would be expected, to a web page), provide an identifier (in our case, a Base-64 encoded version of the page's URL) and finally, specify extra properties (here, simply a `url` property corresponding to the page's URL that will be used when we process our event in our Unomi extension).
+
+[source,javascript]
+----
+var scope = 'unomi-tweet-button-samples';
+var itemId = btoa(window.location.href);
+var source = {
+ itemType: 'page',
+ scope: scope,
+ itemId: itemId,
+ properties: {
+ url: window.location.href
+ }
+};
+----
+
+We also specify that we want the context server to return the values of the `tweetNb` and `tweetedFrom` profile properties in its response. Finally, we provide a custom event of type `tweetEvent` with associated scope and source information, which matches the source of our context request in this case.
+
+[source,javascript]
+----
+var contextPayload = {
+ source: source,
+ events: [
+ {
+ eventType: 'tweetEvent',
+ scope: scope,
+ source: source
+ }
+ ],
+ requiredProfileProperties: [
+ 'tweetNb',
+ 'tweetedFrom'
+ ]
+};
+----
+
+The `tweetEvent` event type is not defined by default in Unomi. This is where our Unomi plugin comes into play since we need to tell Unomi how to react when it encounters such events.
+
+===== Unomi plugin overview
+
+In order to react to `tweetEvent` events, we will define a new Unomi rule since this is exactly what Unomi rules are supposed to do. Rules are guarded by conditions and if these
+ conditions match, the associated set of actions will be executed. In our case, we want our new
+ https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/rules/incrementTweetNumber.json[`incrementTweetNumber`] rule to only react to `tweetEvent` events and
+ we want it to perform the profile update accordingly: create the property types for our custom properties if they don't exist and update them. To do so, we will create a
+ custom
+ https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/actions/incrementTweetNumberAction.json[`incrementTweetNumberAction`] action that will be triggered any time our rule matches. An action is some custom code that is deployed in the context server and can access the
+ Unomi API to perform what it is that it needs to do.
+
+===== Rule definition
+
+Let's look at how our custom https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/rules/incrementTweetNumber.json[`incrementTweetNumber`] rule is defined:
+
+[source,json]
+----
+{
+ "metadata": {
+ "id": "smp:incrementTweetNumber",
+ "name": "Increment tweet number",
+ "description": "Increments the number of times a user has tweeted after they click on a tweet button"
+ },
+ "raiseEventOnlyOnceForSession": false,
+ "condition": {
+ "type": "eventTypeCondition",
+ "parameterValues": {
+ "eventTypeId": "tweetEvent"
+ }
+ },
+ "actions": [
+ {
+ "type": "incrementTweetNumberAction",
+ "parameterValues": {}
+ }
+ ]
+}
+----
+
+Rules define a metadata section where we specify the rule name, identifier and description.
+
+When rules trigger, a specific event is raised so that other parts of Unomi can react to it accordingly. We can control how that event should be raised. Here we specify that the event should be raised each time the rule triggers and not only once per session by setting `raiseEventOnlyOnceForSession` to `false`, which is not strictly required since that is the default. A similar setting (`raiseEventOnlyOnceForProfile`) can be used to specify that the event should only be raised once per profile if needed.
+
+We could also specify a priority for our rule in case it needs to be executed before other ones when similar conditions match. This is accomplished using the `priority` property. We're using the default priority here since we don't have other rules triggering on `tweetEvent`s and don't need any special ordering.
+
+We then tell Unomi which condition should trigger the rule via the `condition` property. Here, we specify that we want our rule to trigger on an `eventTypeCondition` condition. Unomi can be extended by adding new condition types that can enrich how matching or querying is performed. The condition type definition file specifies which parameters are expected for our condition to be complete. In our case, we use the built-in event type condition that will match if Unomi receives an event of the type specified in the condition's `eventTypeId` parameter value: `tweetEvent` here.
+
+Finally, we specify a list of actions that should be performed as consequences of the rule matching. We only need one action of type `incrementTweetNumberAction` that doesn't require any parameters.
+
+===== Action definition
+
+Let's now look at our custom https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/actions/incrementTweetNumberAction.json[`incrementTweetNumberAction`] action type definition:
+
+[source,json]
+----
+{
+ "id": "incrementTweetNumberAction",
+ "actionExecutor": "incrementTweetNumber",
+ "systemTags": [
+ "event"
+ ],
+ "parameters": []
+}
+----
+
+We specify the identifier for the action type, a list of systemTags if needed: here we say that our action is a consequence of events using the `event` tag. Our actions does not require any parameters so we don't define any.
+
+Finally, we provide a mysterious `actionExecutor` identifier: `incrementTweetNumber`.
+
+===== Action executor definition
+
+The action executor references the actual implementation of the action as defined in our https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/OSGI-INF/blueprint/blueprint.xml[blueprint definition]:
+
+[source,xml]
+----
+<blueprint xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+ xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
+
+ <reference id="profileService" interface="org.apache.unomi.api.services.ProfileService"/>
+
+ <!-- Action executor -->
+ <service id="incrementTweetNumberAction" interface="org.apache.unomi.api.actions.ActionExecutor">
+ <service-properties>
+ <entry key="actionExecutorId" value="incrementTweetNumber"/>
+ </service-properties>
+ <bean class="org.apache.unomi.examples.unomi_tweet_button_plugin.actions.IncrementTweetNumberAction">
+ <property name="profileService" ref="profileService"/>
+ </bean>
+ </service>
+</blueprint>
+----
+
+In standard Blueprint fashion, we specify that we will need the `profileService` defined by Unomi and then define a service of our own to be exported for Unomi to use. Our service specifies one property: `actionExecutorId` which matches the identifier we specified in our action definition. We then inject the profile service in our executor and we're done for the configuration side of things!
+
+===== Action executor implementation
+
+Our action executor definition specifies that the bean providing the service is implemented in the https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/java/org/apache/unomi/samples/tweet_button_plugin/actions/IncrementTweetNumberAction.java[`org.apache.unomi.samples.tweet_button_plugin.actions
+.IncrementTweetNumberAction`] class. This class implements the Unomi `ActionExecutor` interface which provides a single `int execute(Action action, Event event)` method: the executor gets the action instance to execute along with the event that triggered it, performs its work and returns an integer status corresponding to what happened as defined by public constants of the `EventService` interface of Unomi: `NO_CHANGE`, `SESSION_UPDATED` or `PROFILE_UPDATED`.
+
+Let's now look at the implementation of the method:
+
+[source,java]
+----
+final Profile profile = event.getProfile();
+Integer tweetNb = (Integer) profile.getProperty(TWEET_NB_PROPERTY);
+List<String> tweetedFrom = (List<String>) profile.getProperty(TWEETED_FROM_PROPERTY);
+
+if (tweetNb ==== null || tweetedFrom ==== null) {
+ // create tweet number property type
+ PropertyType propertyType = new PropertyType(new Metadata(event.getScope(), TWEET_NB_PROPERTY, TWEET_NB_PROPERTY, "Number of times a user tweeted"));
+ propertyType.setValueTypeId("integer");
+ service.createPropertyType(propertyType);
+
+ // create tweeted from property type
+ propertyType = new PropertyType(new Metadata(event.getScope(), TWEETED_FROM_PROPERTY, TWEETED_FROM_PROPERTY, "The list of pages a user tweeted from"));
+ propertyType.setValueTypeId("string");
+ propertyType.setMultivalued(true);
+ service.createPropertyType(propertyType);
+
+ tweetNb = 0;
+ tweetedFrom = new ArrayList<>();
+}
+
+profile.setProperty(TWEET_NB_PROPERTY, tweetNb + 1);
+final String sourceURL = extractSourceURL(event);
+if (sourceURL != null) {
+ tweetedFrom.add(sourceURL);
+}
+profile.setProperty(TWEETED_FROM_PROPERTY, tweetedFrom);
+
+return EventService.PROFILE_UPDATED;
+----
+
+It is fairly straightforward: we retrieve the profile associated with the event that triggered the rule and check whether it already has the properties we are interested in. If not, we create the associated property types and initialize the property values.
+
+____
+
+Note that it is not an issue to attempt to create the same property type multiple times as Unomi will not add a new property type if an identical type already exists.
+
+____
+
+Once this is done, we update our profile with the new property values based on the previous values and the metadata extracted from the event using the `extractSourceURL` method which uses our `url` property that we've specified for our event source. We then return that the profile was updated as a result of our action and Unomi will properly save it for us when appropriate. That's it!
+
+For reference, here's the `extractSourceURL` method implementation:
+
+[source,java]
+----
+private String extractSourceURL(Event event) {
+ final Item sourceAsItem = event.getSource();
+ if (sourceAsItem instanceof CustomItem) {
+ CustomItem source = (CustomItem) sourceAsItem;
+ final String url = (String) source.getProperties().get("url");
+ if (url != null) {
+ return url;
+ }
+ }
+
+ return null;
+}
+----
+
+=== Conclusion
+
+We have seen a simple example how to interact with Unomi using a combination of client-side code and Unomi plugin. Hopefully, this provided an introduction to the power of what Unomi can do and how it can be extended to suit your needs.
+
+=== Annex
+
+Here is an overview of how Unomi processes incoming requests to the `ContextServlet`.
+image: images/unomi-request.png[Unomi request overview]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/samples/weather-update-sample.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/samples/weather-update-sample.adoc b/manual/src/main/asciidoc/samples/weather-update-sample.adoc
new file mode 100644
index 0000000..cfde0f6
--- /dev/null
+++ b/manual/src/main/asciidoc/samples/weather-update-sample.adoc
@@ -0,0 +1,14 @@
+//
+// Licensed 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.
+//
+=== Weather update samples
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/apache-theme.yml
----------------------------------------------------------------------
diff --git a/manual/src/theme/apache-theme.yml b/manual/src/theme/apache-theme.yml
new file mode 100644
index 0000000..855b46c
--- /dev/null
+++ b/manual/src/theme/apache-theme.yml
@@ -0,0 +1,271 @@
+font:
+ catalog:
+ #SourceSansPro
+ SourceSansPro:
+ normal: SourceSansPro-Regular.ttf
+ italic: SourceSansPro-Italic.ttf
+ bold: SourceSansPro-Bold.ttf
+ bold_italic: SourceSansPro-BoldItalic.ttf
+ #DroidSerif
+ DroidSerif:
+ normal: DroidSerif-Regular.ttf
+ italic: DroidSerif-Italic.ttf
+ bold: DroidSerif-Bold.ttf
+ bold_italic: DroidSerif-BoldItalic.ttf
+
+page:
+ background_color: #ffffff
+ layout: portrait
+ margin: [0.5in, 0.67in, 0.67in, 0.67in]
+ # margin_inner and margin_outer keys are used for recto/verso print margins when media=prepress
+ margin_inner: 0.75in
+ margin_outer: 0.59in
+ size: A4
+base:
+ align: justify
+ # color as hex string (leading # is optional)
+ font_color: #333333
+ # color as RGB array
+ #font_color: [51, 51, 51]
+ # color as CMYK array (approximated)
+ #font_color: [0, 0, 0, 0.92]
+ #font_color: [0, 0, 0, 92%]
+ font_family: DroidSerif
+ # choose one of these font_size/line_height_length combinations
+ #font_size: 14
+ #line_height_length: 20
+ #font_size: 11.25
+ #line_height_length: 18
+ #font_size: 11.2
+ #line_height_length: 16
+ font_size: 10
+ line_height_length: 15
+ #font_size: 11.25
+ #line_height_length: 18
+ line_height: $base_line_height_length / $base_font_size
+ font_size_large: round($base_font_size * 1.25)
+ font_size_small: round($base_font_size * 0.85)
+ font_size_min: $base_font_size * 0.75
+ font_style: normal
+ border_color: #cccccc
+ border_radius: 0
+ border_width: 0.5
+# FIXME vertical_rhythm is weird; we should think in terms of ems
+#vertical_rhythm: $base_line_height_length * 2 / 3
+# correct line height for Noto Serif metrics (comes with built-in line height)
+vertical_rhythm: $base_line_height_length
+horizontal_rhythm: $base_line_height_length
+# QUESTION should vertical_spacing be block_spacing instead?
+vertical_spacing: $vertical_rhythm
+link:
+ font_color: #585ac2
+# literal is currently used for inline monospaced in prose and table cells
+literal:
+ font_color: #585ac2
+ font_family: DroidSerif
+menu_caret_content: " <font size=\"1.15em\"><color rgb=\"b12146\">\u203a</color></font> "
+heading:
+ align: left
+ font_color: #303284
+ #font_color: $base_font_color
+ font_family: SourceSansPro
+ font_style: bold
+ text_transform: uppercase
+ # h1 is used for part titles (book doctype only)
+ h1_font_size: floor($base_font_size * 2.6)
+ # h2 is used for chapter titles (book doctype only)
+ h2_font_size: floor($base_font_size * 2.15)
+ h3_font_size: round($base_font_size * 1.7)
+ h4_font_size: $base_font_size_large
+ h5_font_size: $base_font_size
+ h6_font_size: $base_font_size_small
+ #line_height: 1.4
+ # correct line height for Noto Serif metrics (comes with built-in line height)
+ line_height: 1
+ margin_top: $vertical_rhythm * 0.4
+ margin_bottom: $vertical_rhythm * 0.9
+title_page:
+ align: right
+ logo:
+ top: 10%
+ align: right
+ image: image:images/asf_logo_url.png[pdfwidth=35%,align=right]
+ title:
+ top: 55%
+ font_size: $heading_h1_font_size
+ font_family: $heading_font_family
+ font_style: bold
+ text_transform: uppercase
+ font_color: $heading_font_color
+ line_height: 0.9
+ subtitle:
+ font_size: $heading_h3_font_size
+ font_family: $heading_font_family
+ font_style: bold_italic
+ font_color: $heading_font_color
+ line_height: 1
+ authors:
+ margin_top: $base_font_size * 1.25
+ font_size: $base_font_size_large
+ font_color: $heading_font_color
+ font_family: $heading_font_family
+ revision:
+ margin_top: $base_font_size * 1.25
+block:
+ margin_top: 0
+ margin_bottom: $vertical_rhythm
+caption:
+ align: left
+ font_size: $base_font_size * 0.95
+ font_style: italic
+ # FIXME perhaps set line_height instead of / in addition to margins?
+ margin_inside: $vertical_rhythm / 3
+ #margin_inside: $vertical_rhythm / 4
+ margin_outside: 0
+lead:
+ font_size: $base_font_size_large
+ line_height: 1.4
+abstract:
+ font_color: #5c6266
+ font_size: $lead_font_size
+ line_height: $lead_line_height
+ font_style: italic
+ first_line_font_style: bold
+ title:
+ align: center
+ font_color: $heading_font_color
+ font_family: $heading_font_family
+ font_size: $heading_h4_font_size
+ font_style: $heading_font_style
+admonition:
+ column_rule_color: $base_border_color
+ column_rule_width: $base_border_width
+ padding: [0, $horizontal_rhythm, 0, $horizontal_rhythm]
+ #icon:
+ # tip:
+ # name: fa-lightbulb-o
+ # stroke_color: 111111
+ # size: 24
+ label:
+ text_transform: uppercase
+ font_style: bold
+blockquote:
+ font_color: $base_font_color
+ font_size: $base_font_size_large
+ border_color: $base_border_color
+ border_width: 5
+ # FIXME disable negative padding bottom once margin collapsing is implemented
+ padding: [0, $horizontal_rhythm, $block_margin_bottom * -0.75, $horizontal_rhythm + $blockquote_border_width / 2]
+ cite_font_size: $base_font_size_small
+ cite_font_color: #999999
+# code is used for source blocks (perhaps change to source or listing?)
+code:
+ font_color: #5c4cdb
+ font_family: $literal_font_family
+ font_size: ceil($base_font_size)
+ padding: $code_font_size
+ line_height: 1.25
+ # line_gap is an experimental property to control how a background color is applied to an inline block element
+ line_gap: 3.8
+ background_color: #f5f5f5
+ border_color: #f5f5f5
+ border_radius: $base_border_radius
+ border_width: 0.75
+conum:
+ font_family: OpenSans
+ font_color: $literal_font_color
+ font_size: $base_font_size
+ line_height: 4 / 3
+example:
+ border_color: #f5f5f5
+ border_radius: $base_border_radius
+ border_width: 0.75
+ background_color: #f5f5f5
+ # FIXME reenable padding bottom once margin collapsing is implemented
+ padding: [$vertical_rhythm, $horizontal_rhythm, 0, $horizontal_rhythm]
+image:
+ align: left
+prose:
+ margin_top: $block_margin_top
+ margin_bottom: $block_margin_bottom
+sidebar:
+ background_color: #eeeeee
+ border_color: #e1e1e1
+ border_radius: $base_border_radius
+ border_width: $base_border_width
+ # FIXME reenable padding bottom once margin collapsing is implemented
+ padding: [$vertical_rhythm, $vertical_rhythm * 1.25, 0, $vertical_rhythm * 1.25]
+ title:
+ align: center
+ font_color: $heading_font_color
+ font_family: $heading_font_family
+ font_size: $heading_h4_font_size
+ font_style: $heading_font_style
+thematic_break:
+ border_color: $base_border_color
+ border_style: solid
+ border_width: $base_border_width
+ margin_top: $vertical_rhythm * 0.5
+ margin_bottom: $vertical_rhythm * 1.5
+description_list:
+ term_font_style: bold
+ term_spacing: $vertical_rhythm / 4
+ description_indent: $horizontal_rhythm * 1.25
+outline_list:
+ indent: $horizontal_rhythm * 1.5
+ #marker_font_color: 404040
+ # NOTE outline_list_item_spacing applies to list items that do not have complex content
+ item_spacing: $vertical_rhythm / 2
+table:
+ background_color: #ffffff
+ font_color: $base_font_color
+ #head_background_color: <hex value>
+ head_font_color: $base_font_color
+ head_font_style: bold
+ #body_background_color: <hex value>
+ body_stripe_background_color: #f9f9f9
+ foot_background_color: #f5f5f5
+ border_color: #dddddd
+ border_width: $base_border_width
+ cell_padding: 3
+toc:
+ indent: $horizontal_rhythm
+ line_height: 1.4
+ dot_leader:
+ #content: ". "
+ font_color: #a9a9a9
+ #levels: 2 3
+# NOTE in addition to footer, header is also supported
+footer:
+ font_size: $base_font_size_small
+ # NOTE if background_color is set, background and border will span width of page
+ border_color: #dddddd
+ border_width: 0.25
+ height: $base_line_height_length * 2.5
+ line_height: 1
+ padding: [$base_line_height_length / 2, 1, 0, 1]
+ vertical_align: top
+ #image_vertical_align: <alignment> or <number>
+ # additional attributes for content:
+ # * {page-count}
+ # * {page-number}
+ # * {document-title}
+ # * {document-subtitle}
+ # * {chapter-title}
+ # * {section-title}
+ # * {section-or-chapter-title}
+ recto:
+ #columns: "<50% =0% >50%"
+ right:
+ #content: '{page-number}'
+ #content: '{section-or-chapter-title} - {page-number}'
+ content: '{document-title} - {page-number}'
+ #center:
+ # content: '{page-number}'
+ verso:
+ #columns: $footer_recto_columns
+ left:
+ content: $footer_recto_right_content
+ #content: '{page-number} - {chapter-title}'
+ #center:
+# content: '{page-number}'
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/DroidSerif-Bold.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/DroidSerif-Bold.ttf b/manual/src/theme/fonts/DroidSerif-Bold.ttf
new file mode 100644
index 0000000..838d255
Binary files /dev/null and b/manual/src/theme/fonts/DroidSerif-Bold.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/DroidSerif-BoldItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/DroidSerif-BoldItalic.ttf b/manual/src/theme/fonts/DroidSerif-BoldItalic.ttf
new file mode 100644
index 0000000..0b1601f
Binary files /dev/null and b/manual/src/theme/fonts/DroidSerif-BoldItalic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/DroidSerif-Italic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/DroidSerif-Italic.ttf b/manual/src/theme/fonts/DroidSerif-Italic.ttf
new file mode 100644
index 0000000..2972809
Binary files /dev/null and b/manual/src/theme/fonts/DroidSerif-Italic.ttf differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/theme/fonts/DroidSerif-Regular.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/DroidSerif-Regular.ttf b/manual/src/theme/fonts/DroidSerif-Regular.ttf
new file mode 100644
index 0000000..5b4fe81
Binary files /dev/null and b/manual/src/theme/fonts/DroidSerif-Regular.ttf differ
[8/8] incubator-unomi git commit: This closes pull request number #66
Posted by sh...@apache.org.
This closes pull request number #66
Project: http://git-wip-us.apache.org/repos/asf/incubator-unomi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-unomi/commit/8a9559ce
Tree: http://git-wip-us.apache.org/repos/asf/incubator-unomi/tree/8a9559ce
Diff: http://git-wip-us.apache.org/repos/asf/incubator-unomi/diff/8a9559ce
Branch: refs/heads/master
Commit: 8a9559ce60f178d88c3df9adf06f5902884aad9c
Parents: 1d5725a b077d27
Author: Serge Huber <sh...@apache.org>
Authored: Mon Sep 10 11:30:03 2018 +0200
Committer: Serge Huber <sh...@apache.org>
Committed: Mon Sep 10 11:30:03 2018 +0200
----------------------------------------------------------------------
manual/pom.xml | 125 +
manual/src/archives/1.1/asciidoc/apache.css | 2448 ++++++++++++++++++
.../1.1/asciidoc/building-and-deploying.adoc | 225 ++
.../src/archives/1.1/asciidoc/clustering.adoc | 103 +
manual/src/archives/1.1/asciidoc/concepts.adoc | 234 ++
.../archives/1.1/asciidoc/configuration.adoc | 296 +++
.../archives/1.1/asciidoc/getting-started.adoc | 461 ++++
.../1.1/asciidoc/images/asf_logo_url.png | Bin 0 -> 21121 bytes
.../1.1/asciidoc/images/incubator-logo.png | Bin 0 -> 8923 bytes
.../1.1/asciidoc/images/unomi-request.png | Bin 0 -> 132731 bytes
manual/src/archives/1.1/asciidoc/index.adoc | 55 +
manual/src/archives/1.2/asciidoc/apache.css | 2448 ++++++++++++++++++
.../1.2/asciidoc/building-and-deploying.adoc | 268 ++
.../src/archives/1.2/asciidoc/clustering.adoc | 84 +
manual/src/archives/1.2/asciidoc/concepts.adoc | 234 ++
.../archives/1.2/asciidoc/configuration.adoc | 345 +++
.../1.2/asciidoc/connectors/connectors.adoc | 23 +
.../connectors/salesforce-connector.adoc | 234 ++
.../1.2/asciidoc/custom-extensions.adoc | 413 +++
.../archives/1.2/asciidoc/getting-started.adoc | 122 +
.../1.2/asciidoc/images/asf_logo_url.png | Bin 0 -> 21121 bytes
.../1.2/asciidoc/images/incubator-logo.png | Bin 0 -> 8923 bytes
.../1.2/asciidoc/images/unomi-request.png | Bin 0 -> 132731 bytes
manual/src/archives/1.2/asciidoc/index.adoc | 75 +
.../1.2/asciidoc/samples/login-sample.adoc | 74 +
.../archives/1.2/asciidoc/samples/samples.adoc | 20 +
.../1.2/asciidoc/samples/twitter-sample.adoc | 433 ++++
.../asciidoc/samples/weather-update-sample.adoc | 15 +
manual/src/main/asciidoc/apache.css | 2448 ++++++++++++++++++
.../main/asciidoc/building-and-deploying.adoc | 276 ++
manual/src/main/asciidoc/clustering.adoc | 83 +
manual/src/main/asciidoc/concepts.adoc | 125 +
manual/src/main/asciidoc/configuration.adoc | 397 +++
.../main/asciidoc/connectors/connectors.adoc | 22 +
.../connectors/salesforce-connector.adoc | 224 ++
manual/src/main/asciidoc/consent-api.adoc | 139 +
manual/src/main/asciidoc/custom-extensions.adoc | 419 +++
manual/src/main/asciidoc/extending-plugins.adoc | 113 +
manual/src/main/asciidoc/getting-started.adoc | 121 +
.../src/main/asciidoc/images/asf_logo_url.png | Bin 0 -> 21121 bytes
.../src/main/asciidoc/images/incubator-logo.png | Bin 0 -> 8923 bytes
.../src/main/asciidoc/images/unomi-request.png | Bin 0 -> 132731 bytes
manual/src/main/asciidoc/index.adoc | 69 +
.../src/main/asciidoc/samples/login-sample.adoc | 73 +
manual/src/main/asciidoc/samples/samples.adoc | 19 +
.../main/asciidoc/samples/twitter-sample.adoc | 432 ++++
.../asciidoc/samples/weather-update-sample.adoc | 14 +
manual/src/theme/apache-theme.yml | 284 ++
manual/src/theme/fonts/DroidSerif-Bold.ttf | Bin 0 -> 185228 bytes
.../src/theme/fonts/DroidSerif-BoldItalic.ttf | Bin 0 -> 190304 bytes
manual/src/theme/fonts/DroidSerif-Italic.ttf | Bin 0 -> 177560 bytes
manual/src/theme/fonts/DroidSerif-Regular.ttf | Bin 0 -> 172916 bytes
.../theme/fonts/DroidSerif_Apache License.txt | 201 ++
manual/src/theme/fonts/OpenSans-Bold.ttf | Bin 0 -> 224452 bytes
manual/src/theme/fonts/OpenSans-BoldItalic.ttf | Bin 0 -> 213168 bytes
manual/src/theme/fonts/OpenSans-ExtraBold.ttf | Bin 0 -> 222424 bytes
.../theme/fonts/OpenSans-ExtraBoldItalic.ttf | Bin 0 -> 213336 bytes
manual/src/theme/fonts/OpenSans-Italic.ttf | Bin 0 -> 212760 bytes
manual/src/theme/fonts/OpenSans-Light.ttf | Bin 0 -> 222236 bytes
manual/src/theme/fonts/OpenSans-LightItalic.ttf | Bin 0 -> 213024 bytes
manual/src/theme/fonts/OpenSans-Regular.ttf | Bin 0 -> 217276 bytes
manual/src/theme/fonts/OpenSans-SemiBold.ttf | Bin 0 -> 221164 bytes
.../src/theme/fonts/OpenSans-SemiBoldItalic.ttf | Bin 0 -> 212732 bytes
manual/src/theme/fonts/OpenSans_LICENSE.txt | 202 ++
manual/src/theme/images/asf_logo.png | Bin 0 -> 21243 bytes
manual/src/theme/images/asf_logo_url.png | Bin 0 -> 21121 bytes
pom.xml | 1 +
67 files changed, 14397 insertions(+)
----------------------------------------------------------------------
[7/8] incubator-unomi git commit: Add archives versions of
documentation in asciidoc
Posted by sh...@apache.org.
Add archives versions of documentation in asciidoc
Project: http://git-wip-us.apache.org/repos/asf/incubator-unomi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-unomi/commit/b077d27b
Tree: http://git-wip-us.apache.org/repos/asf/incubator-unomi/tree/b077d27b
Diff: http://git-wip-us.apache.org/repos/asf/incubator-unomi/diff/b077d27b
Branch: refs/heads/master
Commit: b077d27bb86335e81c9b7b07c28adeea840c031b
Parents: 837c462
Author: Francois Papon <fp...@apache.org>
Authored: Wed Sep 5 17:50:56 2018 +0400
Committer: Francois Papon <fp...@apache.org>
Committed: Fri Sep 7 11:46:22 2018 +0400
----------------------------------------------------------------------
manual/src/archives/1.1/asciidoc/apache.css | 2448 ++++++++++++++++++
.../1.1/asciidoc/building-and-deploying.adoc | 225 ++
.../src/archives/1.1/asciidoc/clustering.adoc | 103 +
manual/src/archives/1.1/asciidoc/concepts.adoc | 234 ++
.../archives/1.1/asciidoc/configuration.adoc | 296 +++
.../archives/1.1/asciidoc/getting-started.adoc | 461 ++++
.../1.1/asciidoc/images/asf_logo_url.png | Bin 0 -> 21121 bytes
.../1.1/asciidoc/images/incubator-logo.png | Bin 0 -> 8923 bytes
.../1.1/asciidoc/images/unomi-request.png | Bin 0 -> 132731 bytes
manual/src/archives/1.1/asciidoc/index.adoc | 55 +
manual/src/archives/1.2/asciidoc/apache.css | 2448 ++++++++++++++++++
.../1.2/asciidoc/building-and-deploying.adoc | 268 ++
.../src/archives/1.2/asciidoc/clustering.adoc | 84 +
manual/src/archives/1.2/asciidoc/concepts.adoc | 234 ++
.../archives/1.2/asciidoc/configuration.adoc | 345 +++
.../1.2/asciidoc/connectors/connectors.adoc | 23 +
.../connectors/salesforce-connector.adoc | 234 ++
.../1.2/asciidoc/custom-extensions.adoc | 413 +++
.../archives/1.2/asciidoc/getting-started.adoc | 122 +
.../1.2/asciidoc/images/asf_logo_url.png | Bin 0 -> 21121 bytes
.../1.2/asciidoc/images/incubator-logo.png | Bin 0 -> 8923 bytes
.../1.2/asciidoc/images/unomi-request.png | Bin 0 -> 132731 bytes
manual/src/archives/1.2/asciidoc/index.adoc | 75 +
.../1.2/asciidoc/samples/login-sample.adoc | 74 +
.../archives/1.2/asciidoc/samples/samples.adoc | 20 +
.../1.2/asciidoc/samples/twitter-sample.adoc | 433 ++++
.../asciidoc/samples/weather-update-sample.adoc | 15 +
manual/src/main/asciidoc/apache.css | 10 +-
manual/src/theme/apache-theme.yml | 27 +-
manual/src/theme/fonts/SourceSansPro-Black.ttf | Bin 288824 -> 0 bytes
.../theme/fonts/SourceSansPro-BlackItalic.ttf | Bin 102944 -> 0 bytes
manual/src/theme/fonts/SourceSansPro-Bold.ttf | Bin 290916 -> 0 bytes
.../theme/fonts/SourceSansPro-BoldItalic.ttf | Bin 103200 -> 0 bytes
.../theme/fonts/SourceSansPro-ExtraLight.ttf | Bin 291112 -> 0 bytes
.../fonts/SourceSansPro-ExtraLightItalic.ttf | Bin 104304 -> 0 bytes
manual/src/theme/fonts/SourceSansPro-Italic.ttf | Bin 103828 -> 0 bytes
manual/src/theme/fonts/SourceSansPro-Light.ttf | Bin 292680 -> 0 bytes
.../theme/fonts/SourceSansPro-LightItalic.ttf | Bin 104156 -> 0 bytes
.../src/theme/fonts/SourceSansPro-Regular.ttf | Bin 293516 -> 0 bytes
.../src/theme/fonts/SourceSansPro-SemiBold.ttf | Bin 291864 -> 0 bytes
.../fonts/SourceSansPro-SemiBoldItalic.ttf | Bin 103556 -> 0 bytes
manual/src/theme/fonts/SourceSansPro_OFL.txt | 93 -
42 files changed, 8635 insertions(+), 105 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.1/asciidoc/apache.css
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.1/asciidoc/apache.css b/manual/src/archives/1.1/asciidoc/apache.css
new file mode 100644
index 0000000..e66d1fa
--- /dev/null
+++ b/manual/src/archives/1.1/asciidoc/apache.css
@@ -0,0 +1,2448 @@
+
+@import "https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,700%7cDroid+Serif:400,700";
+
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+main,
+nav,
+section,
+summary {
+ display: block
+}
+
+audio,
+canvas,
+video {
+ display: inline-block
+}
+
+audio:not([controls]) {
+ display: none;
+ height: 0
+}
+
+script {
+ display: none !important
+}
+
+html {
+ font-family: "Droid Serif";
+ -ms-text-size-adjust: 100%;
+ -webkit-text-size-adjust: 100%;
+}
+
+a {
+ background: transparent
+}
+
+a:focus {
+ outline: thin dotted
+}
+
+a:active,
+a:hover {
+ outline: 0
+}
+
+h1 {
+ font-size: 2em;
+ margin: .67em 0
+}
+
+abbr[title] {
+ border-bottom: 1px dotted
+}
+
+b,
+strong {
+ font-weight: bold
+}
+
+dfn {
+ font-style: italic
+}
+
+hr {
+ -moz-box-sizing: content-box;
+ box-sizing: content-box;
+ height: 0
+}
+
+mark {
+ background: #ff0;
+ color: #000
+}
+
+code,
+kbd,
+pre,
+samp {
+ font-family: monospace;
+ font-size: 1em
+}
+
+pre {
+ white-space: pre-wrap
+}
+
+q {
+ quotes: "\201C" "\201D" "\2018" "\2019"
+}
+
+small {
+ font-size: 80%
+}
+
+sub,
+sup {
+ font-size: 75%;
+ line-height: 0;
+ position: relative;
+ vertical-align: baseline
+}
+
+sup {
+ top: -.5em
+}
+
+sub {
+ bottom: -.25em
+}
+
+img {
+ border: 0
+}
+
+svg:not(:root) {
+ overflow: hidden
+}
+
+figure {
+ margin: 0
+}
+
+fieldset {
+ border: 1px solid silver;
+ margin: 0 2px;
+ padding: .35em .625em .75em
+}
+
+legend {
+ border: 0;
+ padding: 0
+}
+
+button,
+input,
+select,
+textarea {
+ font-family: inherit;
+ font-size: 100%;
+ margin: 0
+}
+
+button,
+input {
+ line-height: normal
+}
+
+button,
+select {
+ text-transform: none
+}
+
+button,
+html input[type="button"],
+input[type="reset"],
+input[type="submit"] {
+ -webkit-appearance: button;
+ cursor: pointer
+}
+
+button[disabled],
+html input[disabled] {
+ cursor: default
+}
+
+input[type="checkbox"],
+input[type="radio"] {
+ box-sizing: border-box;
+ padding: 0
+}
+
+button::-moz-focus-inner,
+input::-moz-focus-inner {
+ border: 0;
+ padding: 0
+}
+
+textarea {
+ overflow: auto;
+ vertical-align: top
+}
+
+table {
+ border-collapse: collapse;
+ border-spacing: 0
+}
+
+*,
+*::before,
+*::after {
+ -moz-box-sizing: border-box;
+ -webkit-box-sizing: border-box;
+ box-sizing: border-box
+}
+
+html,
+body {
+ /*font-size: 100%*/
+}
+
+body {
+ background: #fff;
+ color: #333;
+ padding: 0;
+ margin: 0;
+ font-family: "Droid Serif", "DejaVu Serif", serif;
+ font-size: 14px;
+ font-style: normal;
+ line-height: 1.42857143;
+ position: relative;
+ cursor: auto;
+ tab-size: 4;
+ -moz-osx-font-smoothing: grayscale;
+ -webkit-font-smoothing: antialiased
+}
+
+a:hover {
+ cursor: pointer
+}
+
+img,
+object,
+embed {
+ max-width: 100%;
+ height: auto
+}
+
+object,
+embed {
+ height: 100%
+}
+
+img {
+ -ms-interpolation-mode: bicubic
+}
+
+.left {
+ float: left !important
+}
+
+.right {
+ float: right !important
+}
+
+.text-left {
+ text-align: left !important
+}
+
+.text-right {
+ text-align: right !important
+}
+
+.text-center {
+ text-align: center !important
+}
+
+.text-justify {
+ text-align: justify !important
+}
+
+.hide {
+ display: none
+}
+
+img,
+object,
+svg {
+ display: inline-block;
+ vertical-align: middle
+}
+
+textarea {
+ height: auto;
+ min-height: 50px
+}
+
+select {
+ width: 100%
+}
+
+.center {
+ margin-left: auto;
+ margin-right: auto
+}
+
+.stretch {
+ width: 100%
+}
+
+.subheader,
+.admonitionblock td.content>.title,
+.audioblock>.title,
+.exampleblock>.title,
+.imageblock>.title,
+.listingblock>.title,
+.literalblock>.title,
+.stemblock>.title,
+.openblock>.title,
+.paragraph>.title,
+.quoteblock>.title,
+table.tableblock>.title,
+.verseblock>.title,
+.videoblock>.title,
+.dlist>.title,
+.olist>.title,
+.ulist>.title,
+.qlist>.title,
+.hdlist>.title {
+ line-height: 1.45;
+ color: #585ac2;
+ font-weight: 400;
+ margin-top: 0;
+ margin-bottom: .25em
+}
+
+div,
+dl,
+dt,
+dd,
+ul,
+ol,
+li,
+h1,
+h2,
+h3,
+#toctitle,
+.sidebarblock>.content>.title,
+h4,
+h5,
+h6,
+pre,
+form,
+p,
+blockquote,
+th,
+td {
+ margin: 0;
+ padding: 0;
+ direction: ltr
+}
+
+a {
+ color: #585ac2;
+ text-decoration: underline;
+ line-height: inherit
+}
+
+a:hover,
+a:focus {
+ color: #373997;
+}
+
+a img {
+ border: none
+}
+
+p {
+ font-family: inherit;
+ font-weight: 400;
+ font-size: 1em;
+ line-height: 1.6;
+ margin-bottom: 1.25em;
+ text-rendering: optimizeLegibility
+}
+
+p aside {
+ font-size: .875em;
+ line-height: 1.35;
+ font-style: italic
+}
+
+h1,
+h2,
+h3,
+#toctitle,
+.sidebarblock>.content>.title,
+h4,
+h5,
+h6 {
+ font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ font-weight: bold;
+ /*font-style: bold;*/
+ color: #303284;
+ text-rendering: optimizeLegibility;
+ margin-top: 1em;
+ margin-bottom: .5em;
+ line-height: 1.0125em;
+ text-transform: uppercase;
+}
+
+h1 small,
+h2 small,
+h3 small,
+#toctitle small,
+.sidebarblock>.content>.title small,
+h4 small,
+h5 small,
+h6 small {
+ font-size: 60%;
+ color: #303284;
+ line-height: 0
+}
+
+h1 {
+ font-size: 2.125em
+}
+
+h2 {
+ font-size: 1.6875em
+}
+
+h3,
+#toctitle,
+.sidebarblock>.content>.title {
+ font-size: 1.375em
+}
+
+h4,
+h5 {
+ font-size: 1.125em
+}
+
+h6 {
+ font-size: 1em
+}
+
+hr {
+ border: solid #dddddd;
+ border-width: 1px 0 0;
+ clear: both;
+ margin: 1.25em 0 1.1875em;
+ height: 0
+}
+
+em,
+i {
+ font-style: italic;
+ line-height: inherit
+}
+
+strong,
+b {
+ font-weight: bold;
+ line-height: inherit
+}
+
+small {
+ font-size: 60%;
+ line-height: inherit
+}
+
+code {
+ font-family: "Droid Sans Mono", "DejaVu Sans Mono", monospace;
+ font-weight: 400;
+ color: #585ac2;
+}
+
+ul,
+ol,
+dl {
+ font-size: 1em;
+ line-height: 1.6;
+ margin-bottom: 1.25em;
+ list-style-position: outside;
+ font-family: inherit
+}
+
+ul,
+ol {
+ margin-left: 1.5em
+}
+
+ul li ul,
+ul li ol {
+ margin-left: 1.25em;
+ margin-bottom: 0;
+ font-size: 1em
+}
+
+ul.square li ul,
+ul.circle li ul,
+ul.disc li ul {
+ list-style: inherit
+}
+
+ul.square {
+ list-style-type: square
+}
+
+ul.circle {
+ list-style-type: circle
+}
+
+ul.disc {
+ list-style-type: disc
+}
+
+ol li ul,
+ol li ol {
+ margin-left: 1.25em;
+ margin-bottom: 0
+}
+
+dl dt {
+ margin-bottom: .3125em;
+ font-weight: bold
+}
+
+dl dd {
+ margin-bottom: 1.25em
+}
+
+abbr,
+acronym {
+ text-transform: uppercase;
+ font-size: 90%;
+ color: rgba(0, 0, 0, .8);
+ border-bottom: 1px dotted #ddd;
+ cursor: help
+}
+
+abbr {
+ text-transform: none
+}
+
+blockquote {
+ margin: 0 0 1.25em;
+ padding: .5625em 1.25em 0 1.1875em;
+ border-left: 1px solid #ddd
+}
+
+blockquote cite {
+ display: block;
+ font-size: .9375em;
+ color: rgba(0, 0, 0, .6)
+}
+
+blockquote cite::before {
+ content: "\2014 \0020"
+}
+
+blockquote cite a,
+blockquote cite a:visited {
+ color: rgba(0, 0, 0, .6)
+}
+
+blockquote,
+blockquote p {
+ line-height: 1.6;
+ color: rgba(0, 0, 0, .85)
+}
+
+@media screen and (min-width:768px) {
+ h1,
+ h2,
+ h3,
+ #toctitle,
+ .sidebarblock>.content>.title,
+ h4,
+ h5,
+ h6 {
+ line-height: 1.2
+ }
+
+ h1 {
+ font-size: 2.75em
+ }
+
+ h2 {
+ font-size: 2.3125em
+ }
+
+ h3,
+ #toctitle,
+ .sidebarblock>.content>.title {
+ font-size: 1.6875em
+ }
+
+ h4 {
+ font-size: 1.4375em
+ }
+
+}
+
+table {
+ background: #fff;
+ margin-bottom: 1.25em;
+ border: solid 1px #dddddd;
+}
+
+table thead,
+table tfoot {
+ background: #f7f8f7
+}
+
+table thead tr th,
+table thead tr td,
+table tfoot tr th,
+table tfoot tr td {
+ padding: .5em .625em .625em;
+ font-size: inherit;
+ color: rgba(0, 0, 0, .8);
+ text-align: left
+}
+
+table tr th,
+table tr td {
+ padding: .5625em .625em;
+ font-size: inherit;
+ color: rgba(0, 0, 0, .8)
+}
+
+table tr.even,
+table tr.alt,
+table tr:nth-of-type(even) {
+ background: #f8f8f7
+}
+
+table thead tr th,
+table tfoot tr th,
+table tbody tr td,
+table tr td,
+table tfoot tr td {
+ display: table-cell;
+ line-height: 1.6
+}
+
+h1,
+h2,
+h3,
+#toctitle,
+.sidebarblock>.content>.title,
+h4,
+h5,
+h6 {
+ line-height: 1.2;
+ word-spacing: -.05em
+}
+
+h1 strong,
+h2 strong,
+h3 strong,
+#toctitle strong,
+.sidebarblock>.content>.title strong,
+h4 strong,
+h5 strong,
+h6 strong {
+ font-weight: 400
+}
+
+.clearfix::before,
+.clearfix::after,
+.float-group::before,
+.float-group::after {
+ content: " ";
+ display: table
+}
+
+.clearfix::after,
+.float-group::after {
+ clear: both
+}
+
+*:not(pre)>code {
+ font-size: .9375em;
+ font-style: normal !important;
+ letter-spacing: 0;
+ padding: .1em .5ex;
+ word-spacing: -.15em;
+ background-color: #f7f7f8;
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+ line-height: 1.45;
+ text-rendering: optimizeSpeed;
+ word-wrap: break-word
+}
+
+*:not(pre)>code.nobreak {
+ word-wrap: normal
+}
+
+*:not(pre)>code.nowrap {
+ white-space: nowrap
+}
+
+pre,
+pre>code {
+ line-height: 1.45;
+ color: #585ac2;
+ font-family: "Droid Sans Mono", "DejaVu Sans Mono", monospace;
+ font-weight: 400;
+ text-rendering: optimizeSpeed
+}
+
+em em {
+ font-style: normal
+}
+
+strong strong {
+ font-weight: 400
+}
+
+.keyseq {
+ color: rgba(51, 51, 51, .8)
+}
+
+kbd {
+ font-family: "Droid Sans Mono", "DejaVu Sans Mono", monospace;
+ display: inline-block;
+ color: rgba(0, 0, 0, .8);
+ font-size: .65em;
+ line-height: 1.45;
+ background-color: #f7f7f7;
+ border: 1px solid #dddddd;
+ -webkit-border-radius: 3px;
+ border-radius: 3px;
+ -webkit-box-shadow: 0 1px 0 rgba(0, 0, 0, .2), 0 0 0 .1em white inset;
+ box-shadow: 0 1px 0 rgba(0, 0, 0, .2), 0 0 0 .1em #fff inset;
+ margin: 0 .15em;
+ padding: .2em .5em;
+ vertical-align: middle;
+ position: relative;
+ top: -.1em;
+ white-space: nowrap
+}
+
+.keyseq kbd:first-child {
+ margin-left: 0
+}
+
+.keyseq kbd:last-child {
+ margin-right: 0
+}
+
+.menuseq,
+.menuref {
+ color: #000
+}
+
+.menuseq b:not(.caret),.menuref {
+ font-weight: inherit
+}
+
+.menuseq {
+ word-spacing: -.02em
+}
+
+.menuseq b.caret {
+ font-size: 1.25em;
+ line-height: .8
+}
+
+.menuseq i.caret {
+ font-weight: bold;
+ text-align: center;
+ width: .45em
+}
+
+b.button::before,
+b.button::after {
+ position: relative;
+ top: -1px;
+ font-weight: 400
+}
+
+b.button::before {
+ content: "[";
+ padding: 0 3px 0 2px
+}
+
+b.button::after {
+ content: "]";
+ padding: 0 2px 0 3px
+}
+
+p a>code:hover {
+ color: #585ac2;
+}
+
+#header,
+#content,
+#footnotes,
+#footer {
+ width: 100%;
+ margin-left: auto;
+ margin-right: auto;
+ margin-top: 0;
+ margin-bottom: 0;
+ max-width: 62.5em;
+ *zoom: 1;
+ position: relative;
+ padding-left: .9375em;
+ padding-right: .9375em
+}
+
+#header::before,
+#header::after,
+#content::before,
+#content::after,
+#footnotes::before,
+#footnotes::after,
+#footer::before,
+#footer::after {
+ content: " ";
+ display: table
+}
+
+#header::after,
+#content::after,
+#footnotes::after,
+#footer::after {
+ clear: both
+}
+
+#content {
+ margin-top: 1.25em
+}
+
+#content::before {
+ content: none
+}
+
+#header>h1:first-child {
+ color: #303284;
+ margin-top: 2.25rem;
+ margin-bottom: 0
+}
+
+#header>h1:first-child+#toc {
+ margin-top: 8px;
+ border-top: 1px solid #dddddd
+}
+
+#header>h1:only-child,
+body.toc2 #header>h1:nth-last-child(2) {
+ border-bottom: 1px solid #dddddd;
+ padding-bottom: 8px
+}
+
+#header .details {
+ border-bottom: 1px solid #dddddd;
+ line-height: 1.45;
+ padding-top: .25em;
+ padding-bottom: .25em;
+ padding-left: .25em;
+ color: rgba(0, 0, 0, .6);
+ display: -ms-flexbox;
+ display: -webkit-flex;
+ display: flex;
+ -ms-flex-flow: row wrap;
+ -webkit-flex-flow: row wrap;
+ flex-flow: row wrap
+}
+
+#header .details span:first-child {
+ margin-left: -.125em
+}
+
+#header .details span.email a {
+ color: rgba(0, 0, 0, .85)
+}
+
+#header .details br {
+ display: none
+}
+
+#header .details br+span::before {
+ content: "\00a0\2013\00a0"
+}
+
+#header .details br+span.author::before {
+ content: "\00a0\22c5\00a0";
+ color: rgba(0, 0, 0, .85)
+}
+
+#header .details br+span#revremark::before {
+ content: "\00a0|\00a0"
+}
+
+#header #revnumber {
+ text-transform: capitalize
+}
+
+#header #revnumber::after {
+ content: "\00a0"
+}
+
+#content>h1:first-child:not([class]) {
+ color: rgba(0, 0, 0, .85);
+ border-bottom: 1px solid #dddddd
+;
+ padding-bottom: 8px;
+ margin-top: 0;
+ padding-top: 1rem;
+ margin-bottom: 1.25rem
+}
+
+#toc {
+ border-bottom: 1px solid #dddddd;
+ padding-bottom: .5em
+}
+
+#toc>ul {
+ margin-left: .125em
+}
+
+#toc ul.sectlevel0>li>a {
+ font-style: italic
+}
+
+#toc ul.sectlevel0 ul.sectlevel1 {
+ margin: .5em 0
+}
+
+#toc ul {
+ font-family: "Droid Serif", "DejaVu Sans", sans-serif;
+ list-style-type: none
+}
+
+#toc li {
+ line-height: 1.3334;
+ margin-top: .3334em
+}
+
+#toc a {
+ text-decoration: none
+}
+
+#toc a:active {
+ text-decoration: underline
+}
+
+#toctitle {
+ color: #303284;
+ font-size: 1.2em
+}
+
+@media screen and (min-width:768px) {
+ #toctitle {
+ font-size: 1.375em
+ }
+
+ body.toc2 {
+ padding-left: 15em;
+ padding-right: 0
+ }
+
+ #toc.toc2 {
+ margin-top: 0 !important;
+ background-color: #eee;
+ position: fixed;
+ width: 15em;
+ left: 0;
+ top: 0;
+ border-right: 1px solid #dddddd;
+ border-top-width: 0 !important;
+ border-bottom-width: 0 !important;
+ z-index: 1000;
+ padding: 1.25em 1em;
+ height: 100%;
+ overflow: auto
+ }
+
+ #toc.toc2 #toctitle {
+ margin-top: 0;
+ margin-bottom: .8rem;
+ font-size: 1.2em
+ }
+
+ #toc.toc2>ul {
+ font-size: .9em;
+ margin-bottom: 0
+ }
+
+ #toc.toc2 ul ul {
+ margin-left: 0;
+ padding-left: 1em
+ }
+
+ #toc.toc2 ul.sectlevel0 ul.sectlevel1 {
+ padding-left: 0;
+ margin-top: .5em;
+ margin-bottom: .5em
+ }
+
+ body.toc2.toc-right {
+ padding-left: 0;
+ padding-right: 15em
+ }
+
+ body.toc2.toc-right #toc.toc2 {
+ border-right-width: 0;
+ border-left: 1px solid #dddddd;
+ left: auto;
+ right: 0
+ }
+
+}
+
+@media screen and (min-width:1280px) {
+ body.toc2 {
+ padding-left: 20em;
+ padding-right: 0
+ }
+
+ #toc.toc2 {
+ width: 20em
+ }
+
+ #toc.toc2 #toctitle {
+ font-size: 1.375em
+ }
+
+ #toc.toc2>ul {
+ font-size: .95em
+ }
+
+ #toc.toc2 ul ul {
+ padding-left: 1.25em
+ }
+
+ body.toc2.toc-right {
+ padding-left: 0;
+ padding-right: 20em
+ }
+
+}
+
+#content #toc {
+ border-style: solid;
+ border-width: 1px;
+ border-color: #dddddd;
+ margin-bottom: 1.25em;
+ padding: 1.25em;
+ background: #f8f8f7;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+#content #toc>:first-child {
+ margin-top: 0
+}
+
+#content #toc>:last-child {
+ margin-bottom: 0
+}
+
+#footer {
+ max-width: 100%;
+ background-color: #303284;
+ padding: 1.25em
+}
+
+#footer-text {
+ color: #fff;
+ line-height: 1.44
+}
+
+#content {
+ margin-bottom: .625em
+}
+
+.sect1 {
+ padding-bottom: .625em
+}
+
+@media screen and (min-width:768px) {
+ #content {
+ margin-bottom: 1.25em
+ }
+
+ .sect1 {
+ padding-bottom: 1.25em
+ }
+
+}
+
+.sect1:last-child {
+ padding-bottom: 0
+}
+
+.sect1+.sect1 {
+ border-top: 1px solid #dddddd;
+}
+
+#content h1>a.anchor,
+h2>a.anchor,
+h3>a.anchor,
+#toctitle>a.anchor,
+.sidebarblock>.content>.title>a.anchor,
+h4>a.anchor,
+h5>a.anchor,
+h6>a.anchor {
+ position: absolute;
+ z-index: 1001;
+ width: 1.5ex;
+ margin-left: -1.5ex;
+ display: block;
+ text-decoration: none !important;
+ visibility: hidden;
+ text-align: center;
+ font-weight: 400
+}
+
+#content h1>a.anchor::before,
+h2>a.anchor::before,
+h3>a.anchor::before,
+#toctitle>a.anchor::before,
+.sidebarblock>.content>.title>a.anchor::before,
+h4>a.anchor::before,
+h5>a.anchor::before,
+h6>a.anchor::before {
+ content: "\00A7";
+ font-size: .85em;
+ display: block;
+ padding-top: .1em
+}
+
+#content h1:hover>a.anchor,
+#content h1>a.anchor:hover,
+h2:hover>a.anchor,
+h2>a.anchor:hover,
+h3:hover>a.anchor,
+#toctitle:hover>a.anchor,
+.sidebarblock>.content>.title:hover>a.anchor,
+h3>a.anchor:hover,
+#toctitle>a.anchor:hover,
+.sidebarblock>.content>.title>a.anchor:hover,
+h4:hover>a.anchor,
+h4>a.anchor:hover,
+h5:hover>a.anchor,
+h5>a.anchor:hover,
+h6:hover>a.anchor,
+h6>a.anchor:hover {
+ visibility: visible
+}
+
+#content h1>a.link,
+h2>a.link,
+h3>a.link,
+#toctitle>a.link,
+.sidebarblock>.content>.title>a.link,
+h4>a.link,
+h5>a.link,
+h6>a.link {
+ color: #ba3925;
+ text-decoration: none
+}
+
+#content h1>a.link:hover,
+h2>a.link:hover,
+h3>a.link:hover,
+#toctitle>a.link:hover,
+.sidebarblock>.content>.title>a.link:hover,
+h4>a.link:hover,
+h5>a.link:hover,
+h6>a.link:hover {
+ color: #a53221
+}
+
+.audioblock,
+.imageblock,
+.literalblock,
+.listingblock,
+.stemblock,
+.videoblock {
+ margin-bottom: 1.25em
+}
+
+.admonitionblock td.content>.title,
+.audioblock>.title,
+.exampleblock>.title,
+.imageblock>.title,
+.listingblock>.title,
+.literalblock>.title,
+.stemblock>.title,
+.openblock>.title,
+.paragraph>.title,
+.quoteblock>.title,
+table.tableblock>.title,
+.verseblock>.title,
+.videoblock>.title,
+.dlist>.title,
+.olist>.title,
+.ulist>.title,
+.qlist>.title,
+.hdlist>.title {
+ text-rendering: optimizeLegibility;
+ text-align: left;
+ font-family: "Droid Serif", "DejaVu Serif", serif;
+ font-size: 1rem;
+ font-style: italic
+}
+
+table.tableblock.fit-content>caption.title {
+ white-space: nowrap;
+ width: 0
+}
+
+.paragraph.lead>p,
+#preamble>.sectionbody>[class="paragraph"]:first-of-type p {
+ font-size: 1.21875em;
+ line-height: 1.6;
+ color: rgba(0, 0, 0, .85)
+}
+
+table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p {
+ font-size: inherit
+}
+
+.admonitionblock>table {
+ border-collapse: separate;
+ border: 0;
+ background: none;
+ width: 100%
+}
+
+.admonitionblock>table td.icon {
+ text-align: center;
+ width: 80px
+}
+
+.admonitionblock>table td.icon img {
+ max-width: none
+}
+
+.admonitionblock>table td.icon .title {
+ font-weight: bold;
+ font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ text-transform: uppercase
+}
+
+.admonitionblock>table td.content {
+ padding-left: 1.125em;
+ padding-right: 1.25em;
+ border-left: 1px solid #dddddd;
+ color: rgba(0, 0, 0, .6)
+}
+
+.admonitionblock>table td.content>:last-child>:last-child {
+ margin-bottom: 0
+}
+
+.exampleblock>.content {
+ border-style: solid;
+ border-width: 1px;
+ border-color: #dddddd;
+ margin-bottom: 1.25em;
+ padding: 1.25em;
+ background: #fff;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+.exampleblock>.content>:first-child {
+ margin-top: 0
+}
+
+.exampleblock>.content>:last-child {
+ margin-bottom: 0
+}
+
+.sidebarblock {
+ border-style: solid;
+ border-width: 1px;
+ border-color: #dddddd;
+ margin-bottom: 1.25em;
+ padding: 1.25em;
+ background: #f8f8f7;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+.sidebarblock>:first-child {
+ margin-top: 0
+}
+
+.sidebarblock>:last-child {
+ margin-bottom: 0
+}
+
+.sidebarblock>.content>.title {
+ color: #303284;
+ margin-top: 0;
+ text-align: center
+}
+
+.exampleblock>.content>:last-child>:last-child,
+.exampleblock>.content .olist>ol>li:last-child>:last-child,
+.exampleblock>.content .ulist>ul>li:last-child>:last-child,
+.exampleblock>.content .qlist>ol>li:last-child>:last-child,
+.sidebarblock>.content>:last-child>:last-child,
+.sidebarblock>.content .olist>ol>li:last-child>:last-child,
+.sidebarblock>.content .ulist>ul>li:last-child>:last-child,
+.sidebarblock>.content .qlist>ol>li:last-child>:last-child {
+ margin-bottom: 0
+}
+
+.literalblock pre,
+.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint {
+ background: #f7f7f8
+}
+
+.sidebarblock .literalblock pre,
+.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint {
+ background: #f2f1f1
+}
+
+.literalblock pre,
+.literalblock pre[class],
+.listingblock pre,
+.listingblock pre[class] {
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+ word-wrap: break-word;
+ padding: 1em;
+ font-size: .8125em
+}
+
+.literalblock pre.nowrap,
+.literalblock pre[class].nowrap,
+.listingblock pre.nowrap,
+.listingblock pre[class].nowrap {
+ overflow-x: auto;
+ white-space: pre;
+ word-wrap: normal
+}
+
+@media screen and (min-width:768px) {
+ .literalblock pre,
+ .literalblock pre[class],
+ .listingblock pre,
+ .listingblock pre[class] {
+ font-size: .90625em
+ }
+
+}
+
+@media screen and (min-width:1280px) {
+ .literalblock pre,
+ .literalblock pre[class],
+ .listingblock pre,
+ .listingblock pre[class] {
+ font-size: 1em
+ }
+
+}
+
+.literalblock.output pre {
+ color: #f7f7f8;
+ background-color: rgba(0, 0, 0, .9)
+}
+
+.listingblock pre.highlightjs {
+ padding: 0
+}
+
+.listingblock pre.highlightjs>code {
+ padding: 1em;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+.listingblock pre.prettyprint {
+ border-width: 0
+}
+
+.listingblock>.content {
+ position: relative
+}
+
+.listingblock code[data-lang]::before {
+ display: none;
+ content: attr(data-lang);
+ position: absolute;
+ font-size: .75em;
+ top: .425rem;
+ right: .5rem;
+ line-height: 1;
+ text-transform: uppercase;
+ color: #999
+}
+
+.listingblock:hover code[data-lang]::before {
+ display: block
+}
+
+.listingblock.terminal pre .command::before {
+ content: attr(data-prompt);
+ padding-right: .5em;
+ color: #999
+}
+
+.listingblock.terminal pre .command:not([data-prompt])::before {
+ content: "$"
+}
+
+table.pyhltable {
+ border-collapse: separate;
+ border: 0;
+ margin-bottom: 0;
+ background: none
+}
+
+table.pyhltable td {
+ vertical-align: top;
+ padding-top: 0;
+ padding-bottom: 0;
+ line-height: 1.45
+}
+
+table.pyhltable td.code {
+ padding-left: .75em;
+ padding-right: 0
+}
+
+pre.pygments .lineno,
+table.pyhltable td:not(.code) {
+ color: #999;
+ padding-left: 0;
+ padding-right: .5em;
+ border-right: 1px solid #dddddd;
+}
+
+pre.pygments .lineno {
+ display: inline-block;
+ margin-right: .25em
+}
+
+table.pyhltable .linenodiv {
+ background: none !important;
+ padding-right: 0 !important
+}
+
+.quoteblock {
+ margin: 0 1em 1.25em 1.5em;
+ display: table
+}
+
+.quoteblock>.title {
+ margin-left: -1.5em;
+ margin-bottom: .75em
+}
+
+.quoteblock blockquote,
+.quoteblock blockquote p {
+ color: rgba(0, 0, 0, .85);
+ font-size: 1.05rem;
+ line-height: 1.75;
+ word-spacing: .1em;
+ letter-spacing: 0;
+ font-style: italic;
+ text-align: justify
+}
+
+.quoteblock blockquote {
+ margin: 0;
+ padding: 0;
+ border: 0
+}
+
+.quoteblock blockquote::before {
+ content: "\201c";
+ float: left;
+ font-size: 2.75em;
+ font-weight: bold;
+ line-height: .6em;
+ margin-left: -.6em;
+ color: #303284;
+ text-shadow: 0 1px 2px rgba(0, 0, 0, .1)
+}
+
+.quoteblock blockquote>.paragraph:last-child p {
+ margin-bottom: 0
+}
+
+.quoteblock .attribution {
+ margin-top: .5em;
+ margin-right: .5ex;
+ text-align: right
+}
+
+.quoteblock .quoteblock {
+ margin-left: 0;
+ margin-right: 0;
+ padding: .5em 0;
+ border-left: 3px solid rgba(0, 0, 0, .6)
+}
+
+.quoteblock .quoteblock blockquote {
+ padding: 0 0 0 .75em
+}
+
+.quoteblock .quoteblock blockquote::before {
+ display: none
+}
+
+.verseblock {
+ margin: 0 1em 1.25em
+}
+
+.verseblock pre {
+ font-family: "Source Sans Pro", "DejaVu Sans", sans;
+ font-size: 1.15rem;
+ color: rgba(0, 0, 0, .85);
+ font-weight: 300;
+ text-rendering: optimizeLegibility
+}
+
+.verseblock pre strong {
+ font-weight: 400
+}
+
+.verseblock .attribution {
+ margin-top: 1.25rem;
+ margin-left: .5ex
+}
+
+.quoteblock .attribution,
+.verseblock .attribution {
+ font-size: .9375em;
+ line-height: 1.45;
+ font-style: italic
+}
+
+.quoteblock .attribution br,
+.verseblock .attribution br {
+ display: none
+}
+
+.quoteblock .attribution cite,
+.verseblock .attribution cite {
+ display: block;
+ letter-spacing: -.025em;
+ color: rgba(0, 0, 0, .6)
+}
+
+.quoteblock.abstract {
+ margin: 0 1em 1.25em;
+ display: block
+}
+
+.quoteblock.abstract>.title {
+ margin: 0 0 .375em;
+ font-size: 1.15em;
+ text-align: center
+}
+
+.quoteblock.abstract blockquote,
+.quoteblock.abstract blockquote p {
+ word-spacing: 0;
+ line-height: 1.6
+}
+
+.quoteblock.abstract blockquote::before,
+.quoteblock.abstract p::before {
+ display: none
+}
+
+table.tableblock {
+ max-width: 100%;
+ border-collapse: separate
+}
+
+p.tableblock:last-child {
+ margin-bottom: 0
+}
+
+td.tableblock>.content {
+ margin-bottom: -1.25em
+}
+
+table.tableblock,
+th.tableblock,
+td.tableblock {
+ border: 0 solid #dddddd;
+}
+
+table.grid-all>thead>tr>.tableblock,
+table.grid-all>tbody>tr>.tableblock {
+ border-width: 0 1px 1px 0
+}
+
+table.grid-all>tfoot>tr>.tableblock {
+ border-width: 1px 1px 0 0
+}
+
+table.grid-cols>*>tr>.tableblock {
+ border-width: 0 1px 0 0
+}
+
+table.grid-rows>thead>tr>.tableblock,
+table.grid-rows>tbody>tr>.tableblock {
+ border-width: 0 0 1px
+}
+
+table.grid-rows>tfoot>tr>.tableblock {
+ border-width: 1px 0 0
+}
+
+table.grid-all>*>tr>.tableblock:last-child,
+table.grid-cols>*>tr>.tableblock:last-child {
+ border-right-width: 0
+}
+
+table.grid-all>tbody>tr:last-child>.tableblock,
+table.grid-all>thead:last-child>tr>.tableblock,
+table.grid-rows>tbody>tr:last-child>.tableblock,
+table.grid-rows>thead:last-child>tr>.tableblock {
+ border-bottom-width: 0
+}
+
+table.frame-all {
+ border-width: 1px
+}
+
+table.frame-sides {
+ border-width: 0 1px
+}
+
+table.frame-topbot,
+table.frame-ends {
+ border-width: 1px 0
+}
+
+table.stripes-all tr,
+table.stripes-odd tr:nth-of-type(odd) {
+ background: #f8f8f7
+}
+
+table.stripes-none tr,
+table.stripes-odd tr:nth-of-type(even) {
+ background: none
+}
+
+th.halign-left,
+td.halign-left {
+ text-align: left
+}
+
+th.halign-right,
+td.halign-right {
+ text-align: right
+}
+
+th.halign-center,
+td.halign-center {
+ text-align: center
+}
+
+th.valign-top,
+td.valign-top {
+ vertical-align: top
+}
+
+th.valign-bottom,
+td.valign-bottom {
+ vertical-align: bottom
+}
+
+th.valign-middle,
+td.valign-middle {
+ vertical-align: middle
+}
+
+table thead th,
+table tfoot th {
+ font-weight: bold
+}
+
+tbody tr th {
+ display: table-cell;
+ line-height: 1.6;
+ background: #f7f8f7
+}
+
+tbody tr th,
+tbody tr th p,
+tfoot tr th,
+tfoot tr th p {
+ color: rgba(0, 0, 0, .8);
+ font-weight: bold
+}
+
+p.tableblock>code:only-child {
+ background: none;
+ padding: 0
+}
+
+p.tableblock {
+ font-size: 1em
+}
+
+td>div.verse {
+ white-space: pre
+}
+
+ol {
+ margin-left: 1.75em
+}
+
+ul li ol {
+ margin-left: 1.5em
+}
+
+dl dd {
+ margin-left: 1.125em
+}
+
+dl dd:last-child,
+dl dd:last-child>:last-child {
+ margin-bottom: 0
+}
+
+ol>li p,
+ul>li p,
+ul dd,
+ol dd,
+.olist .olist,
+.ulist .ulist,
+.ulist .olist,
+.olist .ulist {
+ margin-bottom: .625em
+}
+
+ul.checklist,
+ul.none,
+ol.none,
+ul.no-bullet,
+ol.no-bullet,
+ol.unnumbered,
+ul.unstyled,
+ol.unstyled {
+ list-style-type: none
+}
+
+ul.no-bullet,
+ol.no-bullet,
+ol.unnumbered {
+ margin-left: .625em
+}
+
+ul.unstyled,
+ol.unstyled {
+ margin-left: 0
+}
+
+ul.checklist {
+ margin-left: .625em
+}
+
+ul.checklist li>p:first-child>.fa-square-o:first-child,
+ul.checklist li>p:first-child>.fa-check-square-o:first-child {
+ width: 1.25em;
+ font-size: .8em;
+ position: relative;
+ bottom: .125em
+}
+
+ul.checklist li>p:first-child>input[type="checkbox"]:first-child {
+ margin-right: .25em
+}
+
+ul.inline {
+ display: -ms-flexbox;
+ display: -webkit-box;
+ display: flex;
+ -ms-flex-flow: row wrap;
+ -webkit-flex-flow: row wrap;
+ flex-flow: row wrap;
+ list-style: none;
+ margin: 0 0 .625em -1.25em
+}
+
+ul.inline>li {
+ margin-left: 1.25em
+}
+
+.unstyled dl dt {
+ font-weight: 400;
+ font-style: normal
+}
+
+ol.arabic {
+ list-style-type: decimal
+}
+
+ol.decimal {
+ list-style-type: decimal-leading-zero
+}
+
+ol.loweralpha {
+ list-style-type: lower-alpha
+}
+
+ol.upperalpha {
+ list-style-type: upper-alpha
+}
+
+ol.lowerroman {
+ list-style-type: lower-roman
+}
+
+ol.upperroman {
+ list-style-type: upper-roman
+}
+
+ol.lowergreek {
+ list-style-type: lower-greek
+}
+
+.hdlist>table,
+.colist>table {
+ border: 0;
+ background: none
+}
+
+.hdlist>table>tbody>tr,
+.colist>table>tbody>tr {
+ background: none
+}
+
+td.hdlist1,
+td.hdlist2 {
+ vertical-align: top;
+ padding: 0 .625em
+}
+
+td.hdlist1 {
+ font-weight: bold;
+ padding-bottom: 1.25em
+}
+
+.literalblock+.colist,
+.listingblock+.colist {
+ margin-top: -.5em
+}
+
+.colist td:not([class]):first-child {
+ padding: .4em .75em 0;
+ line-height: 1;
+ vertical-align: top
+}
+
+.colist td:not([class]):first-child img {
+ max-width: none
+}
+
+.colist td:not([class]):last-child {
+ padding: .25em 0
+}
+
+.thumb,
+.th {
+ line-height: 0;
+ display: inline-block;
+ border: solid 4px #fff;
+ -webkit-box-shadow: 0 0 0 1px #ddd;
+ box-shadow: 0 0 0 1px #ddd
+}
+
+.imageblock.left,
+.imageblock[style*="float:left"] {
+ margin: .25em .625em 1.25em 0
+}
+
+.imageblock.right,
+.imageblock[style*="float:right"] {
+ margin: .25em 0 1.25em .625em
+}
+
+.imageblock>.title {
+ margin-bottom: 0
+}
+
+.imageblock.thumb,
+.imageblock.th {
+ border-width: 6px
+}
+
+.imageblock.thumb>.title,
+.imageblock.th>.title {
+ padding: 0 .125em
+}
+
+.image.left,
+.image.right {
+ margin-top: .25em;
+ margin-bottom: .25em;
+ display: inline-block;
+ line-height: 0
+}
+
+.image.left {
+ margin-right: .625em
+}
+
+.image.right {
+ margin-left: .625em
+}
+
+a.image {
+ text-decoration: none;
+ display: inline-block
+}
+
+a.image object {
+ pointer-events: none
+}
+
+sup.footnote,
+sup.footnoteref {
+ font-size: .875em;
+ position: static;
+ vertical-align: super
+}
+
+sup.footnote a,
+sup.footnoteref a {
+ text-decoration: none
+}
+
+sup.footnote a:active,
+sup.footnoteref a:active {
+ text-decoration: underline
+}
+
+#footnotes {
+ padding-top: .75em;
+ padding-bottom: .75em;
+ margin-bottom: .625em
+}
+
+#footnotes hr {
+ width: 20%;
+ min-width: 6.25em;
+ margin: -.25em 0 .75em;
+ border-width: 1px 0 0
+}
+
+#footnotes .footnote {
+ padding: 0 .375em 0 .225em;
+ line-height: 1.3334;
+ font-size: .875em;
+ margin-left: 1.2em;
+ margin-bottom: .2em
+}
+
+#footnotes .footnote a:first-of-type {
+ font-weight: bold;
+ text-decoration: none;
+ margin-left: -1.05em
+}
+
+#footnotes .footnote:last-of-type {
+ margin-bottom: 0
+}
+
+#content #footnotes {
+ margin-top: -.625em;
+ margin-bottom: 0;
+ padding: .75em 0
+}
+
+.gist .file-data>table {
+ border: 0;
+ background: #fff;
+ width: 100%;
+ margin-bottom: 0
+}
+
+.gist .file-data>table td.line-data {
+ width: 99%
+}
+
+div.unbreakable {
+ page-break-inside: avoid
+}
+
+.big {
+ font-size: larger
+}
+
+.small {
+ font-size: smaller
+}
+
+.underline {
+ text-decoration: underline
+}
+
+.overline {
+ text-decoration: overline
+}
+
+.line-through {
+ text-decoration: line-through
+}
+
+.aqua {
+ color: #00bfbf
+}
+
+.aqua-background {
+ background-color: #00fafa
+}
+
+.black {
+ color: #000
+}
+
+.black-background {
+ background-color: #000
+}
+
+.blue {
+ color: #0000bf
+}
+
+.blue-background {
+ background-color: #0000fa
+}
+
+.fuchsia {
+ color: #bf00bf
+}
+
+.fuchsia-background {
+ background-color: #fa00fa
+}
+
+.gray {
+ color: #606060
+}
+
+.gray-background {
+ background-color: #7d7d7d
+}
+
+.green {
+ color: #006000
+}
+
+.green-background {
+ background-color: #007d00
+}
+
+.lime {
+ color: #00bf00
+}
+
+.lime-background {
+ background-color: #00fa00
+}
+
+.maroon {
+ color: #600000
+}
+
+.maroon-background {
+ background-color: #7d0000
+}
+
+.navy {
+ color: #000060
+}
+
+.navy-background {
+ background-color: #00007d
+}
+
+.olive {
+ color: #606000
+}
+
+.olive-background {
+ background-color: #7d7d00
+}
+
+.purple {
+ color: #600060
+}
+
+.purple-background {
+ background-color: #7d007d
+}
+
+.red {
+ color: #bf0000
+}
+
+.red-background {
+ background-color: #fa0000
+}
+
+.silver {
+ color: #909090
+}
+
+.silver-background {
+ background-color: #bcbcbc
+}
+
+.teal {
+ color: #006060
+}
+
+.teal-background {
+ background-color: #007d7d
+}
+
+.white {
+ color: #bfbfbf
+}
+
+.white-background {
+ background-color: #fafafa
+}
+
+.yellow {
+ color: #bfbf00
+}
+
+.yellow-background {
+ background-color: #fafa00
+}
+
+span.icon>.fa {
+ cursor: default
+}
+
+a span.icon>.fa {
+ cursor: inherit
+}
+
+.admonitionblock td.icon [class^="fa icon-"] {
+ font-size: 2.5em;
+ text-shadow: 1px 1px 2px rgba(0, 0, 0, .5);
+ cursor: default
+}
+
+.admonitionblock td.icon .icon-note::before {
+ content: "\f05a";
+ color: #19407c
+}
+
+.admonitionblock td.icon .icon-tip::before {
+ content: "\f0eb";
+ text-shadow: 1px 1px 2px rgba(155, 155, 0, .8);
+ color: #111
+}
+
+.admonitionblock td.icon .icon-warning::before {
+ content: "\f071";
+ color: #bf6900
+}
+
+.admonitionblock td.icon .icon-caution::before {
+ content: "\f06d";
+ color: #bf3400
+}
+
+.admonitionblock td.icon .icon-important::before {
+ content: "\f06a";
+ color: #bf0000
+}
+
+.conum[data-value] {
+ display: inline-block;
+ color: #fff !important;
+ background-color: rgba(0, 0, 0, .8);
+ -webkit-border-radius: 100px;
+ border-radius: 100px;
+ text-align: center;
+ font-size: .75em;
+ width: 1.67em;
+ height: 1.67em;
+ line-height: 1.67em;
+ font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ font-style: normal;
+ font-weight: bold
+}
+
+.conum[data-value] * {
+ color: #fff !important
+}
+
+.conum[data-value]+b {
+ display: none
+}
+
+.conum[data-value]::after {
+ content: attr(data-value)
+}
+
+pre .conum[data-value] {
+ position: relative;
+ top: -.125em
+}
+
+b.conum * {
+ color: inherit !important
+}
+
+.conum:not([data-value]):empty {
+ display: none
+}
+
+dt,
+th.tableblock,
+td.content,
+div.footnote {
+ text-rendering: optimizeLegibility
+}
+
+h1,
+h2,
+p,
+td.content,
+span.alt {
+ letter-spacing: -.01em
+}
+
+p strong,
+td.content strong,
+div.footnote strong {
+ letter-spacing: -.005em
+}
+
+p,
+blockquote,
+dt,
+td.content,
+span.alt {
+ /*font-size: 1.0625rem*/
+}
+
+p {
+ margin-bottom: 1.25rem
+}
+
+.sidebarblock p,
+.sidebarblock dt,
+.sidebarblock td.content,
+p.tableblock {
+ font-size: 1em
+}
+
+.exampleblock>.content {
+ background-color: #fffef7;
+ border-color: #dddddd;
+ -webkit-box-shadow: 0 1px 4px #e0e0dc;
+ box-shadow: 0 1px 4px #e0e0dc
+}
+
+.print-only {
+ display: none !important
+}
+
+@page {
+ margin: 1.25cm .75cm
+}
+
+@media print {
+ * {
+ -webkit-box-shadow: none !important;
+ box-shadow: none !important;
+ text-shadow: none !important
+ }
+
+ html {
+ font-size: 80%
+ }
+
+ a {
+ color: inherit !important;
+ text-decoration: underline !important
+ }
+
+ a.bare,
+ a[href^="#"],
+ a[href^="mailto:"] {
+ text-decoration: none !important
+ }
+
+ a[href^="http:"]:not(.bare)::after,
+ a[href^="https:"]:not(.bare)::after {
+ content: "("attr(href) ")";
+ display: inline-block;
+ font-size: .875em;
+ padding-left: .25em
+ }
+
+ abbr[title]::after {
+ content: " ("attr(title) ")"
+ }
+
+ pre,
+ blockquote,
+ tr,
+ img,
+ object,
+ svg {
+ page-break-inside: avoid
+ }
+
+ thead {
+ display: table-header-group
+ }
+
+ svg {
+ max-width: 100%
+ }
+
+ p,
+ blockquote,
+ dt,
+ td.content {
+ font-size: 1em;
+ orphans: 3;
+ widows: 3
+ }
+
+ h2,
+ h3,
+ #toctitle,
+ .sidebarblock>.content>.title {
+ page-break-after: avoid
+ }
+
+ #toc,
+ .sidebarblock,
+ .exampleblock>.content {
+ background: none !important
+ }
+
+ #toc {
+ border-bottom: 1px solid #dddddd !important;
+ padding-bottom: 0 !important
+ }
+
+ body.book #header {
+ text-align: center
+ }
+
+ body.book #header>h1:first-child {
+ border: 0 !important;
+ margin: 2.5em 0 1em
+ }
+
+ body.book #header .details {
+ border: 0 !important;
+ display: block;
+ padding: 0 !important
+ }
+
+ body.book #header .details span:first-child {
+ margin-left: 0 !important
+ }
+
+ body.book #header .details br {
+ display: block
+ }
+
+ body.book #header .details br+span::before {
+ content: none !important
+ }
+
+ body.book #toc {
+ border: 0 !important;
+ text-align: left !important;
+ padding: 0 !important;
+ margin: 0 !important
+ }
+
+ body.book #toc,
+ body.book #preamble,
+ body.book h1.sect0,
+ body.book .sect1>h2 {
+ page-break-before: always
+ }
+
+ .listingblock code[data-lang]::before {
+ display: block
+ }
+
+ #footer {
+ padding: 0 .9375em
+ }
+
+ .hide-on-print {
+ display: none !important
+ }
+
+ .print-only {
+ display: block !important
+ }
+
+ .hide-for-print {
+ display: none !important
+ }
+
+ .show-for-print {
+ display: inherit !important
+ }
+
+}
+
+@media print, amzn-kf8 {
+ #header>h1:first-child {
+ margin-top: 1.25rem
+ }
+
+ .sect1 {
+ padding: 0 !important
+ }
+
+ .sect1+.sect1 {
+ border: 0
+ }
+
+ #footer {
+ background: none
+ }
+
+ #footer-text {
+ color: rgba(0, 0, 0, .6);
+ font-size: .9em
+ }
+
+}
+
+@media amzn-kf8 {
+ #header,
+ #content,
+ #footnotes,
+ #footer {
+ padding: 0
+ }
+
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.1/asciidoc/building-and-deploying.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.1/asciidoc/building-and-deploying.adoc b/manual/src/archives/1.1/asciidoc/building-and-deploying.adoc
new file mode 100644
index 0000000..04add15
--- /dev/null
+++ b/manual/src/archives/1.1/asciidoc/building-and-deploying.adoc
@@ -0,0 +1,225 @@
+//
+// Licensed 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.
+//
+
+=== Building
+
+Simply type at the root of the project:
+
+[source]
+----
+mvn clean install -P generate-package
+----
+
+The Maven build process will generate both a standalone package you can use directly to start the context server
+(see "Deploying the generated package") or a KAR file that you can then deploy using a manual deployment process into
+an already installed Apache Karaf server (see "Deploying into an existing Karaf server")
+
+If you want to build and run the integration tests, you should instead use :
+
+[source]
+----
+mvn -P integration-tests clean install
+----
+
+==== Deploying the generated package
+
+The "package" sub-project generates a pre-configured Apache Karaf installation that is the simplest way to get started.
+Simply uncompress the `package/target/unomi-VERSION.tar.gz` (for Linux or Mac OS X) or
+ `package/target/unomi-VERSION.zip` (for Windows) archive into the directory of your choice.
+
+You can then start the server simply by using the command on UNIX/Linux/MacOS X :
+
+[source]
+----
+./bin/karaf
+----
+
+or on Windows shell :
+
+[source]
+----
+bin\karaf.bat
+----
+
+==== Deploying into an existing Karaf server
+
+This is only needed if you didn't use the generated package. Also, this is the preferred way to install a development
+environment if you intend to re-deploy the context server KAR iteratively.
+
+Additional requirements:
+ - Apache Karaf 3.0.2+, http://karaf.apache.org[http://karaf.apache.org]
+ - Local copy of the Elasticsearch ZIP package, available here : http://www.elasticsearch.org[http://www.elasticsearch.org]
+
+.
+
+Before deploying, make sure that you have Apache Karaf properly installed. You will also have to increase the
+default maximum memory size and perm gen size by adjusting the following environment values in the bin/setenv(.bat)
+files (at the end of the file):
+
+[source]
+----
+ MY_DIRNAME=`dirname $0`
+ MY_KARAF_HOME=`cd "$MY_DIRNAME/.."; pwd`
+ export KARAF_OPTS="-Djava.library.path=$MY_KARAF_HOME/lib/sigar"
+ export JAVA_MAX_MEM=3G
+ export JAVA_MAX_PERM_MEM=384M
+----
+
+.
+
+You will also need to have the Hyperic Sigar native libraries in your Karaf installation, so in order to this
+go to the Elasticsearch website (http://www.elasticsearch.org[http://www.elasticsearch.org]) and download the ZIP package. Decompress it somewhere
+on your disk and copy all the files from the lib/sigar directory into Karaf's lib/sigar directory
+(must be created first) EXCEPT THE SIGAR.JAR file.
+
+.
+
+Install the WAR support, CXF into Karaf by doing the following in the Karaf command line:
+
+[source]
+----
+ feature:install -v war
+ feature:repo-add cxf 2.7.11
+ feature:install -v cxf/2.7.11
+----
+
+.
+
+Create a new $MY_KARAF_HOME/etc/org.apache.cxf.osgi.cfg file and put the following property inside :
+
+[source]
+----
+ org.apache.cxf.servlet.context=/cxs
+----
+
+.
+
+Copy the following KAR to the Karaf deploy directory, as in this example line:
+
+[source]
+----
+ cp kar/target/unomi-kar-1.0.0-SNAPSHOT.kar ~/java/deployments/unomi/apache-karaf-3.0.1/deploy/
+----
+
+.
+
+If all went smoothly, you should be able to access the context script here : http://localhost:8181/cxs/cluster[http://localhost:8181/cxs/cluster] .
+ You should be able to login with karaf / karaf and see basic server information. If not something went wrong during the install.
+
+==== JDK Selection on Mac OS X
+
+You might need to select the JDK to run the tests in the itests subproject. In order to do so you can list the
+installed JDKs with the following command :
+
+[source]
+----
+/usr/libexec/java_home -V
+----
+
+which will output something like this :
+
+[source]
+----
+Matching Java Virtual Machines (7):
+ 1.7.0_51, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_51.jdk/Contents/Home
+ 1.7.0_45, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_45.jdk/Contents/Home
+ 1.7.0_25, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_25.jdk/Contents/Home
+ 1.6.0_65-b14-462, x86_64: "Java SE 6" /Library/Java/JavaVirtualMachines/1.6.0_65-b14-462.jdk/Contents/Home
+ 1.6.0_65-b14-462, i386: "Java SE 6" /Library/Java/JavaVirtualMachines/1.6.0_65-b14-462.jdk/Contents/Home
+ 1.6.0_65-b14-462, x86_64: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
+ 1.6.0_65-b14-462, i386: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
+----
+
+You can then select the one you want using :
+
+[source]
+----
+export JAVA_HOME=`/usr/libexec/java_home -v 1.7.0_51`
+----
+
+and then check that it was correctly referenced using:
+
+[source]
+----
+java -version
+----
+
+which should give you a result such as this:
+
+[source]
+----
+java version "1.7.0_51"
+Java(TM) SE Runtime Environment (build 1.7.0_51-b13)
+Java HotSpot(TM) 64-Bit Server VM (build 24.51-b03, mixed mode)
+----
+
+==== Running the integration tests
+
+The integration tests are not executed by default to make build time minimal, but it is recommended to run the
+integration tests at least once before using the server to make sure that everything is ok in the build. Another way
+to use these tests is to run them from a continuous integration server such as Jenkins, Apache Gump, Atlassian Bamboo or
+ others.
+
+Note : the integration tests require a JDK 7 or more recent !
+
+To run the tests simply activate the following profile :
+
+[source]
+----
+mvn -P integration-tests clean install
+----
+
+==== Running the performance tests
+
+Performance tests are based on Gatling. You need to have a running context server or cluster of servers before
+executing the tests.
+
+Test parameteres are editable in the performance-tests/src/test/scala/unomi/Parameters.scala file. baseUrls should
+contains the URLs of all your cluster nodes
+
+Run the test by using the gatling.conf file in performance-tests/src/test/resources :
+
+[source]
+----
+ export GATLING_CONF=<path>/performance-tests/src/test/resources
+ gatling.sh
+----
+
+Reports are generated in performance-tests/target/results.
+
+==== Testing with an example page
+
+A default test page is provided at the following URL:
+
+[source]
+----
+ http://localhost:8181/index.html
+----
+
+This test page will trigger the loading of the /context.js script, which will try to retrieving the user context
+or create a new one if it doesn't exist yet. It also contains an experimental integration with Facebook Login, but it
+doesn't yet save the context back to the context server.
+
+==== Integrating onto a page
+
+Simply reference the context script in your HTML as in the following example:
+
+[source,javascript]
+----
+<script type="text/javascript">
+ (function(){ var u=(("https:" == document.location.protocol) ? "https://localhost:8181/" : "http://localhost:8181/");
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.defer=true; g.async=true; g.src=u+'context.js';
+ s.parentNode.insertBefore(g,s); })();
+</script>
+----
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.1/asciidoc/clustering.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.1/asciidoc/clustering.adoc b/manual/src/archives/1.1/asciidoc/clustering.adoc
new file mode 100644
index 0000000..efab64e
--- /dev/null
+++ b/manual/src/archives/1.1/asciidoc/clustering.adoc
@@ -0,0 +1,103 @@
+//
+// Licensed 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.
+//
+
+=== Cluster setup
+
+Context server relies on Elasticsearch to discover and configure its cluster. You just need to install multiple context
+servers on the same network, and enable the discovery protocol in $MY_KARAF_HOME/etc/org.apache.unomi.persistence.elasticsearch.cfg file :
+
+[source]
+----
+discovery.zen.ping.multicast.enabled=true
+----
+
+All nodes on the same network, sharing the same cluster name will be part of the same cluster.
+
+==== Recommended configurations
+
+It is recommended to have one node dedicated to the context server, where the other nodes take care of the
+Elasticsearch persistence. The node dedicated to the context server will have node.data set to false.
+
+===== 2 nodes configuration
+
+One node dedicated to context server, 1 node for elasticsearch storage.
+
+Node A :
+
+[source]
+----
+node.data=true
+numberOfReplicas=0
+monthlyIndex.numberOfReplicas=0
+----
+
+Node B :
+
+[source]
+----
+node.data=false
+numberOfReplicas=0
+monthlyIndex.numberOfReplicas=0
+----
+
+===== 3 nodes configuration
+
+One node dedicated to context server, 2 nodes for elasticsearch storage with fault-tolerance
+
+Node A :
+
+[source]
+----
+node.data=false
+numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+----
+
+Node B :
+
+[source]
+----
+node.data=true
+numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+----
+
+Node C :
+
+[source]
+----
+node.data=true
+numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+----
+
+==== Specific configuration
+
+If multicast is not allowed on your network, you'll need to switch to unicast protocol and manually configure the server IPs. This can be
+done by disabling the elasticsearch automatic discovery in $MY_KARAF_HOME/etc/org.apache.unomi.persistence.elasticsearch.cfg :
+
+[source]
+----
+discovery.zen.ping.multicast.enabled=false
+----
+
+And then set the property discovery.zen.ping.unicast.hosts in $MY_KARAF_HOME/etc/elasticsearch.yml files :
+
+[source]
+----
+discovery.zen.ping.unicast.hosts: [‘192.168.0.1:9300', ‘192.168.0.2:9300']
+----
+
+More information and configuration options can be found at :
+https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery.html[https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-discovery.html]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.1/asciidoc/concepts.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.1/asciidoc/concepts.adoc b/manual/src/archives/1.1/asciidoc/concepts.adoc
new file mode 100644
index 0000000..5c1f117
--- /dev/null
+++ b/manual/src/archives/1.1/asciidoc/concepts.adoc
@@ -0,0 +1,234 @@
+//
+// Licensed 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.
+//
+
+=== Concepts
+
+Apache Unomi gathers information about users actions, information that is processed and stored by Unomi services. The collected information can then be used to personalize content, derive insights on user behavior, categorize the user profiles into segments along user-definable dimensions or acted upon by algorithms.
+
+==== Items and types
+
+Unomi structures the information it collects using the concept of `Item` which provides the base information (an identifier and a type) the context server needs to process and store the data. Items are persisted according to their type (structure) and identifier (identity). This base structure can be extended, if needed, using properties in the form of key-value pairs.
+
+These properties are further defined by the `Item`’s type definition which explicits the `Item`’s structure and semantics. By defining new types, users specify which properties (including the type of values they accept) are available to items of that specific type.
+
+Unomi defines default value types: `date`, `email`, `integer` and `string`, all pretty self-explanatory. While you can think of these value types as "primitive" types, it is possible to extend Unomi by providing additional value types.
+
+Additionally, most items are also associated to a scope, which is a concept that Unomi uses to group together related items. A given scope is represented in Unomi by a simple string identifier and usually represents an application or set of applications from which Unomi gathers data, depending on the desired analysis granularity. In the context of web sites, a scope could, for example, represent a site or family of related sites being analyzed. Scopes allow clients accessing the context server to filter data to only see relevant data.
+
+_Base `Item` structure:_
+
+[source,json]
+----
+{
+ "itemType": <type of the item>,
+ "scope": <scope>,
+ "itemId": <item identifier>,
+ "properties": <optional properties>
+}
+----
+
+Some types can be dynamically defined at runtime by calling to the REST API while other extensions are done via Unomi plugins. Part of extending Unomi, therefore, is a matter of defining new types and specifying which kind of Unomi entity (e.g. profiles) they can be affected to. For example, the following JSON document can be passed to Unomi to declare a new property type identified (and named) `tweetNb`, tagged with the `social` tag, targeting profiles and using the `integer` value type.
+
+_Example JSON type definition:_
+
+[source,json]
+----
+{
+ "itemId": "tweetNb",
+ "itemType": "propertyType",
+ "metadata": {
+ "id": "tweetNb",
+ "name": "tweetNb",
+ "tags": ["social"]
+ },
+ "target": "profiles",
+ "type": "integer"
+}
+----
+
+____
+
+Unomi defines a built-in scope (called `systemscope`) that clients can use to share data across scopes.
+
+____
+
+==== Events
+
+Users' actions are conveyed from clients to the context server using events. Of course, the required information depends on what is collected and users' interactions with the observed systems but events minimally provide a type, a scope and source and target items. Additionally, events are timestamped. Conceptually, an event can be seen as a sentence, the event's type being the verb, the source the subject and the target the object.
+
+_Event structure:_
+
+[source,json]
+----
+{
+ "eventType": <type of the event>,
+ "scope": <scope of the event>,
+ "source": <Item>,
+ "target": <Item>,
+ "properties": <optional properties>
+}
+----
+
+Source and target can be any Unomi item but are not limited to them. In particular, as long as they can be described using properties and Unomi’s type mechanism and can be processed either natively or via extension plugins, source and target can represent just about anything. Events can also be triggered as part of Unomi’s internal processes for example when a rule is triggered.
+
+Events are sent to Unomi from client applications using the JSON format and a typical page view event from a web site could look something like the following:
+
+_Example page view event:_
+
+[source,json]
+----
+{
+ "eventType": "view",
+ "scope": "ACMESPACE",
+ "source": {
+ "itemType": "site",
+ "scope": "ACMESPACE",
+ "itemId": "c4761bbf-d85d-432b-8a94-37e866410375"
+ },
+ "target": {
+ "itemType": "page",
+ "scope": "ACMESPACE",
+ "itemId": "b6acc7b3-6b9d-4a9f-af98-54800ec13a71",
+ "properties": {
+ "pageInfo": {
+ "pageID": "b6acc7b3-6b9d-4a9f-af98-54800ec13a71",
+ "pageName": "Home",
+ "pagePath": "/sites/ACMESPACE/home",
+ "destinationURL": "http://localhost:8080/sites/ACMESPACE/home.html",
+ "referringURL": "http://localhost:8080/",
+ "language": "en"
+ },
+ "category": {},
+ "attributes": {}
+ }
+ }
+}
+----
+
+==== Profiles
+
+By processing events, Unomi progressively builds a picture of who the user is and how they behave. This knowledge is embedded in `Profile` object. A profile is an `Item` with any number of properties and optional segments and scores. Unomi provides default properties to cover common data (name, last name, age, email, etc.) as well as default segments to categorize users. Unomi users are, however, free and even encouraged to create additional properties and segments to better suit their needs.
+
+Contrary to other Unomi items, profiles are not part of a scope since we want to be able to track the associated user across applications. For this reason, data collected for a given profile in a specific scope is still available to any scoped item that accesses the profile information.
+
+It is interesting to note that there is not necessarily a one to one mapping between users and profiles as users can be captured across applications and different observation contexts. As identifying information might not be available in all contexts in which data is collected, resolving profiles to a single physical user can become complex because physical users are not observed directly. Rather, their portrait is progressively patched together and made clearer as Unomi captures more and more traces of their actions. Unomi will merge related profiles as soon as collected data permits positive association between distinct profiles, usually as a result of the user performing some identifying action in a context where the user hadn’t already been positively identified.
+
+==== Sessions
+
+A session represents a time-bounded interaction between a user (via their associated profile) and a Unomi-enabled application. A session represents the sequence of actions the user performed during its duration. For this reason, events are associated with the session during which they occurred. In the context of web applications, sessions are usually linked to HTTP sessions.
+
+
+=== Extending Unomi via plugins
+
+Unomi is architected so that users can provided extensions in the form of plugins.
+
+==== Types vs. instances
+
+Several extension points in Unomi rely on the concept of type: the extension defines a prototype for what the actual items will be once parameterized with values known only at runtime. This is similar to the concept of classes in object-oriented programming: types define classes, providing the expected structure and which fields are expected to be provided at runtime, that are then instantiated when needed with actual values.
+
+==== Plugin structure
+
+Being built on top of Apache Karaf, Unomi leverages OSGi to support plugins. A Unomi plugin is, thus, an OSGi bundle specifying some specific metadata to tell Unomi the kind of entities it provides. A plugin can provide the following entities to extend Unomi, each with its associated definition (as a JSON file), located in a specific spot within the `META-INF/cxs/` directory of the bundle JAR file:
+
+|===
+|Entity |Location in `cxs` directory
+
+|ActionType |actions
+|ConditionType |conditions
+|Persona |personas
+|PropertyMergeStrategyType |mergers
+|PropertyType |properties then profiles or sessions subdirectory then `<category name>` directory
+|Rule |rules
+|Scoring |scorings
+|Segment |segments
+|Tag |tags
+|ValueType |values
+|===
+
+http://aries.apache.org/modules/blueprint.html[Blueprint] is used to declare what the plugin provides and inject any required dependency. The Blueprint file is located, as usual, at `OSGI-INF/blueprint/blueprint.xml` in the bundle JAR file.
+
+The plugin otherwise follows a regular maven project layout and should depend on the Unomi API maven artifact:
+
+[source,xml]
+----
+<dependency>
+ <groupId>org.apache.unomi</groupId>
+ <artifactId>unomi-api</artifactId>
+ <version>...</version>
+</dependency>
+----
+
+Some plugins consists only of JSON definitions that are used to instantiate the appropriate structures at runtime while some more involved plugins provide code that extends Unomi in deeper ways.
+
+In both cases, plugins can provide more that one type of extension. For example, a plugin could provide both `ActionType`s and `ConditionType`s.
+
+==== Extension points
+
+===== ActionType
+
+`ActionType`s define new actions that can be used as consequences of Rules being triggered. When a rule triggers, it creates new actions based on the event data and the rule internal processes, providing values for parameters defined in the associated `ActionType`. Example actions include: “Set user property x to value y” or “Send a message to service x”.
+
+===== ConditionType
+
+`ConditionType`s define new conditions that can be applied to items (for example to decide whether a rule needs to be triggered or if a profile is considered as taking part in a campaign) or to perform queries against the stored Unomi data. They may be implemented in Java when attempting to define a particularly complex test or one that can better be optimized by coding it. They may also be defined as combination of other conditions. A simple condition could be: “User is male”, while a more generic condition with parameters may test whether a given property has a specific value: “User property x has value y”.
+
+===== Persona
+
+A persona is a "virtual" profile used to represent categories of profiles, and may also be used to test how a personalized experience would look like using this virtual profile. A persona can define predefined properties and sessions. Persona definition make it possible to “emulate” a certain type of profile, e.g : US visitor, non-US visitor, etc.
+
+===== PropertyMergeStrategyType
+
+A strategy to resolve how to merge properties when merging profile together.
+
+===== PropertyType
+
+Definition for a profile or session property, specifying how possible values are constrained, if the value is multi-valued (a vector of values as opposed to a scalar value). `PropertyType`s can also be categorized using tags or file system structure, using sub-directories to organize definition files.
+
+===== Rule
+
+`Rule`s are conditional sets of actions to be executed in response to incoming events. Triggering of rules is guarded by a condition: the rule is only triggered if the associated condition is satisfied. That condition can test the event itself, but also the profile or the session. Once a rule triggers, a list of actions can be performed as consequences. Also, when rules trigger, a specific event is raised so that other parts of Unomi can react accordingly.
+
+===== Scoring
+
+`Scoring`s are set of conditions associated with a value to assign to profiles when matching so that the associated users can be scored along that dimension. Each scoring element is evaluated and matching profiles' scores are incremented with the associated value.
+
+===== Segments
+
+`Segment`s represent dynamically evaluated groups of similar profiles in order to categorize the associated users. To be considered part of a given segment, users must satisfies the segment’s condition. If they match, users are automatically added to the segment. Similarly, if at any given point during, they cease to satisfy the segment’s condition, they are automatically removed from it.
+
+===== Tag
+
+`Tag`s are simple labels that are used to classify all other objects inside Unomi.
+
+===== ValueType
+
+Definition for values that can be assigned to properties ("primitive" types).
+
+==== Other Unomi entities
+
+===== UserList
+
+User list are simple static lists of users. The associated profile stores the lists it belongs to in a specific property.
+
+===== Goal
+
+Goals represent tracked activities / actions that can be accomplished by site (or more precisely scope) visitors. These are tracked in general because they relate to specific business objectives or are relevant to measure site/scope performance.
+
+Goals can be defined at the scope level or in the context of a particular `Campaign`. Either types of goals behave exactly the same way with the exception of two notable differences:
+ - duration: scope-level goals are considered until removed while campaign-level goals are only considered for the campaign duration
+ - audience filtering: any visitor is considered for scope-level goals while campaign-level goals only consider visitors who match the campaign's conditions
+
+===== Campaign
+
+A goal-oriented, time-limited marketing operation that needs to be evaluated for return on investment performance by tracking the ratio of visits to conversions.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.1/asciidoc/configuration.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.1/asciidoc/configuration.adoc b/manual/src/archives/1.1/asciidoc/configuration.adoc
new file mode 100644
index 0000000..e9f4353
--- /dev/null
+++ b/manual/src/archives/1.1/asciidoc/configuration.adoc
@@ -0,0 +1,296 @@
+//
+// Licensed 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.
+//
+
+=== Configuration
+
+==== Changing the default configuration
+
+If you want to change the default configuration, you can perform any modification you want in the $MY_KARAF_HOME/etc directory.
+
+The context server configuration is kept in the $MY_KARAF_HOME/etc/org.apache.unomi.web.cfg . It defines the
+addresses and port where it can be found :
+
+[source]
+----
+contextserver.address=localhost
+contextserver.port=8181
+contextserver.secureAddress=localhost
+contextserver.securePort=9443
+contextserver.domain=apache.org
+----
+
+If you need to specify an Elasticsearch cluster name that is different than the default, it is recommended to do this
+BEFORE you start the server for the first time, or you will loose all the data you have stored previously.
+
+To change the cluster name, first create a file called
+
+[source]
+----
+$MY_KARAF_HOME/etc/org.apache.unomi.persistence.elasticsearch.cfg
+----
+
+with the following contents:
+
+[source]
+----
+cluster.name=contextElasticSearch
+index.name=context
+elasticSearchConfig=file:${karaf.etc}/elasticsearch.yml
+----
+
+And replace the cluster.name parameter here by your cluster name.
+
+You can also put an elasticsearch configuration file in $MY_KARAF_HOME/etc/elasticsearch.yml ,
+and put any standard Elasticsearch configuration options in this last file.
+
+If you want your context server to be a client only on a cluster of elasticsearch nodes, just set the node.data property
+to false.
+
+==== Installing the MaxMind GeoIPLite2 IP lookup database
+
+The Context Server requires an IP database in order to resolve IP addresses to user location.
+The GeoLite2 database can be downloaded from MaxMind here :
+http://dev.maxmind.com/geoip/geoip2/geolite2/[http://dev.maxmind.com/geoip/geoip2/geolite2/]
+
+Simply download the GeoLite2-City.mmdb file into the "etc" directory.
+
+==== Installing Geonames database
+
+Context server includes a geocoding service based on the geonames database ( http://www.geonames.org/[http://www.geonames.org/] ). It can be
+used to create conditions on countries or cities.
+
+In order to use it, you need to install the Geonames database into . Get the "allCountries.zip" database from here :
+http://download.geonames.org/export/dump/[http://download.geonames.org/export/dump/]
+
+Download it and put it in the "etc" directory, without unzipping it.
+Edit $MY_KARAF_HOME/etc/org.apache.unomi.geonames.cfg and set request.geonamesDatabase.forceImport to true, import should start right away.
+Otherwise, import should start at the next startup. Import runs in background, but can take about 15 minutes.
+At the end, you should have about 4 million entries in the geonames index.
+
+==== REST API Security
+
+The Context Server REST API is protected using JAAS authentication and using Basic or Digest HTTP auth.
+By default, the login/password for the REST API full administrative access is "karaf/karaf".
+
+The generated package is also configured with a default SSL certificate. You can change it by following these steps :
+
+.
+
+Replace the existing keystore in $MY_KARAF_HOME/etc/keystore by your own certificate :
+
+http://wiki.eclipse.org/Jetty/Howto/Configure_SSL[http://wiki.eclipse.org/Jetty/Howto/Configure_SSL]
+
+.
+
+Update the keystore and certificate password in $MY_KARAF_HOME/etc/custom.properties file :
+
+[source]
+----
+ org.osgi.service.http.secure.enabled = true
+ org.ops4j.pax.web.ssl.keystore=${karaf.etc}/keystore
+ org.ops4j.pax.web.ssl.password=changeme
+ org.ops4j.pax.web.ssl.keypassword=changeme
+ org.osgi.service.http.port.secure=9443
+----
+
+You should now have SSL setup on Karaf with your certificate, and you can test it by trying to access it on port 9443.
+
+==== Automatic profile merging
+
+The context server is capable of merging profiles based on a common property value. In order to use this, you must
+add the MergeProfileOnPropertyAction to a rule (such as a login rule for example), and configure it with the name
+ of the property that will be used to identify the profiles to be merged. An example could be the "email" property,
+ meaning that if two (or more) profiles are found to have the same value for the "email" property they will be merged
+ by this action.
+
+Upon merge, the old profiles are marked with a "mergedWith" property that will be used on next profile access to delete
+the original profile and replace it with the merged profile (aka "master" profile). Once this is done, all cookie tracking
+will use the merged profile.
+
+To test, simply configure the action in the "login" or "facebookLogin" rules and set it up on the "email" property.
+Upon sending one of the events, all matching profiles will be merged.
+
+==== Securing a production environment
+
+Before going live with a project, you should _absolutely_ read the following section that will help you setup a proper
+secure environment for running your context server.
+
+Step 1: Install and configure a firewall
+
+You should setup a firewall around your cluster of context servers and/or Elasticsearch nodes. If you have an
+application-level firewall you should only allow the following connections open to the whole world :
+
+* http://localhost:8181/context.js[http://localhost:8181/context.js]
+* http://localhost:8181/eventcollector[http://localhost:8181/eventcollector]
+
+All other ports should not be accessible to the world.
+
+For your Context Server client applications (such as the Jahia CMS), you will need to make the following ports
+accessible :
+
+[source]
+----
+8181 (Context Server HTTP port)
+9443 (Context Server HTTPS port)
+----
+
+The context server actually requires HTTP Basic Auth for access to the Context Server administration REST API, so it is
+highly recommended that you design your client applications to use the HTTPS port for accessing the REST API.
+
+The user accounts to access the REST API are actually routed through Karaf's JAAS support, which you may find the
+documentation for here :
+
+* http://karaf.apache.org/manual/latest/users-guide/security.html[http://karaf.apache.org/manual/latest/users-guide/security.html]
+
+The default username/password is
+
+[source]
+----
+karaf/karaf
+----
+
+You should really change this default username/password as soon as possible. To do so, simply modify the following
+file :
+
+[source]
+----
+$MY_KARAF_HOME/etc/users.properties
+----
+
+For your context servers, and for any standalone Elasticsearch nodes you will need to open the following ports for proper
+node-to-node communication : 9200 (Elasticsearch REST API), 9300 (Elasticsearch TCP transport)
+
+Of course any ports listed here are the default ports configured in each server, you may adjust them if needed.
+
+Step 2 : Adjust the Context Server IP filtering
+
+By default the Context Server limits to connections to port 9200 and 9300 to the following IP ranges
+
+[source]
+----
+- localhost
+- 127.0.0.1
+- ::1
+- the current subnet (i.e., 192.168.1.0-192.168.1.255)
+----
+
+(this is done using a custom plugin for Elasticsearch, that you may find here :
+https://git-wip-us.apache.org/repos/asf/incubator-unomi/context-server/persistence-elasticsearch/plugins/security[https://git-wip-us.apache.org/repos/asf/incubator-unomi/context-server/persistence-elasticsearch/plugins/security])
+
+You can adjust this setting by using the following setting in the $MY_KARAF_HOME/etc/elasticsearch.yml file :
+
+[source]
+----
+security.ipranges: localhost,127.0.0.1,::1,10.0.1.0-10.0.1.255
+----
+
+Step 3 : Follow industry recommended best practices for securing Elasticsearch
+
+You may find more valuable recommendations here :
+
+* https://www.elastic.co/blog/found-elasticsearch-security[https://www.elastic.co/blog/found-elasticsearch-security]
+* https://www.elastic.co/blog/scripting-security[https://www.elastic.co/blog/scripting-security]
+
+Step 4 : Setup a proxy in front of the context server
+
+As an alternative to an application-level firewall, you could also route all traffic to the context server through
+a proxy, and use it to filter any communication.
+
+==== Integrating with an Apache HTTP web server
+
+If you want to setup an Apache HTTP web server in from of Apache Unomi, here is an example configuration using
+mod_proxy.
+
+In your Unomi package directory, in /etc/org.apache.unomi.web.cfg for unomi.apache.org
+
+contextserver.address=unomi.apache.org
+ contextserver.port=80
+ contextserver.secureAddress=unomi.apache.org
+ contextserver.securePort=443
+ contextserver.domain=apache.org
+
+Main virtual host config:
+
+[source]
+----
+<VirtualHost *:80>
+ Include /var/www/vhosts/unomi.apache.org/conf/common.conf
+</VirtualHost>
+
+<IfModule mod_ssl.c>
+ <VirtualHost *:443>
+ Include /var/www/vhosts/unomi.apache.org/conf/common.conf
+
+ SSLEngine on
+
+ SSLCertificateFile /var/www/vhosts/unomi.apache.org/conf/ssl/24d5b9691e96eafa.crt
+ SSLCertificateKeyFile /var/www/vhosts/unomi.apache.org/conf/ssl/apache.org.key
+ SSLCertificateChainFile /var/www/vhosts/unomi.apache.org/conf/ssl/gd_bundle-g2-g1.crt
+
+ <FilesMatch "\.(cgi|shtml|phtml|php)$">
+ SSLOptions +StdEnvVars
+ </FilesMatch>
+ <Directory /usr/lib/cgi-bin>
+ SSLOptions +StdEnvVars
+ </Directory>
+ BrowserMatch "MSIE [2-6]" \
+ nokeepalive ssl-unclean-shutdown \
+ downgrade-1.0 force-response-1.0
+ BrowserMatch "MSIE [17-9]" ssl-unclean-shutdown
+
+ </VirtualHost>
+</IfModule>
+----
+
+common.conf:
+
+[source]
+----
+ServerName unomi.apache.org
+ServerAdmin webmaster@apache.org
+
+DocumentRoot /var/www/vhosts/unomi.apache.org/html
+CustomLog /var/log/apache2/access-unomi.apache.org.log combined
+<Directory />
+ Options FollowSymLinks
+ AllowOverride None
+</Directory>
+<Directory /var/www/vhosts/unomi.apache.org/html>
+ Options FollowSymLinks MultiViews
+ AllowOverride None
+ Order allow,deny
+ allow from all
+</Directory>
+<Location /cxs>
+ Order deny,allow
+ deny from all
+ allow from 88.198.26.2
+ allow from www.apache.org
+</Location>
+
+RewriteEngine On
+RewriteCond %{REQUEST_METHOD} ^(TRACE|TRACK)
+RewriteRule .* - [F]
+ProxyPreserveHost On
+ProxyPass /server-status !
+ProxyPass /robots.txt !
+
+RewriteCond %{HTTP_USER_AGENT} Googlebot [OR]
+RewriteCond %{HTTP_USER_AGENT} msnbot [OR]
+RewriteCond %{HTTP_USER_AGENT} Slurp
+RewriteRule ^.* - [F,L]
+
+ProxyPass / http://localhost:8181/ connectiontimeout=20 timeout=300 ttl=120
+ProxyPassReverse / http://localhost:8181/
+----
\ No newline at end of file
[3/8] incubator-unomi git commit: Create new manual module and add
master documentation in asciidoc format
Posted by sh...@apache.org.
Create new manual module and add master documentation in asciidoc format
Project: http://git-wip-us.apache.org/repos/asf/incubator-unomi/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-unomi/commit/837c4628
Tree: http://git-wip-us.apache.org/repos/asf/incubator-unomi/tree/837c4628
Diff: http://git-wip-us.apache.org/repos/asf/incubator-unomi/diff/837c4628
Branch: refs/heads/master
Commit: 837c4628b40ecf244198a96de3542ce79401721c
Parents: 989fc36
Author: Francois Papon <fp...@yupiik.com>
Authored: Thu Aug 30 22:58:59 2018 +0400
Committer: Francois Papon <fp...@apache.org>
Committed: Wed Sep 5 23:06:57 2018 +0400
----------------------------------------------------------------------
manual/pom.xml | 125 +
manual/src/main/asciidoc/apache.css | 2448 ++++++++++++++++++
.../main/asciidoc/building-and-deploying.adoc | 276 ++
manual/src/main/asciidoc/clustering.adoc | 83 +
manual/src/main/asciidoc/concepts.adoc | 125 +
manual/src/main/asciidoc/configuration.adoc | 397 +++
.../main/asciidoc/connectors/connectors.adoc | 22 +
.../connectors/salesforce-connector.adoc | 224 ++
manual/src/main/asciidoc/consent-api.adoc | 139 +
manual/src/main/asciidoc/custom-extensions.adoc | 419 +++
manual/src/main/asciidoc/extending-plugins.adoc | 113 +
manual/src/main/asciidoc/getting-started.adoc | 121 +
.../src/main/asciidoc/images/asf_logo_url.png | Bin 0 -> 21121 bytes
.../src/main/asciidoc/images/incubator-logo.png | Bin 0 -> 8923 bytes
.../src/main/asciidoc/images/unomi-request.png | Bin 0 -> 132731 bytes
manual/src/main/asciidoc/index.adoc | 69 +
.../src/main/asciidoc/samples/login-sample.adoc | 73 +
manual/src/main/asciidoc/samples/samples.adoc | 19 +
.../main/asciidoc/samples/twitter-sample.adoc | 432 ++++
.../asciidoc/samples/weather-update-sample.adoc | 14 +
manual/src/theme/apache-theme.yml | 271 ++
manual/src/theme/fonts/DroidSerif-Bold.ttf | Bin 0 -> 185228 bytes
.../src/theme/fonts/DroidSerif-BoldItalic.ttf | Bin 0 -> 190304 bytes
manual/src/theme/fonts/DroidSerif-Italic.ttf | Bin 0 -> 177560 bytes
manual/src/theme/fonts/DroidSerif-Regular.ttf | Bin 0 -> 172916 bytes
.../theme/fonts/DroidSerif_Apache License.txt | 201 ++
manual/src/theme/fonts/OpenSans-Bold.ttf | Bin 0 -> 224452 bytes
manual/src/theme/fonts/OpenSans-BoldItalic.ttf | Bin 0 -> 213168 bytes
manual/src/theme/fonts/OpenSans-ExtraBold.ttf | Bin 0 -> 222424 bytes
.../theme/fonts/OpenSans-ExtraBoldItalic.ttf | Bin 0 -> 213336 bytes
manual/src/theme/fonts/OpenSans-Italic.ttf | Bin 0 -> 212760 bytes
manual/src/theme/fonts/OpenSans-Light.ttf | Bin 0 -> 222236 bytes
manual/src/theme/fonts/OpenSans-LightItalic.ttf | Bin 0 -> 213024 bytes
manual/src/theme/fonts/OpenSans-Regular.ttf | Bin 0 -> 217276 bytes
manual/src/theme/fonts/OpenSans-SemiBold.ttf | Bin 0 -> 221164 bytes
.../src/theme/fonts/OpenSans-SemiBoldItalic.ttf | Bin 0 -> 212732 bytes
manual/src/theme/fonts/OpenSans_LICENSE.txt | 202 ++
manual/src/theme/fonts/SourceSansPro-Black.ttf | Bin 0 -> 288824 bytes
.../theme/fonts/SourceSansPro-BlackItalic.ttf | Bin 0 -> 102944 bytes
manual/src/theme/fonts/SourceSansPro-Bold.ttf | Bin 0 -> 290916 bytes
.../theme/fonts/SourceSansPro-BoldItalic.ttf | Bin 0 -> 103200 bytes
.../theme/fonts/SourceSansPro-ExtraLight.ttf | Bin 0 -> 291112 bytes
.../fonts/SourceSansPro-ExtraLightItalic.ttf | Bin 0 -> 104304 bytes
manual/src/theme/fonts/SourceSansPro-Italic.ttf | Bin 0 -> 103828 bytes
manual/src/theme/fonts/SourceSansPro-Light.ttf | Bin 0 -> 292680 bytes
.../theme/fonts/SourceSansPro-LightItalic.ttf | Bin 0 -> 104156 bytes
.../src/theme/fonts/SourceSansPro-Regular.ttf | Bin 0 -> 293516 bytes
.../src/theme/fonts/SourceSansPro-SemiBold.ttf | Bin 0 -> 291864 bytes
.../fonts/SourceSansPro-SemiBoldItalic.ttf | Bin 0 -> 103556 bytes
manual/src/theme/fonts/SourceSansPro_OFL.txt | 93 +
manual/src/theme/images/asf_logo.png | Bin 0 -> 21243 bytes
manual/src/theme/images/asf_logo_url.png | Bin 0 -> 21121 bytes
pom.xml | 1 +
53 files changed, 5867 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/pom.xml
----------------------------------------------------------------------
diff --git a/manual/pom.xml b/manual/pom.xml
new file mode 100644
index 0000000..01f9310
--- /dev/null
+++ b/manual/pom.xml
@@ -0,0 +1,125 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+<!--
+ ~ 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.
+ -->
+
+ <parent>
+ <artifactId>unomi-root</artifactId>
+ <groupId>org.apache.unomi</groupId>
+ <version>1.4.0-incubating-SNAPSHOT</version>
+ </parent>
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>manual</artifactId>
+ <name>Apache Unomi :: Manual</name>
+ <packaging>bundle</packaging>
+
+ <profiles>
+ <profile>
+ <id>html</id>
+ <build>
+ <defaultGoal>process-resources</defaultGoal>
+ <plugins>
+ <plugin>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctor-maven-plugin</artifactId>
+ <version>1.5.6</version>
+ <executions>
+ <execution>
+ <id>output-html</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>process-asciidoc</goal>
+ </goals>
+ <configuration>
+ <backend>html5</backend>
+ <doctype>article</doctype>
+ <attributes>
+ <toc />
+ <linkcss>true</linkcss>
+ <stylesheet>apache.css</stylesheet>
+ <imagesdir>images</imagesdir>
+ </attributes>
+ </configuration>
+ </execution>
+ </executions>
+ <configuration>
+ <sourceDirectory>src/main/asciidoc</sourceDirectory>
+ <outputDirectory>target/generated-html/${project.version}</outputDirectory>
+ <preserveDirectories>true</preserveDirectories>
+ <headerFooter>true</headerFooter>
+ <imagesDir>src/main/asciidoc/images</imagesDir>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+
+ <profile>
+ <id>pdf</id>
+ <build>
+ <defaultGoal>process-resources</defaultGoal>
+ <plugins>
+ <plugin>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctor-maven-plugin</artifactId>
+ <version>1.5.6</version>
+ <dependencies>
+ <dependency>
+ <groupId>org.asciidoctor</groupId>
+ <artifactId>asciidoctorj-pdf</artifactId>
+ <version>1.5.0-alpha.16</version>
+ </dependency>
+ </dependencies>
+ <configuration>
+ <sourceDirectory>src/main/asciidoc</sourceDirectory>
+ <outputDirectory>target/generated-pdf/${project.version}</outputDirectory>
+ <preserveDirectories>true</preserveDirectories>
+ <headerFooter>true</headerFooter>
+ <backend>pdf</backend>
+ <attributes>
+ <project-version>${project.version}</project-version>
+ <pdf-stylesdir>${project.basedir}/src/theme</pdf-stylesdir>
+ <pdf-style>apache</pdf-style>
+ <pdf-fontsdir>${project.basedir}/src/theme/fonts</pdf-fontsdir>
+ <imagesdir>images</imagesdir>
+ <icons>font</icons>
+ <pagenums>true</pagenums>
+ <toc/>
+ <idprefix/>
+ <idseparator>-</idseparator>
+ <sectnums>true</sectnums>
+ </attributes>
+ </configuration>
+ <executions>
+ <execution>
+ <id>generate-pdf-doc</id>
+ <phase>generate-resources</phase>
+ <goals>
+ <goal>process-asciidoc</goal>
+ </goals>
+ </execution>
+ </executions>
+ </plugin>
+ </plugins>
+ </build>
+ </profile>
+ </profiles>
+
+</project>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/apache.css
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/apache.css b/manual/src/main/asciidoc/apache.css
new file mode 100644
index 0000000..e66d1fa
--- /dev/null
+++ b/manual/src/main/asciidoc/apache.css
@@ -0,0 +1,2448 @@
+
+@import "https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,700%7cDroid+Serif:400,700";
+
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+main,
+nav,
+section,
+summary {
+ display: block
+}
+
+audio,
+canvas,
+video {
+ display: inline-block
+}
+
+audio:not([controls]) {
+ display: none;
+ height: 0
+}
+
+script {
+ display: none !important
+}
+
+html {
+ font-family: "Droid Serif";
+ -ms-text-size-adjust: 100%;
+ -webkit-text-size-adjust: 100%;
+}
+
+a {
+ background: transparent
+}
+
+a:focus {
+ outline: thin dotted
+}
+
+a:active,
+a:hover {
+ outline: 0
+}
+
+h1 {
+ font-size: 2em;
+ margin: .67em 0
+}
+
+abbr[title] {
+ border-bottom: 1px dotted
+}
+
+b,
+strong {
+ font-weight: bold
+}
+
+dfn {
+ font-style: italic
+}
+
+hr {
+ -moz-box-sizing: content-box;
+ box-sizing: content-box;
+ height: 0
+}
+
+mark {
+ background: #ff0;
+ color: #000
+}
+
+code,
+kbd,
+pre,
+samp {
+ font-family: monospace;
+ font-size: 1em
+}
+
+pre {
+ white-space: pre-wrap
+}
+
+q {
+ quotes: "\201C" "\201D" "\2018" "\2019"
+}
+
+small {
+ font-size: 80%
+}
+
+sub,
+sup {
+ font-size: 75%;
+ line-height: 0;
+ position: relative;
+ vertical-align: baseline
+}
+
+sup {
+ top: -.5em
+}
+
+sub {
+ bottom: -.25em
+}
+
+img {
+ border: 0
+}
+
+svg:not(:root) {
+ overflow: hidden
+}
+
+figure {
+ margin: 0
+}
+
+fieldset {
+ border: 1px solid silver;
+ margin: 0 2px;
+ padding: .35em .625em .75em
+}
+
+legend {
+ border: 0;
+ padding: 0
+}
+
+button,
+input,
+select,
+textarea {
+ font-family: inherit;
+ font-size: 100%;
+ margin: 0
+}
+
+button,
+input {
+ line-height: normal
+}
+
+button,
+select {
+ text-transform: none
+}
+
+button,
+html input[type="button"],
+input[type="reset"],
+input[type="submit"] {
+ -webkit-appearance: button;
+ cursor: pointer
+}
+
+button[disabled],
+html input[disabled] {
+ cursor: default
+}
+
+input[type="checkbox"],
+input[type="radio"] {
+ box-sizing: border-box;
+ padding: 0
+}
+
+button::-moz-focus-inner,
+input::-moz-focus-inner {
+ border: 0;
+ padding: 0
+}
+
+textarea {
+ overflow: auto;
+ vertical-align: top
+}
+
+table {
+ border-collapse: collapse;
+ border-spacing: 0
+}
+
+*,
+*::before,
+*::after {
+ -moz-box-sizing: border-box;
+ -webkit-box-sizing: border-box;
+ box-sizing: border-box
+}
+
+html,
+body {
+ /*font-size: 100%*/
+}
+
+body {
+ background: #fff;
+ color: #333;
+ padding: 0;
+ margin: 0;
+ font-family: "Droid Serif", "DejaVu Serif", serif;
+ font-size: 14px;
+ font-style: normal;
+ line-height: 1.42857143;
+ position: relative;
+ cursor: auto;
+ tab-size: 4;
+ -moz-osx-font-smoothing: grayscale;
+ -webkit-font-smoothing: antialiased
+}
+
+a:hover {
+ cursor: pointer
+}
+
+img,
+object,
+embed {
+ max-width: 100%;
+ height: auto
+}
+
+object,
+embed {
+ height: 100%
+}
+
+img {
+ -ms-interpolation-mode: bicubic
+}
+
+.left {
+ float: left !important
+}
+
+.right {
+ float: right !important
+}
+
+.text-left {
+ text-align: left !important
+}
+
+.text-right {
+ text-align: right !important
+}
+
+.text-center {
+ text-align: center !important
+}
+
+.text-justify {
+ text-align: justify !important
+}
+
+.hide {
+ display: none
+}
+
+img,
+object,
+svg {
+ display: inline-block;
+ vertical-align: middle
+}
+
+textarea {
+ height: auto;
+ min-height: 50px
+}
+
+select {
+ width: 100%
+}
+
+.center {
+ margin-left: auto;
+ margin-right: auto
+}
+
+.stretch {
+ width: 100%
+}
+
+.subheader,
+.admonitionblock td.content>.title,
+.audioblock>.title,
+.exampleblock>.title,
+.imageblock>.title,
+.listingblock>.title,
+.literalblock>.title,
+.stemblock>.title,
+.openblock>.title,
+.paragraph>.title,
+.quoteblock>.title,
+table.tableblock>.title,
+.verseblock>.title,
+.videoblock>.title,
+.dlist>.title,
+.olist>.title,
+.ulist>.title,
+.qlist>.title,
+.hdlist>.title {
+ line-height: 1.45;
+ color: #585ac2;
+ font-weight: 400;
+ margin-top: 0;
+ margin-bottom: .25em
+}
+
+div,
+dl,
+dt,
+dd,
+ul,
+ol,
+li,
+h1,
+h2,
+h3,
+#toctitle,
+.sidebarblock>.content>.title,
+h4,
+h5,
+h6,
+pre,
+form,
+p,
+blockquote,
+th,
+td {
+ margin: 0;
+ padding: 0;
+ direction: ltr
+}
+
+a {
+ color: #585ac2;
+ text-decoration: underline;
+ line-height: inherit
+}
+
+a:hover,
+a:focus {
+ color: #373997;
+}
+
+a img {
+ border: none
+}
+
+p {
+ font-family: inherit;
+ font-weight: 400;
+ font-size: 1em;
+ line-height: 1.6;
+ margin-bottom: 1.25em;
+ text-rendering: optimizeLegibility
+}
+
+p aside {
+ font-size: .875em;
+ line-height: 1.35;
+ font-style: italic
+}
+
+h1,
+h2,
+h3,
+#toctitle,
+.sidebarblock>.content>.title,
+h4,
+h5,
+h6 {
+ font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ font-weight: bold;
+ /*font-style: bold;*/
+ color: #303284;
+ text-rendering: optimizeLegibility;
+ margin-top: 1em;
+ margin-bottom: .5em;
+ line-height: 1.0125em;
+ text-transform: uppercase;
+}
+
+h1 small,
+h2 small,
+h3 small,
+#toctitle small,
+.sidebarblock>.content>.title small,
+h4 small,
+h5 small,
+h6 small {
+ font-size: 60%;
+ color: #303284;
+ line-height: 0
+}
+
+h1 {
+ font-size: 2.125em
+}
+
+h2 {
+ font-size: 1.6875em
+}
+
+h3,
+#toctitle,
+.sidebarblock>.content>.title {
+ font-size: 1.375em
+}
+
+h4,
+h5 {
+ font-size: 1.125em
+}
+
+h6 {
+ font-size: 1em
+}
+
+hr {
+ border: solid #dddddd;
+ border-width: 1px 0 0;
+ clear: both;
+ margin: 1.25em 0 1.1875em;
+ height: 0
+}
+
+em,
+i {
+ font-style: italic;
+ line-height: inherit
+}
+
+strong,
+b {
+ font-weight: bold;
+ line-height: inherit
+}
+
+small {
+ font-size: 60%;
+ line-height: inherit
+}
+
+code {
+ font-family: "Droid Sans Mono", "DejaVu Sans Mono", monospace;
+ font-weight: 400;
+ color: #585ac2;
+}
+
+ul,
+ol,
+dl {
+ font-size: 1em;
+ line-height: 1.6;
+ margin-bottom: 1.25em;
+ list-style-position: outside;
+ font-family: inherit
+}
+
+ul,
+ol {
+ margin-left: 1.5em
+}
+
+ul li ul,
+ul li ol {
+ margin-left: 1.25em;
+ margin-bottom: 0;
+ font-size: 1em
+}
+
+ul.square li ul,
+ul.circle li ul,
+ul.disc li ul {
+ list-style: inherit
+}
+
+ul.square {
+ list-style-type: square
+}
+
+ul.circle {
+ list-style-type: circle
+}
+
+ul.disc {
+ list-style-type: disc
+}
+
+ol li ul,
+ol li ol {
+ margin-left: 1.25em;
+ margin-bottom: 0
+}
+
+dl dt {
+ margin-bottom: .3125em;
+ font-weight: bold
+}
+
+dl dd {
+ margin-bottom: 1.25em
+}
+
+abbr,
+acronym {
+ text-transform: uppercase;
+ font-size: 90%;
+ color: rgba(0, 0, 0, .8);
+ border-bottom: 1px dotted #ddd;
+ cursor: help
+}
+
+abbr {
+ text-transform: none
+}
+
+blockquote {
+ margin: 0 0 1.25em;
+ padding: .5625em 1.25em 0 1.1875em;
+ border-left: 1px solid #ddd
+}
+
+blockquote cite {
+ display: block;
+ font-size: .9375em;
+ color: rgba(0, 0, 0, .6)
+}
+
+blockquote cite::before {
+ content: "\2014 \0020"
+}
+
+blockquote cite a,
+blockquote cite a:visited {
+ color: rgba(0, 0, 0, .6)
+}
+
+blockquote,
+blockquote p {
+ line-height: 1.6;
+ color: rgba(0, 0, 0, .85)
+}
+
+@media screen and (min-width:768px) {
+ h1,
+ h2,
+ h3,
+ #toctitle,
+ .sidebarblock>.content>.title,
+ h4,
+ h5,
+ h6 {
+ line-height: 1.2
+ }
+
+ h1 {
+ font-size: 2.75em
+ }
+
+ h2 {
+ font-size: 2.3125em
+ }
+
+ h3,
+ #toctitle,
+ .sidebarblock>.content>.title {
+ font-size: 1.6875em
+ }
+
+ h4 {
+ font-size: 1.4375em
+ }
+
+}
+
+table {
+ background: #fff;
+ margin-bottom: 1.25em;
+ border: solid 1px #dddddd;
+}
+
+table thead,
+table tfoot {
+ background: #f7f8f7
+}
+
+table thead tr th,
+table thead tr td,
+table tfoot tr th,
+table tfoot tr td {
+ padding: .5em .625em .625em;
+ font-size: inherit;
+ color: rgba(0, 0, 0, .8);
+ text-align: left
+}
+
+table tr th,
+table tr td {
+ padding: .5625em .625em;
+ font-size: inherit;
+ color: rgba(0, 0, 0, .8)
+}
+
+table tr.even,
+table tr.alt,
+table tr:nth-of-type(even) {
+ background: #f8f8f7
+}
+
+table thead tr th,
+table tfoot tr th,
+table tbody tr td,
+table tr td,
+table tfoot tr td {
+ display: table-cell;
+ line-height: 1.6
+}
+
+h1,
+h2,
+h3,
+#toctitle,
+.sidebarblock>.content>.title,
+h4,
+h5,
+h6 {
+ line-height: 1.2;
+ word-spacing: -.05em
+}
+
+h1 strong,
+h2 strong,
+h3 strong,
+#toctitle strong,
+.sidebarblock>.content>.title strong,
+h4 strong,
+h5 strong,
+h6 strong {
+ font-weight: 400
+}
+
+.clearfix::before,
+.clearfix::after,
+.float-group::before,
+.float-group::after {
+ content: " ";
+ display: table
+}
+
+.clearfix::after,
+.float-group::after {
+ clear: both
+}
+
+*:not(pre)>code {
+ font-size: .9375em;
+ font-style: normal !important;
+ letter-spacing: 0;
+ padding: .1em .5ex;
+ word-spacing: -.15em;
+ background-color: #f7f7f8;
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+ line-height: 1.45;
+ text-rendering: optimizeSpeed;
+ word-wrap: break-word
+}
+
+*:not(pre)>code.nobreak {
+ word-wrap: normal
+}
+
+*:not(pre)>code.nowrap {
+ white-space: nowrap
+}
+
+pre,
+pre>code {
+ line-height: 1.45;
+ color: #585ac2;
+ font-family: "Droid Sans Mono", "DejaVu Sans Mono", monospace;
+ font-weight: 400;
+ text-rendering: optimizeSpeed
+}
+
+em em {
+ font-style: normal
+}
+
+strong strong {
+ font-weight: 400
+}
+
+.keyseq {
+ color: rgba(51, 51, 51, .8)
+}
+
+kbd {
+ font-family: "Droid Sans Mono", "DejaVu Sans Mono", monospace;
+ display: inline-block;
+ color: rgba(0, 0, 0, .8);
+ font-size: .65em;
+ line-height: 1.45;
+ background-color: #f7f7f7;
+ border: 1px solid #dddddd;
+ -webkit-border-radius: 3px;
+ border-radius: 3px;
+ -webkit-box-shadow: 0 1px 0 rgba(0, 0, 0, .2), 0 0 0 .1em white inset;
+ box-shadow: 0 1px 0 rgba(0, 0, 0, .2), 0 0 0 .1em #fff inset;
+ margin: 0 .15em;
+ padding: .2em .5em;
+ vertical-align: middle;
+ position: relative;
+ top: -.1em;
+ white-space: nowrap
+}
+
+.keyseq kbd:first-child {
+ margin-left: 0
+}
+
+.keyseq kbd:last-child {
+ margin-right: 0
+}
+
+.menuseq,
+.menuref {
+ color: #000
+}
+
+.menuseq b:not(.caret),.menuref {
+ font-weight: inherit
+}
+
+.menuseq {
+ word-spacing: -.02em
+}
+
+.menuseq b.caret {
+ font-size: 1.25em;
+ line-height: .8
+}
+
+.menuseq i.caret {
+ font-weight: bold;
+ text-align: center;
+ width: .45em
+}
+
+b.button::before,
+b.button::after {
+ position: relative;
+ top: -1px;
+ font-weight: 400
+}
+
+b.button::before {
+ content: "[";
+ padding: 0 3px 0 2px
+}
+
+b.button::after {
+ content: "]";
+ padding: 0 2px 0 3px
+}
+
+p a>code:hover {
+ color: #585ac2;
+}
+
+#header,
+#content,
+#footnotes,
+#footer {
+ width: 100%;
+ margin-left: auto;
+ margin-right: auto;
+ margin-top: 0;
+ margin-bottom: 0;
+ max-width: 62.5em;
+ *zoom: 1;
+ position: relative;
+ padding-left: .9375em;
+ padding-right: .9375em
+}
+
+#header::before,
+#header::after,
+#content::before,
+#content::after,
+#footnotes::before,
+#footnotes::after,
+#footer::before,
+#footer::after {
+ content: " ";
+ display: table
+}
+
+#header::after,
+#content::after,
+#footnotes::after,
+#footer::after {
+ clear: both
+}
+
+#content {
+ margin-top: 1.25em
+}
+
+#content::before {
+ content: none
+}
+
+#header>h1:first-child {
+ color: #303284;
+ margin-top: 2.25rem;
+ margin-bottom: 0
+}
+
+#header>h1:first-child+#toc {
+ margin-top: 8px;
+ border-top: 1px solid #dddddd
+}
+
+#header>h1:only-child,
+body.toc2 #header>h1:nth-last-child(2) {
+ border-bottom: 1px solid #dddddd;
+ padding-bottom: 8px
+}
+
+#header .details {
+ border-bottom: 1px solid #dddddd;
+ line-height: 1.45;
+ padding-top: .25em;
+ padding-bottom: .25em;
+ padding-left: .25em;
+ color: rgba(0, 0, 0, .6);
+ display: -ms-flexbox;
+ display: -webkit-flex;
+ display: flex;
+ -ms-flex-flow: row wrap;
+ -webkit-flex-flow: row wrap;
+ flex-flow: row wrap
+}
+
+#header .details span:first-child {
+ margin-left: -.125em
+}
+
+#header .details span.email a {
+ color: rgba(0, 0, 0, .85)
+}
+
+#header .details br {
+ display: none
+}
+
+#header .details br+span::before {
+ content: "\00a0\2013\00a0"
+}
+
+#header .details br+span.author::before {
+ content: "\00a0\22c5\00a0";
+ color: rgba(0, 0, 0, .85)
+}
+
+#header .details br+span#revremark::before {
+ content: "\00a0|\00a0"
+}
+
+#header #revnumber {
+ text-transform: capitalize
+}
+
+#header #revnumber::after {
+ content: "\00a0"
+}
+
+#content>h1:first-child:not([class]) {
+ color: rgba(0, 0, 0, .85);
+ border-bottom: 1px solid #dddddd
+;
+ padding-bottom: 8px;
+ margin-top: 0;
+ padding-top: 1rem;
+ margin-bottom: 1.25rem
+}
+
+#toc {
+ border-bottom: 1px solid #dddddd;
+ padding-bottom: .5em
+}
+
+#toc>ul {
+ margin-left: .125em
+}
+
+#toc ul.sectlevel0>li>a {
+ font-style: italic
+}
+
+#toc ul.sectlevel0 ul.sectlevel1 {
+ margin: .5em 0
+}
+
+#toc ul {
+ font-family: "Droid Serif", "DejaVu Sans", sans-serif;
+ list-style-type: none
+}
+
+#toc li {
+ line-height: 1.3334;
+ margin-top: .3334em
+}
+
+#toc a {
+ text-decoration: none
+}
+
+#toc a:active {
+ text-decoration: underline
+}
+
+#toctitle {
+ color: #303284;
+ font-size: 1.2em
+}
+
+@media screen and (min-width:768px) {
+ #toctitle {
+ font-size: 1.375em
+ }
+
+ body.toc2 {
+ padding-left: 15em;
+ padding-right: 0
+ }
+
+ #toc.toc2 {
+ margin-top: 0 !important;
+ background-color: #eee;
+ position: fixed;
+ width: 15em;
+ left: 0;
+ top: 0;
+ border-right: 1px solid #dddddd;
+ border-top-width: 0 !important;
+ border-bottom-width: 0 !important;
+ z-index: 1000;
+ padding: 1.25em 1em;
+ height: 100%;
+ overflow: auto
+ }
+
+ #toc.toc2 #toctitle {
+ margin-top: 0;
+ margin-bottom: .8rem;
+ font-size: 1.2em
+ }
+
+ #toc.toc2>ul {
+ font-size: .9em;
+ margin-bottom: 0
+ }
+
+ #toc.toc2 ul ul {
+ margin-left: 0;
+ padding-left: 1em
+ }
+
+ #toc.toc2 ul.sectlevel0 ul.sectlevel1 {
+ padding-left: 0;
+ margin-top: .5em;
+ margin-bottom: .5em
+ }
+
+ body.toc2.toc-right {
+ padding-left: 0;
+ padding-right: 15em
+ }
+
+ body.toc2.toc-right #toc.toc2 {
+ border-right-width: 0;
+ border-left: 1px solid #dddddd;
+ left: auto;
+ right: 0
+ }
+
+}
+
+@media screen and (min-width:1280px) {
+ body.toc2 {
+ padding-left: 20em;
+ padding-right: 0
+ }
+
+ #toc.toc2 {
+ width: 20em
+ }
+
+ #toc.toc2 #toctitle {
+ font-size: 1.375em
+ }
+
+ #toc.toc2>ul {
+ font-size: .95em
+ }
+
+ #toc.toc2 ul ul {
+ padding-left: 1.25em
+ }
+
+ body.toc2.toc-right {
+ padding-left: 0;
+ padding-right: 20em
+ }
+
+}
+
+#content #toc {
+ border-style: solid;
+ border-width: 1px;
+ border-color: #dddddd;
+ margin-bottom: 1.25em;
+ padding: 1.25em;
+ background: #f8f8f7;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+#content #toc>:first-child {
+ margin-top: 0
+}
+
+#content #toc>:last-child {
+ margin-bottom: 0
+}
+
+#footer {
+ max-width: 100%;
+ background-color: #303284;
+ padding: 1.25em
+}
+
+#footer-text {
+ color: #fff;
+ line-height: 1.44
+}
+
+#content {
+ margin-bottom: .625em
+}
+
+.sect1 {
+ padding-bottom: .625em
+}
+
+@media screen and (min-width:768px) {
+ #content {
+ margin-bottom: 1.25em
+ }
+
+ .sect1 {
+ padding-bottom: 1.25em
+ }
+
+}
+
+.sect1:last-child {
+ padding-bottom: 0
+}
+
+.sect1+.sect1 {
+ border-top: 1px solid #dddddd;
+}
+
+#content h1>a.anchor,
+h2>a.anchor,
+h3>a.anchor,
+#toctitle>a.anchor,
+.sidebarblock>.content>.title>a.anchor,
+h4>a.anchor,
+h5>a.anchor,
+h6>a.anchor {
+ position: absolute;
+ z-index: 1001;
+ width: 1.5ex;
+ margin-left: -1.5ex;
+ display: block;
+ text-decoration: none !important;
+ visibility: hidden;
+ text-align: center;
+ font-weight: 400
+}
+
+#content h1>a.anchor::before,
+h2>a.anchor::before,
+h3>a.anchor::before,
+#toctitle>a.anchor::before,
+.sidebarblock>.content>.title>a.anchor::before,
+h4>a.anchor::before,
+h5>a.anchor::before,
+h6>a.anchor::before {
+ content: "\00A7";
+ font-size: .85em;
+ display: block;
+ padding-top: .1em
+}
+
+#content h1:hover>a.anchor,
+#content h1>a.anchor:hover,
+h2:hover>a.anchor,
+h2>a.anchor:hover,
+h3:hover>a.anchor,
+#toctitle:hover>a.anchor,
+.sidebarblock>.content>.title:hover>a.anchor,
+h3>a.anchor:hover,
+#toctitle>a.anchor:hover,
+.sidebarblock>.content>.title>a.anchor:hover,
+h4:hover>a.anchor,
+h4>a.anchor:hover,
+h5:hover>a.anchor,
+h5>a.anchor:hover,
+h6:hover>a.anchor,
+h6>a.anchor:hover {
+ visibility: visible
+}
+
+#content h1>a.link,
+h2>a.link,
+h3>a.link,
+#toctitle>a.link,
+.sidebarblock>.content>.title>a.link,
+h4>a.link,
+h5>a.link,
+h6>a.link {
+ color: #ba3925;
+ text-decoration: none
+}
+
+#content h1>a.link:hover,
+h2>a.link:hover,
+h3>a.link:hover,
+#toctitle>a.link:hover,
+.sidebarblock>.content>.title>a.link:hover,
+h4>a.link:hover,
+h5>a.link:hover,
+h6>a.link:hover {
+ color: #a53221
+}
+
+.audioblock,
+.imageblock,
+.literalblock,
+.listingblock,
+.stemblock,
+.videoblock {
+ margin-bottom: 1.25em
+}
+
+.admonitionblock td.content>.title,
+.audioblock>.title,
+.exampleblock>.title,
+.imageblock>.title,
+.listingblock>.title,
+.literalblock>.title,
+.stemblock>.title,
+.openblock>.title,
+.paragraph>.title,
+.quoteblock>.title,
+table.tableblock>.title,
+.verseblock>.title,
+.videoblock>.title,
+.dlist>.title,
+.olist>.title,
+.ulist>.title,
+.qlist>.title,
+.hdlist>.title {
+ text-rendering: optimizeLegibility;
+ text-align: left;
+ font-family: "Droid Serif", "DejaVu Serif", serif;
+ font-size: 1rem;
+ font-style: italic
+}
+
+table.tableblock.fit-content>caption.title {
+ white-space: nowrap;
+ width: 0
+}
+
+.paragraph.lead>p,
+#preamble>.sectionbody>[class="paragraph"]:first-of-type p {
+ font-size: 1.21875em;
+ line-height: 1.6;
+ color: rgba(0, 0, 0, .85)
+}
+
+table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p {
+ font-size: inherit
+}
+
+.admonitionblock>table {
+ border-collapse: separate;
+ border: 0;
+ background: none;
+ width: 100%
+}
+
+.admonitionblock>table td.icon {
+ text-align: center;
+ width: 80px
+}
+
+.admonitionblock>table td.icon img {
+ max-width: none
+}
+
+.admonitionblock>table td.icon .title {
+ font-weight: bold;
+ font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ text-transform: uppercase
+}
+
+.admonitionblock>table td.content {
+ padding-left: 1.125em;
+ padding-right: 1.25em;
+ border-left: 1px solid #dddddd;
+ color: rgba(0, 0, 0, .6)
+}
+
+.admonitionblock>table td.content>:last-child>:last-child {
+ margin-bottom: 0
+}
+
+.exampleblock>.content {
+ border-style: solid;
+ border-width: 1px;
+ border-color: #dddddd;
+ margin-bottom: 1.25em;
+ padding: 1.25em;
+ background: #fff;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+.exampleblock>.content>:first-child {
+ margin-top: 0
+}
+
+.exampleblock>.content>:last-child {
+ margin-bottom: 0
+}
+
+.sidebarblock {
+ border-style: solid;
+ border-width: 1px;
+ border-color: #dddddd;
+ margin-bottom: 1.25em;
+ padding: 1.25em;
+ background: #f8f8f7;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+.sidebarblock>:first-child {
+ margin-top: 0
+}
+
+.sidebarblock>:last-child {
+ margin-bottom: 0
+}
+
+.sidebarblock>.content>.title {
+ color: #303284;
+ margin-top: 0;
+ text-align: center
+}
+
+.exampleblock>.content>:last-child>:last-child,
+.exampleblock>.content .olist>ol>li:last-child>:last-child,
+.exampleblock>.content .ulist>ul>li:last-child>:last-child,
+.exampleblock>.content .qlist>ol>li:last-child>:last-child,
+.sidebarblock>.content>:last-child>:last-child,
+.sidebarblock>.content .olist>ol>li:last-child>:last-child,
+.sidebarblock>.content .ulist>ul>li:last-child>:last-child,
+.sidebarblock>.content .qlist>ol>li:last-child>:last-child {
+ margin-bottom: 0
+}
+
+.literalblock pre,
+.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint {
+ background: #f7f7f8
+}
+
+.sidebarblock .literalblock pre,
+.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint {
+ background: #f2f1f1
+}
+
+.literalblock pre,
+.literalblock pre[class],
+.listingblock pre,
+.listingblock pre[class] {
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+ word-wrap: break-word;
+ padding: 1em;
+ font-size: .8125em
+}
+
+.literalblock pre.nowrap,
+.literalblock pre[class].nowrap,
+.listingblock pre.nowrap,
+.listingblock pre[class].nowrap {
+ overflow-x: auto;
+ white-space: pre;
+ word-wrap: normal
+}
+
+@media screen and (min-width:768px) {
+ .literalblock pre,
+ .literalblock pre[class],
+ .listingblock pre,
+ .listingblock pre[class] {
+ font-size: .90625em
+ }
+
+}
+
+@media screen and (min-width:1280px) {
+ .literalblock pre,
+ .literalblock pre[class],
+ .listingblock pre,
+ .listingblock pre[class] {
+ font-size: 1em
+ }
+
+}
+
+.literalblock.output pre {
+ color: #f7f7f8;
+ background-color: rgba(0, 0, 0, .9)
+}
+
+.listingblock pre.highlightjs {
+ padding: 0
+}
+
+.listingblock pre.highlightjs>code {
+ padding: 1em;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+.listingblock pre.prettyprint {
+ border-width: 0
+}
+
+.listingblock>.content {
+ position: relative
+}
+
+.listingblock code[data-lang]::before {
+ display: none;
+ content: attr(data-lang);
+ position: absolute;
+ font-size: .75em;
+ top: .425rem;
+ right: .5rem;
+ line-height: 1;
+ text-transform: uppercase;
+ color: #999
+}
+
+.listingblock:hover code[data-lang]::before {
+ display: block
+}
+
+.listingblock.terminal pre .command::before {
+ content: attr(data-prompt);
+ padding-right: .5em;
+ color: #999
+}
+
+.listingblock.terminal pre .command:not([data-prompt])::before {
+ content: "$"
+}
+
+table.pyhltable {
+ border-collapse: separate;
+ border: 0;
+ margin-bottom: 0;
+ background: none
+}
+
+table.pyhltable td {
+ vertical-align: top;
+ padding-top: 0;
+ padding-bottom: 0;
+ line-height: 1.45
+}
+
+table.pyhltable td.code {
+ padding-left: .75em;
+ padding-right: 0
+}
+
+pre.pygments .lineno,
+table.pyhltable td:not(.code) {
+ color: #999;
+ padding-left: 0;
+ padding-right: .5em;
+ border-right: 1px solid #dddddd;
+}
+
+pre.pygments .lineno {
+ display: inline-block;
+ margin-right: .25em
+}
+
+table.pyhltable .linenodiv {
+ background: none !important;
+ padding-right: 0 !important
+}
+
+.quoteblock {
+ margin: 0 1em 1.25em 1.5em;
+ display: table
+}
+
+.quoteblock>.title {
+ margin-left: -1.5em;
+ margin-bottom: .75em
+}
+
+.quoteblock blockquote,
+.quoteblock blockquote p {
+ color: rgba(0, 0, 0, .85);
+ font-size: 1.05rem;
+ line-height: 1.75;
+ word-spacing: .1em;
+ letter-spacing: 0;
+ font-style: italic;
+ text-align: justify
+}
+
+.quoteblock blockquote {
+ margin: 0;
+ padding: 0;
+ border: 0
+}
+
+.quoteblock blockquote::before {
+ content: "\201c";
+ float: left;
+ font-size: 2.75em;
+ font-weight: bold;
+ line-height: .6em;
+ margin-left: -.6em;
+ color: #303284;
+ text-shadow: 0 1px 2px rgba(0, 0, 0, .1)
+}
+
+.quoteblock blockquote>.paragraph:last-child p {
+ margin-bottom: 0
+}
+
+.quoteblock .attribution {
+ margin-top: .5em;
+ margin-right: .5ex;
+ text-align: right
+}
+
+.quoteblock .quoteblock {
+ margin-left: 0;
+ margin-right: 0;
+ padding: .5em 0;
+ border-left: 3px solid rgba(0, 0, 0, .6)
+}
+
+.quoteblock .quoteblock blockquote {
+ padding: 0 0 0 .75em
+}
+
+.quoteblock .quoteblock blockquote::before {
+ display: none
+}
+
+.verseblock {
+ margin: 0 1em 1.25em
+}
+
+.verseblock pre {
+ font-family: "Source Sans Pro", "DejaVu Sans", sans;
+ font-size: 1.15rem;
+ color: rgba(0, 0, 0, .85);
+ font-weight: 300;
+ text-rendering: optimizeLegibility
+}
+
+.verseblock pre strong {
+ font-weight: 400
+}
+
+.verseblock .attribution {
+ margin-top: 1.25rem;
+ margin-left: .5ex
+}
+
+.quoteblock .attribution,
+.verseblock .attribution {
+ font-size: .9375em;
+ line-height: 1.45;
+ font-style: italic
+}
+
+.quoteblock .attribution br,
+.verseblock .attribution br {
+ display: none
+}
+
+.quoteblock .attribution cite,
+.verseblock .attribution cite {
+ display: block;
+ letter-spacing: -.025em;
+ color: rgba(0, 0, 0, .6)
+}
+
+.quoteblock.abstract {
+ margin: 0 1em 1.25em;
+ display: block
+}
+
+.quoteblock.abstract>.title {
+ margin: 0 0 .375em;
+ font-size: 1.15em;
+ text-align: center
+}
+
+.quoteblock.abstract blockquote,
+.quoteblock.abstract blockquote p {
+ word-spacing: 0;
+ line-height: 1.6
+}
+
+.quoteblock.abstract blockquote::before,
+.quoteblock.abstract p::before {
+ display: none
+}
+
+table.tableblock {
+ max-width: 100%;
+ border-collapse: separate
+}
+
+p.tableblock:last-child {
+ margin-bottom: 0
+}
+
+td.tableblock>.content {
+ margin-bottom: -1.25em
+}
+
+table.tableblock,
+th.tableblock,
+td.tableblock {
+ border: 0 solid #dddddd;
+}
+
+table.grid-all>thead>tr>.tableblock,
+table.grid-all>tbody>tr>.tableblock {
+ border-width: 0 1px 1px 0
+}
+
+table.grid-all>tfoot>tr>.tableblock {
+ border-width: 1px 1px 0 0
+}
+
+table.grid-cols>*>tr>.tableblock {
+ border-width: 0 1px 0 0
+}
+
+table.grid-rows>thead>tr>.tableblock,
+table.grid-rows>tbody>tr>.tableblock {
+ border-width: 0 0 1px
+}
+
+table.grid-rows>tfoot>tr>.tableblock {
+ border-width: 1px 0 0
+}
+
+table.grid-all>*>tr>.tableblock:last-child,
+table.grid-cols>*>tr>.tableblock:last-child {
+ border-right-width: 0
+}
+
+table.grid-all>tbody>tr:last-child>.tableblock,
+table.grid-all>thead:last-child>tr>.tableblock,
+table.grid-rows>tbody>tr:last-child>.tableblock,
+table.grid-rows>thead:last-child>tr>.tableblock {
+ border-bottom-width: 0
+}
+
+table.frame-all {
+ border-width: 1px
+}
+
+table.frame-sides {
+ border-width: 0 1px
+}
+
+table.frame-topbot,
+table.frame-ends {
+ border-width: 1px 0
+}
+
+table.stripes-all tr,
+table.stripes-odd tr:nth-of-type(odd) {
+ background: #f8f8f7
+}
+
+table.stripes-none tr,
+table.stripes-odd tr:nth-of-type(even) {
+ background: none
+}
+
+th.halign-left,
+td.halign-left {
+ text-align: left
+}
+
+th.halign-right,
+td.halign-right {
+ text-align: right
+}
+
+th.halign-center,
+td.halign-center {
+ text-align: center
+}
+
+th.valign-top,
+td.valign-top {
+ vertical-align: top
+}
+
+th.valign-bottom,
+td.valign-bottom {
+ vertical-align: bottom
+}
+
+th.valign-middle,
+td.valign-middle {
+ vertical-align: middle
+}
+
+table thead th,
+table tfoot th {
+ font-weight: bold
+}
+
+tbody tr th {
+ display: table-cell;
+ line-height: 1.6;
+ background: #f7f8f7
+}
+
+tbody tr th,
+tbody tr th p,
+tfoot tr th,
+tfoot tr th p {
+ color: rgba(0, 0, 0, .8);
+ font-weight: bold
+}
+
+p.tableblock>code:only-child {
+ background: none;
+ padding: 0
+}
+
+p.tableblock {
+ font-size: 1em
+}
+
+td>div.verse {
+ white-space: pre
+}
+
+ol {
+ margin-left: 1.75em
+}
+
+ul li ol {
+ margin-left: 1.5em
+}
+
+dl dd {
+ margin-left: 1.125em
+}
+
+dl dd:last-child,
+dl dd:last-child>:last-child {
+ margin-bottom: 0
+}
+
+ol>li p,
+ul>li p,
+ul dd,
+ol dd,
+.olist .olist,
+.ulist .ulist,
+.ulist .olist,
+.olist .ulist {
+ margin-bottom: .625em
+}
+
+ul.checklist,
+ul.none,
+ol.none,
+ul.no-bullet,
+ol.no-bullet,
+ol.unnumbered,
+ul.unstyled,
+ol.unstyled {
+ list-style-type: none
+}
+
+ul.no-bullet,
+ol.no-bullet,
+ol.unnumbered {
+ margin-left: .625em
+}
+
+ul.unstyled,
+ol.unstyled {
+ margin-left: 0
+}
+
+ul.checklist {
+ margin-left: .625em
+}
+
+ul.checklist li>p:first-child>.fa-square-o:first-child,
+ul.checklist li>p:first-child>.fa-check-square-o:first-child {
+ width: 1.25em;
+ font-size: .8em;
+ position: relative;
+ bottom: .125em
+}
+
+ul.checklist li>p:first-child>input[type="checkbox"]:first-child {
+ margin-right: .25em
+}
+
+ul.inline {
+ display: -ms-flexbox;
+ display: -webkit-box;
+ display: flex;
+ -ms-flex-flow: row wrap;
+ -webkit-flex-flow: row wrap;
+ flex-flow: row wrap;
+ list-style: none;
+ margin: 0 0 .625em -1.25em
+}
+
+ul.inline>li {
+ margin-left: 1.25em
+}
+
+.unstyled dl dt {
+ font-weight: 400;
+ font-style: normal
+}
+
+ol.arabic {
+ list-style-type: decimal
+}
+
+ol.decimal {
+ list-style-type: decimal-leading-zero
+}
+
+ol.loweralpha {
+ list-style-type: lower-alpha
+}
+
+ol.upperalpha {
+ list-style-type: upper-alpha
+}
+
+ol.lowerroman {
+ list-style-type: lower-roman
+}
+
+ol.upperroman {
+ list-style-type: upper-roman
+}
+
+ol.lowergreek {
+ list-style-type: lower-greek
+}
+
+.hdlist>table,
+.colist>table {
+ border: 0;
+ background: none
+}
+
+.hdlist>table>tbody>tr,
+.colist>table>tbody>tr {
+ background: none
+}
+
+td.hdlist1,
+td.hdlist2 {
+ vertical-align: top;
+ padding: 0 .625em
+}
+
+td.hdlist1 {
+ font-weight: bold;
+ padding-bottom: 1.25em
+}
+
+.literalblock+.colist,
+.listingblock+.colist {
+ margin-top: -.5em
+}
+
+.colist td:not([class]):first-child {
+ padding: .4em .75em 0;
+ line-height: 1;
+ vertical-align: top
+}
+
+.colist td:not([class]):first-child img {
+ max-width: none
+}
+
+.colist td:not([class]):last-child {
+ padding: .25em 0
+}
+
+.thumb,
+.th {
+ line-height: 0;
+ display: inline-block;
+ border: solid 4px #fff;
+ -webkit-box-shadow: 0 0 0 1px #ddd;
+ box-shadow: 0 0 0 1px #ddd
+}
+
+.imageblock.left,
+.imageblock[style*="float:left"] {
+ margin: .25em .625em 1.25em 0
+}
+
+.imageblock.right,
+.imageblock[style*="float:right"] {
+ margin: .25em 0 1.25em .625em
+}
+
+.imageblock>.title {
+ margin-bottom: 0
+}
+
+.imageblock.thumb,
+.imageblock.th {
+ border-width: 6px
+}
+
+.imageblock.thumb>.title,
+.imageblock.th>.title {
+ padding: 0 .125em
+}
+
+.image.left,
+.image.right {
+ margin-top: .25em;
+ margin-bottom: .25em;
+ display: inline-block;
+ line-height: 0
+}
+
+.image.left {
+ margin-right: .625em
+}
+
+.image.right {
+ margin-left: .625em
+}
+
+a.image {
+ text-decoration: none;
+ display: inline-block
+}
+
+a.image object {
+ pointer-events: none
+}
+
+sup.footnote,
+sup.footnoteref {
+ font-size: .875em;
+ position: static;
+ vertical-align: super
+}
+
+sup.footnote a,
+sup.footnoteref a {
+ text-decoration: none
+}
+
+sup.footnote a:active,
+sup.footnoteref a:active {
+ text-decoration: underline
+}
+
+#footnotes {
+ padding-top: .75em;
+ padding-bottom: .75em;
+ margin-bottom: .625em
+}
+
+#footnotes hr {
+ width: 20%;
+ min-width: 6.25em;
+ margin: -.25em 0 .75em;
+ border-width: 1px 0 0
+}
+
+#footnotes .footnote {
+ padding: 0 .375em 0 .225em;
+ line-height: 1.3334;
+ font-size: .875em;
+ margin-left: 1.2em;
+ margin-bottom: .2em
+}
+
+#footnotes .footnote a:first-of-type {
+ font-weight: bold;
+ text-decoration: none;
+ margin-left: -1.05em
+}
+
+#footnotes .footnote:last-of-type {
+ margin-bottom: 0
+}
+
+#content #footnotes {
+ margin-top: -.625em;
+ margin-bottom: 0;
+ padding: .75em 0
+}
+
+.gist .file-data>table {
+ border: 0;
+ background: #fff;
+ width: 100%;
+ margin-bottom: 0
+}
+
+.gist .file-data>table td.line-data {
+ width: 99%
+}
+
+div.unbreakable {
+ page-break-inside: avoid
+}
+
+.big {
+ font-size: larger
+}
+
+.small {
+ font-size: smaller
+}
+
+.underline {
+ text-decoration: underline
+}
+
+.overline {
+ text-decoration: overline
+}
+
+.line-through {
+ text-decoration: line-through
+}
+
+.aqua {
+ color: #00bfbf
+}
+
+.aqua-background {
+ background-color: #00fafa
+}
+
+.black {
+ color: #000
+}
+
+.black-background {
+ background-color: #000
+}
+
+.blue {
+ color: #0000bf
+}
+
+.blue-background {
+ background-color: #0000fa
+}
+
+.fuchsia {
+ color: #bf00bf
+}
+
+.fuchsia-background {
+ background-color: #fa00fa
+}
+
+.gray {
+ color: #606060
+}
+
+.gray-background {
+ background-color: #7d7d7d
+}
+
+.green {
+ color: #006000
+}
+
+.green-background {
+ background-color: #007d00
+}
+
+.lime {
+ color: #00bf00
+}
+
+.lime-background {
+ background-color: #00fa00
+}
+
+.maroon {
+ color: #600000
+}
+
+.maroon-background {
+ background-color: #7d0000
+}
+
+.navy {
+ color: #000060
+}
+
+.navy-background {
+ background-color: #00007d
+}
+
+.olive {
+ color: #606000
+}
+
+.olive-background {
+ background-color: #7d7d00
+}
+
+.purple {
+ color: #600060
+}
+
+.purple-background {
+ background-color: #7d007d
+}
+
+.red {
+ color: #bf0000
+}
+
+.red-background {
+ background-color: #fa0000
+}
+
+.silver {
+ color: #909090
+}
+
+.silver-background {
+ background-color: #bcbcbc
+}
+
+.teal {
+ color: #006060
+}
+
+.teal-background {
+ background-color: #007d7d
+}
+
+.white {
+ color: #bfbfbf
+}
+
+.white-background {
+ background-color: #fafafa
+}
+
+.yellow {
+ color: #bfbf00
+}
+
+.yellow-background {
+ background-color: #fafa00
+}
+
+span.icon>.fa {
+ cursor: default
+}
+
+a span.icon>.fa {
+ cursor: inherit
+}
+
+.admonitionblock td.icon [class^="fa icon-"] {
+ font-size: 2.5em;
+ text-shadow: 1px 1px 2px rgba(0, 0, 0, .5);
+ cursor: default
+}
+
+.admonitionblock td.icon .icon-note::before {
+ content: "\f05a";
+ color: #19407c
+}
+
+.admonitionblock td.icon .icon-tip::before {
+ content: "\f0eb";
+ text-shadow: 1px 1px 2px rgba(155, 155, 0, .8);
+ color: #111
+}
+
+.admonitionblock td.icon .icon-warning::before {
+ content: "\f071";
+ color: #bf6900
+}
+
+.admonitionblock td.icon .icon-caution::before {
+ content: "\f06d";
+ color: #bf3400
+}
+
+.admonitionblock td.icon .icon-important::before {
+ content: "\f06a";
+ color: #bf0000
+}
+
+.conum[data-value] {
+ display: inline-block;
+ color: #fff !important;
+ background-color: rgba(0, 0, 0, .8);
+ -webkit-border-radius: 100px;
+ border-radius: 100px;
+ text-align: center;
+ font-size: .75em;
+ width: 1.67em;
+ height: 1.67em;
+ line-height: 1.67em;
+ font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ font-style: normal;
+ font-weight: bold
+}
+
+.conum[data-value] * {
+ color: #fff !important
+}
+
+.conum[data-value]+b {
+ display: none
+}
+
+.conum[data-value]::after {
+ content: attr(data-value)
+}
+
+pre .conum[data-value] {
+ position: relative;
+ top: -.125em
+}
+
+b.conum * {
+ color: inherit !important
+}
+
+.conum:not([data-value]):empty {
+ display: none
+}
+
+dt,
+th.tableblock,
+td.content,
+div.footnote {
+ text-rendering: optimizeLegibility
+}
+
+h1,
+h2,
+p,
+td.content,
+span.alt {
+ letter-spacing: -.01em
+}
+
+p strong,
+td.content strong,
+div.footnote strong {
+ letter-spacing: -.005em
+}
+
+p,
+blockquote,
+dt,
+td.content,
+span.alt {
+ /*font-size: 1.0625rem*/
+}
+
+p {
+ margin-bottom: 1.25rem
+}
+
+.sidebarblock p,
+.sidebarblock dt,
+.sidebarblock td.content,
+p.tableblock {
+ font-size: 1em
+}
+
+.exampleblock>.content {
+ background-color: #fffef7;
+ border-color: #dddddd;
+ -webkit-box-shadow: 0 1px 4px #e0e0dc;
+ box-shadow: 0 1px 4px #e0e0dc
+}
+
+.print-only {
+ display: none !important
+}
+
+@page {
+ margin: 1.25cm .75cm
+}
+
+@media print {
+ * {
+ -webkit-box-shadow: none !important;
+ box-shadow: none !important;
+ text-shadow: none !important
+ }
+
+ html {
+ font-size: 80%
+ }
+
+ a {
+ color: inherit !important;
+ text-decoration: underline !important
+ }
+
+ a.bare,
+ a[href^="#"],
+ a[href^="mailto:"] {
+ text-decoration: none !important
+ }
+
+ a[href^="http:"]:not(.bare)::after,
+ a[href^="https:"]:not(.bare)::after {
+ content: "("attr(href) ")";
+ display: inline-block;
+ font-size: .875em;
+ padding-left: .25em
+ }
+
+ abbr[title]::after {
+ content: " ("attr(title) ")"
+ }
+
+ pre,
+ blockquote,
+ tr,
+ img,
+ object,
+ svg {
+ page-break-inside: avoid
+ }
+
+ thead {
+ display: table-header-group
+ }
+
+ svg {
+ max-width: 100%
+ }
+
+ p,
+ blockquote,
+ dt,
+ td.content {
+ font-size: 1em;
+ orphans: 3;
+ widows: 3
+ }
+
+ h2,
+ h3,
+ #toctitle,
+ .sidebarblock>.content>.title {
+ page-break-after: avoid
+ }
+
+ #toc,
+ .sidebarblock,
+ .exampleblock>.content {
+ background: none !important
+ }
+
+ #toc {
+ border-bottom: 1px solid #dddddd !important;
+ padding-bottom: 0 !important
+ }
+
+ body.book #header {
+ text-align: center
+ }
+
+ body.book #header>h1:first-child {
+ border: 0 !important;
+ margin: 2.5em 0 1em
+ }
+
+ body.book #header .details {
+ border: 0 !important;
+ display: block;
+ padding: 0 !important
+ }
+
+ body.book #header .details span:first-child {
+ margin-left: 0 !important
+ }
+
+ body.book #header .details br {
+ display: block
+ }
+
+ body.book #header .details br+span::before {
+ content: none !important
+ }
+
+ body.book #toc {
+ border: 0 !important;
+ text-align: left !important;
+ padding: 0 !important;
+ margin: 0 !important
+ }
+
+ body.book #toc,
+ body.book #preamble,
+ body.book h1.sect0,
+ body.book .sect1>h2 {
+ page-break-before: always
+ }
+
+ .listingblock code[data-lang]::before {
+ display: block
+ }
+
+ #footer {
+ padding: 0 .9375em
+ }
+
+ .hide-on-print {
+ display: none !important
+ }
+
+ .print-only {
+ display: block !important
+ }
+
+ .hide-for-print {
+ display: none !important
+ }
+
+ .show-for-print {
+ display: inherit !important
+ }
+
+}
+
+@media print, amzn-kf8 {
+ #header>h1:first-child {
+ margin-top: 1.25rem
+ }
+
+ .sect1 {
+ padding: 0 !important
+ }
+
+ .sect1+.sect1 {
+ border: 0
+ }
+
+ #footer {
+ background: none
+ }
+
+ #footer-text {
+ color: rgba(0, 0, 0, .6);
+ font-size: .9em
+ }
+
+}
+
+@media amzn-kf8 {
+ #header,
+ #content,
+ #footnotes,
+ #footer {
+ padding: 0
+ }
+
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/building-and-deploying.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/building-and-deploying.adoc b/manual/src/main/asciidoc/building-and-deploying.adoc
new file mode 100644
index 0000000..b285779
--- /dev/null
+++ b/manual/src/main/asciidoc/building-and-deploying.adoc
@@ -0,0 +1,276 @@
+//
+// Licensed 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.
+//
+
+=== Building
+
+==== Initial Setup
+
+1) Install J2SE 8.0 SDK (or later), which can be downloaded from
+ http://www.oracle.com/technetwork/java/javase/downloads/index.html[http://www.oracle.com/technetwork/java/javase/downloads/index.html]
+
+2) Make sure that your JAVA_HOME environment variable is set to the newly installed
+ JDK location, and that your PATH includes %JAVA_HOME%\bin (windows) or
+ $JAVA_HOME$/bin (unix).
+
+3) Install Maven 3.0.3 (or later), which can be downloaded from
+ http://maven.apache.org/download.html[http://maven.apache.org/download.html]. Make sure that your PATH includes
+ the MVN_HOME/bin directory.
+
+==== Building
+
+1) Change to the top level directory of Apache Unomi source distribution.
+2) Run
+
+[source]
+----
+ $> mvn clean install
+----
+
+This will compile Apache Unomi and run all of the tests in the
+ Apache Unomi source distribution. Alternatively, you can run
+
+[source]
+----
+ $> mvn -P \!integration-tests,\!performance-tests clean install
+----
+
+This will compile Apache Unomi without running the tests and takes less
+ time to build.
+
+3) The distributions will be available under "package/target" directory.
+
+==== Installing an ElasticSearch server
+
+Starting with version 1.2, Apache Unomi no longer embeds an ElasticSearch server as this is no longer supported by
+the developers of ElasticSearch. Therefore you will need to install a standalone ElasticSearch using the following steps:
+
+.
+
+Download an ElasticSearch version. Here's the version you will need depending
+on your version of Apache Unomi.
+
+Apache Unomi <= 1.2 : https://www.elastic.co/downloads/past-releases/elasticsearch-5-1-2[https://www.elastic.co/downloads/past-releases/elasticsearch-5-1-2]
+Apache Unomi >= 1.3 : https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-3[https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-3]
+
+.
+
+Uncompress the downloaded package into a directory
+
+.
+
+In the config/elasticsearch.yml file, uncomment and modify the following line :
+
+[source]
+----
+cluster.name: contextElasticSearch
+----
+
+.
+
+Launch the server using
+
+[source]
+----
+bin/elasticsearch (Mac, Linux)
+bin\elasticsearch.bat (Windows)
+----
+
+.
+
+Check that the ElasticSearch is up and running by accessing the following URL :
+
+http://localhost:9200[http://localhost:9200]
+
+==== Deploying the generated binary package
+
+The "package" sub-project generates a pre-configured Apache Karaf installation that is the simplest way to get started.
+Simply uncompress the package/target/unomi-VERSION.tar.gz (for Linux or Mac OS X) or
+ package/target/unomi-VERSION.zip (for Windows) archive into the directory of your choice.
+
+You can then start the server simply by using the command on UNIX/Linux/MacOS X :
+
+[source]
+----
+./bin/karaf
+----
+
+or on Windows shell :
+
+[source]
+----
+bin\karaf.bat
+----
+
+You will then need to launch (only on the first Karaf start) the Apache Unomi packages using the following Apache Karaf
+shell command:
+
+[source]
+----
+unomi:start
+----
+
+==== Deploying into an existing Karaf server
+
+This is only needed if you didn't use the generated package. Also, this is the preferred way to install a development
+environment if you intend to re-deploy the context server KAR iteratively.
+
+Additional requirements:
+* Apache Karaf 3.x, http://karaf.apache.org[http://karaf.apache.org]
+
+.
+
+Before deploying, make sure that you have Apache Karaf properly installed. You will also have to increase the
+default maximum memory size and perm gen size by adjusting the following environment values in the bin/setenv(.bat)
+files (at the end of the file):
+
+[source]
+----
+ MY_DIRNAME=`dirname $0`
+ MY_KARAF_HOME=`cd "$MY_DIRNAME/.."; pwd`
+ export JAVA_MAX_MEM=3G
+ export JAVA_MAX_PERM_MEM=384M
+----
+
+.
+
+Install the WAR support, CXF and Karaf Cellar into Karaf by doing the following in the Karaf command line:
+
+[source]
+----
+ feature:repo-add cxf 3.0.2
+ feature:repo-add cellar 3.0.3
+ feature:repo-add mvn:org.apache.unomi/unomi-kar/VERSION/xml/features
+ feature:install unomi-kar
+----
+
+.
+
+Create a new $MY_KARAF_HOME/etc/org.apache.cxf.osgi.cfg file and put the following property inside :
+
+[source]
+----
+ org.apache.cxf.servlet.context=/cxs
+----
+
+.
+
+If all went smoothly, you should be able to access the context script here : http://localhost:8181/cxs/cluster[http://localhost:8181/cxs/cluster] .
+ You should be able to login with karaf / karaf and see basic server information. If not something went wrong during the install.
+
+==== JDK Selection on Mac OS X
+
+You might need to select the JDK to run the tests in the itests subproject. In order to do so you can list the
+installed JDKs with the following command :
+
+[source]
+----
+/usr/libexec/java_home -V
+----
+
+which will output something like this :
+
+[source]
+----
+Matching Java Virtual Machines (7):
+ 1.7.0_51, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_51.jdk/Contents/Home
+ 1.7.0_45, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_45.jdk/Contents/Home
+ 1.7.0_25, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_25.jdk/Contents/Home
+ 1.6.0_65-b14-462, x86_64: "Java SE 6" /Library/Java/JavaVirtualMachines/1.6.0_65-b14-462.jdk/Contents/Home
+ 1.6.0_65-b14-462, i386: "Java SE 6" /Library/Java/JavaVirtualMachines/1.6.0_65-b14-462.jdk/Contents/Home
+ 1.6.0_65-b14-462, x86_64: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
+ 1.6.0_65-b14-462, i386: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
+----
+
+You can then select the one you want using :
+
+[source]
+----
+export JAVA_HOME=`/usr/libexec/java_home -v 1.7.0_51`
+----
+
+and then check that it was correctly referenced using:
+
+[source]
+----
+java -version
+----
+
+which should give you a result such as this:
+
+[source]
+----
+java version "1.7.0_51"
+Java(TM) SE Runtime Environment (build 1.7.0_51-b13)
+Java HotSpot(TM) 64-Bit Server VM (build 24.51-b03, mixed mode)
+----
+
+==== Running the integration tests
+
+The integration tests are not executed by default to make build time minimal, but it is recommended to run the
+integration tests at least once before using the server to make sure that everything is ok in the build. Another way
+to use these tests is to run them from a continuous integration server such as Jenkins, Apache Gump, Atlassian Bamboo or
+ others.
+
+Note : the integration tests require a JDK 7 or more recent !
+
+To run the tests simply activate the following profile :
+
+[source]
+----
+mvn -P integration-tests clean install
+----
+
+==== Running the performance tests
+
+Performance tests are based on Gatling. You need to have a running context server or cluster of servers before
+executing the tests.
+
+Test parameteres are editable in the performance-tests/src/test/scala/unomi/Parameters.scala file. baseUrls should
+contains the URLs of all your cluster nodes
+
+Run the test by using the gatling.conf file in performance-tests/src/test/resources :
+
+[source]
+----
+ export GATLING_CONF=<path>/performance-tests/src/test/resources
+ gatling.sh
+----
+
+Reports are generated in performance-tests/target/results.
+
+==== Testing with an example page
+
+A default test page is provided at the following URL:
+
+[source]
+----
+ http://localhost:8181/index.html
+----
+
+This test page will trigger the loading of the /context.js script, which will try to retrieving the user context
+or create a new one if it doesn't exist yet. It also contains an experimental integration with Facebook Login, but it
+doesn't yet save the context back to the context server.
+
+==== Integrating onto a page
+
+Simply reference the context script in your HTML as in the following example:
+
+[source,javascript]
+----
+<script type="text/javascript">
+ (function(){ var u=(("https:" ==== document.location.protocol) ? "https://localhost:8181/" : "http://localhost:8181/");
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.defer=true; g.async=true; g.src=u+'context.js';
+ s.parentNode.insertBefore(g,s); })();
+</script>
+----
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/clustering.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/clustering.adoc b/manual/src/main/asciidoc/clustering.adoc
new file mode 100644
index 0000000..0abc1f5
--- /dev/null
+++ b/manual/src/main/asciidoc/clustering.adoc
@@ -0,0 +1,83 @@
+//
+// Licensed 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.
+//
+=== Cluster setup
+
+Apache Karaf relies on Apache Karaf Cellar, which in turn uses Hazelcast to discover and configure its cluster.
+You just need to install multiple context servers on the same network, and then (optionally) change the Hazelcast
+ configuration in the following file :
+
+[source]
+----
+etc/hazelcast.xml
+----
+
+All nodes on the same network, sharing the same cluster name will be part of the same cluster.
+
+For the actual ElasticSearch configuration however, this must be done using the following file:
+
+[source]
+----
+etc/org.apache.unomi.persistence.elasticsearch.cfg
+----
+
+Depending on the cluster size, you will want to adjust the following parameters to make sure your setup is optimal in
+terms of performance and safety.
+
+==== 2 nodes configuration
+
+One node dedicated to context server, 1 node for elasticsearch storage.
+
+Node A :
+
+[source]
+----
+numberOfReplicas=0
+monthlyIndex.numberOfReplicas=0
+----
+
+Node B :
+
+[source]
+----
+numberOfReplicas=0
+monthlyIndex.numberOfReplicas=0
+----
+
+==== 3 nodes configuration
+
+One node dedicated to context server, 2 nodes for elasticsearch storage with fault-tolerance
+
+Node A :
+
+[source]
+----
+numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+----
+
+Node B :
+
+[source]
+----
+numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+----
+
+Node C :
+
+[source]
+----
+numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+----
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/concepts.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/concepts.adoc b/manual/src/main/asciidoc/concepts.adoc
new file mode 100644
index 0000000..0849fcc
--- /dev/null
+++ b/manual/src/main/asciidoc/concepts.adoc
@@ -0,0 +1,125 @@
+//
+// Licensed 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.
+//
+Apache Unomi gathers information about users actions, information that is processed and stored by Unomi services. The collected information can then be used to personalize content, derive insights on user behavior, categorize the user profiles into segments along user-definable dimensions or acted upon by algorithms.
+
+=== Items and types
+
+Unomi structures the information it collects using the concept of `Item` which provides the base information (an identifier and a type) the context server needs to process and store the data. Items are persisted according to their type (structure) and identifier (identity). This base structure can be extended, if needed, using properties in the form of key-value pairs.
+
+These properties are further defined by the `Item`’s type definition which explicits the `Item`’s structure and semantics. By defining new types, users specify which properties (including the type of values they accept) are available to items of that specific type.
+
+Unomi defines default value types: `date`, `email`, `integer` and `string`, all pretty self-explanatory. While you can think of these value types as "primitive" types, it is possible to extend Unomi by providing additional value types.
+
+Additionally, most items are also associated to a scope, which is a concept that Unomi uses to group together related items. A given scope is represented in Unomi by a simple string identifier and usually represents an application or set of applications from which Unomi gathers data, depending on the desired analysis granularity. In the context of web sites, a scope could, for example, represent a site or family of related sites being analyzed. Scopes allow clients accessing the context server to filter data to only see relevant data.
+
+_Base `Item` structure:_
+
+[source,json]
+----
+{
+ "itemType": <type of the item>,
+ "scope": <scope>,
+ "itemId": <item identifier>,
+ "properties": <optional properties>
+}
+----
+
+Some types can be dynamically defined at runtime by calling to the REST API while other extensions are done via Unomi plugins. Part of extending Unomi, therefore, is a matter of defining new types and specifying which kind of Unomi entity (e.g. profiles) they can be affected to. For example, the following JSON document can be passed to Unomi to declare a new property type identified (and named) `tweetNb`, tagged with the `social` tag, targeting profiles and using the `integer` value type.
+
+_Example JSON type definition:_
+
+[source,json]
+----
+{
+ "itemId": "tweetNb",
+ "itemType": "propertyType",
+ "metadata": {
+ "id": "tweetNb",
+ "name": "tweetNb",
+ "systemTags": ["social"]
+ },
+ "target": "profiles",
+ "type": "integer"
+}
+----
+
+____
+
+Unomi defines a built-in scope (called `systemscope`) that clients can use to share data across scopes.
+____
+
+=== Events
+
+Users' actions are conveyed from clients to the context server using events. Of course, the required information depends on what is collected and users' interactions with the observed systems but events minimally provide a type, a scope and source and target items. Additionally, events are timestamped. Conceptually, an event can be seen as a sentence, the event's type being the verb, the source the subject and the target the object.
+
+_Event structure:_
+
+[source,json]
+----
+{
+ "eventType": <type of the event>,
+ "scope": <scope of the event>,
+ "source": <Item>,
+ "target": <Item>,
+ "properties": <optional properties>
+}
+----
+
+Source and target can be any Unomi item but are not limited to them. In particular, as long as they can be described using properties and Unomi’s type mechanism and can be processed either natively or via extension plugins, source and target can represent just about anything. Events can also be triggered as part of Unomi’s internal processes for example when a rule is triggered.
+
+Events are sent to Unomi from client applications using the JSON format and a typical page view event from a web site could look something like the following:
+
+_Example page view event:_
+
+[source,json]
+----
+{
+ "eventType": "view",
+ "scope": "ACMESPACE",
+ "source": {
+ "itemType": "site",
+ "scope": "ACMESPACE",
+ "itemId": "c4761bbf-d85d-432b-8a94-37e866410375"
+ },
+ "target": {
+ "itemType": "page",
+ "scope": "ACMESPACE",
+ "itemId": "b6acc7b3-6b9d-4a9f-af98-54800ec13a71",
+ "properties": {
+ "pageInfo": {
+ "pageID": "b6acc7b3-6b9d-4a9f-af98-54800ec13a71",
+ "pageName": "Home",
+ "pagePath": "/sites/ACMESPACE/home",
+ "destinationURL": "http://localhost:8080/sites/ACMESPACE/home.html",
+ "referringURL": "http://localhost:8080/",
+ "language": "en"
+ },
+ "category": {},
+ "attributes": {}
+ }
+ }
+}
+----
+
+=== Profiles
+
+By processing events, Unomi progressively builds a picture of who the user is and how they behave. This knowledge is embedded in `Profile` object. A profile is an `Item` with any number of properties and optional segments and scores. Unomi provides default properties to cover common data (name, last name, age, email, etc.) as well as default segments to categorize users. Unomi users are, however, free and even encouraged to create additional properties and segments to better suit their needs.
+
+Contrary to other Unomi items, profiles are not part of a scope since we want to be able to track the associated user across applications. For this reason, data collected for a given profile in a specific scope is still available to any scoped item that accesses the profile information.
+
+It is interesting to note that there is not necessarily a one to one mapping between users and profiles as users can be captured across applications and different observation contexts. As identifying information might not be available in all contexts in which data is collected, resolving profiles to a single physical user can become complex because physical users are not observed directly. Rather, their portrait is progressively patched together and made clearer as Unomi captures more and more traces of their actions. Unomi will merge related profiles as soon as collected data permits positive association between distinct profiles, usually as a result of the user performing some identifying action in a context where the user hadn’t already been positively identified.
+
+=== Sessions
+
+A session represents a time-bounded interaction between a user (via their associated profile) and a Unomi-enabled application. A session represents the sequence of actions the user performed during its duration. For this reason, events are associated with the session during which they occurred. In the context of web applications, sessions are usually linked to HTTP sessions.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/configuration.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/configuration.adoc b/manual/src/main/asciidoc/configuration.adoc
new file mode 100644
index 0000000..d6103e8
--- /dev/null
+++ b/manual/src/main/asciidoc/configuration.adoc
@@ -0,0 +1,397 @@
+//
+// Licensed 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.
+//
+=== Configuration
+
+==== Changing the default configuration
+
+If you want to change the default configuration, you can perform any modification you want in the $MY_KARAF_HOME/etc directory.
+
+The context server configuration is kept in the $MY_KARAF_HOME/etc/org.apache.unomi.cluster.cfg . It defines the
+addresses where it can be found :
+
+[source]
+----
+contextserver.publicAddress=https://localhost:9443
+contextserver.internalAddress=http://127.0.0.1:8181
+----
+
+If you need to specify an Elasticsearch cluster name, or a host and port that are different than the default,
+it is recommended to do this BEFORE you start the server for the first time, or you will loose all the data
+you have stored previously.
+
+To change these settings, you will need to modify a file called
+
+[source]
+----
+$MY_KARAF_HOME/etc/org.apache.unomi.persistence.elasticsearch.cfg
+----
+
+with the following contents:
+
+[source]
+----
+cluster.name=contextElasticSearch
+# The elasticSearchAddresses may be a comma seperated list of host names and ports such as
+# hostA:9300,hostB:9300
+# Note: the port number must be repeated for each host.
+elasticSearchAddresses=localhost:9300
+index.name=context
+----
+
+==== Secured events configuration
+
+Unomi secures some events by default. You can find the default configuration in the following file (created after the
+first server startup):
+
+[source]
+----
+$MY_KARAF_HOME/etc/org.apache.unomi.thirdparty.cfg
+----
+
+Ususally, login events, which operate on profiles and do merge on protected properties, must be secured. For each
+trusted third party server, you need to add these 3 lines :
+
+[source]
+----
+thirdparty.provider1.key=secret-key
+thirdparty.provider1.ipAddresses=127.0.0.1,::1
+thirdparty.provider1.allowedEvents=login,updateProperties
+----
+
+The events set in allowedEvents will be secured and will only be accepted if the call comes from the specified IP
+address, and if the secret-key is passed in the X-Unomi-Peer header.
+
+==== Installing the MaxMind GeoIPLite2 IP lookup database
+
+The Context Server requires an IP database in order to resolve IP addresses to user location.
+The GeoLite2 database can be downloaded from MaxMind here :
+http://dev.maxmind.com/geoip/geoip2/geolite2/[http://dev.maxmind.com/geoip/geoip2/geolite2/]
+
+Simply download the GeoLite2-City.mmdb file into the "etc" directory.
+
+==== Installing Geonames database
+
+Context server includes a geocoding service based on the geonames database ( http://www.geonames.org/[http://www.geonames.org/] ). It can be
+used to create conditions on countries or cities.
+
+In order to use it, you need to install the Geonames database into . Get the "allCountries.zip" database from here :
+http://download.geonames.org/export/dump/[http://download.geonames.org/export/dump/]
+
+Download it and put it in the "etc" directory, without unzipping it.
+Edit $MY_KARAF_HOME/etc/org.apache.unomi.geonames.cfg and set request.geonamesDatabase.forceImport to true, import should start right away.
+Otherwise, import should start at the next startup. Import runs in background, but can take about 15 minutes.
+At the end, you should have about 4 million entries in the geonames index.
+
+==== REST API Security
+
+The Context Server REST API is protected using JAAS authentication and using Basic or Digest HTTP auth.
+By default, the login/password for the REST API full administrative access is "karaf/karaf".
+
+The generated package is also configured with a default SSL certificate. You can change it by following these steps :
+
+.
+
+Replace the existing keystore in $MY_KARAF_HOME/etc/keystore by your own certificate :
+
+http://wiki.eclipse.org/Jetty/Howto/Configure_SSL[http://wiki.eclipse.org/Jetty/Howto/Configure_SSL]
+
+.
+
+Update the keystore and certificate password in $MY_KARAF_HOME/etc/custom.properties file :
+
+[source]
+----
+ org.osgi.service.http.secure.enabled = true
+ org.ops4j.pax.web.ssl.keystore=${karaf.etc}/keystore
+ org.ops4j.pax.web.ssl.password=changeme
+ org.ops4j.pax.web.ssl.keypassword=changeme
+ org.osgi.service.http.port.secure=9443
+----
+
+You should now have SSL setup on Karaf with your certificate, and you can test it by trying to access it on port 9443.
+
+. Changing the default Karaf password can be done by modifying the etc/users.properties file
+
+==== Automatic profile merging
+
+The context server is capable of merging profiles based on a common property value. In order to use this, you must
+add the MergeProfileOnPropertyAction to a rule (such as a login rule for example), and configure it with the name
+ of the property that will be used to identify the profiles to be merged. An example could be the "email" property,
+ meaning that if two (or more) profiles are found to have the same value for the "email" property they will be merged
+ by this action.
+
+Upon merge, the old profiles are marked with a "mergedWith" property that will be used on next profile access to delete
+the original profile and replace it with the merged profile (aka "master" profile). Once this is done, all cookie tracking
+will use the merged profile.
+
+To test, simply configure the action in the "login" or "facebookLogin" rules and set it up on the "email" property.
+Upon sending one of the events, all matching profiles will be merged.
+
+==== Securing a production environment
+
+Before going live with a project, you should _absolutely_ read the following section that will help you setup a proper
+secure environment for running your context server.
+
+Step 1: Install and configure a firewall
+
+You should setup a firewall around your cluster of context servers and/or Elasticsearch nodes. If you have an
+application-level firewall you should only allow the following connections open to the whole world :
+
+* http://localhost:8181/context.js[http://localhost:8181/context.js]
+* http://localhost:8181/eventcollector[http://localhost:8181/eventcollector]
+
+All other ports should not be accessible to the world.
+
+For your Context Server client applications (such as the Jahia CMS), you will need to make the following ports
+accessible :
+
+[source]
+----
+8181 (Context Server HTTP port)
+9443 (Context Server HTTPS port)
+----
+
+The context server actually requires HTTP Basic Auth for access to the Context Server administration REST API, so it is
+highly recommended that you design your client applications to use the HTTPS port for accessing the REST API.
+
+The user accounts to access the REST API are actually routed through Karaf's JAAS support, which you may find the
+documentation for here :
+
+* http://karaf.apache.org/manual/latest/users-guide/security.html[http://karaf.apache.org/manual/latest/users-guide/security.html]
+
+The default username/password is
+
+[source]
+----
+karaf/karaf
+----
+
+You should really change this default username/password as soon as possible. To do so, simply modify the following
+file :
+
+[source]
+----
+$MY_KARAF_HOME/etc/users.properties
+----
+
+For your context servers, and for any standalone Elasticsearch nodes you will need to open the following ports for proper
+node-to-node communication : 9200 (Elasticsearch REST API), 9300 (Elasticsearch TCP transport)
+
+Of course any ports listed here are the default ports configured in each server, you may adjust them if needed.
+
+Step 2 : Follow industry recommended best practices for securing Elasticsearch
+
+You may find more valuable recommendations here :
+
+* https://www.elastic.co/blog/found-elasticsearch-security[https://www.elastic.co/blog/found-elasticsearch-security]
+* https://www.elastic.co/blog/scripting-security[https://www.elastic.co/blog/scripting-security]
+
+Step 4 : Setup a proxy in front of the context server
+
+As an alternative to an application-level firewall, you could also route all traffic to the context server through
+a proxy, and use it to filter any communication.
+
+==== Integrating with an Apache HTTP web server
+
+If you want to setup an Apache HTTP web server in from of Apache Unomi, here is an example configuration using
+mod_proxy.
+
+In your Unomi package directory, in /etc/org.apache.unomi.cluster.cfg for unomi.apache.org
+
+contextserver.publicAddress=https://unomi.apache.org/
+ contextserver.internalAddress=http://192.168.1.1:8181
+
+and you will also need to change the contextserver.domain in the /etc/org.apache.unomi.web.cfg file
+
+contextserver.domain=apache.org
+
+Main virtual host config:
+
+[source]
+----
+<VirtualHost *:80>
+ Include /var/www/vhosts/unomi.apache.org/conf/common.conf
+</VirtualHost>
+
+<IfModule mod_ssl.c>
+ <VirtualHost *:443>
+ Include /var/www/vhosts/unomi.apache.org/conf/common.conf
+
+ SSLEngine on
+
+ SSLCertificateFile /var/www/vhosts/unomi.apache.org/conf/ssl/24d5b9691e96eafa.crt
+ SSLCertificateKeyFile /var/www/vhosts/unomi.apache.org/conf/ssl/apache.org.key
+ SSLCertificateChainFile /var/www/vhosts/unomi.apache.org/conf/ssl/gd_bundle-g2-g1.crt
+
+ <FilesMatch "\.(cgi|shtml|phtml|php)$">
+ SSLOptions +StdEnvVars
+ </FilesMatch>
+ <Directory /usr/lib/cgi-bin>
+ SSLOptions +StdEnvVars
+ </Directory>
+ BrowserMatch "MSIE [2-6]" \
+ nokeepalive ssl-unclean-shutdown \
+ downgrade-1.0 force-response-1.0
+ BrowserMatch "MSIE [17-9]" ssl-unclean-shutdown
+
+ </VirtualHost>
+</IfModule>
+----
+
+common.conf:
+
+[source]
+----
+ServerName unomi.apache.org
+ServerAdmin webmaster@apache.org
+
+DocumentRoot /var/www/vhosts/unomi.apache.org/html
+CustomLog /var/log/apache2/access-unomi.apache.org.log combined
+<Directory />
+ Options FollowSymLinks
+ AllowOverride None
+</Directory>
+<Directory /var/www/vhosts/unomi.apache.org/html>
+ Options FollowSymLinks MultiViews
+ AllowOverride None
+ Order allow,deny
+ allow from all
+</Directory>
+<Location /cxs>
+ Order deny,allow
+ deny from all
+ allow from 88.198.26.2
+ allow from www.apache.org
+</Location>
+
+RewriteEngine On
+RewriteCond %{REQUEST_METHOD} ^(TRACE|TRACK)
+RewriteRule .* - [F]
+ProxyPreserveHost On
+ProxyPass /server-status !
+ProxyPass /robots.txt !
+
+RewriteCond %{HTTP_USER_AGENT} Googlebot [OR]
+RewriteCond %{HTTP_USER_AGENT} msnbot [OR]
+RewriteCond %{HTTP_USER_AGENT} Slurp
+RewriteRule ^.* - [F,L]
+
+ProxyPass / http://localhost:8181/ connectiontimeout=20 timeout=300 ttl=120
+ProxyPassReverse / http://localhost:8181/
+----
+
+==== Changing the default tracking location
+
+When performing localhost requests to Apache Unomi, a default location will be used to insert values into the session
+to make the location-based personalization still work. You can find the default location settings in the file :
+
+[source]
+----
+org.apache.unomi.plugins.request.cfg
+----
+
+that contains the following default settings:
+
+[source]
+----
+# The following settings represent the default position that is used for localhost requests
+defaultSessionCountryCode=CH
+defaultSessionCountryName=Switzerland
+defaultSessionCity=Geneva
+defaultSessionAdminSubDiv1=2660645
+defaultSessionAdminSubDiv2=6458783
+defaultSessionIsp=Cablecom
+defaultLatitude=46.1884341
+defaultLongitude=6.1282508
+----
+
+You might want to change these for testing or for demonstration purposes.
+
+==== Apache Karaf SSH Console
+
+The Apache Karaf SSH console is available inside Apache Unomi, but the port has been changed from the default value of
+8101 to 8102 to avoid conflicts with other Karaf-based products. So to connect to the SSH console you should use:
+
+[source]
+----
+ssh -p 8102 karaf@localhost
+----
+
+or the user/password you have setup to protect the system if you have changed it.
+
+==== ElasticSearch X-Pack Support
+
+It is now possible to use X-Pack to connect to ElasticSearch. However, for licensing reasons this is not provided out
+of the box. Here is the procedure to install X-Pack with Apache Unomi:
+
+=== Important !
+
+Do not start Unomi directly with unomi:start, perform the following steps below first !
+
+=== Installation steps
+
+. Create a directory for all the JARs that you will download, we will call it XPACK_JARS_DIRECTORY
+. Download https://artifacts.elastic.co/maven/org/elasticsearch/client/x-pack-transport/5.6.3/x-pack-transport-5.6.3.jar[https://artifacts.elastic.co/maven/org/elasticsearch/client/x-pack-transport/5.6.3/x-pack-transport-5.6.3.jar] to XPACK_JARS_DIRECTORY
+. Download https://artifacts.elastic.co/maven/org/elasticsearch/plugin/x-pack-api/5.6.3/x-pack-api-5.6.3.jar[https://artifacts.elastic.co/maven/org/elasticsearch/plugin/x-pack-api/5.6.3/x-pack-api-5.6.3.jar] to XPACK_JARS_DIRECTORY
+. Download http://central.maven.org/maven2/com/unboundid/unboundid-ldapsdk/3.2.0/unboundid-ldapsdk-3.2.0.jar[http://central.maven.org/maven2/com/unboundid/unboundid-ldapsdk/3.2.0/unboundid-ldapsdk-3.2.0.jar] to XPACK_JARS_DIRECTORY
+. Download http://central.maven.org/maven2/org/bouncycastle/bcpkix-jdk15on/1.55/bcpkix-jdk15on-1.55.jar[http://central.maven.org/maven2/org/bouncycastle/bcpkix-jdk15on/1.55/bcpkix-jdk15on-1.55.jar] to XPACK_JARS_DIRECTORY
+. Download http://central.maven.org/maven2/org/bouncycastle/bcprov-jdk15on/1.55/bcprov-jdk15on-1.55.jar[http://central.maven.org/maven2/org/bouncycastle/bcprov-jdk15on/1.55/bcprov-jdk15on-1.55.jar] to XPACK_JARS_DIRECTORY
+. Download http://central.maven.org/maven2/com/sun/mail/javax.mail/1.5.3/javax.mail-1.5.3.jar[http://central.maven.org/maven2/com/sun/mail/javax.mail/1.5.3/javax.mail-1.5.3.jar] to XPACK_JARS_DIRECTORY
+.
+
+Edit etc/org.apache.unomi.persistence.elasticsearch.cfg to add the following settings:
+
+[source]
+----
+transportClientClassName=org.elasticsearch.xpack.client.PreBuiltXPackTransportClient
+transportClientJarDirectory=XPACK_JARS_DIRECTORY
+transportClientProperties=xpack.security.user=elastic:changeme
+----
+
+You can setup more properties (for example for SSL/TLS support) by seperating the properties with commas,
+as in the following example:
+
+[source]
+----
+transportClientProperties=xpack.security.user=elastic:changeme,xpack.ssl.key=/home/user/elasticsearch-5.6.3/config/x-pack/localhost/localhost.key,xpack.ssl.certificate=/home/user/elasticsearch-5.6.3/config/x-pack/localhost/localhost.crt,xpack.ssl.certificate_authorities=/home/user/elasticsearch-5.6.3/config/x-pack/ca/ca.crt,xpack.security.transport.ssl.enabled=true
+----
+
+.
+
+Launch Karaf and launch unomi using the command from the shell :
+
+[source]
+----
+unomi:start
+----
+
+Alternatively you could edit the configuration directly from the Karaf shell using the following commands:
+
+[source]
+----
+config:edit org.apache.unomi.persistence.elasticsearch
+config:property-set transportClientClassName org.elasticsearch.xpack.client.PreBuiltXPackTransportClient
+config:property-set transportClientJarDirectory XPACK_JARS_DIRECTORY
+config:property-set transportClientProperties xpack.security.user=elastic:changeme
+config:update
+unomi:start
+----
+
+You can setup more properties (for example for SSL/TLS support) by seperating the properties with commas,
+as in the following example:
+
+[source]
+----
+config:property-set transportClientProperties xpack.security.user=elastic:changeme,xpack.ssl.key=/home/user/elasticsearch-5.6.3/config/x-pack/localhost/localhost.key,xpack.ssl.certificate=/home/user/elasticsearch-5.6.3/config/x-pack/localhost/localhost.crt,xpack.ssl.certificate_authorities=/home/user/elasticsearch-5.6.3/config/x-pack/ca/ca.crt,xpack.security.transport.ssl.enabled=true
+----
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/837c4628/manual/src/main/asciidoc/connectors/connectors.adoc
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/connectors/connectors.adoc b/manual/src/main/asciidoc/connectors/connectors.adoc
new file mode 100644
index 0000000..ee3551b
--- /dev/null
+++ b/manual/src/main/asciidoc/connectors/connectors.adoc
@@ -0,0 +1,22 @@
+//
+// Licensed 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.
+//
+=== Connectors
+
+Apache Unomi provides the following connectors:
+
+* link:salesforce-connectors.html[Salesforce CRM connectors]
+
+==== Call for contributors
+
+We are looking for help with the development of additional connectors. Any contribution (large or small) is more than welcome. Feel free to discuss this in our link:../../mail-lists.html[mailing list].
\ No newline at end of file
[5/8] incubator-unomi git commit: Add archives versions of
documentation in asciidoc
Posted by sh...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/concepts.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/concepts.adoc b/manual/src/archives/1.2/asciidoc/concepts.adoc
new file mode 100644
index 0000000..f7e034c
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/concepts.adoc
@@ -0,0 +1,234 @@
+//
+// Licensed 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.
+//
+
+=== Concepts
+
+Apache Unomi gathers information about users actions, information that is processed and stored by Unomi services. The collected information can then be used to personalize content, derive insights on user behavior, categorize the user profiles into segments along user-definable dimensions or acted upon by algorithms.
+
+==== Items and types
+
+Unomi structures the information it collects using the concept of `Item` which provides the base information (an identifier and a type) the context server needs to process and store the data. Items are persisted according to their type (structure) and identifier (identity). This base structure can be extended, if needed, using properties in the form of key-value pairs.
+
+These properties are further defined by the `Item`’s type definition which explicits the `Item`’s structure and semantics. By defining new types, users specify which properties (including the type of values they accept) are available to items of that specific type.
+
+Unomi defines default value types: `date`, `email`, `integer` and `string`, all pretty self-explanatory. While you can think of these value types as "primitive" types, it is possible to extend Unomi by providing additional value types.
+
+Additionally, most items are also associated to a scope, which is a concept that Unomi uses to group together related items. A given scope is represented in Unomi by a simple string identifier and usually represents an application or set of applications from which Unomi gathers data, depending on the desired analysis granularity. In the context of web sites, a scope could, for example, represent a site or family of related sites being analyzed. Scopes allow clients accessing the context server to filter data to only see relevant data.
+
+_Base `Item` structure:_
+
+[source,json]
+----
+{
+ "itemType": <type of the item>,
+ "scope": <scope>,
+ "itemId": <item identifier>,
+ "properties": <optional properties>
+}
+----
+
+Some types can be dynamically defined at runtime by calling to the REST API while other extensions are done via Unomi plugins. Part of extending Unomi, therefore, is a matter of defining new types and specifying which kind of Unomi entity (e.g. profiles) they can be affected to. For example, the following JSON document can be passed to Unomi to declare a new property type identified (and named) `tweetNb`, tagged with the `social` tag, targeting profiles and using the `integer` value type.
+
+_Example JSON type definition:_
+
+[source,json]
+----
+{
+ "itemId": "tweetNb",
+ "itemType": "propertyType",
+ "metadata": {
+ "id": "tweetNb",
+ "name": "tweetNb"
+ },
+ "tags": ["social"],
+ "target": "profiles",
+ "type": "integer"
+}
+----
+
+____
+
+Unomi defines a built-in scope (called `systemscope`) that clients can use to share data across scopes.
+
+____
+
+==== Events
+
+Users' actions are conveyed from clients to the context server using events. Of course, the required information depends on what is collected and users' interactions with the observed systems but events minimally provide a type, a scope and source and target items. Additionally, events are timestamped. Conceptually, an event can be seen as a sentence, the event's type being the verb, the source the subject and the target the object.
+
+_Event structure:_
+
+[source,json]
+----
+{
+ "eventType": <type of the event>,
+ "scope": <scope of the event>,
+ "source": <Item>,
+ "target": <Item>,
+ "properties": <optional properties>
+}
+----
+
+Source and target can be any Unomi item but are not limited to them. In particular, as long as they can be described using properties and Unomi’s type mechanism and can be processed either natively or via extension plugins, source and target can represent just about anything. Events can also be triggered as part of Unomi’s internal processes for example when a rule is triggered.
+
+Events are sent to Unomi from client applications using the JSON format and a typical page view event from a web site could look something like the following:
+
+_Example page view event:_
+
+[source,json]
+----
+{
+ "eventType": "view",
+ "scope": "ACMESPACE",
+ "source": {
+ "itemType": "site",
+ "scope": "ACMESPACE",
+ "itemId": "c4761bbf-d85d-432b-8a94-37e866410375"
+ },
+ "target": {
+ "itemType": "page",
+ "scope": "ACMESPACE",
+ "itemId": "b6acc7b3-6b9d-4a9f-af98-54800ec13a71",
+ "properties": {
+ "pageInfo": {
+ "pageID": "b6acc7b3-6b9d-4a9f-af98-54800ec13a71",
+ "pageName": "Home",
+ "pagePath": "/sites/ACMESPACE/home",
+ "destinationURL": "http://localhost:8080/sites/ACMESPACE/home.html",
+ "referringURL": "http://localhost:8080/",
+ "language": "en"
+ },
+ "category": {},
+ "attributes": {}
+ }
+ }
+}
+----
+
+==== Profiles
+
+By processing events, Unomi progressively builds a picture of who the user is and how they behave. This knowledge is embedded in `Profile` object. A profile is an `Item` with any number of properties and optional segments and scores. Unomi provides default properties to cover common data (name, last name, age, email, etc.) as well as default segments to categorize users. Unomi users are, however, free and even encouraged to create additional properties and segments to better suit their needs.
+
+Contrary to other Unomi items, profiles are not part of a scope since we want to be able to track the associated user across applications. For this reason, data collected for a given profile in a specific scope is still available to any scoped item that accesses the profile information.
+
+It is interesting to note that there is not necessarily a one to one mapping between users and profiles as users can be captured across applications and different observation contexts. As identifying information might not be available in all contexts in which data is collected, resolving profiles to a single physical user can become complex because physical users are not observed directly. Rather, their portrait is progressively patched together and made clearer as Unomi captures more and more traces of their actions. Unomi will merge related profiles as soon as collected data permits positive association between distinct profiles, usually as a result of the user performing some identifying action in a context where the user hadn’t already been positively identified.
+
+==== Sessions
+
+A session represents a time-bounded interaction between a user (via their associated profile) and a Unomi-enabled application. A session represents the sequence of actions the user performed during its duration. For this reason, events are associated with the session during which they occurred. In the context of web applications, sessions are usually linked to HTTP sessions.
+
+
+=== Extending Unomi via plugins
+
+Unomi is architected so that users can provided extensions in the form of plugins.
+
+==== Types vs. instances
+
+Several extension points in Unomi rely on the concept of type: the extension defines a prototype for what the actual items will be once parameterized with values known only at runtime. This is similar to the concept of classes in object-oriented programming: types define classes, providing the expected structure and which fields are expected to be provided at runtime, that are then instantiated when needed with actual values.
+
+==== Plugin structure
+
+Being built on top of Apache Karaf, Unomi leverages OSGi to support plugins. A Unomi plugin is, thus, an OSGi bundle specifying some specific metadata to tell Unomi the kind of entities it provides. A plugin can provide the following entities to extend Unomi, each with its associated definition (as a JSON file), located in a specific spot within the `META-INF/cxs/` directory of the bundle JAR file:
+
+|===
+|Entity |Location in `cxs` directory
+
+|ActionType |actions
+|ConditionType |conditions
+|Persona |personas
+|PropertyMergeStrategyType |mergers
+|PropertyType |properties then profiles or sessions subdirectory then `<category name>` directory
+|Rule |rules
+|Scoring |scorings
+|Segment |segments
+|Tag |tags then `<category name>` directory
+|ValueType |values
+|===
+
+http://aries.apache.org/modules/blueprint.html[Blueprint] is used to declare what the plugin provides and inject any required dependency. The Blueprint file is located, as usual, at `OSGI-INF/blueprint/blueprint.xml` in the bundle JAR file.
+
+The plugin otherwise follows a regular maven project layout and should depend on the Unomi API maven artifact:
+
+[source,xml]
+----
+<dependency>
+ <groupId>org.apache.unomi</groupId>
+ <artifactId>unomi-api</artifactId>
+ <version>...</version>
+</dependency>
+----
+
+Some plugins consists only of JSON definitions that are used to instantiate the appropriate structures at runtime while some more involved plugins provide code that extends Unomi in deeper ways.
+
+In both cases, plugins can provide more that one type of extension. For example, a plugin could provide both `ActionType`s and `ConditionType`s.
+
+==== Extension points
+
+===== ActionType
+
+`ActionType`s define new actions that can be used as consequences of Rules being triggered. When a rule triggers, it creates new actions based on the event data and the rule internal processes, providing values for parameters defined in the associated `ActionType`. Example actions include: “Set user property x to value y” or “Send a message to service x”.
+
+===== ConditionType
+
+`ConditionType`s define new conditions that can be applied to items (for example to decide whether a rule needs to be triggered or if a profile is considered as taking part in a campaign) or to perform queries against the stored Unomi data. They may be implemented in Java when attempting to define a particularly complex test or one that can better be optimized by coding it. They may also be defined as combination of other conditions. A simple condition could be: “User is male”, while a more generic condition with parameters may test whether a given property has a specific value: “User property x has value y”.
+
+===== Persona
+
+A persona is a "virtual" profile used to represent categories of profiles, and may also be used to test how a personalized experience would look like using this virtual profile. A persona can define predefined properties and sessions. Persona definition make it possible to “emulate” a certain type of profile, e.g : US visitor, non-US visitor, etc.
+
+===== PropertyMergeStrategyType
+
+A strategy to resolve how to merge properties when merging profile together.
+
+===== PropertyType
+
+Definition for a profile or session property, specifying how possible values are constrained, if the value is multi-valued (a vector of values as opposed to a scalar value). `PropertyType`s can also be categorized using tags or file system structure, using sub-directories to organize definition files.
+
+===== Rule
+
+`Rule`s are conditional sets of actions to be executed in response to incoming events. Triggering of rules is guarded by a condition: the rule is only triggered if the associated condition is satisfied. That condition can test the event itself, but also the profile or the session. Once a rule triggers, a list of actions can be performed as consequences. Also, when rules trigger, a specific event is raised so that other parts of Unomi can react accordingly.
+
+===== Scoring
+
+`Scoring`s are set of conditions associated with a value to assign to profiles when matching so that the associated users can be scored along that dimension. Each scoring element is evaluated and matching profiles' scores are incremented with the associated value.
+
+===== Segments
+
+`Segment`s represent dynamically evaluated groups of similar profiles in order to categorize the associated users. To be considered part of a given segment, users must satisfies the segment’s condition. If they match, users are automatically added to the segment. Similarly, if at any given point during, they cease to satisfy the segment’s condition, they are automatically removed from it.
+
+===== Tag
+
+`Tag`s are simple labels that are used to classify all other objects inside Unomi. Tags can define sub-tags.
+
+===== ValueType
+
+Definition for values that can be assigned to properties ("primitive" types).
+
+==== Other Unomi entities
+
+===== UserList
+
+User list are simple static lists of users. The associated profile stores the lists it belongs to in a specific property.
+
+===== Goal
+
+Goals represent tracked activities / actions that can be accomplished by site (or more precisely scope) visitors. These are tracked in general because they relate to specific business objectives or are relevant to measure site/scope performance.
+
+Goals can be defined at the scope level or in the context of a particular `Campaign`. Either types of goals behave exactly the same way with the exception of two notable differences:
+ - duration: scope-level goals are considered until removed while campaign-level goals are only considered for the campaign duration
+ - audience filtering: any visitor is considered for scope-level goals while campaign-level goals only consider visitors who match the campaign's conditions
+
+===== Campaign
+
+A goal-oriented, time-limited marketing operation that needs to be evaluated for return on investment performance by tracking the ratio of visits to conversions.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/configuration.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/configuration.adoc b/manual/src/archives/1.2/asciidoc/configuration.adoc
new file mode 100644
index 0000000..2d915f5
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/configuration.adoc
@@ -0,0 +1,345 @@
+//
+// Licensed 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.
+//
+
+=== Configuration
+
+==== Changing the default configuration
+
+If you want to change the default configuration, you can perform any modification you want in the $MY_KARAF_HOME/etc directory.
+
+The context server configuration is kept in the $MY_KARAF_HOME/etc/org.apache.unomi.cluster.cfg . It defines the
+addresses where it can be found :
+
+[source]
+----
+contextserver.publicAddress=https://localhost:9443
+contextserver.internalAddress=http://127.0.0.1:8181
+----
+
+If you need to specify an Elasticsearch cluster name, or a host and port that are different than the default,
+it is recommended to do this BEFORE you start the server for the first time, or you will loose all the data
+you have stored previously.
+
+To change these settings, you will need to modify a file called
+
+[source]
+----
+$MY_KARAF_HOME/etc/org.apache.unomi.persistence.elasticsearch.cfg
+----
+
+with the following contents:
+
+[source]
+----
+cluster.name=contextElasticSearch
+# The elasticSearchAddresses may be a comma seperated list of host names and ports such as
+# hostA:9300,hostB:9300
+# Note: the port number must be repeated for each host.
+elasticSearchAddresses=localhost:9300
+index.name=context
+----
+
+==== Secured events configuration
+
+If you need to secure some events, that will be sent only by a trusted third party server, you can update the file :
+
+[source]
+----
+$MY_KARAF_HOME/etc/org.apache.unomi.thirdparty.cfg
+----
+
+Ususally, login events, which operate on profiles and do merge on protected properties, must be secured. For each
+trusted third party server, you need to add these 3 lines :
+
+[source]
+----
+thirdparty.provider1.key=secret-key
+thirdparty.provider1.ipAddresses=127.0.0.1,::1
+thirdparty.provider1.allowedEvents=login,download
+----
+
+The events set in allowedEvents will be secured and will only be accepted if the call comes from the specified IP
+address, and if the secret-key is passed in the X-Unomi-Peer header.
+
+==== Installing the MaxMind GeoIPLite2 IP lookup database
+
+The Context Server requires an IP database in order to resolve IP addresses to user location.
+The GeoLite2 database can be downloaded from MaxMind here :
+http://dev.maxmind.com/geoip/geoip2/geolite2/[http://dev.maxmind.com/geoip/geoip2/geolite2/]
+
+Simply download the GeoLite2-City.mmdb file into the "etc" directory.
+
+==== Installing Geonames database
+
+Context server includes a geocoding service based on the geonames database ( http://www.geonames.org/[http://www.geonames.org/] ). It can be
+used to create conditions on countries or cities.
+
+In order to use it, you need to install the Geonames database into . Get the "allCountries.zip" database from here :
+http://download.geonames.org/export/dump/[http://download.geonames.org/export/dump/]
+
+Download it and put it in the "etc" directory, without unzipping it.
+Edit $MY_KARAF_HOME/etc/org.apache.unomi.geonames.cfg and set request.geonamesDatabase.forceImport to true, import should start right away.
+Otherwise, import should start at the next startup. Import runs in background, but can take about 15 minutes.
+At the end, you should have about 4 million entries in the geonames index.
+
+==== REST API Security
+
+The Context Server REST API is protected using JAAS authentication and using Basic or Digest HTTP auth.
+By default, the login/password for the REST API full administrative access is "karaf/karaf".
+
+The generated package is also configured with a default SSL certificate. You can change it by following these steps :
+
+.
+
+Replace the existing keystore in $MY_KARAF_HOME/etc/keystore by your own certificate :
+
+http://wiki.eclipse.org/Jetty/Howto/Configure_SSL[http://wiki.eclipse.org/Jetty/Howto/Configure_SSL]
+
+.
+
+Update the keystore and certificate password in $MY_KARAF_HOME/etc/custom.properties file :
+
+[source]
+----
+ org.osgi.service.http.secure.enabled = true
+ org.ops4j.pax.web.ssl.keystore=${karaf.etc}/keystore
+ org.ops4j.pax.web.ssl.password=changeme
+ org.ops4j.pax.web.ssl.keypassword=changeme
+ org.osgi.service.http.port.secure=9443
+----
+
+You should now have SSL setup on Karaf with your certificate, and you can test it by trying to access it on port 9443.
+
+.
+
+Changing the default Karaf password can be done by modifying the etc/users.properties file
+
+.
+
+You will also need to change the user/password information in the org.apache.unomi.cluster.cfg file :
+
+[source]
+----
+ cluster.group=default
+ cluster.jmxUsername=karaf
+ cluster.jmxPassword=karaf
+ cluster.jmxPort=1099
+----
+
+==== Automatic profile merging
+
+The context server is capable of merging profiles based on a common property value. In order to use this, you must
+add the MergeProfileOnPropertyAction to a rule (such as a login rule for example), and configure it with the name
+ of the property that will be used to identify the profiles to be merged. An example could be the "email" property,
+ meaning that if two (or more) profiles are found to have the same value for the "email" property they will be merged
+ by this action.
+
+Upon merge, the old profiles are marked with a "mergedWith" property that will be used on next profile access to delete
+the original profile and replace it with the merged profile (aka "master" profile). Once this is done, all cookie tracking
+will use the merged profile.
+
+To test, simply configure the action in the "login" or "facebookLogin" rules and set it up on the "email" property.
+Upon sending one of the events, all matching profiles will be merged.
+
+==== Securing a production environment
+
+Before going live with a project, you should _absolutely_ read the following section that will help you setup a proper
+secure environment for running your context server.
+
+Step 1: Install and configure a firewall
+
+You should setup a firewall around your cluster of context servers and/or Elasticsearch nodes. If you have an
+application-level firewall you should only allow the following connections open to the whole world :
+
+* http://localhost:8181/context.js[http://localhost:8181/context.js]
+* http://localhost:8181/eventcollector[http://localhost:8181/eventcollector]
+
+All other ports should not be accessible to the world.
+
+For your Context Server client applications (such as the Jahia CMS), you will need to make the following ports
+accessible :
+
+[source]
+----
+8181 (Context Server HTTP port)
+9443 (Context Server HTTPS port)
+----
+
+The context server actually requires HTTP Basic Auth for access to the Context Server administration REST API, so it is
+highly recommended that you design your client applications to use the HTTPS port for accessing the REST API.
+
+The user accounts to access the REST API are actually routed through Karaf's JAAS support, which you may find the
+documentation for here :
+
+* http://karaf.apache.org/manual/latest/users-guide/security.html[http://karaf.apache.org/manual/latest/users-guide/security.html]
+
+The default username/password is
+
+[source]
+----
+karaf/karaf
+----
+
+You should really change this default username/password as soon as possible. To do so, simply modify the following
+file :
+
+[source]
+----
+$MY_KARAF_HOME/etc/users.properties
+----
+
+For your context servers, and for any standalone Elasticsearch nodes you will need to open the following ports for proper
+node-to-node communication : 9200 (Elasticsearch REST API), 9300 (Elasticsearch TCP transport)
+
+Of course any ports listed here are the default ports configured in each server, you may adjust them if needed.
+
+Step 2 : Follow industry recommended best practices for securing Elasticsearch
+
+You may find more valuable recommendations here :
+
+* https://www.elastic.co/blog/found-elasticsearch-security[https://www.elastic.co/blog/found-elasticsearch-security]
+* https://www.elastic.co/blog/scripting-security[https://www.elastic.co/blog/scripting-security]
+
+Step 4 : Setup a proxy in front of the context server
+
+As an alternative to an application-level firewall, you could also route all traffic to the context server through
+a proxy, and use it to filter any communication.
+
+==== Integrating with an Apache HTTP web server
+
+If you want to setup an Apache HTTP web server in from of Apache Unomi, here is an example configuration using
+mod_proxy.
+
+In your Unomi package directory, in /etc/org.apache.unomi.cluster.cfg for unomi.apache.org
+
+contextserver.publicAddress=https://unomi.apache.org/
+ contextserver.internalAddress=http://192.168.1.1:8181
+
+and you will also need to change the contextserver.domain in the /etc/org.apache.unomi.web.cfg file
+
+contextserver.domain=apache.org
+
+Main virtual host config:
+
+[source]
+----
+<VirtualHost *:80>
+ Include /var/www/vhosts/unomi.apache.org/conf/common.conf
+</VirtualHost>
+
+<IfModule mod_ssl.c>
+ <VirtualHost *:443>
+ Include /var/www/vhosts/unomi.apache.org/conf/common.conf
+
+ SSLEngine on
+
+ SSLCertificateFile /var/www/vhosts/unomi.apache.org/conf/ssl/24d5b9691e96eafa.crt
+ SSLCertificateKeyFile /var/www/vhosts/unomi.apache.org/conf/ssl/apache.org.key
+ SSLCertificateChainFile /var/www/vhosts/unomi.apache.org/conf/ssl/gd_bundle-g2-g1.crt
+
+ <FilesMatch "\.(cgi|shtml|phtml|php)$">
+ SSLOptions +StdEnvVars
+ </FilesMatch>
+ <Directory /usr/lib/cgi-bin>
+ SSLOptions +StdEnvVars
+ </Directory>
+ BrowserMatch "MSIE [2-6]" \
+ nokeepalive ssl-unclean-shutdown \
+ downgrade-1.0 force-response-1.0
+ BrowserMatch "MSIE [17-9]" ssl-unclean-shutdown
+
+ </VirtualHost>
+</IfModule>
+----
+
+common.conf:
+
+[source]
+----
+ServerName unomi.apache.org
+ServerAdmin webmaster@apache.org
+
+DocumentRoot /var/www/vhosts/unomi.apache.org/html
+CustomLog /var/log/apache2/access-unomi.apache.org.log combined
+<Directory />
+ Options FollowSymLinks
+ AllowOverride None
+</Directory>
+<Directory /var/www/vhosts/unomi.apache.org/html>
+ Options FollowSymLinks MultiViews
+ AllowOverride None
+ Order allow,deny
+ allow from all
+</Directory>
+<Location /cxs>
+ Order deny,allow
+ deny from all
+ allow from 88.198.26.2
+ allow from www.apache.org
+</Location>
+
+RewriteEngine On
+RewriteCond %{REQUEST_METHOD} ^(TRACE|TRACK)
+RewriteRule .* - [F]
+ProxyPreserveHost On
+ProxyPass /server-status !
+ProxyPass /robots.txt !
+
+RewriteCond %{HTTP_USER_AGENT} Googlebot [OR]
+RewriteCond %{HTTP_USER_AGENT} msnbot [OR]
+RewriteCond %{HTTP_USER_AGENT} Slurp
+RewriteRule ^.* - [F,L]
+
+ProxyPass / http://localhost:8181/ connectiontimeout=20 timeout=300 ttl=120
+ProxyPassReverse / http://localhost:8181/
+----
+
+==== Changing the default tracking location
+
+When performing localhost requests to Apache Unomi, a default location will be used to insert values into the session
+to make the location-based personalization still work. You can find the default location settings in the file :
+
+[source]
+----
+org.apache.unomi.plugins.request.cfg
+----
+
+that contains the following default settings:
+
+[source]
+----
+# The following settings represent the default position that is used for localhost requests
+defaultSessionCountryCode=CH
+defaultSessionCountryName=Switzerland
+defaultSessionCity=Geneva
+defaultSessionAdminSubDiv1=2660645
+defaultSessionAdminSubDiv2=6458783
+defaultSessionIsp=Cablecom
+defaultLatitude=46.1884341
+defaultLongitude=6.1282508
+----
+
+You might want to change these for testing or for demonstration purposes.
+
+==== Apache Karaf SSH Console
+
+The Apache Karaf SSH console is available inside Apache Unomi, but the port has been changed from the default value of
+8101 to 8102 to avoid conflicts with other Karaf-based products. So to connect to the SSH console you should use:
+
+[source]
+----
+ssh -p 8102 karaf@localhost
+----
+
+or the user/password you have setup to protect the system if you have changed it.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/connectors/connectors.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/connectors/connectors.adoc b/manual/src/archives/1.2/asciidoc/connectors/connectors.adoc
new file mode 100644
index 0000000..2b38694
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/connectors/connectors.adoc
@@ -0,0 +1,23 @@
+//
+// Licensed 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.
+//
+
+=== Connectors
+
+Apache Unomi provides the following connector:
+
+* link:salesforce-connector.html[Salesforce CRM connector]
+
+==== Call for contributors
+
+We are looking for help with the development of additional connectors. Any contribution (large or small) is more than welcome. Feel free to discuss this in our link:../../mail-lists.html[mailing list].
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/connectors/salesforce-connector.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/connectors/salesforce-connector.adoc b/manual/src/archives/1.2/asciidoc/connectors/salesforce-connector.adoc
new file mode 100644
index 0000000..0866082
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/connectors/salesforce-connector.adoc
@@ -0,0 +1,234 @@
+//
+// Licensed 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.
+//
+
+=== Apache Unomi Salesforce Connector
+
+This connector makes it possible to push and pull data to/from the Salesforce CRM. It can copy information between
+Apache Unomi profiles and Salesforce Leads.
+
+==== Getting started
+
+.
+
+Create a new developer account here:
+
+[source]
+----
+https://developer.salesforce.com/signup
+----
+
+.
+
+Create a new Connected App, by going into Setup -> App Manager and click "Create Connected App"
+
+.
+
+In the settings, make sure you do the following:
+
+[source]
+----
+Enable OAuth settings -> Activated
+Enable for device flow -> Activated (no need for a callback URL)
+Add all the selected OAuth scopes you want (or put all of them)
+Make sure Require Secret for Web Server flow is activated
+----
+
+.
+
+Make sure you retrieve the following information once you have created the app in the API (Enable OAuth Settings):
+
+[source]
+----
+Consumer key
+Consumer secret (click to see it)
+----
+
+.
+
+You must also retrieve your user's security token, or create it if you don't have one already. To do this simply
+click on your user at the top right, select "Settings", the click on "Reset my security token". You will receive an email
+with the security token.
+
+.
+
+You are now ready to configure the Apache Unomi Salesforce Connector. In the etc/org.apache.unomi.sfdc.cfg file
+change the following settings:
+
+[source]
+----
+sfdc.user.username=YOUR_USER_NAME
+sfdc.user.password=YOUR_PASSWORD
+sfdc.user.securityToken=YOUR_USER_SECURITY_TOKEN
+sfdc.consumer.key=CONNECTED_APP_CONSUMER_KEY
+sfdc.consumer.secret=CONNECTED_APP_SECRET
+----
+
+.
+
+Connected to the Apache Unomi Karaf Shell using :
+
+[source]
+----
+ssh -p 8102 karaf@localhost (default password is karaf)
+----
+
+.
+
+Deploy into Apache Unomi using the following commands from the Apache Karaf shell:
+
+[source]
+----
+feature:repo-add mvn:org.apache.unomi/unomi-salesforce-connector-karaf-kar/1.2.0-incubating-SNAPSHOT/xml/features
+feature:install unomi-salesforce-connector-karaf-kar
+----
+
+.
+
+You can then test the connection to Salesforce by accessing the following URLs:
+
+[source]
+----
+https://localhost:9443/cxs/sfdc/version
+https://localhost:9443/cxs/sfdc/limits
+----
+
+The first URL will give you information about the version of the connector, so this makes it easy to check that the
+plugin is properly deployed, started and the correct version. The second URL will actually make a request to the
+Salesforce REST API to retrieve the limits of the Salesforce API.
+
+Both URLs are password protected by the Apache Unomi (Karaf) password. You can find this user and password information
+in the etc/users.properties file.
+
+.
+
+You can now use the connector's defined actions in rules to push or pull data to/from the Salesforce CRM. You can
+find more information about rules in the link:concepts.html[Concepts] and the link:getting-started.html[Getting Started] pages.
+
+==== Troubleshooting
+
+In case you're having problem retrieving or sending data to Salesforce, make sure you check the logs (log:display from the
+Karaf shell) or in the data/log/karaf.log file. It should usually tell you what went wrong.
+
+Common problems include trying to send profiles that don't include mandatory fields in Salesforce. By default the
+mandatory fields are : Last name, Company and Email. If you are missing some mandatory fields, the connector will not
+pushed any new leads to Salesforce.
+
+==== Upgrading the Salesforce connector
+
+If you followed all the steps in the Getting Started section, you can upgrade the Salesforce connector by using the following steps:
+
+.
+
+Compile the connector using:
+
+[source]
+----
+cd extensions/salesforce-connector
+mvn clean install
+----
+
+.
+
+Login to the Unomi Karaf Shell using:
+
+[source]
+----
+ssh -p 8102 karaf@localhost (password by default is karaf)
+----
+
+.
+
+Execute the following commands in the Karaf shell
+
+[source]
+----
+feature:repo-refresh
+feature:uninstall unomi-salesforce-connector-karaf-feature
+feature:install unomi-salesforce-connector-karaf-feature
+----
+
+.
+
+You can then check that the new version is properly deployed by accessing the following URL and checking the build date:
+
+[source]
+----
+https://localhost:9443/cxs/sfdc/version
+----
+
+(if asked for a password it's the same karaf/karaf default)
+
+==== Using the Salesforce Workbench for testing REST API
+
+The Salesforce Workbench contains a REST API Explorer that is very useful to test requests. You may find it here :
+
+[source]
+----
+https://workbench.developerforce.com/restExplorer.php
+----
+
+==== Setting up Streaming Push queries
+
+Using the Salesforce Workbench, you can setting streaming push queries (Queries->Streaming push topics) such as the
+following example:
+
+[source]
+----
+Name: LeadUpdates
+Query : SELECT Id,FirstName,LastName,Email,Company FROM Lead
+----
+
+==== Executing the unit tests
+
+Before running the tests, make sure you have completed all the steps above, including the streaming push queries setup.
+
+By default the unit tests will not run as they need proper Salesforce credentials to run. To set this up create a
+properties file like the following one:
+
+test.properties
+
+[source]
+----
+#
+# 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.
+#
+sfdc.user.username=YOUR_USER_NAME
+sfdc.user.password=YOUR_PASSWORD
+sfdc.user.securityToken=YOUR_USER_SECURITY_TOKEN
+sfdc.consumer.key=CONNECTED_APP_CONSUMER_KEY
+sfdc.consumer.secret=CONNECTED_APP_SECRET
+----
+
+and then use the following command line to reference the file:
+
+[source]
+----
+cd extensions/salesforce-connector
+mvn clean install -DsfdcProperties=../test.properties
+----
+
+(in case you're wondering the ../ is because the test is located in the services sub-directory)
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/custom-extensions.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/custom-extensions.adoc b/manual/src/archives/1.2/asciidoc/custom-extensions.adoc
new file mode 100644
index 0000000..4c2b80f
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/custom-extensions.adoc
@@ -0,0 +1,413 @@
+//
+// Licensed 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.
+//
+
+=== Custom extensions
+
+Apache Unomi is a pluggeable server that may be extended in many ways. This document assumes you are familiar with the
+link:concepts.html[Apache Unomi concepts] . This document is mostly a reference document on the different things that may
+be used inside an extension. If you are looking for complete samples, please see the link:samples.html[samples page].
+
+==== Creating an extension
+
+An extension is simply a Maven project, with a Maven pom that looks like this:
+
+[source]
+----
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+ <parent>
+ <groupId>org.apache.unomi</groupId>
+ <artifactId>unomi-extensions</artifactId>
+ <version>1.2.0-incubating-SNAPSHOT</version>
+ </parent>
+
+ <modelVersion>4.0.0</modelVersion>
+
+ <artifactId>unomi-extension-example</artifactId>
+ <name>Apache Unomi :: Extensions :: Example</name>
+ <description>Service implementation for the Apache Unomi Context Server extension that integrates with the Geonames database</description>
+ <version>1.2.0-incubating-SNAPSHOT</version>
+ <packaging>bundle</packaging>
+
+ <dependencies>
+ <!-- This dependency is not required but generally used in extensions -->
+ <dependency>
+ <groupId>org.apache.unomi</groupId>
+ <artifactId>unomi-api</artifactId>
+ <version>1.2.0-incubating-SNAPSHOT</version>
+ <scope>provided</scope>
+ </dependency>
+ </dependencies>
+
+ <build>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.felix</groupId>
+ <artifactId>maven-bundle-plugin</artifactId>
+ <extensions>true</extensions>
+ <configuration>
+ <instructions>
+ <Embed-Dependency>*;scope=compile|runtime</Embed-Dependency>
+ <Import-Package>
+ sun.misc;resolution:=optional,
+ *
+ </Import-Package>
+ </instructions>
+ </configuration>
+ </plugin>
+ </plugins>
+ </build>
+</project>
+----
+
+An extension may contain many different kinds of Apache Unomi objects, as well as custom OSGi services or anything that
+is needed to build your application.
+
+==== Predefined segments
+
+You may provide pre-defined segments by simply adding a JSON file in the src/main/resources/META-INF/cxs/segments directory of
+your Maven project. Here is an example of a pre-defined segment:
+
+[source]
+----
+{
+ "metadata": {
+ "id": "leads",
+ "name": "Leads",
+ "scope": "systemscope",
+ "description": "You can customize the list below by editing the leads segment.",
+ "readOnly":true
+ },
+ "condition": {
+ "parameterValues": {
+ "subConditions": [
+ {
+ "parameterValues": {
+ "propertyName": "properties.leadAssignedTo",
+ "comparisonOperator": "exists"
+ },
+ "type": "profilePropertyCondition"
+ }
+ ],
+ "operator" : "and"
+ },
+ "type": "booleanCondition"
+ }
+}
+----
+
+Basically this segment uses a condition to test if the profile has a property `leadAssignedTo` that exists. All profiles
+that match this condition will be part of the pre-defined segment.
+
+==== Predefined rules
+
+You may provide pre-defined rules by simply adding a JSON file in the src/main/resources/META-INF/cxs/rules directory of
+your Maven project. Here is an example of a pre-defined rule:
+
+[source]
+----
+{
+ "metadata" : {
+ "id": "evaluateProfileSegments",
+ "name": "Evaluate segments",
+ "description" : "Evaluate segments when a profile is modified",
+ "readOnly":true
+ },
+
+ "condition" : {
+ "type": "profileUpdatedEventCondition",
+ "parameterValues": {
+ }
+ },
+
+ "actions" : [
+ {
+ "type": "evaluateProfileSegmentsAction",
+ "parameterValues": {
+ }
+ }
+ ]
+
+}
+----
+
+In this example we provide a rule that will execute when a predefined composed condition of type
+"profileUpdatedEventCondition" is received. See below to see how predefined composed conditions are declared.
+Once the condition is matched, the actions will be executed in sequence. In this example there is only a single
+action of type "evaluateProfileSegmentsAction" that is defined so it will be executed by Apache Unomi's rule engine.
+You can also see below how custom actions may be defined.
+
+==== Predefined properties
+
+By default Apache Unomi comes with a set of pre-defined properties, but in many cases it is useful to add additional
+predefined property definitions. You can create property definitions for session or profile properties by creating them
+in different directories.
+
+For session properties you must create a JSON file in the following directory in your Maven project:
+
+[source]
+----
+src/main/resources/META-INF/cxs/properties/sessions
+----
+
+For profile properties you must create the JSON file inside the directory in your Maven project:
+
+[source]
+----
+src/main/resources/META-INF/cxs/properties/profiles
+----
+
+Here is an example of a property definition JSON file
+
+[source]
+----
+{
+ "metadata": { "id": "city", "name": "City" },
+ "type": "string",
+ "tags": ["contactProfileProperties"],
+ "defaultValue": "",
+ "automaticMappingsFrom": [ ],
+ "rank": "304.0"
+}
+----
+
+==== Predefined child conditions
+
+You can define new predefined conditions that are actually conditions inheriting from a parent condition and setting
+pre-defined parameter values. You can do this by creating a JSON file in:
+
+[source]
+----
+src/main/resources/META-INF/cxs/conditions
+----
+
+Here is an example of a JSON file that defines a profileUpdateEventCondition that inherits from a parent condition of
+type eventTypeCondition.
+
+[source]
+----
+{
+ "metadata": {
+ "id": "profileUpdatedEventCondition",
+ "name": "profileUpdatedEventCondition",
+ "description": "",
+ "tags": [
+ "event",
+ "eventCondition"
+ ],
+ "readOnly": true
+ },
+ "parentCondition": {
+ "type": "eventTypeCondition",
+ "parameterValues": {
+ "eventTypeId": "profileUpdated"
+ }
+ },
+
+ "parameters": [
+ ]
+}
+----
+
+==== Predefined personas
+
+Personas may also be pre-defined by creating JSON files in the following directory:
+
+[source]
+----
+src/main/resources/META-INF/cxs/personas
+----
+
+Here is an example of a persona definition JSON file:
+
+[source]
+----
+{
+ "persona": {
+ "itemId": "usVisitor",
+ "properties": {
+ "description": "Represents a visitor browsing from inside the continental US",
+ "firstName": "U.S.",
+ "lastName": "Visitor"
+ },
+ "segments": []
+ },
+ "sessions": [
+ {
+ "itemId": "aa3b04bd-8f4d-4a07-8e96-d33ffa04d3d9",
+ "profileId": "usVisitor",
+ "properties": {
+ "operatingSystemName": "OS X 10.9 Mavericks",
+ "sessionCountryName": "United States",
+ "location": {
+ "lat":37.422,
+ "lon":-122.084058
+ },
+ "userAgentVersion": "37.0.2062.120",
+ "sessionCountryCode": "US",
+ "deviceCategory": "Personal computer",
+ "operatingSystemFamily": "OS X",
+ "userAgentName": "Chrome",
+ "sessionCity": "Mountain View",
+ "remoteHost": "www.google.com",
+ "remoteAddr": "66.249.66.1"
+ },
+ "timeStamp": "2014-09-18T11:40:54Z",
+ "lastEventDate": "2014-09-18T11:40:59Z",
+ "duration": 4790
+ }
+ ]
+}
+----
+
+You can see that it's also possible to define sessions for personas.
+
+==== Custom actions
+
+Custom actions are a powerful way to integrate with external systems by being able to define custom logic that will
+be executed by an Apache Unomi rule. An action is defined by a JSON file created in the following directory:
+
+[source]
+----
+src/main/resources/META-INF/cxs/actions
+----
+
+Here is an example of a JSON action definition:
+
+[source]
+----
+{
+ "metadata": {
+ "id": "addToListsAction",
+ "name": "addToListsAction",
+ "description": "",
+ "tags": [
+ "demographic",
+ "hidden.availableToEndUser"
+ ],
+ "readOnly": true
+ },
+ "actionExecutor": "addToLists",
+ "parameters": [
+ {
+ "id": "listIdentifiers",
+ "type": "string",
+ "multivalued": true
+ }
+ ]
+}
+----
+
+The `actionExecutor` identifier refers to a service property that is defined in the OSGi Blueprint service registration.
+Note that any OSGi service registration may be used, but in these examples we use OSGi Blueprint. The definition for the
+above JSON file will be found in a file called `src/main/resources/OSGI-INF/blueprint/blueprint.xml` with the following
+content:
+
+[source]
+----
+<?xml version="1.0" encoding="UTF-8"?>
+<blueprint xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+ xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
+
+ <reference id="profileService" interface="org.apache.unomi.api.services.ProfileService"/>
+ <reference id="eventService" interface="org.apache.unomi.api.services.EventService"/>
+
+ <!-- Action executors -->
+
+ <service auto-export="interfaces">
+ <service-properties>
+ <entry key="actionExecutorId" value="addToLists"/>
+ </service-properties>
+ <bean class="org.apache.unomi.lists.actions.AddToListsAction">
+ <property name="profileService" ref="profileService"/>
+ <property name="eventService" ref="eventService"/>
+ </bean>
+ </service>
+
+</blueprint>
+----
+
+You can note here the `actionExecutorId` that corresponds to the `actionExecutor` in the JSON file.
+
+The implementation of the action is available here : https://github.com/apache/incubator-unomi/blob/master/extensions/lists-extension/actions/src/main/java/org/apache/unomi/lists/actions/AddToListsAction.java[org.apache.unomi.lists.actions.AddToListsAction]
+
+==== Custom conditions
+
+Custom conditions are different from predefined child conditions because they implement their logic using Java classes.
+They are also declared by adding a JSON file into the conditions directory:
+
+[source]
+----
+src/main/resources/META-INF/cxs/conditions
+----
+
+Here is an example of JSON custom condition definition:
+
+[source]
+----
+{
+ "metadata": {
+ "id": "matchAllCondition",
+ "name": "matchAllCondition",
+ "description": "",
+ "tags": [
+ "logical",
+ "profileCondition",
+ "eventCondition",
+ "sessionCondition",
+ "sourceEventCondition"
+ ],
+ "readOnly": true
+ },
+ "conditionEvaluator": "matchAllConditionEvaluator",
+ "queryBuilder": "matchAllConditionESQueryBuilder",
+
+ "parameters": [
+ ]
+}
+----
+
+Note the `conditionEvaluator` and the `queryBuilder` values. These reference OSGi service properties that are declared
+in an OSGi Blueprint configuration file (other service definitions may also be used such as Declarative Services or even
+Java registered services). Here is an example of an OSGi Blueprint definition corresponding to the above JSON condition
+definition file.
+
+[source]
+----
+src/main/resources/OSGI-INF/blueprint/blueprint.xml
+
+<blueprint xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+ xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
+
+ <service
+ interface="org.apache.unomi.persistence.elasticsearch.conditions.ConditionESQueryBuilder">
+ <service-properties>
+ <entry key="queryBuilderId" value="matchAllConditionESQueryBuilder"/>
+ </service-properties>
+ <bean class="org.apache.unomi.plugins.baseplugin.conditions.MatchAllConditionESQueryBuilder"/>
+ </service>
+
+ <service interface="org.apache.unomi.persistence.elasticsearch.conditions.ConditionEvaluator">
+ <service-properties>
+ <entry key="conditionEvaluatorId" value="matchAllConditionEvaluator"/>
+ </service-properties>
+ <bean class="org.apache.unomi.plugins.baseplugin.conditions.MatchAllConditionEvaluator"/>
+ </service>
+
+</blueprint>
+----
+
+You can find the implementation of the two classes here :
+
+* https://github.com/apache/incubator-unomi/blob/master/plugins/baseplugin/src/main/java/org/apache/unomi/plugins/baseplugin/conditions/MatchAllConditionESQueryBuilder.java[org.apache.unomi.plugins.baseplugin.conditions.MatchAllConditionESQueryBuilder]
+* https://github.com/apache/incubator-unomi/blob/master/plugins/baseplugin/src/main/java/org/apache/unomi/plugins/baseplugin/conditions/MatchAllConditionEvaluator.java[org.apache.unomi.plugins.baseplugin.conditions.MatchAllConditionEvaluator]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/getting-started.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/getting-started.adoc b/manual/src/archives/1.2/asciidoc/getting-started.adoc
new file mode 100644
index 0000000..fbbdc04
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/getting-started.adoc
@@ -0,0 +1,122 @@
+//
+// Licensed 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.
+//
+
+=== Getting started with Unomi
+
+We will first get you up and running with an example. We will then lift the corner of the cover somewhat and explain in greater details what just happened.
+
+==== Prerequisites
+
+This document assumes that you are already familiar with Unomi's link:concepts.html[concepts]. On the technical side, we also assume working knowledge of https://git-scm.com/[git] to be able to retrieve the code for Unomi and the example. Additionnally, you will require a working Java 7 or above install. Refer to http://www.oracle.com/technetwork/java/javase/[http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 7 or greater.
+
+==== Running Unomi
+
+===== Building Unomi
+
+. Get the code: `git clone https://git-wip-us.apache.org/repos/asf/incubator-unomi.git`
+. Build and install according to the link:building-and-deploying.html[instructions] and install Unomi.
+
+===== Start Unomi
+
+Start Unomi according to the link:building-and-deploying.html#Deploying_the_generated_package[instructions]. Once you have Karaf running,
+ you should wait until you see the following messages on the Karaf console:
+
+[source]
+----
+Initializing user list service endpoint...
+Initializing geonames service endpoint...
+Initializing segment service endpoint...
+Initializing scoring service endpoint...
+Initializing campaigns service endpoint...
+Initializing rule service endpoint...
+Initializing profile service endpoint...
+Initializing cluster service endpoint...
+----
+
+This indicates that all the Unomi services are started and ready to react to requests. You can then open a browser and go to `http://localhost:8181/cxs` to see the list of
+available RESTful services or retrieve an initial context at `http://localhost:8181/context.json` (which isn't very useful at this point).
+
+===== Request examples
+
+====== Retrieving your first context
+
+You can retrieve a context using curl like this :
+
+[source]
+----
+curl http://localhost:8181/context.js?sessionId=1234
+----
+
+This will retrieve a JavaScript script that contains a `cxs` object that contains the context with the current user
+profile, segments, scores as well as functions that makes it easier to perform further requests (such as collecting
+events using the cxs.collectEvents() function).
+
+====== Retrieving a context as a JSON object.
+
+If you prefer to retrieve a pure JSON object, you can simply use a request formed like this:
+
+[source]
+----
+curl http://localhost:8181/context.json?sessionId=1234
+----
+
+====== Accessing profile properties in a context
+
+By default, in order to optimize the amount of data sent over the network, Apache Unomi will not send the content of
+the profile or session properties. If you need this data, you must send a JSON object to configure the resulting output
+of the context.js(on) servlet.
+
+Here is an example that will retrieve all the session and profile properties.
+
+[source]
+----
+curl -H "Content-Type: application/json" -X POST -d '{"source":{"itemId":"homepage","itemType":"page","scope":"example"},"requiredProfileProperties":["*"],"requiredSessionProperties":["*"],"requireSegments":true}' http://localhost:8181/context.json?sessionId=1234
+----
+
+The `requiredProfileProperties` and `requiredSessionProperties` are properties that take an array of property names
+that should be retrieved. In this case we use the wildcard character '*' to say we want to retrieve all the available
+properties. The structure of the JSON object that you should send is a JSON-serialized version of the http://unomi.incubator.apache.org/unomi-api/apidocs/org/apache/unomi/api/ContextRequest.html[ContextRequest]
+Java class.
+
+====== Sending events using the context servlet
+
+At the same time as you are retrieving the context, you can also directly send events in the ContextRequest object as
+illustrated in the following example:
+
+[source]
+----
+curl -H "Content-Type: application/json" -X POST -d '{"source":{"itemId":"homepage","itemType":"page","scope":"example"},"events":[{"eventType":"view","scope": "example","source":{"itemType": "site","scope":"example","itemId": "mysite"},"target":{"itemType":"page","scope":"example","itemId":"homepage","properties":{"pageInfo":{"referringURL":""}}}}]}' http://localhost:8181/context.json?sessionId=1234
+----
+
+Upon received events, Apache Unomi will execute all the rules that match the current context, and return an updated context.
+This way of sending events is usually used upon first loading of a page. If you want to send events after the page has
+finished loading you could either do a second call and get an updating context, or if you don't need the context and want
+to send events in a network optimal way you can use the eventcollector servlet (see below).
+
+====== Sending events using the eventcollector servlet
+
+If you only need to send events without retrieving a context, you should use the eventcollector servlet that is optimized
+respond quickly and minimize network traffic. Here is an example of using this servlet:
+
+[source]
+----
+curl -H "Content-Type: application/json" -X POST -d '{"events":[{"eventType":"view","scope": "example","source":{"itemType": "site","scope":"example","itemId": "mysite"},"target":{"itemType":"page","scope":"example","itemId":"homepage","properties":{"pageInfo":{"referringURL":""}}}}]}' http://localhost:8181/eventcollector?sessionId=1234
+----
+
+Note that the eventcollector executes the rules but does not return a context. If is generally used after a page is loaded
+to send additional events.
+
+===== Where to go from here
+
+* Read the link:twitter-sample.html[Twitter sample] documentation that contains a detailed example of how to integrate with Apache Unomi.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/images/asf_logo_url.png
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/images/asf_logo_url.png b/manual/src/archives/1.2/asciidoc/images/asf_logo_url.png
new file mode 100644
index 0000000..5ad4544
Binary files /dev/null and b/manual/src/archives/1.2/asciidoc/images/asf_logo_url.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/images/incubator-logo.png
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/images/incubator-logo.png b/manual/src/archives/1.2/asciidoc/images/incubator-logo.png
new file mode 100644
index 0000000..714dbd7
Binary files /dev/null and b/manual/src/archives/1.2/asciidoc/images/incubator-logo.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/images/unomi-request.png
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/images/unomi-request.png b/manual/src/archives/1.2/asciidoc/images/unomi-request.png
new file mode 100755
index 0000000..fdba277
Binary files /dev/null and b/manual/src/archives/1.2/asciidoc/images/unomi-request.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/index.adoc b/manual/src/archives/1.2/asciidoc/index.adoc
new file mode 100644
index 0000000..4ec6dc6
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/index.adoc
@@ -0,0 +1,75 @@
+//
+// Licensed 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.
+//
+
+//
+// Licensed 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.
+//
+
+= Apache Unomi 1.2.x - Documentation
+Apache Software Foundation
+:doctype: article
+:toc: left
+:toclevels: 3
+:toc-position: left
+:toc-title: Table of Contents
+:numbered:
+:homepage: https://unomi.apache.org
+
+image::incubator-logo.png[pdfwidth=35%,align=center]
+
+== Concepts
+
+include::concepts.adoc[]
+
+== Quick start
+
+include::building-and-deploying.adoc[]
+
+include::getting-started.adoc[]
+
+include::configuration.adoc[]
+
+== Sample
+
+include::samples/samples.adoc[]
+
+include::samples/login-sample.adoc[]
+
+include::samples/twitter-sample.adoc[]
+
+include::samples/weather-update-sample.adoc[]
+
+== Connectors
+
+include::connectors/connectors.adoc[]
+
+include::connectors/salesforce-connector.adoc[]
+
+== Cluster setup
+
+include::clustering.adoc[]
+
+== Custom extensions
+
+include::custom-extensions.adoc[]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/samples/login-sample.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/samples/login-sample.adoc b/manual/src/archives/1.2/asciidoc/samples/login-sample.adoc
new file mode 100644
index 0000000..e02cbfa
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/samples/login-sample.adoc
@@ -0,0 +1,74 @@
+//
+// Licensed 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.
+//
+
+=== Login sample
+
+This sample is an example of what is involved in integrated a login with Apache Unomi.
+
+==== Warning !
+
+The example code uses client-side Javascript code to send the login event. This is only
+done this way for the sake of sample simplicity but if should NEVER BE DONE THIS WAY in real cases.
+
+The login event should always be sent from the server performing the actual login since it must
+only be sent if the user has authenticated properly, and only the authentication server can validate this.
+
+==== Installing the sample
+
+.
+
+Login into the Unomi Karaf SSH shell using something like this :
+
+[source]
+----
+ssh -p 8102 karaf@localhost (default password is karaf)
+----
+
+.
+
+Install the login sample using the following command:
+
+[source]
+----
+bundle:install mvn:org.apache.unomi/login-integration-sample/1.2.0-incubating-SNAPSHOT
+----
+
+when the bundle is successfully install you will get an bundle ID back we will call it BUNDLE_ID.
+
+.
+
+You can then do:
+
+[source]
+----
+bundle:start BUNDLE_ID
+----
+
+.
+
+If all went well you can access the login sample HTML page here :
+
+[source]
+----
+http://localhost:8181/login/index.html
+----
+
+.
+
+You can fill in the form to test it. Note that the hardcoded password is:
+
+[source]
+----
+test1234
+----
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/samples/samples.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/samples/samples.adoc b/manual/src/archives/1.2/asciidoc/samples/samples.adoc
new file mode 100644
index 0000000..9037942
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/samples/samples.adoc
@@ -0,0 +1,20 @@
+//
+// Licensed 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.
+//
+
+=== Samples
+
+Apache Unomi provides the following samples:
+
+* link:twitter-sample.html[Twitter integration]
+* link:login-sample.html[Login integration]
\ No newline at end of file
[6/8] incubator-unomi git commit: Add archives versions of
documentation in asciidoc
Posted by sh...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.1/asciidoc/getting-started.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.1/asciidoc/getting-started.adoc b/manual/src/archives/1.1/asciidoc/getting-started.adoc
new file mode 100644
index 0000000..112d07b
--- /dev/null
+++ b/manual/src/archives/1.1/asciidoc/getting-started.adoc
@@ -0,0 +1,461 @@
+//
+// Licensed 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.
+//
+
+=== Getting started with Unomi
+
+We will first get you up and running with an example. We will then lift the corner of the cover somewhat and explain in greater details what just happened.
+
+==== Prerequisites
+
+This document assumes that you are already familiar with Unomi's link:concepts.html[concepts]. On the technical side, we also assume working knowledge of https://git-scm.com/[git] to be able to retrieve the code for Unomi and the example. Additionnally, you will require a working Java 7 or above install. Refer to http://www.oracle.com/technetwork/java/javase/[http://www.oracle.com/technetwork/java/javase/] for details on how to download and install Java SE 7 or greater.
+
+==== Running Unomi
+
+===== Building Unomi
+
+. Get the code: `git clone https://git-wip-us.apache.org/repos/asf/incubator-unomi.git`
+. Build and install according to the link:building-and-deploying.html[instructions] and install Unomi.
+
+===== Start Unomi
+
+Start Unomi according to the link:building-and-deploying.html#Deploying_the_generated_package[instructions]. Once you have Karaf running,
+ you should wait until you see the following messages on the Karaf console:
+
+[source]
+----
+Initializing user list service endpoint...
+Initializing geonames service endpoint...
+Initializing segment service endpoint...
+Initializing scoring service endpoint...
+Initializing campaigns service endpoint...
+Initializing rule service endpoint...
+Initializing profile service endpoint...
+Initializing cluster service endpoint...
+----
+
+This indicates that all the Unomi services are started and ready to react to requests. You can then open a browser and go to `http://localhost:8181/cxs` to see the list of
+available RESTful services or retrieve an initial context at `http://localhost:8181/context.json` (which isn't very useful at this point).
+
+===== Building the tweet button sample
+
+In your local copy of the Unomi repository and run:
+
+[source]
+----
+cd samples/tweet-button-plugin
+mvn clean install
+----
+
+This will compile and create the OSGi bundle that can be deployed on Unomi to extend it.
+
+===== Deploying the tweet button sample
+
+In standard Karaf fashion, you will need to copy the sample bundle to your Karaf `deploy` directory.
+
+If you are using the packaged version of Unomi (as opposed to deploying it to your own Karaf version), you can simply run, assuming your current directory is `samples/tweet-button-plugin` and that you uncompressed the archive in the directory it was created:
+
+[source]
+----
+cp target/tweet-button-plugin-1.0.0-incubating-SNAPSHOT.jar ../../package/target/unomi-1.0.0-incubating-SNAPSHOT/deploy
+----
+
+===== Testing the sample
+
+You can now go to http://localhost:8181/index.html[http://localhost:8181/index.html] to test the sample code. The page is very simple, you will see a Twitter button, which, once clicked, will open a new window to tweet about the current page. The original page should be updated with the new values of the properties coming from Unomi. Additionnally, the raw JSON response is displayed.
+
+We will now explain in greater details some concepts and see how the example works.
+
+==== Interacting with the context server
+
+There are essentially two modalities to interact with the context server, reflecting different types of Unomi users: context server clients and context server integrators.
+
+*Context server clients* are usually web applications or content management systems. They interact with Unomi by providing raw, uninterpreted contextual data in the form of events and associated metadata. That contextual data is then processed by the context server to be fed to clients once actionable. In that sense context server clients are both consumers and producers of contextual data. Context server clients will mostly interact with Unomi using a single entry point called the `ContextServlet`, requesting context for the current user and providing any triggered events along the way.
+
+On the other hand, *context server integrators* provide ways to feed more structured data to the context server either to integrate with third party services or to provide analysis of the uninterpreted data provided by context server clients. Such integration will mostly be done using Unomi's API either directly using Unomi plugins or via the provided REST APIs. However, access to REST APIs is restricted due for security reasons, requiring privileged access to the Unomi server, making things a little more complex to set up.
+
+For simplicity's sake, this document will focus solely on the first use case and will interact only with the context servlet.
+
+==== Retrieving context information from Unomi using the context servlet
+
+Unomi provides two ways to retrieve context: either as a pure JSON object containing strictly context information or as a couple of JSON objects augmented with javascript functions that can be used to interact with the Unomi server using the `<context server base URL>/context.json` or `<context server base URL>/context.js` URLs, respectively.
+
+Below is an example of asynchronously loading the initial context using the javascript version, assuming a default Unomi install running on `http://localhost:8181`:
+
+[source,javascript]
+----
+// Load context from Unomi asynchronously
+(function (document, elementToCreate, id) {
+ var js, fjs = document.getElementsByTagName(elementToCreate)[0];
+ if (document.getElementById(id)) return;
+ js = document.createElement(elementToCreate);
+ js.id = id;
+ js.src = 'http://localhost:8181/context.js';
+ fjs.parentNode.insertBefore(js, fjs);
+}(document, 'script', 'context'));
+
+----
+
+This initial context results in a javascript file providing some functions to interact with the context server from javascript along with two objects: a `cxs` object containing
+information about the context for the current user and a `digitalData` object that is injected into the browser’s `window` object (leveraging the
+http://www.w3.org/2013/12/ceddl-201312.pdf[Customer Experience Digital Data Layer] standard). Note that this last object is not under control of the context server and clients
+ are free to use it or not. Our example will not make use of it.
+
+On the other hand, the `cxs` top level object contains interesting contextual information about the current user:
+
+[source,json]
+----
+{
+ "profileId":<identifier of the profile associated with the current user>,
+ "sessionId":<identifier of the current user session>,
+ "profileProperties":<requested profile properties, if any>,
+ "sessionProperties":<requested session properties, if any>,
+ "profileSegments":<segments the profile is part of if requested>,
+ "filteringResults":<result of the evaluation of personalization filters>,
+ "trackedConditions":<tracked conditions in the source page, if any>
+}
+----
+
+We will look at the details of the context request and response later.
+
+=== Example
+
+==== Overview
+
+We will examine how a simple HTML page can interact with Unomi to enrich a user's profile. The use case we will follow is a rather simple one: we want to react to Twitter events by associating information to their profile. We will record the number of times the user tweeted (as a `tweetNb` profile integer property) as well as the URLs they tweeted from (as a `tweetedFrom` multi-valued string profile property). We will accomplish this using a simple HTML page on which we position a standard "Tweet" button. A javascript script will use the Twitter API to react to clicks on this button and update the user profile using a `ContextServlet` request triggering a custom event. This event will, in turn, trigger a Unomi action on the server implemented using a Unomi plugin, a standard extension point for the server.
+
+==== HTML page
+
+The code for the HTML page with our Tweet button can be found at https://github.com/apache/incubator-unomi/blob/master/wab/src/main/webapp/index.html[https://github.com/apache/incubator-unomi/blob/master/wab/src/main/webapp/index.html].
+
+This HTML page is fairly straightforward: we create a tweet button using the Twitter API while a Javascript script performs the actual logic.
+
+==== Javascript
+
+Globally, the script loads both the twitter widget and the initial context asynchronously (as shown previously). This is accomplished using fairly standard javascript code and we won't look at it here. Using the Twitter API, we react to the `tweet` event and call the Unomi server to update the user's profile with the required information, triggering a custom `tweetEvent` event. This is accomplished using a `contextRequest` function which is an extended version of a classic `AJAX` request:
+
+[source,javascript]
+----
+function contextRequest(successCallback, errorCallback, payload) {
+ var data = JSON.stringify(payload);
+ // if we don't already have a session id, generate one
+ var sessionId = cxs.sessionId || generateUUID();
+ var url = 'http://localhost:8181/context.json?sessionId=' + sessionId;
+ var xhr = new XMLHttpRequest();
+ var isGet = data.length < 100;
+ if (isGet) {
+ xhr.withCredentials = true;
+ xhr.open("GET", url + "&payload=" + encodeURIComponent(data), true);
+ } else if ("withCredentials" in xhr) {
+ xhr.open("POST", url, true);
+ xhr.withCredentials = true;
+ } else if (typeof XDomainRequest != "undefined") {
+ xhr = new XDomainRequest();
+ xhr.open("POST", url);
+ }
+ xhr.onreadystatechange = function () {
+ if (xhr.readyState != 4) {
+ return;
+ }
+ if (xhr.status == 200) {
+ var response = xhr.responseText ? JSON.parse(xhr.responseText) : undefined;
+ if (response) {
+ cxs.sessionId = response.sessionId;
+ successCallback(response);
+ }
+ } else {
+ console.log("contextserver: " + xhr.status + " ERROR: " + xhr.statusText);
+ if (errorCallback) {
+ errorCallback(xhr);
+ }
+ }
+ };
+ xhr.setRequestHeader("Content-Type", "text/plain;charset=UTF-8"); // Use text/plain to avoid CORS preflight
+ if (isGet) {
+ xhr.send();
+ } else {
+ xhr.send(data);
+ }
+}
+----
+
+There are a couple of things to note here:
+
+* If we specify a payload, it is expected to use the JSON format so we `stringify` it and encode it if passed as a URL parameter in a `GET` request.
+* We need to make a https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS[`CORS`] request since the Unomi server is most likely not running on the same host than the one from which the request originates. The specific details are fairly standard and we will not explain them here.
+* We need to either retrieve (from the initial context we retrieved previously using `cxs.sessionId`) or generate a session identifier for our request since Unomi currently requires one.
+* We're calling the `ContextServlet` using the default install URI, specifying the session identifier: `http://localhost:8181/context.json?sessionId=' + sessionId`. This URI requests context from Unomi, resulting in an updated `cxs` object in the javascript global scope. The context server can reply to this request either by returning a JSON-only object containing solely the context information as is the case when the requested URI is `context.json`. However, if the client requests `context.js` then useful functions to interact with Unomi are added to the `cxs` object in addition to the context information as depicted above.
+* We don't need to provide any authentication at all to interact with this part of Unomi since we only have access to read-only data (as well as providing events as we shall see later on). If we had been using the REST API, we would have needed to provide authentication information as well.
+
+===== Context request and response structure
+
+The interesting part, though, is the payload. This is where we provide Unomi with contextual information as well as ask for data in return. This allows clients to specify which type of information they are interested in getting from the context server as well as specify incoming events or content filtering or property/segment overrides for personalization or impersonation. This conditions what the context server will return with its response.
+
+Let's look at the context request structure:
+
+[source,json]
+----
+{
+ source: <Item source of the context request>,
+ events: <optional array of triggered events>,
+ requiredProfileProperties: <optional array of property identifiers>,
+ requiredSessionProperties: <optional array of property identifiers>,
+ filters: <optional array of filters to evaluate>,
+ profileOverrides: <optional profile containing segments,scores or profile properties to override>,
+ - segments: <optional array of segment identifiers>,
+ - profileProperties: <optional map of property name / value pairs>,
+ - scores: <optional map of score id / value pairs>
+ sessionPropertiesOverrides: <optional map of property name / value pairs>,
+ requireSegments: <boolean, whether to return the associated segments>
+}
+----
+
+We will now look at each part in greater details.
+
+====== Source
+
+A context request payload needs to at least specify some information about the source of the request in the form of an `Item` (meaning identifier, type and scope plus any additional properties we might have to provide), via the `source` property of the payload. Of course the more information can be provided about the source, the better.
+
+====== Filters
+
+A client wishing to perform content personalization might also specify filtering conditions to be evaluated by the context server so that it can tell the client whether the content associated with the filter should be activated for this profile/session. This is accomplished by providing a list of filter definitions to be evaluated by the context server via the `filters` field of the payload. If provided, the evaluation results will be provided in the `filteringResults` field of the resulting `cxs` object the context server will send.
+
+====== Overrides
+
+It is also possible for clients wishing to perform user impersonation to specify properties, segments or scores to override the proper ones so as to emulate a specific profile, in which case the overridden value will temporarily replace the proper values so that all rules will be evaluated with these values instead of the proper ones. The `segments` (array of segment identifiers), `profileProperties` (maps of property name and associated object value) and `scores` (maps of score id and value) all wrapped in a profileOverrides object and the `sessionPropertiesOverrides` (maps of property name and associated object value) fields allow to provide such information. Providing such overrides will, of course, impact content filtering results and segments matching for this specific request.
+
+====== Controlling the content of the response
+
+The clients can also specify which information to include in the response by setting the `requireSegments` property to true if segments the current profile matches should be returned or provide an array of property identifiers for `requiredProfileProperties` or `requiredSessionProperties` fields to ask the context server to return the values for the specified profile or session properties, respectively. This information is provided by the `profileProperties`, `sessionProperties` and `profileSegments` fields of the context server response.
+
+Additionally, the context server will also returns any tracked conditions associated with the source of the context request. Upon evaluating the incoming request, the context server will determine if there are any rules marked with the `trackedCondition` tag and which source condition matches the source of the incoming request and return these tracked conditions to the client. The client can use these tracked conditions to learn that the context server can react to events matching the tracked condition and coming from that source. This is, in particular, used to implement form mapping (a solution that allows clients to update user profiles based on values provided when a form is submitted).
+
+====== Events
+
+Finally, the client can specify any events triggered by the user actions, so that the context server can process them, via the `events` field of the context request.
+
+====== Default response
+
+If no payload is specified, the context server will simply return the minimal information deemed necessary for client applications to properly function: profile identifier, session identifier and any tracked conditions that might exist for the source of the request.
+
+===== Context request for our example
+
+Now that we've seen the structure of the request and what we can expect from the context response, let's examine the request our component is doing.
+
+In our case, our `source` item looks as follows: we specify a scope for our application (`unomi-tweet-button-sample`), specify that the item type (i.e. the kind of element that is the source of our event) is a `page` (which corresponds, as would be expected, to a web page), provide an identifier (in our case, a Base-64 encoded version of the page's URL) and finally, specify extra properties (here, simply a `url` property corresponding to the page's URL that will be used when we process our event in our Unomi extension).
+
+[source,javascript]
+----
+var scope = 'unomi-tweet-button-sample';
+var itemId = btoa(window.location.href);
+var source = {
+ itemType: 'page',
+ scope: scope,
+ itemId: itemId,
+ properties: {
+ url: window.location.href
+ }
+};
+----
+
+We also specify that we want the context server to return the values of the `tweetNb` and `tweetedFrom` profile properties in its response. Finally, we provide a custom event of type `tweetEvent` with associated scope and source information, which matches the source of our context request in this case.
+
+[source,javascript]
+----
+var contextPayload = {
+ source: source,
+ events: [
+ {
+ eventType: 'tweetEvent',
+ scope: scope,
+ source: source
+ }
+ ],
+ requiredProfileProperties: [
+ 'tweetNb',
+ 'tweetedFrom'
+ ]
+};
+----
+
+The `tweetEvent` event type is not defined by default in Unomi. This is where our Unomi plugin comes into play since we need to tell Unomi how to react when it encounters such events.
+
+===== Unomi plugin overview
+
+In order to react to `tweetEvent` events, we will define a new Unomi rule since this is exactly what Unomi rules are supposed to do. Rules are guarded by conditions and if these
+ conditions match, the associated set of actions will be executed. In our case, we want our new
+ https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/rules/incrementTweetNumber.json[`incrementTweetNumber`] rule to only react to `tweetEvent` events and
+ we want it to perform the profile update accordingly: create the property types for our custom properties if they don't exist and update them. To do so, we will create a
+ custom
+ https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/actions/incrementTweetNumberAction.json[`incrementTweetNumberAction`] action that will be triggered any time our rule matches. An action is some custom code that is deployed in the context server and can access the
+ Unomi API to perform what it is that it needs to do.
+
+===== Rule definition
+
+Let's look at how our custom https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/rules/incrementTweetNumber.json[`incrementTweetNumber`] rule is defined:
+
+[source,json]
+----
+{
+ "metadata": {
+ "id": "smp:incrementTweetNumber",
+ "name": "Increment tweet number",
+ "description": "Increments the number of times a user has tweeted after they click on a tweet button"
+ },
+ "raiseEventOnlyOnceForSession": false,
+ "condition": {
+ "type": "eventTypeCondition",
+ "parameterValues": {
+ "eventTypeId": "tweetEvent"
+ }
+ },
+ "actions": [
+ {
+ "type": "incrementTweetNumberAction",
+ "parameterValues": {}
+ }
+ ]
+}
+----
+
+Rules define a metadata section where we specify the rule name, identifier and description.
+
+When rules trigger, a specific event is raised so that other parts of Unomi can react to it accordingly. We can control how that event should be raised. Here we specify that the event should be raised each time the rule triggers and not only once per session by setting `raiseEventOnlyOnceForSession` to `false`, which is not strictly required since that is the default. A similar setting (`raiseEventOnlyOnceForProfile`) can be used to specify that the event should only be raised once per profile if needed.
+
+We could also specify a priority for our rule in case it needs to be executed before other ones when similar conditions match. This is accomplished using the `priority` property. We're using the default priority here since we don't have other rules triggering on `tweetEvent`s and don't need any special ordering.
+
+We then tell Unomi which condition should trigger the rule via the `condition` property. Here, we specify that we want our rule to trigger on an `eventTypeCondition` condition. Unomi can be extended by adding new condition types that can enrich how matching or querying is performed. The condition type definition file specifies which parameters are expected for our condition to be complete. In our case, we use the built-in event type condition that will match if Unomi receives an event of the type specified in the condition's `eventTypeId` parameter value: `tweetEvent` here.
+
+Finally, we specify a list of actions that should be performed as consequences of the rule matching. We only need one action of type `incrementTweetNumberAction` that doesn't require any parameters.
+
+===== Action definition
+
+Let's now look at our custom https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/actions/incrementTweetNumberAction.json[`incrementTweetNumberAction`] action type definition:
+
+[source,json]
+----
+{
+ "id": "incrementTweetNumberAction",
+ "actionExecutor": "incrementTweetNumber",
+ "tags": [
+ "event"
+ ],
+ "parameters": []
+}
+----
+
+We specify the identifier for the action type, a list of tags if needed: here we say that our action is a consequence of events using the `event` tag. Our actions does not require any parameters so we don't define any.
+
+Finally, we provide a mysterious `actionExecutor` identifier: `incrementTweetNumber`.
+
+===== Action executor definition
+
+The action executor references the actual implementation of the action as defined in our https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/OSGI-INF/blueprint/blueprint.xml[blueprint definition]:
+
+[source,xml]
+----
+<blueprint xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+ xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
+
+ <reference id="profileService" interface="org.apache.unomi.api.services.ProfileService"/>
+
+ <!-- Action executor -->
+ <service id="incrementTweetNumberAction" auto-export="interfaces">
+ <service-properties>
+ <entry key="actionExecutorId" value="incrementTweetNumber"/>
+ </service-properties>
+ <bean class="org.apache.unomi.examples.unomi_tweet_button_plugin.actions.IncrementTweetNumberAction">
+ <property name="profileService" ref="profileService"/>
+ </bean>
+ </service>
+</blueprint>
+----
+
+In standard Blueprint fashion, we specify that we will need the `profileService` defined by Unomi and then define a service of our own to be exported for Unomi to use. Our service specifies one property: `actionExecutorId` which matches the identifier we specified in our action definition. We then inject the profile service in our executor and we're done for the configuration side of things!
+
+===== Action executor implementation
+
+Our action executor definition specifies that the bean providing the service is implemented in the https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/java/org/apache/unomi/samples/tweet_button_plugin/actions/IncrementTweetNumberAction.java[`org.apache.unomi.samples.tweet_button_plugin.actions
+.IncrementTweetNumberAction`] class. This class implements the Unomi `ActionExecutor` interface which provides a single `int execute(Action action, Event event)` method: the executor gets the action instance to execute along with the event that triggered it, performs its work and returns an integer status corresponding to what happened as defined by public constants of the `EventService` interface of Unomi: `NO_CHANGE`, `SESSION_UPDATED` or `PROFILE_UPDATED`.
+
+Let's now look at the implementation of the method:
+
+[source,java]
+----
+final Profile profile = event.getProfile();
+Integer tweetNb = (Integer) profile.getProperty(TWEET_NB_PROPERTY);
+List<String> tweetedFrom = (List<String>) profile.getProperty(TWEETED_FROM_PROPERTY);
+
+if (tweetNb == null || tweetedFrom == null) {
+ // create tweet number property type
+ PropertyType propertyType = new PropertyType(new Metadata(event.getScope(), TWEET_NB_PROPERTY, TWEET_NB_PROPERTY, "Number of times a user tweeted"));
+ propertyType.setValueTypeId("integer");
+ service.createPropertyType(propertyType);
+
+ // create tweeted from property type
+ propertyType = new PropertyType(new Metadata(event.getScope(), TWEETED_FROM_PROPERTY, TWEETED_FROM_PROPERTY, "The list of pages a user tweeted from"));
+ propertyType.setValueTypeId("string");
+ propertyType.setMultivalued(true);
+ service.createPropertyType(propertyType);
+
+ tweetNb = 0;
+ tweetedFrom = new ArrayList<>();
+}
+
+profile.setProperty(TWEET_NB_PROPERTY, tweetNb + 1);
+final String sourceURL = extractSourceURL(event);
+if (sourceURL != null) {
+ tweetedFrom.add(sourceURL);
+}
+profile.setProperty(TWEETED_FROM_PROPERTY, tweetedFrom);
+
+return EventService.PROFILE_UPDATED;
+----
+
+It is fairly straightforward: we retrieve the profile associated with the event that triggered the rule and check whether it already has the properties we are interested in. If not, we create the associated property types and initialize the property values.
+
+____
+
+Note that it is not an issue to attempt to create the same property type multiple times as Unomi will not add a new property type if an identical type already exists.
+
+____
+
+Once this is done, we update our profile with the new property values based on the previous values and the metadata extracted from the event using the `extractSourceURL` method which uses our `url` property that we've specified for our event source. We then return that the profile was updated as a result of our action and Unomi will properly save it for us when appropriate. That's it!
+
+For reference, here's the `extractSourceURL` method implementation:
+
+[source,java]
+----
+private String extractSourceURL(Event event) {
+ final Item sourceAsItem = event.getSource();
+ if (sourceAsItem instanceof CustomItem) {
+ CustomItem source = (CustomItem) sourceAsItem;
+ final String url = (String) source.getProperties().get("url");
+ if (url != null) {
+ return url;
+ }
+ }
+
+ return null;
+}
+----
+
+=== Conclusion
+
+We have seen a simple example how to interact with Unomi using a combination of client-side code and Unomi plugin. Hopefully, this provided an introduction to the power of what Unomi can do and how it can be extended to suit your needs.
+
+=== Annex
+
+Here is an overview of how Unomi processes incoming requests to the `ContextServlet`.
+image:../../images/unomi-request.png[Unomi request overview]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.1/asciidoc/images/asf_logo_url.png
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.1/asciidoc/images/asf_logo_url.png b/manual/src/archives/1.1/asciidoc/images/asf_logo_url.png
new file mode 100644
index 0000000..5ad4544
Binary files /dev/null and b/manual/src/archives/1.1/asciidoc/images/asf_logo_url.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.1/asciidoc/images/incubator-logo.png
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.1/asciidoc/images/incubator-logo.png b/manual/src/archives/1.1/asciidoc/images/incubator-logo.png
new file mode 100644
index 0000000..714dbd7
Binary files /dev/null and b/manual/src/archives/1.1/asciidoc/images/incubator-logo.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.1/asciidoc/images/unomi-request.png
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.1/asciidoc/images/unomi-request.png b/manual/src/archives/1.1/asciidoc/images/unomi-request.png
new file mode 100755
index 0000000..fdba277
Binary files /dev/null and b/manual/src/archives/1.1/asciidoc/images/unomi-request.png differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.1/asciidoc/index.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.1/asciidoc/index.adoc b/manual/src/archives/1.1/asciidoc/index.adoc
new file mode 100644
index 0000000..1246e46
--- /dev/null
+++ b/manual/src/archives/1.1/asciidoc/index.adoc
@@ -0,0 +1,55 @@
+//
+// Licensed 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.
+//
+
+//
+// Licensed 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.
+//
+
+= Apache Unomi 1.1.x - Documentation
+Apache Software Foundation
+:doctype: article
+:toc: left
+:toclevels: 3
+:toc-position: left
+:toc-title: Table of Contents
+:numbered:
+:homepage: https://unomi.apache.org
+
+image::incubator-logo.png[pdfwidth=35%,align=center]
+
+== Concepts
+
+include::concepts.adoc[]
+
+== Quick start
+
+include::building-and-deploying.adoc[]
+
+include::getting-started.adoc[]
+
+include::configuration.adoc[]
+
+== Cluster setup
+
+include::clustering.adoc[]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/apache.css
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/apache.css b/manual/src/archives/1.2/asciidoc/apache.css
new file mode 100644
index 0000000..e66d1fa
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/apache.css
@@ -0,0 +1,2448 @@
+
+@import "https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,700%7cDroid+Serif:400,700";
+
+article,
+aside,
+details,
+figcaption,
+figure,
+footer,
+header,
+hgroup,
+main,
+nav,
+section,
+summary {
+ display: block
+}
+
+audio,
+canvas,
+video {
+ display: inline-block
+}
+
+audio:not([controls]) {
+ display: none;
+ height: 0
+}
+
+script {
+ display: none !important
+}
+
+html {
+ font-family: "Droid Serif";
+ -ms-text-size-adjust: 100%;
+ -webkit-text-size-adjust: 100%;
+}
+
+a {
+ background: transparent
+}
+
+a:focus {
+ outline: thin dotted
+}
+
+a:active,
+a:hover {
+ outline: 0
+}
+
+h1 {
+ font-size: 2em;
+ margin: .67em 0
+}
+
+abbr[title] {
+ border-bottom: 1px dotted
+}
+
+b,
+strong {
+ font-weight: bold
+}
+
+dfn {
+ font-style: italic
+}
+
+hr {
+ -moz-box-sizing: content-box;
+ box-sizing: content-box;
+ height: 0
+}
+
+mark {
+ background: #ff0;
+ color: #000
+}
+
+code,
+kbd,
+pre,
+samp {
+ font-family: monospace;
+ font-size: 1em
+}
+
+pre {
+ white-space: pre-wrap
+}
+
+q {
+ quotes: "\201C" "\201D" "\2018" "\2019"
+}
+
+small {
+ font-size: 80%
+}
+
+sub,
+sup {
+ font-size: 75%;
+ line-height: 0;
+ position: relative;
+ vertical-align: baseline
+}
+
+sup {
+ top: -.5em
+}
+
+sub {
+ bottom: -.25em
+}
+
+img {
+ border: 0
+}
+
+svg:not(:root) {
+ overflow: hidden
+}
+
+figure {
+ margin: 0
+}
+
+fieldset {
+ border: 1px solid silver;
+ margin: 0 2px;
+ padding: .35em .625em .75em
+}
+
+legend {
+ border: 0;
+ padding: 0
+}
+
+button,
+input,
+select,
+textarea {
+ font-family: inherit;
+ font-size: 100%;
+ margin: 0
+}
+
+button,
+input {
+ line-height: normal
+}
+
+button,
+select {
+ text-transform: none
+}
+
+button,
+html input[type="button"],
+input[type="reset"],
+input[type="submit"] {
+ -webkit-appearance: button;
+ cursor: pointer
+}
+
+button[disabled],
+html input[disabled] {
+ cursor: default
+}
+
+input[type="checkbox"],
+input[type="radio"] {
+ box-sizing: border-box;
+ padding: 0
+}
+
+button::-moz-focus-inner,
+input::-moz-focus-inner {
+ border: 0;
+ padding: 0
+}
+
+textarea {
+ overflow: auto;
+ vertical-align: top
+}
+
+table {
+ border-collapse: collapse;
+ border-spacing: 0
+}
+
+*,
+*::before,
+*::after {
+ -moz-box-sizing: border-box;
+ -webkit-box-sizing: border-box;
+ box-sizing: border-box
+}
+
+html,
+body {
+ /*font-size: 100%*/
+}
+
+body {
+ background: #fff;
+ color: #333;
+ padding: 0;
+ margin: 0;
+ font-family: "Droid Serif", "DejaVu Serif", serif;
+ font-size: 14px;
+ font-style: normal;
+ line-height: 1.42857143;
+ position: relative;
+ cursor: auto;
+ tab-size: 4;
+ -moz-osx-font-smoothing: grayscale;
+ -webkit-font-smoothing: antialiased
+}
+
+a:hover {
+ cursor: pointer
+}
+
+img,
+object,
+embed {
+ max-width: 100%;
+ height: auto
+}
+
+object,
+embed {
+ height: 100%
+}
+
+img {
+ -ms-interpolation-mode: bicubic
+}
+
+.left {
+ float: left !important
+}
+
+.right {
+ float: right !important
+}
+
+.text-left {
+ text-align: left !important
+}
+
+.text-right {
+ text-align: right !important
+}
+
+.text-center {
+ text-align: center !important
+}
+
+.text-justify {
+ text-align: justify !important
+}
+
+.hide {
+ display: none
+}
+
+img,
+object,
+svg {
+ display: inline-block;
+ vertical-align: middle
+}
+
+textarea {
+ height: auto;
+ min-height: 50px
+}
+
+select {
+ width: 100%
+}
+
+.center {
+ margin-left: auto;
+ margin-right: auto
+}
+
+.stretch {
+ width: 100%
+}
+
+.subheader,
+.admonitionblock td.content>.title,
+.audioblock>.title,
+.exampleblock>.title,
+.imageblock>.title,
+.listingblock>.title,
+.literalblock>.title,
+.stemblock>.title,
+.openblock>.title,
+.paragraph>.title,
+.quoteblock>.title,
+table.tableblock>.title,
+.verseblock>.title,
+.videoblock>.title,
+.dlist>.title,
+.olist>.title,
+.ulist>.title,
+.qlist>.title,
+.hdlist>.title {
+ line-height: 1.45;
+ color: #585ac2;
+ font-weight: 400;
+ margin-top: 0;
+ margin-bottom: .25em
+}
+
+div,
+dl,
+dt,
+dd,
+ul,
+ol,
+li,
+h1,
+h2,
+h3,
+#toctitle,
+.sidebarblock>.content>.title,
+h4,
+h5,
+h6,
+pre,
+form,
+p,
+blockquote,
+th,
+td {
+ margin: 0;
+ padding: 0;
+ direction: ltr
+}
+
+a {
+ color: #585ac2;
+ text-decoration: underline;
+ line-height: inherit
+}
+
+a:hover,
+a:focus {
+ color: #373997;
+}
+
+a img {
+ border: none
+}
+
+p {
+ font-family: inherit;
+ font-weight: 400;
+ font-size: 1em;
+ line-height: 1.6;
+ margin-bottom: 1.25em;
+ text-rendering: optimizeLegibility
+}
+
+p aside {
+ font-size: .875em;
+ line-height: 1.35;
+ font-style: italic
+}
+
+h1,
+h2,
+h3,
+#toctitle,
+.sidebarblock>.content>.title,
+h4,
+h5,
+h6 {
+ font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ font-weight: bold;
+ /*font-style: bold;*/
+ color: #303284;
+ text-rendering: optimizeLegibility;
+ margin-top: 1em;
+ margin-bottom: .5em;
+ line-height: 1.0125em;
+ text-transform: uppercase;
+}
+
+h1 small,
+h2 small,
+h3 small,
+#toctitle small,
+.sidebarblock>.content>.title small,
+h4 small,
+h5 small,
+h6 small {
+ font-size: 60%;
+ color: #303284;
+ line-height: 0
+}
+
+h1 {
+ font-size: 2.125em
+}
+
+h2 {
+ font-size: 1.6875em
+}
+
+h3,
+#toctitle,
+.sidebarblock>.content>.title {
+ font-size: 1.375em
+}
+
+h4,
+h5 {
+ font-size: 1.125em
+}
+
+h6 {
+ font-size: 1em
+}
+
+hr {
+ border: solid #dddddd;
+ border-width: 1px 0 0;
+ clear: both;
+ margin: 1.25em 0 1.1875em;
+ height: 0
+}
+
+em,
+i {
+ font-style: italic;
+ line-height: inherit
+}
+
+strong,
+b {
+ font-weight: bold;
+ line-height: inherit
+}
+
+small {
+ font-size: 60%;
+ line-height: inherit
+}
+
+code {
+ font-family: "Droid Sans Mono", "DejaVu Sans Mono", monospace;
+ font-weight: 400;
+ color: #585ac2;
+}
+
+ul,
+ol,
+dl {
+ font-size: 1em;
+ line-height: 1.6;
+ margin-bottom: 1.25em;
+ list-style-position: outside;
+ font-family: inherit
+}
+
+ul,
+ol {
+ margin-left: 1.5em
+}
+
+ul li ul,
+ul li ol {
+ margin-left: 1.25em;
+ margin-bottom: 0;
+ font-size: 1em
+}
+
+ul.square li ul,
+ul.circle li ul,
+ul.disc li ul {
+ list-style: inherit
+}
+
+ul.square {
+ list-style-type: square
+}
+
+ul.circle {
+ list-style-type: circle
+}
+
+ul.disc {
+ list-style-type: disc
+}
+
+ol li ul,
+ol li ol {
+ margin-left: 1.25em;
+ margin-bottom: 0
+}
+
+dl dt {
+ margin-bottom: .3125em;
+ font-weight: bold
+}
+
+dl dd {
+ margin-bottom: 1.25em
+}
+
+abbr,
+acronym {
+ text-transform: uppercase;
+ font-size: 90%;
+ color: rgba(0, 0, 0, .8);
+ border-bottom: 1px dotted #ddd;
+ cursor: help
+}
+
+abbr {
+ text-transform: none
+}
+
+blockquote {
+ margin: 0 0 1.25em;
+ padding: .5625em 1.25em 0 1.1875em;
+ border-left: 1px solid #ddd
+}
+
+blockquote cite {
+ display: block;
+ font-size: .9375em;
+ color: rgba(0, 0, 0, .6)
+}
+
+blockquote cite::before {
+ content: "\2014 \0020"
+}
+
+blockquote cite a,
+blockquote cite a:visited {
+ color: rgba(0, 0, 0, .6)
+}
+
+blockquote,
+blockquote p {
+ line-height: 1.6;
+ color: rgba(0, 0, 0, .85)
+}
+
+@media screen and (min-width:768px) {
+ h1,
+ h2,
+ h3,
+ #toctitle,
+ .sidebarblock>.content>.title,
+ h4,
+ h5,
+ h6 {
+ line-height: 1.2
+ }
+
+ h1 {
+ font-size: 2.75em
+ }
+
+ h2 {
+ font-size: 2.3125em
+ }
+
+ h3,
+ #toctitle,
+ .sidebarblock>.content>.title {
+ font-size: 1.6875em
+ }
+
+ h4 {
+ font-size: 1.4375em
+ }
+
+}
+
+table {
+ background: #fff;
+ margin-bottom: 1.25em;
+ border: solid 1px #dddddd;
+}
+
+table thead,
+table tfoot {
+ background: #f7f8f7
+}
+
+table thead tr th,
+table thead tr td,
+table tfoot tr th,
+table tfoot tr td {
+ padding: .5em .625em .625em;
+ font-size: inherit;
+ color: rgba(0, 0, 0, .8);
+ text-align: left
+}
+
+table tr th,
+table tr td {
+ padding: .5625em .625em;
+ font-size: inherit;
+ color: rgba(0, 0, 0, .8)
+}
+
+table tr.even,
+table tr.alt,
+table tr:nth-of-type(even) {
+ background: #f8f8f7
+}
+
+table thead tr th,
+table tfoot tr th,
+table tbody tr td,
+table tr td,
+table tfoot tr td {
+ display: table-cell;
+ line-height: 1.6
+}
+
+h1,
+h2,
+h3,
+#toctitle,
+.sidebarblock>.content>.title,
+h4,
+h5,
+h6 {
+ line-height: 1.2;
+ word-spacing: -.05em
+}
+
+h1 strong,
+h2 strong,
+h3 strong,
+#toctitle strong,
+.sidebarblock>.content>.title strong,
+h4 strong,
+h5 strong,
+h6 strong {
+ font-weight: 400
+}
+
+.clearfix::before,
+.clearfix::after,
+.float-group::before,
+.float-group::after {
+ content: " ";
+ display: table
+}
+
+.clearfix::after,
+.float-group::after {
+ clear: both
+}
+
+*:not(pre)>code {
+ font-size: .9375em;
+ font-style: normal !important;
+ letter-spacing: 0;
+ padding: .1em .5ex;
+ word-spacing: -.15em;
+ background-color: #f7f7f8;
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+ line-height: 1.45;
+ text-rendering: optimizeSpeed;
+ word-wrap: break-word
+}
+
+*:not(pre)>code.nobreak {
+ word-wrap: normal
+}
+
+*:not(pre)>code.nowrap {
+ white-space: nowrap
+}
+
+pre,
+pre>code {
+ line-height: 1.45;
+ color: #585ac2;
+ font-family: "Droid Sans Mono", "DejaVu Sans Mono", monospace;
+ font-weight: 400;
+ text-rendering: optimizeSpeed
+}
+
+em em {
+ font-style: normal
+}
+
+strong strong {
+ font-weight: 400
+}
+
+.keyseq {
+ color: rgba(51, 51, 51, .8)
+}
+
+kbd {
+ font-family: "Droid Sans Mono", "DejaVu Sans Mono", monospace;
+ display: inline-block;
+ color: rgba(0, 0, 0, .8);
+ font-size: .65em;
+ line-height: 1.45;
+ background-color: #f7f7f7;
+ border: 1px solid #dddddd;
+ -webkit-border-radius: 3px;
+ border-radius: 3px;
+ -webkit-box-shadow: 0 1px 0 rgba(0, 0, 0, .2), 0 0 0 .1em white inset;
+ box-shadow: 0 1px 0 rgba(0, 0, 0, .2), 0 0 0 .1em #fff inset;
+ margin: 0 .15em;
+ padding: .2em .5em;
+ vertical-align: middle;
+ position: relative;
+ top: -.1em;
+ white-space: nowrap
+}
+
+.keyseq kbd:first-child {
+ margin-left: 0
+}
+
+.keyseq kbd:last-child {
+ margin-right: 0
+}
+
+.menuseq,
+.menuref {
+ color: #000
+}
+
+.menuseq b:not(.caret),.menuref {
+ font-weight: inherit
+}
+
+.menuseq {
+ word-spacing: -.02em
+}
+
+.menuseq b.caret {
+ font-size: 1.25em;
+ line-height: .8
+}
+
+.menuseq i.caret {
+ font-weight: bold;
+ text-align: center;
+ width: .45em
+}
+
+b.button::before,
+b.button::after {
+ position: relative;
+ top: -1px;
+ font-weight: 400
+}
+
+b.button::before {
+ content: "[";
+ padding: 0 3px 0 2px
+}
+
+b.button::after {
+ content: "]";
+ padding: 0 2px 0 3px
+}
+
+p a>code:hover {
+ color: #585ac2;
+}
+
+#header,
+#content,
+#footnotes,
+#footer {
+ width: 100%;
+ margin-left: auto;
+ margin-right: auto;
+ margin-top: 0;
+ margin-bottom: 0;
+ max-width: 62.5em;
+ *zoom: 1;
+ position: relative;
+ padding-left: .9375em;
+ padding-right: .9375em
+}
+
+#header::before,
+#header::after,
+#content::before,
+#content::after,
+#footnotes::before,
+#footnotes::after,
+#footer::before,
+#footer::after {
+ content: " ";
+ display: table
+}
+
+#header::after,
+#content::after,
+#footnotes::after,
+#footer::after {
+ clear: both
+}
+
+#content {
+ margin-top: 1.25em
+}
+
+#content::before {
+ content: none
+}
+
+#header>h1:first-child {
+ color: #303284;
+ margin-top: 2.25rem;
+ margin-bottom: 0
+}
+
+#header>h1:first-child+#toc {
+ margin-top: 8px;
+ border-top: 1px solid #dddddd
+}
+
+#header>h1:only-child,
+body.toc2 #header>h1:nth-last-child(2) {
+ border-bottom: 1px solid #dddddd;
+ padding-bottom: 8px
+}
+
+#header .details {
+ border-bottom: 1px solid #dddddd;
+ line-height: 1.45;
+ padding-top: .25em;
+ padding-bottom: .25em;
+ padding-left: .25em;
+ color: rgba(0, 0, 0, .6);
+ display: -ms-flexbox;
+ display: -webkit-flex;
+ display: flex;
+ -ms-flex-flow: row wrap;
+ -webkit-flex-flow: row wrap;
+ flex-flow: row wrap
+}
+
+#header .details span:first-child {
+ margin-left: -.125em
+}
+
+#header .details span.email a {
+ color: rgba(0, 0, 0, .85)
+}
+
+#header .details br {
+ display: none
+}
+
+#header .details br+span::before {
+ content: "\00a0\2013\00a0"
+}
+
+#header .details br+span.author::before {
+ content: "\00a0\22c5\00a0";
+ color: rgba(0, 0, 0, .85)
+}
+
+#header .details br+span#revremark::before {
+ content: "\00a0|\00a0"
+}
+
+#header #revnumber {
+ text-transform: capitalize
+}
+
+#header #revnumber::after {
+ content: "\00a0"
+}
+
+#content>h1:first-child:not([class]) {
+ color: rgba(0, 0, 0, .85);
+ border-bottom: 1px solid #dddddd
+;
+ padding-bottom: 8px;
+ margin-top: 0;
+ padding-top: 1rem;
+ margin-bottom: 1.25rem
+}
+
+#toc {
+ border-bottom: 1px solid #dddddd;
+ padding-bottom: .5em
+}
+
+#toc>ul {
+ margin-left: .125em
+}
+
+#toc ul.sectlevel0>li>a {
+ font-style: italic
+}
+
+#toc ul.sectlevel0 ul.sectlevel1 {
+ margin: .5em 0
+}
+
+#toc ul {
+ font-family: "Droid Serif", "DejaVu Sans", sans-serif;
+ list-style-type: none
+}
+
+#toc li {
+ line-height: 1.3334;
+ margin-top: .3334em
+}
+
+#toc a {
+ text-decoration: none
+}
+
+#toc a:active {
+ text-decoration: underline
+}
+
+#toctitle {
+ color: #303284;
+ font-size: 1.2em
+}
+
+@media screen and (min-width:768px) {
+ #toctitle {
+ font-size: 1.375em
+ }
+
+ body.toc2 {
+ padding-left: 15em;
+ padding-right: 0
+ }
+
+ #toc.toc2 {
+ margin-top: 0 !important;
+ background-color: #eee;
+ position: fixed;
+ width: 15em;
+ left: 0;
+ top: 0;
+ border-right: 1px solid #dddddd;
+ border-top-width: 0 !important;
+ border-bottom-width: 0 !important;
+ z-index: 1000;
+ padding: 1.25em 1em;
+ height: 100%;
+ overflow: auto
+ }
+
+ #toc.toc2 #toctitle {
+ margin-top: 0;
+ margin-bottom: .8rem;
+ font-size: 1.2em
+ }
+
+ #toc.toc2>ul {
+ font-size: .9em;
+ margin-bottom: 0
+ }
+
+ #toc.toc2 ul ul {
+ margin-left: 0;
+ padding-left: 1em
+ }
+
+ #toc.toc2 ul.sectlevel0 ul.sectlevel1 {
+ padding-left: 0;
+ margin-top: .5em;
+ margin-bottom: .5em
+ }
+
+ body.toc2.toc-right {
+ padding-left: 0;
+ padding-right: 15em
+ }
+
+ body.toc2.toc-right #toc.toc2 {
+ border-right-width: 0;
+ border-left: 1px solid #dddddd;
+ left: auto;
+ right: 0
+ }
+
+}
+
+@media screen and (min-width:1280px) {
+ body.toc2 {
+ padding-left: 20em;
+ padding-right: 0
+ }
+
+ #toc.toc2 {
+ width: 20em
+ }
+
+ #toc.toc2 #toctitle {
+ font-size: 1.375em
+ }
+
+ #toc.toc2>ul {
+ font-size: .95em
+ }
+
+ #toc.toc2 ul ul {
+ padding-left: 1.25em
+ }
+
+ body.toc2.toc-right {
+ padding-left: 0;
+ padding-right: 20em
+ }
+
+}
+
+#content #toc {
+ border-style: solid;
+ border-width: 1px;
+ border-color: #dddddd;
+ margin-bottom: 1.25em;
+ padding: 1.25em;
+ background: #f8f8f7;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+#content #toc>:first-child {
+ margin-top: 0
+}
+
+#content #toc>:last-child {
+ margin-bottom: 0
+}
+
+#footer {
+ max-width: 100%;
+ background-color: #303284;
+ padding: 1.25em
+}
+
+#footer-text {
+ color: #fff;
+ line-height: 1.44
+}
+
+#content {
+ margin-bottom: .625em
+}
+
+.sect1 {
+ padding-bottom: .625em
+}
+
+@media screen and (min-width:768px) {
+ #content {
+ margin-bottom: 1.25em
+ }
+
+ .sect1 {
+ padding-bottom: 1.25em
+ }
+
+}
+
+.sect1:last-child {
+ padding-bottom: 0
+}
+
+.sect1+.sect1 {
+ border-top: 1px solid #dddddd;
+}
+
+#content h1>a.anchor,
+h2>a.anchor,
+h3>a.anchor,
+#toctitle>a.anchor,
+.sidebarblock>.content>.title>a.anchor,
+h4>a.anchor,
+h5>a.anchor,
+h6>a.anchor {
+ position: absolute;
+ z-index: 1001;
+ width: 1.5ex;
+ margin-left: -1.5ex;
+ display: block;
+ text-decoration: none !important;
+ visibility: hidden;
+ text-align: center;
+ font-weight: 400
+}
+
+#content h1>a.anchor::before,
+h2>a.anchor::before,
+h3>a.anchor::before,
+#toctitle>a.anchor::before,
+.sidebarblock>.content>.title>a.anchor::before,
+h4>a.anchor::before,
+h5>a.anchor::before,
+h6>a.anchor::before {
+ content: "\00A7";
+ font-size: .85em;
+ display: block;
+ padding-top: .1em
+}
+
+#content h1:hover>a.anchor,
+#content h1>a.anchor:hover,
+h2:hover>a.anchor,
+h2>a.anchor:hover,
+h3:hover>a.anchor,
+#toctitle:hover>a.anchor,
+.sidebarblock>.content>.title:hover>a.anchor,
+h3>a.anchor:hover,
+#toctitle>a.anchor:hover,
+.sidebarblock>.content>.title>a.anchor:hover,
+h4:hover>a.anchor,
+h4>a.anchor:hover,
+h5:hover>a.anchor,
+h5>a.anchor:hover,
+h6:hover>a.anchor,
+h6>a.anchor:hover {
+ visibility: visible
+}
+
+#content h1>a.link,
+h2>a.link,
+h3>a.link,
+#toctitle>a.link,
+.sidebarblock>.content>.title>a.link,
+h4>a.link,
+h5>a.link,
+h6>a.link {
+ color: #ba3925;
+ text-decoration: none
+}
+
+#content h1>a.link:hover,
+h2>a.link:hover,
+h3>a.link:hover,
+#toctitle>a.link:hover,
+.sidebarblock>.content>.title>a.link:hover,
+h4>a.link:hover,
+h5>a.link:hover,
+h6>a.link:hover {
+ color: #a53221
+}
+
+.audioblock,
+.imageblock,
+.literalblock,
+.listingblock,
+.stemblock,
+.videoblock {
+ margin-bottom: 1.25em
+}
+
+.admonitionblock td.content>.title,
+.audioblock>.title,
+.exampleblock>.title,
+.imageblock>.title,
+.listingblock>.title,
+.literalblock>.title,
+.stemblock>.title,
+.openblock>.title,
+.paragraph>.title,
+.quoteblock>.title,
+table.tableblock>.title,
+.verseblock>.title,
+.videoblock>.title,
+.dlist>.title,
+.olist>.title,
+.ulist>.title,
+.qlist>.title,
+.hdlist>.title {
+ text-rendering: optimizeLegibility;
+ text-align: left;
+ font-family: "Droid Serif", "DejaVu Serif", serif;
+ font-size: 1rem;
+ font-style: italic
+}
+
+table.tableblock.fit-content>caption.title {
+ white-space: nowrap;
+ width: 0
+}
+
+.paragraph.lead>p,
+#preamble>.sectionbody>[class="paragraph"]:first-of-type p {
+ font-size: 1.21875em;
+ line-height: 1.6;
+ color: rgba(0, 0, 0, .85)
+}
+
+table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p {
+ font-size: inherit
+}
+
+.admonitionblock>table {
+ border-collapse: separate;
+ border: 0;
+ background: none;
+ width: 100%
+}
+
+.admonitionblock>table td.icon {
+ text-align: center;
+ width: 80px
+}
+
+.admonitionblock>table td.icon img {
+ max-width: none
+}
+
+.admonitionblock>table td.icon .title {
+ font-weight: bold;
+ font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ text-transform: uppercase
+}
+
+.admonitionblock>table td.content {
+ padding-left: 1.125em;
+ padding-right: 1.25em;
+ border-left: 1px solid #dddddd;
+ color: rgba(0, 0, 0, .6)
+}
+
+.admonitionblock>table td.content>:last-child>:last-child {
+ margin-bottom: 0
+}
+
+.exampleblock>.content {
+ border-style: solid;
+ border-width: 1px;
+ border-color: #dddddd;
+ margin-bottom: 1.25em;
+ padding: 1.25em;
+ background: #fff;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+.exampleblock>.content>:first-child {
+ margin-top: 0
+}
+
+.exampleblock>.content>:last-child {
+ margin-bottom: 0
+}
+
+.sidebarblock {
+ border-style: solid;
+ border-width: 1px;
+ border-color: #dddddd;
+ margin-bottom: 1.25em;
+ padding: 1.25em;
+ background: #f8f8f7;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+.sidebarblock>:first-child {
+ margin-top: 0
+}
+
+.sidebarblock>:last-child {
+ margin-bottom: 0
+}
+
+.sidebarblock>.content>.title {
+ color: #303284;
+ margin-top: 0;
+ text-align: center
+}
+
+.exampleblock>.content>:last-child>:last-child,
+.exampleblock>.content .olist>ol>li:last-child>:last-child,
+.exampleblock>.content .ulist>ul>li:last-child>:last-child,
+.exampleblock>.content .qlist>ol>li:last-child>:last-child,
+.sidebarblock>.content>:last-child>:last-child,
+.sidebarblock>.content .olist>ol>li:last-child>:last-child,
+.sidebarblock>.content .ulist>ul>li:last-child>:last-child,
+.sidebarblock>.content .qlist>ol>li:last-child>:last-child {
+ margin-bottom: 0
+}
+
+.literalblock pre,
+.listingblock pre:not(.highlight),.listingblock pre[class="highlight"],.listingblock pre[class^="highlight "],.listingblock pre.CodeRay,.listingblock pre.prettyprint {
+ background: #f7f7f8
+}
+
+.sidebarblock .literalblock pre,
+.sidebarblock .listingblock pre:not(.highlight),.sidebarblock .listingblock pre[class="highlight"],.sidebarblock .listingblock pre[class^="highlight "],.sidebarblock .listingblock pre.CodeRay,.sidebarblock .listingblock pre.prettyprint {
+ background: #f2f1f1
+}
+
+.literalblock pre,
+.literalblock pre[class],
+.listingblock pre,
+.listingblock pre[class] {
+ -webkit-border-radius: 4px;
+ border-radius: 4px;
+ word-wrap: break-word;
+ padding: 1em;
+ font-size: .8125em
+}
+
+.literalblock pre.nowrap,
+.literalblock pre[class].nowrap,
+.listingblock pre.nowrap,
+.listingblock pre[class].nowrap {
+ overflow-x: auto;
+ white-space: pre;
+ word-wrap: normal
+}
+
+@media screen and (min-width:768px) {
+ .literalblock pre,
+ .literalblock pre[class],
+ .listingblock pre,
+ .listingblock pre[class] {
+ font-size: .90625em
+ }
+
+}
+
+@media screen and (min-width:1280px) {
+ .literalblock pre,
+ .literalblock pre[class],
+ .listingblock pre,
+ .listingblock pre[class] {
+ font-size: 1em
+ }
+
+}
+
+.literalblock.output pre {
+ color: #f7f7f8;
+ background-color: rgba(0, 0, 0, .9)
+}
+
+.listingblock pre.highlightjs {
+ padding: 0
+}
+
+.listingblock pre.highlightjs>code {
+ padding: 1em;
+ -webkit-border-radius: 4px;
+ border-radius: 4px
+}
+
+.listingblock pre.prettyprint {
+ border-width: 0
+}
+
+.listingblock>.content {
+ position: relative
+}
+
+.listingblock code[data-lang]::before {
+ display: none;
+ content: attr(data-lang);
+ position: absolute;
+ font-size: .75em;
+ top: .425rem;
+ right: .5rem;
+ line-height: 1;
+ text-transform: uppercase;
+ color: #999
+}
+
+.listingblock:hover code[data-lang]::before {
+ display: block
+}
+
+.listingblock.terminal pre .command::before {
+ content: attr(data-prompt);
+ padding-right: .5em;
+ color: #999
+}
+
+.listingblock.terminal pre .command:not([data-prompt])::before {
+ content: "$"
+}
+
+table.pyhltable {
+ border-collapse: separate;
+ border: 0;
+ margin-bottom: 0;
+ background: none
+}
+
+table.pyhltable td {
+ vertical-align: top;
+ padding-top: 0;
+ padding-bottom: 0;
+ line-height: 1.45
+}
+
+table.pyhltable td.code {
+ padding-left: .75em;
+ padding-right: 0
+}
+
+pre.pygments .lineno,
+table.pyhltable td:not(.code) {
+ color: #999;
+ padding-left: 0;
+ padding-right: .5em;
+ border-right: 1px solid #dddddd;
+}
+
+pre.pygments .lineno {
+ display: inline-block;
+ margin-right: .25em
+}
+
+table.pyhltable .linenodiv {
+ background: none !important;
+ padding-right: 0 !important
+}
+
+.quoteblock {
+ margin: 0 1em 1.25em 1.5em;
+ display: table
+}
+
+.quoteblock>.title {
+ margin-left: -1.5em;
+ margin-bottom: .75em
+}
+
+.quoteblock blockquote,
+.quoteblock blockquote p {
+ color: rgba(0, 0, 0, .85);
+ font-size: 1.05rem;
+ line-height: 1.75;
+ word-spacing: .1em;
+ letter-spacing: 0;
+ font-style: italic;
+ text-align: justify
+}
+
+.quoteblock blockquote {
+ margin: 0;
+ padding: 0;
+ border: 0
+}
+
+.quoteblock blockquote::before {
+ content: "\201c";
+ float: left;
+ font-size: 2.75em;
+ font-weight: bold;
+ line-height: .6em;
+ margin-left: -.6em;
+ color: #303284;
+ text-shadow: 0 1px 2px rgba(0, 0, 0, .1)
+}
+
+.quoteblock blockquote>.paragraph:last-child p {
+ margin-bottom: 0
+}
+
+.quoteblock .attribution {
+ margin-top: .5em;
+ margin-right: .5ex;
+ text-align: right
+}
+
+.quoteblock .quoteblock {
+ margin-left: 0;
+ margin-right: 0;
+ padding: .5em 0;
+ border-left: 3px solid rgba(0, 0, 0, .6)
+}
+
+.quoteblock .quoteblock blockquote {
+ padding: 0 0 0 .75em
+}
+
+.quoteblock .quoteblock blockquote::before {
+ display: none
+}
+
+.verseblock {
+ margin: 0 1em 1.25em
+}
+
+.verseblock pre {
+ font-family: "Source Sans Pro", "DejaVu Sans", sans;
+ font-size: 1.15rem;
+ color: rgba(0, 0, 0, .85);
+ font-weight: 300;
+ text-rendering: optimizeLegibility
+}
+
+.verseblock pre strong {
+ font-weight: 400
+}
+
+.verseblock .attribution {
+ margin-top: 1.25rem;
+ margin-left: .5ex
+}
+
+.quoteblock .attribution,
+.verseblock .attribution {
+ font-size: .9375em;
+ line-height: 1.45;
+ font-style: italic
+}
+
+.quoteblock .attribution br,
+.verseblock .attribution br {
+ display: none
+}
+
+.quoteblock .attribution cite,
+.verseblock .attribution cite {
+ display: block;
+ letter-spacing: -.025em;
+ color: rgba(0, 0, 0, .6)
+}
+
+.quoteblock.abstract {
+ margin: 0 1em 1.25em;
+ display: block
+}
+
+.quoteblock.abstract>.title {
+ margin: 0 0 .375em;
+ font-size: 1.15em;
+ text-align: center
+}
+
+.quoteblock.abstract blockquote,
+.quoteblock.abstract blockquote p {
+ word-spacing: 0;
+ line-height: 1.6
+}
+
+.quoteblock.abstract blockquote::before,
+.quoteblock.abstract p::before {
+ display: none
+}
+
+table.tableblock {
+ max-width: 100%;
+ border-collapse: separate
+}
+
+p.tableblock:last-child {
+ margin-bottom: 0
+}
+
+td.tableblock>.content {
+ margin-bottom: -1.25em
+}
+
+table.tableblock,
+th.tableblock,
+td.tableblock {
+ border: 0 solid #dddddd;
+}
+
+table.grid-all>thead>tr>.tableblock,
+table.grid-all>tbody>tr>.tableblock {
+ border-width: 0 1px 1px 0
+}
+
+table.grid-all>tfoot>tr>.tableblock {
+ border-width: 1px 1px 0 0
+}
+
+table.grid-cols>*>tr>.tableblock {
+ border-width: 0 1px 0 0
+}
+
+table.grid-rows>thead>tr>.tableblock,
+table.grid-rows>tbody>tr>.tableblock {
+ border-width: 0 0 1px
+}
+
+table.grid-rows>tfoot>tr>.tableblock {
+ border-width: 1px 0 0
+}
+
+table.grid-all>*>tr>.tableblock:last-child,
+table.grid-cols>*>tr>.tableblock:last-child {
+ border-right-width: 0
+}
+
+table.grid-all>tbody>tr:last-child>.tableblock,
+table.grid-all>thead:last-child>tr>.tableblock,
+table.grid-rows>tbody>tr:last-child>.tableblock,
+table.grid-rows>thead:last-child>tr>.tableblock {
+ border-bottom-width: 0
+}
+
+table.frame-all {
+ border-width: 1px
+}
+
+table.frame-sides {
+ border-width: 0 1px
+}
+
+table.frame-topbot,
+table.frame-ends {
+ border-width: 1px 0
+}
+
+table.stripes-all tr,
+table.stripes-odd tr:nth-of-type(odd) {
+ background: #f8f8f7
+}
+
+table.stripes-none tr,
+table.stripes-odd tr:nth-of-type(even) {
+ background: none
+}
+
+th.halign-left,
+td.halign-left {
+ text-align: left
+}
+
+th.halign-right,
+td.halign-right {
+ text-align: right
+}
+
+th.halign-center,
+td.halign-center {
+ text-align: center
+}
+
+th.valign-top,
+td.valign-top {
+ vertical-align: top
+}
+
+th.valign-bottom,
+td.valign-bottom {
+ vertical-align: bottom
+}
+
+th.valign-middle,
+td.valign-middle {
+ vertical-align: middle
+}
+
+table thead th,
+table tfoot th {
+ font-weight: bold
+}
+
+tbody tr th {
+ display: table-cell;
+ line-height: 1.6;
+ background: #f7f8f7
+}
+
+tbody tr th,
+tbody tr th p,
+tfoot tr th,
+tfoot tr th p {
+ color: rgba(0, 0, 0, .8);
+ font-weight: bold
+}
+
+p.tableblock>code:only-child {
+ background: none;
+ padding: 0
+}
+
+p.tableblock {
+ font-size: 1em
+}
+
+td>div.verse {
+ white-space: pre
+}
+
+ol {
+ margin-left: 1.75em
+}
+
+ul li ol {
+ margin-left: 1.5em
+}
+
+dl dd {
+ margin-left: 1.125em
+}
+
+dl dd:last-child,
+dl dd:last-child>:last-child {
+ margin-bottom: 0
+}
+
+ol>li p,
+ul>li p,
+ul dd,
+ol dd,
+.olist .olist,
+.ulist .ulist,
+.ulist .olist,
+.olist .ulist {
+ margin-bottom: .625em
+}
+
+ul.checklist,
+ul.none,
+ol.none,
+ul.no-bullet,
+ol.no-bullet,
+ol.unnumbered,
+ul.unstyled,
+ol.unstyled {
+ list-style-type: none
+}
+
+ul.no-bullet,
+ol.no-bullet,
+ol.unnumbered {
+ margin-left: .625em
+}
+
+ul.unstyled,
+ol.unstyled {
+ margin-left: 0
+}
+
+ul.checklist {
+ margin-left: .625em
+}
+
+ul.checklist li>p:first-child>.fa-square-o:first-child,
+ul.checklist li>p:first-child>.fa-check-square-o:first-child {
+ width: 1.25em;
+ font-size: .8em;
+ position: relative;
+ bottom: .125em
+}
+
+ul.checklist li>p:first-child>input[type="checkbox"]:first-child {
+ margin-right: .25em
+}
+
+ul.inline {
+ display: -ms-flexbox;
+ display: -webkit-box;
+ display: flex;
+ -ms-flex-flow: row wrap;
+ -webkit-flex-flow: row wrap;
+ flex-flow: row wrap;
+ list-style: none;
+ margin: 0 0 .625em -1.25em
+}
+
+ul.inline>li {
+ margin-left: 1.25em
+}
+
+.unstyled dl dt {
+ font-weight: 400;
+ font-style: normal
+}
+
+ol.arabic {
+ list-style-type: decimal
+}
+
+ol.decimal {
+ list-style-type: decimal-leading-zero
+}
+
+ol.loweralpha {
+ list-style-type: lower-alpha
+}
+
+ol.upperalpha {
+ list-style-type: upper-alpha
+}
+
+ol.lowerroman {
+ list-style-type: lower-roman
+}
+
+ol.upperroman {
+ list-style-type: upper-roman
+}
+
+ol.lowergreek {
+ list-style-type: lower-greek
+}
+
+.hdlist>table,
+.colist>table {
+ border: 0;
+ background: none
+}
+
+.hdlist>table>tbody>tr,
+.colist>table>tbody>tr {
+ background: none
+}
+
+td.hdlist1,
+td.hdlist2 {
+ vertical-align: top;
+ padding: 0 .625em
+}
+
+td.hdlist1 {
+ font-weight: bold;
+ padding-bottom: 1.25em
+}
+
+.literalblock+.colist,
+.listingblock+.colist {
+ margin-top: -.5em
+}
+
+.colist td:not([class]):first-child {
+ padding: .4em .75em 0;
+ line-height: 1;
+ vertical-align: top
+}
+
+.colist td:not([class]):first-child img {
+ max-width: none
+}
+
+.colist td:not([class]):last-child {
+ padding: .25em 0
+}
+
+.thumb,
+.th {
+ line-height: 0;
+ display: inline-block;
+ border: solid 4px #fff;
+ -webkit-box-shadow: 0 0 0 1px #ddd;
+ box-shadow: 0 0 0 1px #ddd
+}
+
+.imageblock.left,
+.imageblock[style*="float:left"] {
+ margin: .25em .625em 1.25em 0
+}
+
+.imageblock.right,
+.imageblock[style*="float:right"] {
+ margin: .25em 0 1.25em .625em
+}
+
+.imageblock>.title {
+ margin-bottom: 0
+}
+
+.imageblock.thumb,
+.imageblock.th {
+ border-width: 6px
+}
+
+.imageblock.thumb>.title,
+.imageblock.th>.title {
+ padding: 0 .125em
+}
+
+.image.left,
+.image.right {
+ margin-top: .25em;
+ margin-bottom: .25em;
+ display: inline-block;
+ line-height: 0
+}
+
+.image.left {
+ margin-right: .625em
+}
+
+.image.right {
+ margin-left: .625em
+}
+
+a.image {
+ text-decoration: none;
+ display: inline-block
+}
+
+a.image object {
+ pointer-events: none
+}
+
+sup.footnote,
+sup.footnoteref {
+ font-size: .875em;
+ position: static;
+ vertical-align: super
+}
+
+sup.footnote a,
+sup.footnoteref a {
+ text-decoration: none
+}
+
+sup.footnote a:active,
+sup.footnoteref a:active {
+ text-decoration: underline
+}
+
+#footnotes {
+ padding-top: .75em;
+ padding-bottom: .75em;
+ margin-bottom: .625em
+}
+
+#footnotes hr {
+ width: 20%;
+ min-width: 6.25em;
+ margin: -.25em 0 .75em;
+ border-width: 1px 0 0
+}
+
+#footnotes .footnote {
+ padding: 0 .375em 0 .225em;
+ line-height: 1.3334;
+ font-size: .875em;
+ margin-left: 1.2em;
+ margin-bottom: .2em
+}
+
+#footnotes .footnote a:first-of-type {
+ font-weight: bold;
+ text-decoration: none;
+ margin-left: -1.05em
+}
+
+#footnotes .footnote:last-of-type {
+ margin-bottom: 0
+}
+
+#content #footnotes {
+ margin-top: -.625em;
+ margin-bottom: 0;
+ padding: .75em 0
+}
+
+.gist .file-data>table {
+ border: 0;
+ background: #fff;
+ width: 100%;
+ margin-bottom: 0
+}
+
+.gist .file-data>table td.line-data {
+ width: 99%
+}
+
+div.unbreakable {
+ page-break-inside: avoid
+}
+
+.big {
+ font-size: larger
+}
+
+.small {
+ font-size: smaller
+}
+
+.underline {
+ text-decoration: underline
+}
+
+.overline {
+ text-decoration: overline
+}
+
+.line-through {
+ text-decoration: line-through
+}
+
+.aqua {
+ color: #00bfbf
+}
+
+.aqua-background {
+ background-color: #00fafa
+}
+
+.black {
+ color: #000
+}
+
+.black-background {
+ background-color: #000
+}
+
+.blue {
+ color: #0000bf
+}
+
+.blue-background {
+ background-color: #0000fa
+}
+
+.fuchsia {
+ color: #bf00bf
+}
+
+.fuchsia-background {
+ background-color: #fa00fa
+}
+
+.gray {
+ color: #606060
+}
+
+.gray-background {
+ background-color: #7d7d7d
+}
+
+.green {
+ color: #006000
+}
+
+.green-background {
+ background-color: #007d00
+}
+
+.lime {
+ color: #00bf00
+}
+
+.lime-background {
+ background-color: #00fa00
+}
+
+.maroon {
+ color: #600000
+}
+
+.maroon-background {
+ background-color: #7d0000
+}
+
+.navy {
+ color: #000060
+}
+
+.navy-background {
+ background-color: #00007d
+}
+
+.olive {
+ color: #606000
+}
+
+.olive-background {
+ background-color: #7d7d00
+}
+
+.purple {
+ color: #600060
+}
+
+.purple-background {
+ background-color: #7d007d
+}
+
+.red {
+ color: #bf0000
+}
+
+.red-background {
+ background-color: #fa0000
+}
+
+.silver {
+ color: #909090
+}
+
+.silver-background {
+ background-color: #bcbcbc
+}
+
+.teal {
+ color: #006060
+}
+
+.teal-background {
+ background-color: #007d7d
+}
+
+.white {
+ color: #bfbfbf
+}
+
+.white-background {
+ background-color: #fafafa
+}
+
+.yellow {
+ color: #bfbf00
+}
+
+.yellow-background {
+ background-color: #fafa00
+}
+
+span.icon>.fa {
+ cursor: default
+}
+
+a span.icon>.fa {
+ cursor: inherit
+}
+
+.admonitionblock td.icon [class^="fa icon-"] {
+ font-size: 2.5em;
+ text-shadow: 1px 1px 2px rgba(0, 0, 0, .5);
+ cursor: default
+}
+
+.admonitionblock td.icon .icon-note::before {
+ content: "\f05a";
+ color: #19407c
+}
+
+.admonitionblock td.icon .icon-tip::before {
+ content: "\f0eb";
+ text-shadow: 1px 1px 2px rgba(155, 155, 0, .8);
+ color: #111
+}
+
+.admonitionblock td.icon .icon-warning::before {
+ content: "\f071";
+ color: #bf6900
+}
+
+.admonitionblock td.icon .icon-caution::before {
+ content: "\f06d";
+ color: #bf3400
+}
+
+.admonitionblock td.icon .icon-important::before {
+ content: "\f06a";
+ color: #bf0000
+}
+
+.conum[data-value] {
+ display: inline-block;
+ color: #fff !important;
+ background-color: rgba(0, 0, 0, .8);
+ -webkit-border-radius: 100px;
+ border-radius: 100px;
+ text-align: center;
+ font-size: .75em;
+ width: 1.67em;
+ height: 1.67em;
+ line-height: 1.67em;
+ font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ font-style: normal;
+ font-weight: bold
+}
+
+.conum[data-value] * {
+ color: #fff !important
+}
+
+.conum[data-value]+b {
+ display: none
+}
+
+.conum[data-value]::after {
+ content: attr(data-value)
+}
+
+pre .conum[data-value] {
+ position: relative;
+ top: -.125em
+}
+
+b.conum * {
+ color: inherit !important
+}
+
+.conum:not([data-value]):empty {
+ display: none
+}
+
+dt,
+th.tableblock,
+td.content,
+div.footnote {
+ text-rendering: optimizeLegibility
+}
+
+h1,
+h2,
+p,
+td.content,
+span.alt {
+ letter-spacing: -.01em
+}
+
+p strong,
+td.content strong,
+div.footnote strong {
+ letter-spacing: -.005em
+}
+
+p,
+blockquote,
+dt,
+td.content,
+span.alt {
+ /*font-size: 1.0625rem*/
+}
+
+p {
+ margin-bottom: 1.25rem
+}
+
+.sidebarblock p,
+.sidebarblock dt,
+.sidebarblock td.content,
+p.tableblock {
+ font-size: 1em
+}
+
+.exampleblock>.content {
+ background-color: #fffef7;
+ border-color: #dddddd;
+ -webkit-box-shadow: 0 1px 4px #e0e0dc;
+ box-shadow: 0 1px 4px #e0e0dc
+}
+
+.print-only {
+ display: none !important
+}
+
+@page {
+ margin: 1.25cm .75cm
+}
+
+@media print {
+ * {
+ -webkit-box-shadow: none !important;
+ box-shadow: none !important;
+ text-shadow: none !important
+ }
+
+ html {
+ font-size: 80%
+ }
+
+ a {
+ color: inherit !important;
+ text-decoration: underline !important
+ }
+
+ a.bare,
+ a[href^="#"],
+ a[href^="mailto:"] {
+ text-decoration: none !important
+ }
+
+ a[href^="http:"]:not(.bare)::after,
+ a[href^="https:"]:not(.bare)::after {
+ content: "("attr(href) ")";
+ display: inline-block;
+ font-size: .875em;
+ padding-left: .25em
+ }
+
+ abbr[title]::after {
+ content: " ("attr(title) ")"
+ }
+
+ pre,
+ blockquote,
+ tr,
+ img,
+ object,
+ svg {
+ page-break-inside: avoid
+ }
+
+ thead {
+ display: table-header-group
+ }
+
+ svg {
+ max-width: 100%
+ }
+
+ p,
+ blockquote,
+ dt,
+ td.content {
+ font-size: 1em;
+ orphans: 3;
+ widows: 3
+ }
+
+ h2,
+ h3,
+ #toctitle,
+ .sidebarblock>.content>.title {
+ page-break-after: avoid
+ }
+
+ #toc,
+ .sidebarblock,
+ .exampleblock>.content {
+ background: none !important
+ }
+
+ #toc {
+ border-bottom: 1px solid #dddddd !important;
+ padding-bottom: 0 !important
+ }
+
+ body.book #header {
+ text-align: center
+ }
+
+ body.book #header>h1:first-child {
+ border: 0 !important;
+ margin: 2.5em 0 1em
+ }
+
+ body.book #header .details {
+ border: 0 !important;
+ display: block;
+ padding: 0 !important
+ }
+
+ body.book #header .details span:first-child {
+ margin-left: 0 !important
+ }
+
+ body.book #header .details br {
+ display: block
+ }
+
+ body.book #header .details br+span::before {
+ content: none !important
+ }
+
+ body.book #toc {
+ border: 0 !important;
+ text-align: left !important;
+ padding: 0 !important;
+ margin: 0 !important
+ }
+
+ body.book #toc,
+ body.book #preamble,
+ body.book h1.sect0,
+ body.book .sect1>h2 {
+ page-break-before: always
+ }
+
+ .listingblock code[data-lang]::before {
+ display: block
+ }
+
+ #footer {
+ padding: 0 .9375em
+ }
+
+ .hide-on-print {
+ display: none !important
+ }
+
+ .print-only {
+ display: block !important
+ }
+
+ .hide-for-print {
+ display: none !important
+ }
+
+ .show-for-print {
+ display: inherit !important
+ }
+
+}
+
+@media print, amzn-kf8 {
+ #header>h1:first-child {
+ margin-top: 1.25rem
+ }
+
+ .sect1 {
+ padding: 0 !important
+ }
+
+ .sect1+.sect1 {
+ border: 0
+ }
+
+ #footer {
+ background: none
+ }
+
+ #footer-text {
+ color: rgba(0, 0, 0, .6);
+ font-size: .9em
+ }
+
+}
+
+@media amzn-kf8 {
+ #header,
+ #content,
+ #footnotes,
+ #footer {
+ padding: 0
+ }
+
+}
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/building-and-deploying.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/building-and-deploying.adoc b/manual/src/archives/1.2/asciidoc/building-and-deploying.adoc
new file mode 100644
index 0000000..64075e9
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/building-and-deploying.adoc
@@ -0,0 +1,268 @@
+//
+// Licensed 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.
+//
+
+=== Building
+
+==== Initial Setup
+
+1) Install J2SE 8.0 SDK (or later), which can be downloaded from
+ http://www.oracle.com/technetwork/java/javase/downloads/index.html[http://www.oracle.com/technetwork/java/javase/downloads/index.html]
+
+2) Make sure that your JAVA_HOME environment variable is set to the newly installed
+ JDK location, and that your PATH includes %JAVA_HOME%\bin (windows) or
+ $JAVA_HOME$/bin (unix).
+
+3) Install Maven 3.0.3 (or later), which can be downloaded from
+ http://maven.apache.org/download.html[http://maven.apache.org/download.html]. Make sure that your PATH includes
+ the MVN_HOME/bin directory.
+
+==== Building
+
+1) Change to the top level directory of Apache Unomi source distribution.
+2) Run
+
+[source]
+----
+ $> mvn clean install
+----
+
+This will compile Apache Unomi and run all of the tests in the
+ Apache Unomi source distribution. Alternatively, you can run
+
+[source]
+----
+ $> mvn -P \!integration-tests,\!performance-tests clean install
+----
+
+This will compile Apache Unomi without running the tests and takes less
+ time to build.
+
+3) The distributions will be available under "package/target" directory.
+
+==== Installing an ElasticSearch server
+
+Starting with version 1.2, Apache Unomi no longer embeds an ElasticSearch server as this is no longer supported by
+the developers of ElasticSearch. Therefore you will need to install a standalone ElasticSearch using the following steps:
+
+.
+
+Download an ElasticSearch version. Here's the version you will need depending
+on your version of Apache Unomi.
+
+Apache Unomi <= 1.2 : https://www.elastic.co/downloads/past-releases/elasticsearch-5-1-2[https://www.elastic.co/downloads/past-releases/elasticsearch-5-1-2]
+Apache Unomi >= 1.3 : https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-3[https://www.elastic.co/downloads/past-releases/elasticsearch-5-6-3]
+
+.
+
+Uncompress the downloaded package into a directory
+
+.
+
+In the config/elasticsearch.yml file, uncomment and modify the following line :
+
+[source]
+----
+cluster.name: contextElasticSearch
+----
+
+.
+
+Launch the server using
+
+[source]
+----
+bin/elasticsearch (Mac, Linux)
+bin\elasticsearch.bat (Windows)
+----
+
+.
+
+Check that the ElasticSearch is up and running by accessing the following URL :
+
+http://localhost:9200[http://localhost:9200]
+
+==== Deploying the generated binary package
+
+The "package" sub-project generates a pre-configured Apache Karaf installation that is the simplest way to get started.
+Simply uncompress the package/target/unomi-VERSION.tar.gz (for Linux or Mac OS X) or
+ package/target/unomi-VERSION.zip (for Windows) archive into the directory of your choice.
+
+You can then start the server simply by using the command on UNIX/Linux/MacOS X :
+
+[source]
+----
+./bin/karaf
+----
+
+or on Windows shell :
+
+[source]
+----
+bin\karaf.bat
+----
+
+==== Deploying into an existing Karaf server
+
+This is only needed if you didn't use the generated package. Also, this is the preferred way to install a development
+environment if you intend to re-deploy the context server KAR iteratively.
+
+Additional requirements:
+* Apache Karaf 3.x, http://karaf.apache.org[http://karaf.apache.org]
+
+.
+
+Before deploying, make sure that you have Apache Karaf properly installed. You will also have to increase the
+default maximum memory size and perm gen size by adjusting the following environment values in the bin/setenv(.bat)
+files (at the end of the file):
+
+[source]
+----
+ MY_DIRNAME=`dirname $0`
+ MY_KARAF_HOME=`cd "$MY_DIRNAME/.."; pwd`
+ export JAVA_MAX_MEM=3G
+ export JAVA_MAX_PERM_MEM=384M
+----
+
+.
+
+Install the WAR support, CXF and Karaf Cellar into Karaf by doing the following in the Karaf command line:
+
+[source]
+----
+ feature:repo-add cxf 3.0.2
+ feature:repo-add cellar 3.0.3
+ feature:repo-add mvn:org.apache.unomi/unomi-kar/VERSION/xml/features
+ feature:install unomi-kar
+----
+
+.
+
+Create a new $MY_KARAF_HOME/etc/org.apache.cxf.osgi.cfg file and put the following property inside :
+
+[source]
+----
+ org.apache.cxf.servlet.context=/cxs
+----
+
+.
+
+If all went smoothly, you should be able to access the context script here : http://localhost:8181/cxs/cluster[http://localhost:8181/cxs/cluster] .
+ You should be able to login with karaf / karaf and see basic server information. If not something went wrong during the install.
+
+==== JDK Selection on Mac OS X
+
+You might need to select the JDK to run the tests in the itests subproject. In order to do so you can list the
+installed JDKs with the following command :
+
+[source]
+----
+/usr/libexec/java_home -V
+----
+
+which will output something like this :
+
+[source]
+----
+Matching Java Virtual Machines (7):
+ 1.7.0_51, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_51.jdk/Contents/Home
+ 1.7.0_45, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_45.jdk/Contents/Home
+ 1.7.0_25, x86_64: "Java SE 7" /Library/Java/JavaVirtualMachines/jdk1.7.0_25.jdk/Contents/Home
+ 1.6.0_65-b14-462, x86_64: "Java SE 6" /Library/Java/JavaVirtualMachines/1.6.0_65-b14-462.jdk/Contents/Home
+ 1.6.0_65-b14-462, i386: "Java SE 6" /Library/Java/JavaVirtualMachines/1.6.0_65-b14-462.jdk/Contents/Home
+ 1.6.0_65-b14-462, x86_64: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
+ 1.6.0_65-b14-462, i386: "Java SE 6" /System/Library/Java/JavaVirtualMachines/1.6.0.jdk/Contents/Home
+----
+
+You can then select the one you want using :
+
+[source]
+----
+export JAVA_HOME=`/usr/libexec/java_home -v 1.7.0_51`
+----
+
+and then check that it was correctly referenced using:
+
+[source]
+----
+java -version
+----
+
+which should give you a result such as this:
+
+[source]
+----
+java version "1.7.0_51"
+Java(TM) SE Runtime Environment (build 1.7.0_51-b13)
+Java HotSpot(TM) 64-Bit Server VM (build 24.51-b03, mixed mode)
+----
+
+==== Running the integration tests
+
+The integration tests are not executed by default to make build time minimal, but it is recommended to run the
+integration tests at least once before using the server to make sure that everything is ok in the build. Another way
+to use these tests is to run them from a continuous integration server such as Jenkins, Apache Gump, Atlassian Bamboo or
+ others.
+
+Note : the integration tests require a JDK 7 or more recent !
+
+To run the tests simply activate the following profile :
+
+[source]
+----
+mvn -P integration-tests clean install
+----
+
+==== Running the performance tests
+
+Performance tests are based on Gatling. You need to have a running context server or cluster of servers before
+executing the tests.
+
+Test parameteres are editable in the performance-tests/src/test/scala/unomi/Parameters.scala file. baseUrls should
+contains the URLs of all your cluster nodes
+
+Run the test by using the gatling.conf file in performance-tests/src/test/resources :
+
+[source]
+----
+ export GATLING_CONF=<path>/performance-tests/src/test/resources
+ gatling.sh
+----
+
+Reports are generated in performance-tests/target/results.
+
+==== Testing with an example page
+
+A default test page is provided at the following URL:
+
+[source]
+----
+ http://localhost:8181/index.html
+----
+
+This test page will trigger the loading of the /context.js script, which will try to retrieving the user context
+or create a new one if it doesn't exist yet. It also contains an experimental integration with Facebook Login, but it
+doesn't yet save the context back to the context server.
+
+==== Integrating onto a page
+
+Simply reference the context script in your HTML as in the following example:
+
+[source,javascript]
+----
+<script type="text/javascript">
+ (function(){ var u=(("https:" == document.location.protocol) ? "https://localhost:8181/" : "http://localhost:8181/");
+ var d=document, g=d.createElement('script'), s=d.getElementsByTagName('script')[0]; g.type='text/javascript'; g.defer=true; g.async=true; g.src=u+'context.js';
+ s.parentNode.insertBefore(g,s); })();
+</script>
+----
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/clustering.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/clustering.adoc b/manual/src/archives/1.2/asciidoc/clustering.adoc
new file mode 100644
index 0000000..cb0a1ef
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/clustering.adoc
@@ -0,0 +1,84 @@
+//
+// Licensed 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.
+//
+
+=== Cluster setup
+
+Apache Karaf relies on Apache Karaf Cellar, which in turn uses Hazelcast to discover and configure its cluster.
+You just need to install multiple context servers on the same network, and then (optionally) change the Hazelcast
+ configuration in the following file :
+
+[source]
+----
+etc/hazelcast.xml
+----
+
+All nodes on the same network, sharing the same cluster name will be part of the same cluster.
+
+For the actual ElasticSearch configuration however, this must be done using the following file:
+
+[source]
+----
+etc/org.apache.unomi.persistence.elasticsearch.cfg
+----
+
+Depending on the cluster size, you will want to adjust the following parameters to make sure your setup is optimal in
+terms of performance and safety.
+
+==== 2 nodes configuration
+
+One node dedicated to context server, 1 node for elasticsearch storage.
+
+Node A :
+
+[source]
+----
+numberOfReplicas=0
+monthlyIndex.numberOfReplicas=0
+----
+
+Node B :
+
+[source]
+----
+numberOfReplicas=0
+monthlyIndex.numberOfReplicas=0
+----
+
+==== 3 nodes configuration
+
+One node dedicated to context server, 2 nodes for elasticsearch storage with fault-tolerance
+
+Node A :
+
+[source]
+----
+numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+----
+
+Node B :
+
+[source]
+----
+numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+----
+
+Node C :
+
+[source]
+----
+numberOfReplicas=1
+monthlyIndex.numberOfReplicas=1
+----
\ No newline at end of file
[4/8] incubator-unomi git commit: Add archives versions of
documentation in asciidoc
Posted by sh...@apache.org.
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/samples/twitter-sample.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/samples/twitter-sample.adoc b/manual/src/archives/1.2/asciidoc/samples/twitter-sample.adoc
new file mode 100644
index 0000000..23de08c
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/samples/twitter-sample.adoc
@@ -0,0 +1,433 @@
+//
+// Licensed 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.
+//
+
+=== Twitter sample
+
+==== Overview
+
+We will examine how a simple HTML page can interact with Unomi to enrich a user's profile. The use case we will follow
+is a rather simple one: we use a Twitter button to record the number of times the visitor tweeted (as a `tweetNb` profile
+integer property) as well as the URLs they tweeted from (as a `tweetedFrom` multi-valued string profile property).
+A javascript script will use the Twitter API to react to clicks on this button
+and update the user profile using a `ContextServlet` request triggering a custom event. This event will, in turn,
+trigger a Unomi action on the server implemented using a Unomi plugin, a standard extension point for the server.
+
+===== Building the tweet button sample
+
+In your local copy of the Unomi repository and run:
+
+[source]
+----
+cd samples/tweet-button-plugin
+mvn clean install
+----
+
+This will compile and create the OSGi bundle that can be deployed on Unomi to extend it.
+
+===== Deploying the tweet button sample
+
+In standard Karaf fashion, you will need to copy the sample bundle to your Karaf `deploy` directory.
+
+If you are using the packaged version of Unomi (as opposed to deploying it to your own Karaf version), you can simply run, assuming your current directory is `samples/tweet-button-plugin` and that you uncompressed the archive in the directory it was created:
+
+[source]
+----
+cp target/tweet-button-plugin-1.0.0-incubating-SNAPSHOT.jar ../../package/target/unomi-1.0.0-incubating-SNAPSHOT/deploy
+----
+
+===== Testing the sample
+
+You can now go to http://localhost:8181/index.html[http://localhost:8181/index.html] to test the sample code. The page is very simple, you will see a Twitter button, which, once clicked, will open a new window to tweet about the current page. The original page should be updated with the new values of the properties coming from Unomi. Additionnally, the raw JSON response is displayed.
+
+We will now explain in greater details some concepts and see how the example works.
+
+==== Interacting with the context server
+
+There are essentially two modalities to interact with the context server, reflecting different types of Unomi users: context server clients and context server integrators.
+
+*Context server clients* are usually web applications or content management systems. They interact with Unomi by providing raw, uninterpreted contextual data in the form of events and associated metadata. That contextual data is then processed by the context server to be fed to clients once actionable. In that sense context server clients are both consumers and producers of contextual data. Context server clients will mostly interact with Unomi using a single entry point called the `ContextServlet`, requesting context for the current user and providing any triggered events along the way.
+
+On the other hand, *context server integrators* provide ways to feed more structured data to the context server either to integrate with third party services or to provide analysis of the uninterpreted data provided by context server clients. Such integration will mostly be done using Unomi's API either directly using Unomi plugins or via the provided REST APIs. However, access to REST APIs is restricted due for security reasons, requiring privileged access to the Unomi server, making things a little more complex to set up.
+
+For simplicity's sake, this document will focus solely on the first use case and will interact only with the context servlet.
+
+==== Retrieving context information from Unomi using the context servlet
+
+Unomi provides two ways to retrieve context: either as a pure JSON object containing strictly context information or as a couple of JSON objects augmented with javascript functions that can be used to interact with the Unomi server using the `<context server base URL>/context.json` or `<context server base URL>/context.js` URLs, respectively.
+
+Below is an example of asynchronously loading the initial context using the javascript version, assuming a default Unomi install running on `http://localhost:8181`:
+
+[source,javascript]
+----
+// Load context from Unomi asynchronously
+(function (document, elementToCreate, id) {
+ var js, fjs = document.getElementsByTagName(elementToCreate)[0];
+ if (document.getElementById(id)) return;
+ js = document.createElement(elementToCreate);
+ js.id = id;
+ js.src = 'http://localhost:8181/context.js';
+ fjs.parentNode.insertBefore(js, fjs);
+}(document, 'script', 'context'));
+
+----
+
+This initial context results in a javascript file providing some functions to interact with the context server from javascript along with two objects: a `cxs` object containing
+information about the context for the current user and a `digitalData` object that is injected into the browser’s `window` object (leveraging the
+http://www.w3.org/2013/12/ceddl-201312.pdf[Customer Experience Digital Data Layer] standard). Note that this last object is not under control of the context server and clients
+ are free to use it or not. Our example will not make use of it.
+
+On the other hand, the `cxs` top level object contains interesting contextual information about the current user:
+
+[source,json]
+----
+{
+ "profileId":<identifier of the profile associated with the current user>,
+ "sessionId":<identifier of the current user session>,
+ "profileProperties":<requested profile properties, if any>,
+ "sessionProperties":<requested session properties, if any>,
+ "profileSegments":<segments the profile is part of if requested>,
+ "filteringResults":<result of the evaluation of personalization filters>,
+ "trackedConditions":<tracked conditions in the source page, if any>
+}
+----
+
+We will look at the details of the context request and response later.
+
+=== Example
+
+==== HTML page
+
+The code for the HTML page with our Tweet button can be found at https://github.com/apache/incubator-unomi/blob/master/wab/src/main/webapp/index.html[https://github.com/apache/incubator-unomi/blob/master/wab/src/main/webapp/index.html].
+
+This HTML page is fairly straightforward: we create a tweet button using the Twitter API while a Javascript script performs the actual logic.
+
+==== Javascript
+
+Globally, the script loads both the twitter widget and the initial context asynchronously (as shown previously). This is accomplished using fairly standard javascript code and we won't look at it here. Using the Twitter API, we react to the `tweet` event and call the Unomi server to update the user's profile with the required information, triggering a custom `tweetEvent` event. This is accomplished using a `contextRequest` function which is an extended version of a classic `AJAX` request:
+
+[source,javascript]
+----
+function contextRequest(successCallback, errorCallback, payload) {
+ var data = JSON.stringify(payload);
+ // if we don't already have a session id, generate one
+ var sessionId = cxs.sessionId || generateUUID();
+ var url = 'http://localhost:8181/context.json?sessionId=' + sessionId;
+ var xhr = new XMLHttpRequest();
+ var isGet = data.length < 100;
+ if (isGet) {
+ xhr.withCredentials = true;
+ xhr.open("GET", url + "&payload=" + encodeURIComponent(data), true);
+ } else if ("withCredentials" in xhr) {
+ xhr.open("POST", url, true);
+ xhr.withCredentials = true;
+ } else if (typeof XDomainRequest != "undefined") {
+ xhr = new XDomainRequest();
+ xhr.open("POST", url);
+ }
+ xhr.onreadystatechange = function () {
+ if (xhr.readyState != 4) {
+ return;
+ }
+ if (xhr.status == 200) {
+ var response = xhr.responseText ? JSON.parse(xhr.responseText) : undefined;
+ if (response) {
+ cxs.sessionId = response.sessionId;
+ successCallback(response);
+ }
+ } else {
+ console.log("contextserver: " + xhr.status + " ERROR: " + xhr.statusText);
+ if (errorCallback) {
+ errorCallback(xhr);
+ }
+ }
+ };
+ xhr.setRequestHeader("Content-Type", "text/plain;charset=UTF-8"); // Use text/plain to avoid CORS preflight
+ if (isGet) {
+ xhr.send();
+ } else {
+ xhr.send(data);
+ }
+}
+----
+
+There are a couple of things to note here:
+
+* If we specify a payload, it is expected to use the JSON format so we `stringify` it and encode it if passed as a URL parameter in a `GET` request.
+* We need to make a https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS[`CORS`] request since the Unomi server is most likely not running on the same host than the one from which the request originates. The specific details are fairly standard and we will not explain them here.
+* We need to either retrieve (from the initial context we retrieved previously using `cxs.sessionId`) or generate a session identifier for our request since Unomi currently requires one.
+* We're calling the `ContextServlet` using the default install URI, specifying the session identifier: `http://localhost:8181/context.json?sessionId=' + sessionId`. This URI requests context from Unomi, resulting in an updated `cxs` object in the javascript global scope. The context server can reply to this request either by returning a JSON-only object containing solely the context information as is the case when the requested URI is `context.json`. However, if the client requests `context.js` then useful functions to interact with Unomi are added to the `cxs` object in addition to the context information as depicted above.
+* We don't need to provide any authentication at all to interact with this part of Unomi since we only have access to read-only data (as well as providing events as we shall see later on). If we had been using the REST API, we would have needed to provide authentication information as well.
+
+===== Context request and response structure
+
+The interesting part, though, is the payload. This is where we provide Unomi with contextual information as well as ask for data in return. This allows clients to specify which type of information they are interested in getting from the context server as well as specify incoming events or content filtering or property/segment overrides for personalization or impersonation. This conditions what the context server will return with its response.
+
+Let's look at the context request structure:
+
+[source,json]
+----
+{
+ source: <Item source of the context request>,
+ events: <optional array of triggered events>,
+ requiredProfileProperties: <optional array of property identifiers>,
+ requiredSessionProperties: <optional array of property identifiers>,
+ filters: <optional array of filters to evaluate>,
+ profileOverrides: <optional profile containing segments,scores or profile properties to override>,
+ - segments: <optional array of segment identifiers>,
+ - profileProperties: <optional map of property name / value pairs>,
+ - scores: <optional map of score id / value pairs>
+ sessionPropertiesOverrides: <optional map of property name / value pairs>,
+ requireSegments: <boolean, whether to return the associated segments>
+}
+----
+
+We will now look at each part in greater details.
+
+====== Source
+
+A context request payload needs to at least specify some information about the source of the request in the form of an `Item` (meaning identifier, type and scope plus any additional properties we might have to provide), via the `source` property of the payload. Of course the more information can be provided about the source, the better.
+
+====== Filters
+
+A client wishing to perform content personalization might also specify filtering conditions to be evaluated by the context server so that it can tell the client whether the content associated with the filter should be activated for this profile/session. This is accomplished by providing a list of filter definitions to be evaluated by the context server via the `filters` field of the payload. If provided, the evaluation results will be provided in the `filteringResults` field of the resulting `cxs` object the context server will send.
+
+====== Overrides
+
+It is also possible for clients wishing to perform user impersonation to specify properties or segments to override the proper ones so as to emulate a specific profile, in which case the overridden value will temporarily replace the proper values so that all rules will be evaluated with these values instead of the proper ones. The `segments` (array of segment identifiers), `profileProperties` (maps of property name and associated object value) and `scores` (maps of score id and value) all wrapped in a profileOverrides object and the `sessionPropertiesOverrides` (maps of property name and associated object value) fields allow to provide such information. Providing such overrides will, of course, impact content filtering results and segments matching for this specific request.
+
+====== Controlling the content of the response
+
+The clients can also specify which information to include in the response by setting the `requireSegments` property to true if segments the current profile matches should be returned or provide an array of property identifiers for `requiredProfileProperties` or `requiredSessionProperties` fields to ask the context server to return the values for the specified profile or session properties, respectively. This information is provided by the `profileProperties`, `sessionProperties` and `profileSegments` fields of the context server response.
+
+Additionally, the context server will also returns any tracked conditions associated with the source of the context request. Upon evaluating the incoming request, the context server will determine if there are any rules marked with the `trackedCondition` tag and which source condition matches the source of the incoming request and return these tracked conditions to the client. The client can use these tracked conditions to learn that the context server can react to events matching the tracked condition and coming from that source. This is, in particular, used to implement form mapping (a solution that allows clients to update user profiles based on values provided when a form is submitted).
+
+====== Events
+
+Finally, the client can specify any events triggered by the user actions, so that the context server can process them, via the `events` field of the context request.
+
+====== Default response
+
+If no payload is specified, the context server will simply return the minimal information deemed necessary for client applications to properly function: profile identifier, session identifier and any tracked conditions that might exist for the source of the request.
+
+===== Context request for our example
+
+Now that we've seen the structure of the request and what we can expect from the context response, let's examine the request our component is doing.
+
+In our case, our `source` item looks as follows: we specify a scope for our application (`unomi-tweet-button-sample`), specify that the item type (i.e. the kind of element that is the source of our event) is a `page` (which corresponds, as would be expected, to a web page), provide an identifier (in our case, a Base-64 encoded version of the page's URL) and finally, specify extra properties (here, simply a `url` property corresponding to the page's URL that will be used when we process our event in our Unomi extension).
+
+[source,javascript]
+----
+var scope = 'unomi-tweet-button-sample';
+var itemId = btoa(window.location.href);
+var source = {
+ itemType: 'page',
+ scope: scope,
+ itemId: itemId,
+ properties: {
+ url: window.location.href
+ }
+};
+----
+
+We also specify that we want the context server to return the values of the `tweetNb` and `tweetedFrom` profile properties in its response. Finally, we provide a custom event of type `tweetEvent` with associated scope and source information, which matches the source of our context request in this case.
+
+[source,javascript]
+----
+var contextPayload = {
+ source: source,
+ events: [
+ {
+ eventType: 'tweetEvent',
+ scope: scope,
+ source: source
+ }
+ ],
+ requiredProfileProperties: [
+ 'tweetNb',
+ 'tweetedFrom'
+ ]
+};
+----
+
+The `tweetEvent` event type is not defined by default in Unomi. This is where our Unomi plugin comes into play since we need to tell Unomi how to react when it encounters such events.
+
+===== Unomi plugin overview
+
+In order to react to `tweetEvent` events, we will define a new Unomi rule since this is exactly what Unomi rules are supposed to do. Rules are guarded by conditions and if these
+ conditions match, the associated set of actions will be executed. In our case, we want our new
+ https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/rules/incrementTweetNumber.json[`incrementTweetNumber`] rule to only react to `tweetEvent` events and
+ we want it to perform the profile update accordingly: create the property types for our custom properties if they don't exist and update them. To do so, we will create a
+ custom
+ https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/actions/incrementTweetNumberAction.json[`incrementTweetNumberAction`] action that will be triggered any time our rule matches. An action is some custom code that is deployed in the context server and can access the
+ Unomi API to perform what it is that it needs to do.
+
+===== Rule definition
+
+Let's look at how our custom https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/rules/incrementTweetNumber.json[`incrementTweetNumber`] rule is defined:
+
+[source,json]
+----
+{
+ "metadata": {
+ "id": "smp:incrementTweetNumber",
+ "name": "Increment tweet number",
+ "description": "Increments the number of times a user has tweeted after they click on a tweet button"
+ },
+ "raiseEventOnlyOnceForSession": false,
+ "condition": {
+ "type": "eventTypeCondition",
+ "parameterValues": {
+ "eventTypeId": "tweetEvent"
+ }
+ },
+ "actions": [
+ {
+ "type": "incrementTweetNumberAction",
+ "parameterValues": {}
+ }
+ ]
+}
+----
+
+Rules define a metadata section where we specify the rule name, identifier and description.
+
+When rules trigger, a specific event is raised so that other parts of Unomi can react to it accordingly. We can control how that event should be raised. Here we specify that the event should be raised each time the rule triggers and not only once per session by setting `raiseEventOnlyOnceForSession` to `false`, which is not strictly required since that is the default. A similar setting (`raiseEventOnlyOnceForProfile`) can be used to specify that the event should only be raised once per profile if needed.
+
+We could also specify a priority for our rule in case it needs to be executed before other ones when similar conditions match. This is accomplished using the `priority` property. We're using the default priority here since we don't have other rules triggering on `tweetEvent`s and don't need any special ordering.
+
+We then tell Unomi which condition should trigger the rule via the `condition` property. Here, we specify that we want our rule to trigger on an `eventTypeCondition` condition. Unomi can be extended by adding new condition types that can enrich how matching or querying is performed. The condition type definition file specifies which parameters are expected for our condition to be complete. In our case, we use the built-in event type condition that will match if Unomi receives an event of the type specified in the condition's `eventTypeId` parameter value: `tweetEvent` here.
+
+Finally, we specify a list of actions that should be performed as consequences of the rule matching. We only need one action of type `incrementTweetNumberAction` that doesn't require any parameters.
+
+===== Action definition
+
+Let's now look at our custom https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/META-INF/cxs/actions/incrementTweetNumberAction.json[`incrementTweetNumberAction`] action type definition:
+
+[source,json]
+----
+{
+ "id": "incrementTweetNumberAction",
+ "actionExecutor": "incrementTweetNumber",
+ "tags": [
+ "event"
+ ],
+ "parameters": []
+}
+----
+
+We specify the identifier for the action type, a list of tags if needed: here we say that our action is a consequence of events using the `event` tag. Our actions does not require any parameters so we don't define any.
+
+Finally, we provide a mysterious `actionExecutor` identifier: `incrementTweetNumber`.
+
+===== Action executor definition
+
+The action executor references the actual implementation of the action as defined in our https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/resources/OSGI-INF/blueprint/blueprint.xml[blueprint definition]:
+
+[source,xml]
+----
+<blueprint xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xmlns="http://www.osgi.org/xmlns/blueprint/v1.0.0"
+ xsi:schemaLocation="http://www.osgi.org/xmlns/blueprint/v1.0.0 http://www.osgi.org/xmlns/blueprint/v1.0.0/blueprint.xsd">
+
+ <reference id="profileService" interface="org.apache.unomi.api.services.ProfileService"/>
+
+ <!-- Action executor -->
+ <service id="incrementTweetNumberAction" auto-export="interfaces">
+ <service-properties>
+ <entry key="actionExecutorId" value="incrementTweetNumber"/>
+ </service-properties>
+ <bean class="org.apache.unomi.examples.unomi_tweet_button_plugin.actions.IncrementTweetNumberAction">
+ <property name="profileService" ref="profileService"/>
+ </bean>
+ </service>
+</blueprint>
+----
+
+In standard Blueprint fashion, we specify that we will need the `profileService` defined by Unomi and then define a service of our own to be exported for Unomi to use. Our service specifies one property: `actionExecutorId` which matches the identifier we specified in our action definition. We then inject the profile service in our executor and we're done for the configuration side of things!
+
+===== Action executor implementation
+
+Our action executor definition specifies that the bean providing the service is implemented in the https://github.com/apache/incubator-unomi/blob/master/samples/tweet-button-plugin/src/main/java/org/apache/unomi/samples/tweet_button_plugin/actions/IncrementTweetNumberAction.java[`org.apache.unomi.samples.tweet_button_plugin.actions
+.IncrementTweetNumberAction`] class. This class implements the Unomi `ActionExecutor` interface which provides a single `int execute(Action action, Event event)` method: the executor gets the action instance to execute along with the event that triggered it, performs its work and returns an integer status corresponding to what happened as defined by public constants of the `EventService` interface of Unomi: `NO_CHANGE`, `SESSION_UPDATED` or `PROFILE_UPDATED`.
+
+Let's now look at the implementation of the method:
+
+[source,java]
+----
+final Profile profile = event.getProfile();
+Integer tweetNb = (Integer) profile.getProperty(TWEET_NB_PROPERTY);
+List<String> tweetedFrom = (List<String>) profile.getProperty(TWEETED_FROM_PROPERTY);
+
+if (tweetNb == null || tweetedFrom == null) {
+ // create tweet number property type
+ PropertyType propertyType = new PropertyType(new Metadata(event.getScope(), TWEET_NB_PROPERTY, TWEET_NB_PROPERTY, "Number of times a user tweeted"));
+ propertyType.setValueTypeId("integer");
+ service.createPropertyType(propertyType);
+
+ // create tweeted from property type
+ propertyType = new PropertyType(new Metadata(event.getScope(), TWEETED_FROM_PROPERTY, TWEETED_FROM_PROPERTY, "The list of pages a user tweeted from"));
+ propertyType.setValueTypeId("string");
+ propertyType.setMultivalued(true);
+ service.createPropertyType(propertyType);
+
+ tweetNb = 0;
+ tweetedFrom = new ArrayList<>();
+}
+
+profile.setProperty(TWEET_NB_PROPERTY, tweetNb + 1);
+final String sourceURL = extractSourceURL(event);
+if (sourceURL != null) {
+ tweetedFrom.add(sourceURL);
+}
+profile.setProperty(TWEETED_FROM_PROPERTY, tweetedFrom);
+
+return EventService.PROFILE_UPDATED;
+----
+
+It is fairly straightforward: we retrieve the profile associated with the event that triggered the rule and check whether it already has the properties we are interested in. If not, we create the associated property types and initialize the property values.
+
+____
+
+Note that it is not an issue to attempt to create the same property type multiple times as Unomi will not add a new property type if an identical type already exists.
+
+____
+
+Once this is done, we update our profile with the new property values based on the previous values and the metadata extracted from the event using the `extractSourceURL` method which uses our `url` property that we've specified for our event source. We then return that the profile was updated as a result of our action and Unomi will properly save it for us when appropriate. That's it!
+
+For reference, here's the `extractSourceURL` method implementation:
+
+[source,java]
+----
+private String extractSourceURL(Event event) {
+ final Item sourceAsItem = event.getSource();
+ if (sourceAsItem instanceof CustomItem) {
+ CustomItem source = (CustomItem) sourceAsItem;
+ final String url = (String) source.getProperties().get("url");
+ if (url != null) {
+ return url;
+ }
+ }
+
+ return null;
+}
+----
+
+=== Conclusion
+
+We have seen a simple example how to interact with Unomi using a combination of client-side code and Unomi plugin. Hopefully, this provided an introduction to the power of what Unomi can do and how it can be extended to suit your needs.
+
+=== Annex
+
+Here is an overview of how Unomi processes incoming requests to the `ContextServlet`.
+image:../../images/unomi-request.png[Unomi request overview]
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/archives/1.2/asciidoc/samples/weather-update-sample.adoc
----------------------------------------------------------------------
diff --git a/manual/src/archives/1.2/asciidoc/samples/weather-update-sample.adoc b/manual/src/archives/1.2/asciidoc/samples/weather-update-sample.adoc
new file mode 100644
index 0000000..e4a79d9
--- /dev/null
+++ b/manual/src/archives/1.2/asciidoc/samples/weather-update-sample.adoc
@@ -0,0 +1,15 @@
+//
+// Licensed 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.
+//
+
+=== Weather update sample
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/main/asciidoc/apache.css
----------------------------------------------------------------------
diff --git a/manual/src/main/asciidoc/apache.css b/manual/src/main/asciidoc/apache.css
index e66d1fa..2872ec3 100644
--- a/manual/src/main/asciidoc/apache.css
+++ b/manual/src/main/asciidoc/apache.css
@@ -1,5 +1,5 @@
-@import "https://fonts.googleapis.com/css?family=Source+Sans+Pro:400,700%7cDroid+Serif:400,700";
+@import "https://fonts.googleapis.com/css?family=Open+Sans:400,700%7cDroid+Serif:400,700";
article,
aside,
@@ -384,7 +384,7 @@ h3,
h4,
h5,
h6 {
- font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ font-family: "Open Sans", "DejaVu Sans", sans-serif;
font-weight: bold;
/*font-style: bold;*/
color: #303284;
@@ -1233,7 +1233,7 @@ table.tableblock #preamble>.sectionbody>[class="paragraph"]:first-of-type p {
.admonitionblock>table td.icon .title {
font-weight: bold;
- font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ font-family: "Open Sans", "DejaVu Sans", sans-serif;
text-transform: uppercase
}
@@ -1507,7 +1507,7 @@ table.pyhltable .linenodiv {
}
.verseblock pre {
- font-family: "Source Sans Pro", "DejaVu Sans", sans;
+ font-family: "Open Sans", "DejaVu Sans", sans;
font-size: 1.15rem;
color: rgba(0, 0, 0, .85);
font-weight: 300;
@@ -2183,7 +2183,7 @@ a span.icon>.fa {
width: 1.67em;
height: 1.67em;
line-height: 1.67em;
- font-family: "Source Sans Pro", "DejaVu Sans", sans-serif;
+ font-family: "Open Sans", "DejaVu Sans", sans-serif;
font-style: normal;
font-weight: bold
}
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/apache-theme.yml
----------------------------------------------------------------------
diff --git a/manual/src/theme/apache-theme.yml b/manual/src/theme/apache-theme.yml
index 855b46c..cc901d6 100644
--- a/manual/src/theme/apache-theme.yml
+++ b/manual/src/theme/apache-theme.yml
@@ -1,11 +1,24 @@
+##
+## Licensed 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.
+##
font:
catalog:
- #SourceSansPro
- SourceSansPro:
- normal: SourceSansPro-Regular.ttf
- italic: SourceSansPro-Italic.ttf
- bold: SourceSansPro-Bold.ttf
- bold_italic: SourceSansPro-BoldItalic.ttf
+ #OpenSans
+ OpenSans:
+ normal: OpenSans-Regular.ttf
+ italic: OpenSans-Italic.ttf
+ bold: OpenSans-Bold.ttf
+ bold_italic: OpenSans-BoldItalic.ttf
#DroidSerif
DroidSerif:
normal: DroidSerif-Regular.ttf
@@ -68,7 +81,7 @@ heading:
align: left
font_color: #303284
#font_color: $base_font_color
- font_family: SourceSansPro
+ font_family: OpenSans
font_style: bold
text_transform: uppercase
# h1 is used for part titles (book doctype only)
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-Black.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-Black.ttf b/manual/src/theme/fonts/SourceSansPro-Black.ttf
deleted file mode 100644
index 7ea0260..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-Black.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-BlackItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-BlackItalic.ttf b/manual/src/theme/fonts/SourceSansPro-BlackItalic.ttf
deleted file mode 100644
index e1a7482..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-BlackItalic.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-Bold.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-Bold.ttf b/manual/src/theme/fonts/SourceSansPro-Bold.ttf
deleted file mode 100644
index f698646..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-Bold.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-BoldItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-BoldItalic.ttf b/manual/src/theme/fonts/SourceSansPro-BoldItalic.ttf
deleted file mode 100644
index 5c00b64..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-BoldItalic.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-ExtraLight.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-ExtraLight.ttf b/manual/src/theme/fonts/SourceSansPro-ExtraLight.ttf
deleted file mode 100644
index f1da6b2..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-ExtraLight.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-ExtraLightItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-ExtraLightItalic.ttf b/manual/src/theme/fonts/SourceSansPro-ExtraLightItalic.ttf
deleted file mode 100644
index 15f7344..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-ExtraLightItalic.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-Italic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-Italic.ttf b/manual/src/theme/fonts/SourceSansPro-Italic.ttf
deleted file mode 100644
index 82e8762..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-Italic.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-Light.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-Light.ttf b/manual/src/theme/fonts/SourceSansPro-Light.ttf
deleted file mode 100644
index ea1104b..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-Light.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-LightItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-LightItalic.ttf b/manual/src/theme/fonts/SourceSansPro-LightItalic.ttf
deleted file mode 100644
index b78f1b0..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-LightItalic.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-Regular.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-Regular.ttf b/manual/src/theme/fonts/SourceSansPro-Regular.ttf
deleted file mode 100644
index 278ad8a..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-Regular.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-SemiBold.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-SemiBold.ttf b/manual/src/theme/fonts/SourceSansPro-SemiBold.ttf
deleted file mode 100644
index ac3e0d1..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-SemiBold.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro-SemiBoldItalic.ttf
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro-SemiBoldItalic.ttf b/manual/src/theme/fonts/SourceSansPro-SemiBoldItalic.ttf
deleted file mode 100644
index b0737bb..0000000
Binary files a/manual/src/theme/fonts/SourceSansPro-SemiBoldItalic.ttf and /dev/null differ
http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/b077d27b/manual/src/theme/fonts/SourceSansPro_OFL.txt
----------------------------------------------------------------------
diff --git a/manual/src/theme/fonts/SourceSansPro_OFL.txt b/manual/src/theme/fonts/SourceSansPro_OFL.txt
deleted file mode 100644
index 72d81ab..0000000
--- a/manual/src/theme/fonts/SourceSansPro_OFL.txt
+++ /dev/null
@@ -1,93 +0,0 @@
-Copyright 2010, 2012, 2014 Adobe Systems Incorporated (http://www.adobe.com/), with Reserved Font Name ‘Source’.
-
-This Font Software is licensed under the SIL Open Font License, Version 1.1.
-This license is copied below, and is also available with a FAQ at:
-http://scripts.sil.org/OFL
-
-
------------------------------------------------------------
-SIL OPEN FONT LICENSE Version 1.1 - 26 February 2007
------------------------------------------------------------
-
-PREAMBLE
-The goals of the Open Font License (OFL) are to stimulate worldwide
-development of collaborative font projects, to support the font creation
-efforts of academic and linguistic communities, and to provide a free and
-open framework in which fonts may be shared and improved in partnership
-with others.
-
-The OFL allows the licensed fonts to be used, studied, modified and
-redistributed freely as long as they are not sold by themselves. The
-fonts, including any derivative works, can be bundled, embedded,
-redistributed and/or sold with any software provided that any reserved
-names are not used by derivative works. The fonts and derivatives,
-however, cannot be released under any other type of license. The
-requirement for fonts to remain under this license does not apply
-to any document created using the fonts or their derivatives.
-
-DEFINITIONS
-"Font Software" refers to the set of files released by the Copyright
-Holder(s) under this license and clearly marked as such. This may
-include source files, build scripts and documentation.
-
-"Reserved Font Name" refers to any names specified as such after the
-copyright statement(s).
-
-"Original Version" refers to the collection of Font Software components as
-distributed by the Copyright Holder(s).
-
-"Modified Version" refers to any derivative made by adding to, deleting,
-or substituting -- in part or in whole -- any of the components of the
-Original Version, by changing formats or by porting the Font Software to a
-new environment.
-
-"Author" refers to any designer, engineer, programmer, technical
-writer or other person who contributed to the Font Software.
-
-PERMISSION & CONDITIONS
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of the Font Software, to use, study, copy, merge, embed, modify,
-redistribute, and sell modified and unmodified copies of the Font
-Software, subject to the following conditions:
-
-1) Neither the Font Software nor any of its individual components,
-in Original or Modified Versions, may be sold by itself.
-
-2) Original or Modified Versions of the Font Software may be bundled,
-redistributed and/or sold with any software, provided that each copy
-contains the above copyright notice and this license. These can be
-included either as stand-alone text files, human-readable headers or
-in the appropriate machine-readable metadata fields within text or
-binary files as long as those fields can be easily viewed by the user.
-
-3) No Modified Version of the Font Software may use the Reserved Font
-Name(s) unless explicit written permission is granted by the corresponding
-Copyright Holder. This restriction only applies to the primary font name as
-presented to the users.
-
-4) The name(s) of the Copyright Holder(s) or the Author(s) of the Font
-Software shall not be used to promote, endorse or advertise any
-Modified Version, except to acknowledge the contribution(s) of the
-Copyright Holder(s) and the Author(s) or with their explicit written
-permission.
-
-5) The Font Software, modified or unmodified, in part or in whole,
-must be distributed entirely under this license, and must not be
-distributed under any other license. The requirement for fonts to
-remain under this license does not apply to any document created
-using the Font Software.
-
-TERMINATION
-This license becomes null and void if any of the above conditions are
-not met.
-
-DISCLAIMER
-THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
-OF COPYRIGHT, PATENT, TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL THE
-COPYRIGHT HOLDER BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
-INCLUDING ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
-DAMAGES, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
-FROM, OUT OF THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM
-OTHER DEALINGS IN THE FONT SOFTWARE.