Scanpolicies: initial help

Signed-off-by: Simon Bennetts <[email protected]>
zaproxy · Nov 12, 2024 · 20c26cc · 20c26cc
1 parent ef7fc3e
commit 20c26cc
Show file tree

Hide file tree

Showing 8 changed files with 110 additions and 1 deletion.
diff --git a/addOns/scanpolicies/CHANGELOG.md b/addOns/scanpolicies/CHANGELOG.md
@@ -5,4 +5,5 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
 ## Unreleased
 ### Added
-- First version, just with the Default Policy
+- First version, just with the Default Policy.
+- Initial help.
diff --git a/addOns/scanpolicies/src/main/javahelp/help/contents/images/equalizer.png b/addOns/scanpolicies/src/main/javahelp/help/contents/images/equalizer.png
diff --git a/addOns/scanpolicies/src/main/javahelp/help/contents/policy-default.html b/addOns/scanpolicies/src/main/javahelp/help/contents/policy-default.html
@@ -0,0 +1,15 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<HTML>
+<HEAD>
+<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
+<TITLE>
+Default Policy
+</TITLE>
+</HEAD>
+<BODY>
+<H1>Default Policy</H1>
+
+A policy which enables all of the installed active scan rules.
+
+</BODY>
+</HTML>
diff --git a/addOns/scanpolicies/src/main/javahelp/help/contents/scanpolicies.html b/addOns/scanpolicies/src/main/javahelp/help/contents/scanpolicies.html
@@ -0,0 +1,20 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
+<HTML>
+<HEAD>
+<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
+<TITLE>
+Scan Policies
+</TITLE>
+</HEAD>
+<BODY>
+<H1>Scan Policies</H1>
+This add-on provides a set of Scan Policies tuned for different purposes.
+<p>
+These policies are initialised as detailed in the relevant pages, but you can tune them as required.
+
+<ul>
+<li><a href="policy-default.html">Default Policy</a> : the default policy, all installed active rules enabled
+</ul>
+
+</BODY>
+</HTML>
diff --git a/addOns/scanpolicies/src/main/javahelp/help/helpset.hs b/addOns/scanpolicies/src/main/javahelp/help/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>Scan Policies</title>
+
+  <maps>
+     <homeID>top</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>
diff --git a/addOns/scanpolicies/src/main/javahelp/help/index.xml b/addOns/scanpolicies/src/main/javahelp/help/index.xml
@@ -0,0 +1,8 @@
+<?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">
+    <indexitem text="scanpolicies" target="scanpolicies" />
+</index>
diff --git a/addOns/scanpolicies/src/main/javahelp/help/map.jhm b/addOns/scanpolicies/src/main/javahelp/help/map.jhm
@@ -0,0 +1,10 @@
+<?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="scanpolicies" url="contents/scanpolicies.html" />
+    <mapID target="policy-default" url="contents/policy-default.html" />
+    <mapID target="scanpolicies-icon" url="contents/images/equalizer.png" />
+</map>
diff --git a/addOns/scanpolicies/src/main/javahelp/help/toc.xml b/addOns/scanpolicies/src/main/javahelp/help/toc.xml
@@ -0,0 +1,14 @@
+<?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="Scan Policies" image="scanpolicies-icon" target="scanpolicies">
+                <tocitem text="Default Policy" target="policy-default"/>
+            </tocitem>
+        </tocitem>
+    </tocitem>
+</toc>