The documentation on this site is maintained using the Atlassian application Confluence.
What is Confluence?
Confluence is a wiki: a system that allows users to work collaboratively on content. Semmle uses Confluence to create the documentation for many of its applications. Unlike many public wikis, this site is maintained internally at Semmle and is read-only to most users.
What is a space?
Spaces are containers for related pages. Pages are grouped into a number of different spaces, for example: pages containing the documentation for a specific release or pages about rules for a specific language.
When you search for information, the results are displayed for all matching pages in any space in the wiki. You can use the Space drop-down option, shown on the left of the Search results page, to filter the results to show only results for a specific space (for example, Semmle documentation or QL resources). This makes it easier to find the information you need.
Overview of spaces
There are three main categories of space in the wiki:
- Help — each space contains documentation for a specific release of the products, including both application and admin information, for example: Semmle documentation always contains the most up-to-date information.
Rules — each space contains all the default rules for a specific language, for example: Java queries
- QL — the space contains some documentation about the QL language but most of this information has moved to: https://help.semmle.com/.
How do I navigate to a different space?
Using the navigation sidebar
A navigation sidebar is shown on all pages apart from the landing page. The sidebar is useful for browsing the documentation.
Where am I?
Every page contains information showing where you are in the public wiki, for example:
Searching for information
All pages contain a search box in the top right corner of the menu bar. This search box helps speed up your searches by providing two different types of search:
An interactive mode. Click on the search box and start typing keywords. As you type, a short list of possible matches is displayed (most recently updated first):
- If you see the information that you want, click on a page title to display that page.
- If none of the matches looks right, type the full keywords that you want to search for and then press Return to perform a full search.
A standard search. Click on the search box, type the keywords to search for and press Return.
The results are displayed on a Search results page:
See Confluence Search documentation for more information about searching.
There are two ways to print information:
- Use the print option available in your browser — the results will vary according to the set up of your browser and printer
- Export to PDF and print the resulting file — it may take a little longer than simply printing from the browser but the results may be more reliable
To export a page to PDF format, to the right of the page title, clickand then click Export to PDF. The content of the page is converted into a PDF file which you can download or view using your standard browser options.