You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@ofbiz.apache.org by ho...@apache.org on 2020/10/26 16:42:54 UTC

[ofbiz-framework] 02/04: Documented: migration to help system using asciidoc files (OFBIZ-11587)

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-framework.git

commit 37c075b1f5d5e73e46cd2f15d24926416fd3abbe
Author: holivier <ho...@apache.org>
AuthorDate: Mon Oct 26 17:12:52 2020 +0100

    Documented: migration to help system using asciidoc files (OFBIZ-11587)
    
    remove in plugin creation gradle task, files related to docbook help
---
 build.gradle                               |  4 +---
 framework/resources/templates/HELP.xml     | 29 -------------------------
 framework/resources/templates/document.xml | 35 ------------------------------
 3 files changed, 1 insertion(+), 67 deletions(-)

diff --git a/build.gradle b/build.gradle
index 3013b75..2c1edbc 100644
--- a/build.gradle
+++ b/build.gradle
@@ -722,7 +722,7 @@ task createPlugin(group: ofbizPlugin, description: 'create a new plugin componen
         def templateDir = "${rootDir}/framework/resources/templates"
         def pluginDir = "${pluginsDir}/${pluginId}"
 
-        ['config', 'data/helpdata', 'dtd', 'documents', 'entitydef', 'lib', 'patches/test', 'patches/qa',
+        ['config', 'dtd', 'entitydef', 'lib', 'patches/test', 'patches/qa',
                 'patches/production', 'groovyScripts', 'minilang', 'servicedef', 'src/main/java', 'src/test/java', 'testdef',
                 'widget', "webapp/${webappName}/error", "webapp/${webappName}/WEB-INF"].each {
             mkdir pluginDir+'/'+it
@@ -734,10 +734,8 @@ task createPlugin(group: ofbizPlugin, description: 'create a new plugin componen
             [tempName:'SecurityPermissionSeedData.xml', newName:"${pluginResourceName}SecurityPermissionSeedData.xml", location:'data'],
             [tempName:'SecurityGroupDemoData.xml', newName:"${pluginResourceName}SecurityGroupDemoData.xml", location:'data'],
             [tempName:'DemoData.xml', newName:"${pluginResourceName}DemoData.xml", location:'data'],
-            [tempName:'HELP.xml', newName:"HELP_${pluginResourceName}.xml", location:'data/helpdata'],
             [tempName:'HELP.adoc', newName:'HELP.adoc', location:''],
             [tempName:'README.adoc', newName:'README.adoc', location:''],
-            [tempName:'document.xml', newName:"${pluginResourceName}.xml", location:'documents'],
             [tempName:'entitymodel.xml', newName:'entitymodel.xml', location:'entitydef'],
             [tempName:'services.xml', newName:'services.xml', location:'servicedef'],
             [tempName:'Tests.xml', newName:"${pluginResourceName}Tests.xml", location:'testdef'],
diff --git a/framework/resources/templates/HELP.xml b/framework/resources/templates/HELP.xml
deleted file mode 100644
index 4b0d5f7..0000000
--- a/framework/resources/templates/HELP.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.
--->
-
-<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>@component-resource-name@  Overview</title>
-    <para>The @component-resource-name@ Help file template.</para>
-</section>
-
diff --git a/framework/resources/templates/document.xml b/framework/resources/templates/document.xml
deleted file mode 100644
index 63ec73c..0000000
--- a/framework/resources/templates/document.xml
+++ /dev/null
@@ -1,35 +0,0 @@
-<?xml version="1.0"?>
-<!--
-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><anchor xml:id="@component-resource-name@"/>The @component-resource-name@ Component</title>
-    <section>
-        <title>Introduction</title>
-        <para>
-        </para>
-    </section>
-        <xi:include href="../data/helpdata/HELP_@component-resource-name@.xml" />
-    
-</chapter>