From 2a7ea475d3a46df4e2dbb0f7d020ebfa2db8493f Mon Sep 17 00:00:00 2001 From: holivier Date: Fri, 1 May 2020 16:50:31 +0200 Subject: [PATCH] Documented: ofbiz-plugins / MyPortal, migration for the Help docbook file to asciidoc (only a short introduction) (OFBIZ-11587) add in _include directory, two portlet help coming from other components (commonext and workeffort) --- docs/asciidoc/plugins-user-manual.adoc | 2 ++ .../asciidoc/_include/portlet-calendar.adoc | 23 +++++++++++++ .../_include/portlet-system-info-notes.adoc | 31 +++++++++++++++++ myportal/src/docs/asciidoc/my-portal.adoc | 34 +++++++++++++++++++ 4 files changed, 90 insertions(+) create mode 100644 myportal/src/docs/asciidoc/_include/portlet-calendar.adoc create mode 100644 myportal/src/docs/asciidoc/_include/portlet-system-info-notes.adoc create mode 100644 myportal/src/docs/asciidoc/my-portal.adoc diff --git a/docs/asciidoc/plugins-user-manual.adoc b/docs/asciidoc/plugins-user-manual.adoc index b5cc6548f..780361500 100644 --- a/docs/asciidoc/plugins-user-manual.adoc +++ b/docs/asciidoc/plugins-user-manual.adoc @@ -32,3 +32,5 @@ include::../../birt/src/docs/asciidoc/birt.adoc[leveloffset=+1] include::../../ebay/src/docs/asciidoc/ebay.adoc[leveloffset=+1] include::../../ebaystore/src/docs/asciidoc/ebay-store.adoc[leveloffset=+1] + +include::../../myportal/src/docs/asciidoc/my-portal.adoc[leveloffset=+1] diff --git a/myportal/src/docs/asciidoc/_include/portlet-calendar.adoc b/myportal/src/docs/asciidoc/_include/portlet-calendar.adoc new file mode 100644 index 000000000..a3aeae81c --- /dev/null +++ b/myportal/src/docs/asciidoc/_include/portlet-calendar.adoc @@ -0,0 +1,23 @@ +//// +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. +//// + += The Calendar Portlet + +This portlet provides an overview on a dayly/weekly/or month period. +You will see the particular view with the ability to add an event. \ No newline at end of file diff --git a/myportal/src/docs/asciidoc/_include/portlet-system-info-notes.adoc b/myportal/src/docs/asciidoc/_include/portlet-system-info-notes.adoc new file mode 100644 index 000000000..31f9cb5f7 --- /dev/null +++ b/myportal/src/docs/asciidoc/_include/portlet-system-info-notes.adoc @@ -0,0 +1,31 @@ +//// +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. +//// + += The System Event Portlet + +This portlet shows changes which happened in the system for the logged on user. +The first two functions which are working now:. + +1. Incoming communication events (email, internal notes). +2. Tasks which are assigned either in projectmanager or workeffort. + + These event can be notified to the user even when not logged on to OFBiz by using a firefox plugin and when it changes the + employee is notified from within firefox + + The plugin: http://updatescanner.mozdev.org/en/index.html and it should check the following url: (adjust to your requirements) + + https://localhost:8443/myportal/control/showPortletSimpleDecorator?portalPortletId=SystemInfoNotes&USERNAME=admin&PASSWORD=ofbiz + + In the Flat Grey theme (only) notifications show in the header when they are available. diff --git a/myportal/src/docs/asciidoc/my-portal.adoc b/myportal/src/docs/asciidoc/my-portal.adoc new file mode 100644 index 000000000..de07d2e36 --- /dev/null +++ b/myportal/src/docs/asciidoc/my-portal.adoc @@ -0,0 +1,34 @@ +//// +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. +//// += My portal Plugin + +Within the 'my portal' application it is possible to create a collection of screens for a specific type of user of the system. + +Examples are a general employee, an account manager, a customer, a supplier etc... + +The system makes use of special portlets which can be arranged and selected/hidden by the logged on user. + +The MyPortal application is an example of what it's possible to do with OFBiz Portal technics +(integrated in ofbiz framework) + +== Some Portlet in other components + +include::_include/portlet-system-info-notes.adoc[leveloffset=+2] + +include::_include/portlet-calendar.adoc[leveloffset=+2]