Skip to content

Adding a Tutorial Page

thc202 edited this page Jan 19, 2021 · 3 revisions

To add a tutorial for a new feature, eg MyNewFeature you need to:

  1. Add a MyNewFeature.html page into zapHomeFiles/hudtutorial/en_GB - this should describe how to use your new feature in a similar way to the other tutorial pages
  2. Optionally add a MyNewFeature.task.html page which described a task the user must complete
  3. Add a MyNewFeaturePage.java class file to org/zaproxy/zap/extension/hud/tutorial/pages - a simple example with no task that you can copy is HtmlReportPage.java. If you want to implement a task then look at one of the existing pages to see what they do.
  4. Add the new class to the constructor in TutorialProxyServer.java
  5. In HudParam.java
    • Increment PARAM_CURRENT_VERSION (unless it has already been incremented since the last HUD release)
    • Add a test for the previous version in updateConfigsImpl and add addTutorialUpdate(MyNewFeaturePage.NAME);