You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/query-help-style-guide.md
+7-7Lines changed: 7 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,7 +16,7 @@ Query help files must have the same base name as the query they describe and mus
16
16
17
17
### File structure and layout
18
18
19
-
Query files are written using an XML format called Qhelp, and stored in a file with a `.qhelp` extension. The basic structure is as follows:
19
+
Query help files are written using a custom XML format, and stored in a file with a `.qhelp` extension. The basic structure is as follows:
20
20
21
21
```
22
22
<!DOCTYPE qhelp SYSTEM "qhelp.dtd">
@@ -25,7 +25,7 @@ Query files are written using an XML format called Qhelp, and stored in a file w
25
25
</qhelp>
26
26
```
27
27
28
-
The header and single top-level `qhelp` element are both mandatory.
28
+
The header and single top-level `<qhelp>` element are both mandatory.
29
29
30
30
### Section-level elements
31
31
@@ -36,7 +36,7 @@ Section-level elements are used to group the information within the query help f
36
36
3.`example`—an example of code showing the problem. Where possible, this section should also include a solution to the issue.
37
37
4.`references`—relevant references, such as authoritative sources on language semantics and best practice.
38
38
39
-
For further information about the other section-level, block, list and table elements supported by the qhelp format, see the [Query help reference](https://help.semmle.com/QL/learn-ql/ql/writing-queries/query-help.html) on help.semmle.com.
39
+
For further information about the other section-level, block, list and table elements supported by query help files, see the [Query help reference](https://help.semmle.com/QL/learn-ql/ql/writing-queries/query-help.html) on help.semmle.com.
40
40
41
41
42
42
## English style
@@ -86,7 +86,7 @@ For example:
86
86
87
87
>W. C. Wake, _Refactoring Workbook_, pp. 93 – 94, Addison-Wesley Professional, 2004.
88
88
89
-
Note, & symbols need to be replaced by \&. The symbol will be displayed correctly in the html files generated from the qhelp files.
89
+
Note, & symbols need to be replaced by \&. The symbol will be displayed correctly in the HTML files generated from the query help files.
90
90
91
91
### Academic papers
92
92
@@ -107,11 +107,11 @@ For example:
107
107
108
108
### Referencing potential security weaknesses
109
109
110
-
If your query checks code for a CWE weakness, you should use the `@tags` element in the query file to reference the associated CWEs, as explained [here](query-metadata-style-guide.md). When you use these tags, a link to the appropriate entry from the [MITRE.org](https://cwe.mitre.org/scoring/index.html) site will automatically appear as a reference in the qhelp file.
110
+
If your query checks code for a CWE weakness, you should use the `@tags` element in the query file to reference the associated CWEs, as explained [here](query-metadata-style-guide.md). When you use these tags, a link to the appropriate entry from the [MITRE.org](https://cwe.mitre.org/scoring/index.html) site will automatically appear as a reference in the output HTML file.
111
111
112
112
## Query help example
113
113
114
-
The following example is a qhelp file for a query from the standard query suite for Java:
114
+
The following example is a query help file for a query from the standard query suite for Java:
115
115
116
116
```
117
117
<!DOCTYPE qhelp PUBLIC
@@ -179,4 +179,4 @@ tab width settings cannot be taken into account.
0 commit comments