From 561552bbeee2a0acfdcfb4850725b3c01dbc723b Mon Sep 17 00:00:00 2001
From: Michael Hohn <hohn@github.com>
Date: Wed, 17 Apr 2024 11:29:59 -0700
Subject: [PATCH] Add query help template in markdown format

---
 session/README.org       |  8 ++++++++
 session/help-template.md | 18 ++++++++++++++++++
 2 files changed, 26 insertions(+)
 create mode 100644 session/help-template.md

diff --git a/session/README.org b/session/README.org
index cef1d3b..82f156a 100644
--- a/session/README.org
+++ b/session/README.org
@@ -129,3 +129,11 @@
             ...
    #+END_SRC
    
+** (optional) Write query help
+   Help is included from a markdown file.  For a query =foo.ql= the file =foo.md=
+   is included in the SARIF output when the
+   : --sarif-include-query-help=always
+   flag is set.
+
+   To write such a help file, copy the template in [[./help-template.md]] and
+   customize the content.
diff --git a/session/help-template.md b/session/help-template.md
new file mode 100644
index 0000000..274477a
--- /dev/null
+++ b/session/help-template.md
@@ -0,0 +1,18 @@
+# SQLI Vulnerability
+Loops can ...
+
+## Recommendation
+When writing...
+
+## Example
+The following example ...
+
+```java
+import java.sql.Connection;
+...
+```
+The solution is ...
+
+## References
+* Java Language Specification: [Blocks and Statements](https://docs.oracle.com/javase/specs/jls/se11/html/jls-14.html).
+