Merge pull request #38 from gdgd009xcd/JOHANNESS240601

## [v0.8.11] - 2024-06-01

addOns/customactivescan/CHANGELOG.md

@@ -3,6 +3,10 @@ All notable changes to this add-on will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [v0.8.11] - 2024-06-01
+### Changed
+- maintenance: added javahelp files for supporting locales.
+
 ## [v0.8.10] - 2024-05-31
 ### Changed
 - bugfix: fixed problemn which can't display this addon's javahelp when user select language except English.

addOns/customactivescan/customactivescan.gradle.kts

@@ -1,7 +1,7 @@
 import org.zaproxy.gradle.addon.AddOnStatus
 
 
-version = "0.8.10"
+version = "0.8.11"
 description = "a Active Scanner with custmizable rules"
 
 val jar by tasks.getting(Jar::class) {
@@ -19,31 +19,40 @@ zapAddOn {
         author.set("gdgd009xcd")
         url.set("https://gdgd009xcd.github.io/CustomActiveScanForZAP")
         repo.set("https://github.com/gdgd009xcd/CustomActiveScanForZAP")
+
+        /**
         helpSet {
+            // ${zapAddOn.addOnId.get()} is the subproject folder name "customactivescan" in addOns project folder.
+            val resourcesPath = "org.zaproxy.zap.extension.${zapAddOn.addOnId.get()}.resources."
+            // helpset root src path is "src/main/javahelp". you must put helpsets under this directory.
+            //
             // baseName and localToken are used for determinating javahelp helpset(.hs)  file path
-            // In English (default) locale, %LC% token is convert to "" then helpset file path is:
-            // main/java/javahelp/help/helpset.hs
+            // In English (default) locale, %LC% token is convert to ""
+            // ${resourcesPath}help.helpset.hs
             // In ja_JP locale, %LC% token is convert to "_ja_JP" then helpset file path is:
-            // main/java/javahelp/help_ja_JP/helpset_ja_JP.hs
+            // ${resourcesPath}help_ja_JP.helpset_ja_JP.hs
             // * if you use %LC% locale token, then you must provide "all" locale specific helpset files for ZAP.
             //   otherwise you may remove %LC% to support any locale helpset in English only.
-            // * if you comment out both baseName and localeToken property,
+            // * if you comment out this helpSet function entirely,
             //   zaproxy expects the help directory to be in the following path:
             //
-            //   main/java/javahelp/[addon package dir]/resources/help
-            //                                                    help_ja_JP
+            //   ${resourcesPath}help
+            //                   help_ja_JP
             //                                                    ...
-            //   [addon package dir] = org/zaproxy/zap/extension/customactivescan
-            //
-            //   ** this help directory hierarchy is used for providing localization help by crowdin.
+            //   ${resourcesPath} == org.zaproxy.zap.extension.customactivescan.resources.
+            //                    == [this addon's Extension package name].resources.
+            //   ** Extension package name is the package name of this addon's Extension class file inherit from ExtensionAdaptor
+            //      e.g. The package name of ExtensionAscanRules class.
+            //   ** this help directory hierarchy will be used for providing localization help by crowdin in the future.
             //
             // ----locale supported helpset configurations.---
-            //baseName.set("help%LC%.helpset")
-            //localeToken.set("%LC%")
+            baseName.set("${resourcesPath}help%LC%.helpset")
+            localeToken.set("%LC%")
             // ---- no locale supported(English only) configurations.---
-            baseName.set("help.helpset")
-            localeToken.set("")
+            //baseName.set("${resourcesPath}help.helpset")
+            //localeToken.set("")
         }
+        **/
     }
 }
 

addOns/customactivescan/src/main/javahelp/help_ja_JP/contents/help.html → addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_ar_SA/contents/help.html

@@ -14,7 +14,7 @@ <H2>About</H2>
 
 <H2>Description</H2>
 <UL>
-    <B>下記のリンクは、次のURLへ遷移します：https://github.com/gdgd009xcd/CustomActiveScanForZAP</B><P></P>
+    <B>These below links go to the page under https://github.com/gdgd009xcd/CustomActiveScanForZAP</B><P></P>
 <LI><A HREF="https://github.com/gdgd009xcd/CustomActiveScanForZAP#customactivescanforzap">Overview</A>
 <LI><A HREF="https://github.com/gdgd009xcd/CustomActiveScanForZAP/wiki/1.0.-Basic-Usage">Basic Usage</A>
 </UL>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_ar_SA/helpset.hs

@@ -0,0 +1,41 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE helpset
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 2.0//EN"
+         "http://java.sun.com/products/javahelp/helpset_2_0.dtd">
+<helpset version="2.0" xml:lang="en-GB">
+  <title>AutoMacroBuilderForZAP Add-On</title>
+
+  <maps>
+     <homeID>customactivescan</homeID>
+     <mapref location="map.jhm"/>
+  </maps>
+
+  <view>
+    <name>TOC</name>
+    <label>Contents</label>
+    <type>org.zaproxy.zap.extension.help.ZapTocView</type>
+    <data>toc.xml</data>
+  </view>
+
+  <view>
+    <name>Index</name>
+    <label>Index</label>
+    <type>javax.help.IndexView</type>
+    <data>index.xml</data>
+  </view>
+
+  <view>
+    <name>Search</name>
+    <label>Search</label>
+    <type>javax.help.SearchView</type>
+    <data engine="com.sun.java.help.search.DefaultSearchEngine">
+      JavaHelpSearch
+    </data>
+  </view>
+
+  <view>
+    <name>Favorites</name>
+    <label>Favorites</label>
+    <type>javax.help.FavoritesView</type>
+  </view>
+</helpset>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_az_AZ/contents/help.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<HTML>
+<HEAD>
+<TITLE>
+CustomActiveScanForZAP
+</TITLE>
+</HEAD>
+<BODY>
+<H1>CustomActiveScanForZAP</H1>
+
+<H2>About</H2>
+a ZAP Addon ActiveScan for detecting SQL injection with more better way.
+<p>
+
+<H2>Description</H2>
+<UL>
+    <B>These below links go to the page under https://github.com/gdgd009xcd/CustomActiveScanForZAP</B><P></P>
+<LI><A HREF="https://github.com/gdgd009xcd/CustomActiveScanForZAP#customactivescanforzap">Overview</A>
+<LI><A HREF="https://github.com/gdgd009xcd/CustomActiveScanForZAP/wiki/1.0.-Basic-Usage">Basic Usage</A>
+</UL>
+</BODY>
+</HTML>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_az_AZ/helpset.hs

@@ -0,0 +1,41 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE helpset
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 2.0//EN"
+         "http://java.sun.com/products/javahelp/helpset_2_0.dtd">
+<helpset version="2.0" xml:lang="en-GB">
+  <title>AutoMacroBuilderForZAP Add-On</title>
+
+  <maps>
+     <homeID>customactivescan</homeID>
+     <mapref location="map.jhm"/>
+  </maps>
+
+  <view>
+    <name>TOC</name>
+    <label>Contents</label>
+    <type>org.zaproxy.zap.extension.help.ZapTocView</type>
+    <data>toc.xml</data>
+  </view>
+
+  <view>
+    <name>Index</name>
+    <label>Index</label>
+    <type>javax.help.IndexView</type>
+    <data>index.xml</data>
+  </view>
+
+  <view>
+    <name>Search</name>
+    <label>Search</label>
+    <type>javax.help.SearchView</type>
+    <data engine="com.sun.java.help.search.DefaultSearchEngine">
+      JavaHelpSearch
+    </data>
+  </view>
+
+  <view>
+    <name>Favorites</name>
+    <label>Favorites</label>
+    <type>javax.help.FavoritesView</type>
+  </view>
+</helpset>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_az_AZ/index.xml

@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE index
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Index Version 1.0//EN"
+         "http://java.sun.com/products/javahelp/index_2_0.dtd">
+
+<index version="2.0">
+    <!-- index entries are merged (sorted) into core index -->
+	<indexitem text="customactivescan" target="addon.customactivescan" />
+</index>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_az_AZ/map.jhm

@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE map
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Map Version 1.0//EN"
+         "http://java.sun.com/products/javahelp/map_1_0.dtd">
+
+<map version="1.0">
+    <mapID target="addon.customactivescan" url="contents/help.html" />
+</map>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_az_AZ/toc.xml

@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE toc
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp TOC Version 2.0//EN"
+         "http://java.sun.com/products/javahelp/toc_2_0.dtd">
+
+<toc version="2.0">
+	<tocitem text="ZAP User Guide" tocid="toplevelitem">
+		<tocitem text="Add Ons" tocid="addons">
+			<tocitem text="CustomActiveScanForZAP" target="addon.customactivescan"/>
+		</tocitem>
+	</tocitem>
+</toc>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_bs_BA/contents/help.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<HTML>
+<HEAD>
+<TITLE>
+CustomActiveScanForZAP
+</TITLE>
+</HEAD>
+<BODY>
+<H1>CustomActiveScanForZAP</H1>
+
+<H2>About</H2>
+a ZAP Addon ActiveScan for detecting SQL injection with more better way.
+<p>
+
+<H2>Description</H2>
+<UL>
+    <B>These below links go to the page under https://github.com/gdgd009xcd/CustomActiveScanForZAP</B><P></P>
+<LI><A HREF="https://github.com/gdgd009xcd/CustomActiveScanForZAP#customactivescanforzap">Overview</A>
+<LI><A HREF="https://github.com/gdgd009xcd/CustomActiveScanForZAP/wiki/1.0.-Basic-Usage">Basic Usage</A>
+</UL>
+</BODY>
+</HTML>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_bs_BA/helpset.hs

@@ -0,0 +1,41 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE helpset
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 2.0//EN"
+         "http://java.sun.com/products/javahelp/helpset_2_0.dtd">
+<helpset version="2.0" xml:lang="en-GB">
+  <title>AutoMacroBuilderForZAP Add-On</title>
+
+  <maps>
+     <homeID>customactivescan</homeID>
+     <mapref location="map.jhm"/>
+  </maps>
+
+  <view>
+    <name>TOC</name>
+    <label>Contents</label>
+    <type>org.zaproxy.zap.extension.help.ZapTocView</type>
+    <data>toc.xml</data>
+  </view>
+
+  <view>
+    <name>Index</name>
+    <label>Index</label>
+    <type>javax.help.IndexView</type>
+    <data>index.xml</data>
+  </view>
+
+  <view>
+    <name>Search</name>
+    <label>Search</label>
+    <type>javax.help.SearchView</type>
+    <data engine="com.sun.java.help.search.DefaultSearchEngine">
+      JavaHelpSearch
+    </data>
+  </view>
+
+  <view>
+    <name>Favorites</name>
+    <label>Favorites</label>
+    <type>javax.help.FavoritesView</type>
+  </view>
+</helpset>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_bs_BA/index.xml

@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE index
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Index Version 1.0//EN"
+         "http://java.sun.com/products/javahelp/index_2_0.dtd">
+
+<index version="2.0">
+    <!-- index entries are merged (sorted) into core index -->
+	<indexitem text="customactivescan" target="addon.customactivescan" />
+</index>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_bs_BA/map.jhm

@@ -0,0 +1,8 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE map
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Map Version 1.0//EN"
+         "http://java.sun.com/products/javahelp/map_1_0.dtd">
+
+<map version="1.0">
+    <mapID target="addon.customactivescan" url="contents/help.html" />
+</map>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_bs_BA/toc.xml

@@ -0,0 +1,12 @@
+<?xml version='1.0' encoding='UTF-8' ?>
+<!DOCTYPE toc
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp TOC Version 2.0//EN"
+         "http://java.sun.com/products/javahelp/toc_2_0.dtd">
+
+<toc version="2.0">
+	<tocitem text="ZAP User Guide" tocid="toplevelitem">
+		<tocitem text="Add Ons" tocid="addons">
+			<tocitem text="CustomActiveScanForZAP" target="addon.customactivescan"/>
+		</tocitem>
+	</tocitem>
+</toc>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_da_DK/contents/help.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<HTML>
+<HEAD>
+<TITLE>
+CustomActiveScanForZAP
+</TITLE>
+</HEAD>
+<BODY>
+<H1>CustomActiveScanForZAP</H1>
+
+<H2>About</H2>
+a ZAP Addon ActiveScan for detecting SQL injection with more better way.
+<p>
+
+<H2>Description</H2>
+<UL>
+    <B>These below links go to the page under https://github.com/gdgd009xcd/CustomActiveScanForZAP</B><P></P>
+<LI><A HREF="https://github.com/gdgd009xcd/CustomActiveScanForZAP#customactivescanforzap">Overview</A>
+<LI><A HREF="https://github.com/gdgd009xcd/CustomActiveScanForZAP/wiki/1.0.-Basic-Usage">Basic Usage</A>
+</UL>
+</BODY>
+</HTML>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_da_DK/helpset.hs

@@ -0,0 +1,41 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE helpset
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp HelpSet Version 2.0//EN"
+         "http://java.sun.com/products/javahelp/helpset_2_0.dtd">
+<helpset version="2.0" xml:lang="en-GB">
+  <title>AutoMacroBuilderForZAP Add-On</title>
+
+  <maps>
+     <homeID>customactivescan</homeID>
+     <mapref location="map.jhm"/>
+  </maps>
+
+  <view>
+    <name>TOC</name>
+    <label>Contents</label>
+    <type>org.zaproxy.zap.extension.help.ZapTocView</type>
+    <data>toc.xml</data>
+  </view>
+
+  <view>
+    <name>Index</name>
+    <label>Index</label>
+    <type>javax.help.IndexView</type>
+    <data>index.xml</data>
+  </view>
+
+  <view>
+    <name>Search</name>
+    <label>Search</label>
+    <type>javax.help.SearchView</type>
+    <data engine="com.sun.java.help.search.DefaultSearchEngine">
+      JavaHelpSearch
+    </data>
+  </view>
+
+  <view>
+    <name>Favorites</name>
+    <label>Favorites</label>
+    <type>javax.help.FavoritesView</type>
+  </view>
+</helpset>

addOns/customactivescan/src/main/javahelp/org/zaproxy/zap/extension/customactivescan/resources/help_da_DK/index.xml

@@ -0,0 +1,9 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!DOCTYPE index
+  PUBLIC "-//Sun Microsystems Inc.//DTD JavaHelp Index Version 1.0//EN"
+         "http://java.sun.com/products/javahelp/index_2_0.dtd">
+
+<index version="2.0">
+    <!-- index entries are merged (sorted) into core index -->
+	<indexitem text="customactivescan" target="addon.customactivescan" />
+</index>