This is an automated email from the ASF dual-hosted git repository.
holivier pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-plugins.git
commit cb082af5134291a2fb410fae1d509305ed1a7f92
Author: holivier <holiv...@apache.org>
AuthorDate: Mon Jul 20 16:08:36 2020 +0200
Documented: migrate help link to asciidoc user manual for Plugin
BIRT (OFBIZ-11587)
All files have been migrated to asciidoc format and help link now point
to the html file generated from the asciidoc files
In the global Help Docbook index tree, change BIRT help page to a short
page with a link to the new help
Remove docbook help files for BIRT
---
birt/data/helpdata/HELP_BIRT.xml | 70 +++++-----------------------------------
birt/documents/Birt.xml | 29 -----------------
birt/widget/birt/BirtScreens.xml | 5 +--
3 files changed, 11 insertions(+), 93 deletions(-)
diff --git a/birt/data/helpdata/HELP_BIRT.xml b/birt/data/helpdata/HELP_BIRT.xml
index ca1c8f9..4235c6f 100644
--- a/birt/data/helpdata/HELP_BIRT.xml
+++ b/birt/data/helpdata/HELP_BIRT.xml
@@ -7,9 +7,9 @@ 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
@@ -17,71 +17,17 @@ KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
-<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink";
+<section xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
+ xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
xsi:schemaLocation="http://docbook.org/ns/docbook
../../../content/dtd/docbook.xsd"
xmlns="http://docbook.org/ns/docbook";>
-
- <title>OFBiz BIRT Overview</title>
+
+ <title>OFBiz BIRT Overview redirection</title>
<para>
Welcome to OFBiz BIRT. The part installed within OFBiz allows you to
run the reports which are prepared using Eclipse with the BIRT plugin installed.
</para>
- <para>
- This is a short document to help you get started using BIRT to make a
report.
- </para>
- <para>
- As a demo we have prepared a an example report.
- Look at the <link xl:href="http://eclipse.org/birt/phoenix/";>Eclipse
BIRT web site</link> for more information.
- </para>
- <para>
- -
- </para>
- <para>
- There is also a new feature (2017) which allows you to dynamically
create Birt reports, and allow your users to customise them: the OFBiz Flexible
Reports.
- </para>
- <para>
- Look at the <link
xl:href="https://cwiki.apache.org/confluence/display/OFBIZ/Birt+Flexible+Reports";>the
official documentation</link> for more information.
+ <para>BIRT Help has been migrated to a new system, you can access it by
using
+ <link
xl:href="https://ci.apache.org/projects/ofbiz/site/trunk/ofbizdoc/html5/user-manual.html#_ebay_store";>OFBiz
user documentation site / BIRT</link>
</para>
- <section>
- <title>1. PDF tab</title>
- <para>When you click on this tab. It will render the example report in
a PDF format</para>
- </section>
- <section>
- <title>2. Send any format through Mail tab</title>
- <para>When you click on this tab. It will show a form that can send
the report per email.</para>
- </section>
- <section>
- <title>3. Chart tab</title>
- <para>When you click on this tab. An example chart will render in a
PDF format</para>
- </section>
- <section>
- <title>Examine the Example Report</title>
- <para>
- The example report that run in OFBiz is in the file
component://birt/webapp/birt/report/example.rptdesign. When you have started
Eclipse BIRT, open this document.
- This report show how a report receives data from OFBiz through
Scripted Data Source using the OFBiz delegator.
- This report has the scripted data source name "OFBiz" and the data
set that use the script data source name is called "Product".
- Open the script editor for Product data set, it uses the delegator
object query data from the Product entity.
- A report that runs on the OFBiz platform can use the delegator
object, dispatcher object, security object and classpath of OFBiz environment
in the script.</para>
- </section>
- <section>
- <title>How do I send parameter to report?</title>
- <para>If a report is to be rendered through a view map, you can send a
parameter through attribute of the request object, the attribute's name is
"birtParameters" which is a map.</para>
- <para>If a report is to be rendered through an e-mail, you can send
the parameter through the service's parameter name called birtParameters.</para>
- </section>
- <section>
- <title>Which are the supported content types?</title>
- <para>Excel (.xls)</para>
- <para>Excel (.xlsx)</para>
- <para>LibreOffice Calc (.ods)</para>
- <para>LibreOffice Impress (.odp)</para>
- <para>LibreOffice Writer (.odt)</para>
- <para>Pdf (.pdf)</para>
- <para>Postscript (.ps)</para>
- <para>Powerpoint (.ppt)</para>
- <para>Powerpoint (.pptx)</para>
- <para>Text (.html)</para>
- <para>Word (.doc)</para>
- <para>Word (.docx)</para>
- </section>
</section>
diff --git a/birt/documents/Birt.xml b/birt/documents/Birt.xml
deleted file mode 100644
index 36bddbd..0000000
--- a/birt/documents/Birt.xml
+++ /dev/null
@@ -1,29 +0,0 @@
-<?xml version="1.0" encoding="UTF-8"?>
-<!--
- 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.
--->
-<chapter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"; version="5.0"
- xmlns:xl="http://www.w3.org/1999/xlink";
xmlns:xi="http://www.w3.org/2001/XInclude";
- xsi:schemaLocation="http://docbook.org/ns/docbook
../../applications/content/dtd/docbook.xsd"
- xmlns="http://docbook.org/ns/docbook";>
- <title>BIRT report generator.</title>
- <para> An example report sales can be found in the example component.
</para>
- <para>
- <xi:include href="../../../plugins/birt/data/helpdata/HELP_BIRT.xml"/>
- </para>
-</chapter>
diff --git a/birt/widget/birt/BirtScreens.xml b/birt/widget/birt/BirtScreens.xml
index de186ab..8dba46a 100644
--- a/birt/widget/birt/BirtScreens.xml
+++ b/birt/widget/birt/BirtScreens.xml
@@ -43,6 +43,7 @@ under the License.
<set field="applicationMenuName" value="BirtAppBar"
global="true"/>
<set field="applicationMenuLocation"
value="component://birt/widget/birt/BirtMenus.xml" global="true"/>
<set field="applicationTitle"
from-field="uiLabelMap.BirtExampleApplication" global="true"/>
+ <set field="helpAnchor" from-field="helpAnchor"
default-value="_birt_ofbiz_plugin"/>
</actions>
<widgets>
<include-screen name="ApplicationDecorator"
location="component://commonext/widget/CommonScreens.xml"/>
@@ -225,12 +226,12 @@ under the License.
<field-map field-name="mainAction" value="CREATE"/>
</service>
<set field="hasCreatePermission"
from-field="permCreateResult.hasPermission"/>
-
+
<service service-name="genericBirtPermission"
result-map="permDeleteResult">
<field-map field-name="mainAction" value="DELETE"/>
</service>
<set field="hasDeletePermission"
from-field="permDeleteResult.hasPermission"/>
-
+
<service service-name="genericBirtPermission"
result-map="permUpdateResult">
<field-map field-name="mainAction" value="UPDATE"/>
</service>
