Using template values to format findings
@
to initiate auto-complete! Typing @{
will display a list of all available template values. The curly brace matches the first character of the template variables, leading to the population of the autocomplete suggestions.
Ghostwriter will process the values when a report is generated. To use a value, read its description for usage instructions and place the {{.VALUE}}
keyword in your finding template.
The .
int {{.VALUE}}
is important and easy to miss. This additional character is necessary to avoid processing other values inside curly braces as variables. Some people use {{ }}
as a way to denote sections of text that should be filled in to use the template.
Keyword | Usage |
---|---|
{{.client}} | This keyword will be replaced with the client’s short name. The full name will be used if a short name has not been set for the client. |
{{.caption}} | Start a line of text with this keyword to make it a caption. This is intended to follow a code block. |
{{.caption reference}} | Adding an alphanumeric string after caption (and a space) will place a bookmark that will link to the matching reference (created with the {{.ref ...}} tag). |
{{.ref ...}} | The “ref” tag places a bookmark that will link to the matching figure. Use evidence-friendly names or the reference you provide in a {{.caption}} tag. |
{{.Screenshot}}
Anywhere else in the finding (before or after {{.Screenshot}}
) you can place one or more references to that image to create bookmarks. Like this:{{.ref Screenshot}}
The final Word document will have your evidence with a “field character” (i.e., a reference like “Figure 1”) and bookmarks (i.e., cross-references) to that field character. They will look and function just like cross-references inserted using Word’s Reference tab.The same works with captions like this:{{.caption myReference}}
and {.ref myReference}}
{{.Enigma}}
, on a new line by itself.