HTML export - techtalk/SpecLog-Resources GitHub Wiki

You can export your requirements in SpecLog to a single HTML file containing all data as JSON. You can view and navigate between requirements in the HTML output. The HTML output is similar to the following:

The requirement list on the left hand-side has the same structure as the hierarchical view in the requirements tool widget. If you uncheck Show relations at the top of the list, requirements are no longer structure hierarchically but displayed as a flat list.

Click on the arrows at the top of the page above the requirement's details to expand or contract the requirements list.

Enter a search term in the search field above the list of requirements to search for a matching requirement. The search returns those requirements where your search term is entered in the requirement fields or acceptance criteria. The search does not currently return hits for the search term in Gherkin files.

You can access the requirements in your HTML export using their URLs; the final part of the URL corresponds to the requirement's ID (#{RequirementId}). For example, the following link references User Story 3 (US3): http://myserver/Bookshop.html#US3

Gherkin files attached to requirements are included in the HTML export.

You can preview Gherkin scenario outlines using the values defined in the example rows. To do so, check Preview in the desired cell:

To export your repository to HTML:

1. Select Export to HTML from the main menu to export your repository to HTML. The Export to HTML dialog is displayed:
   
2. Determine which requirements to export:

• All requirements: Exports all requirements in the repository
• Active workspace: Exports all requirements on the current workspace (this option is only available if the current tab contains a workspace)
• Active list: Exports all requirements in the current search list (this option is only available if the current tab contains a search list)
• Search result: Exports all requirements currently displayed in the Requirements Tool Widget

1. Enable the Include Acceptance Criteria option to export acceptance criteria and images.
2. Enable the Include Gherkin Files option to export Gherkin files.
3. Enter a file name for the HTML file.
4. Click on Export. Your repository is exported to the selected file and opened in your default browser.

The SpecLog server can periodically export the current version of the repository as HTML. Users without access to SpecLog can then access a read-only version, e.g. on a web server.

The HTML export is performed by a plugin on the SpecLog server. To configure and enable the plugin:

1. Select Manage repositories from the main menu and connect to the server hosting the repository that you want to publish.
2. Select Configure plugins for the desired repository:
   
3. Locate the SpecLog.HtmlExportPlugin plugin and select Configure from its menu:
   
4. Check the Enable plugin check box, select the Output Folder and enter the Generation Interval (in minutes) to determine the frequency of the export.
   

Note: The SpecLog service user's account requires access permissions (NTFS, file sharing) to be able to write to the output folder.

A full text search is available to search for entries in requirement fields (Actor, Goal, Value, Title) and acceptance criteria. Hits containing the search term in the field defined as the header in the card templates are listed first and the search term is highlighted.

Customising the HTML export is not currently possible in SpecLog, but you can create your own HTML export plugin to customise the output. The source code for the default HTML export plugin and a tutorial covering the development of custom SpecLog plugins is available on GitHub. This includes a step-by-step description and a git repository containing the individual commits for each step in the process.