Text styles and screenshots

Dradis uses Textile markup to format text. However, we do not support all of the Textile formatting options when exporting to Word. The formatting options listed here are the full list of supported styles. It is possible to force Dradis to display other formatting options, but only the styles and formatting options listed here will export into your reports as expected.

In this page:

Bold and italic

Reports 55
Reports 56

New lines and paragraphs

If you want separate paragraphs in Word, you have to use two new line characters in Dradis:

Reports 57

Will render in Word like:

Reports 58

If you use a single new line character in Dradis:

Reports 59

The rendered Word will look like:

Reports 60

Bullet point and numbered lists

You can use * to create bullet point lists or # to create numbered lists.

Reports 75

When you switch between Write and Preview mode, you'll see the lists displayed as expected.

You can also create nested lists with the following syntax:

Reports 76

And again, when you switch between Write and Preview mode, you'll see the nested lists displayed as expected.

Nested or single-level lists will automatically export into your Word reports.

Reports 77
Reports 78

Screenshots and captions

To include a screenshot in your report, upload it as an attachment to your node by clicking the green and selecting the image from your local system. You can also upload the file by dragging and dropping the image to the Drop zone or by pasting the image directly from your clipboard (if your browser supports it):

Reports 61

Make sure to click the blue icon to finish the upload:

Reports 114

We need to include the link to the attachment in the project. Click the icon to copy the URL to your clipboard.

Reports 115

Now, paste the image URL into the correct location in your project. Now that the file is "living" within Dradis, you can include the URL anywhere in your project (an Issue, Evidence, or Note). Remember to use the Textile markers for embedding images, i.e. !<URL>!:

Reports 116

And the screenshot will be rendered in Word as expected:

Reports 63

Note: make sure to add new blank lines before and after your screenshots so that they are rendered correctly. For example, if you are adding two screenshots in a row, format them like this:

A screenshot showing the attack payload in action:



Instead of like this:

A screenshot showing the attack payload in action:

Screenshots also should not contain any trailing spaces or other characters after the final exclamation mark. The screenshot should be alone on its own line.

Create an image caption

Add a screenshot to your project using the instructions above. Again, you can use the Textile markers for image captions, i.e. !<URL>(Sample image caption)!:

Reports 105

Click Update Evidence, then mouseover the image to see the caption within Dradis:

Reports 106

The screenshot will export into your Word report and the caption will be prepended with Figure # as shown below:

Reports 107 Click image for fullscreen view

The sequence field (# in Figure # above will be automatically created and the field may need to be updated after you export.

Style your captions

The Dradis reporting engine will detect the image captions in your project and style them just how you want them. First, you'll need to decide how you want to style them.

The captions use the built-in Caption style in your Word document. We'll need to modify that style to change the way that the captions are formatted:

  1. Open your Word document and click the small downward arrow in the bottom right of the Styles section of the Home tab.

    Reports 108
  2. Inside the Styles pane, click Options in the bottom right corner.

    Reports 109
  3. Under Select styles to show: select All styles, then click OK.

    Reports 110
  4. Back in the Styles pane, scroll down until you find the Caption style. Click the carat to the right of the name and then select Modify... from the pop-up that appears.

    Reports 111
  5. Modify the style to match the formatting you need for your captions. We've applied color, indents, and more below. When you're ready, click OK to save your changes.

    Reports 112
  6. Now, when you export a Dradis project using this Word report template, all of the captions will use the Caption style we just modified:

    Reports 113

Next help article: Code blocks →