Short Description
Whitebox view on the HTML Sanity Checker.
Iteration
Filled
Level
1

Diagram

 

Blackboxes

Error rendering macro 'create-from-template'

Unknown Blueprint: Blueprint id: null, module key: de.smartics.atlassian.confluence.smartics-projectdoc-confluence-arc42:projectdoc-arc42-blueprint-doctype-blackbox, space: null

Table: HtmlSanityChecker building blocks
Building BlockDescription
CheckerCore
core: html parsing and sanity checking, file handling
HSC Command Line Interface
(not documented)
HSC Gradle Plugin
integrates the Gradle build tool with HtmlSC, enabling arbitrary gradle builds to use HtmlSC functionality.
HSC Graphical Interface
(planned, not implemented)
Reporter
outputs the collected checking results to configurable destinations, e.g. StdOut or a Html file.

Description

We used functional decomposition to separate responsibilities:

  • CheckerCore shall encapsulate checking logic and Html parsing/processing.
  • all kinds of outputs (console, html-file, graphical) shall be handled in a separate component (Reporter)
  • Implementation of Gradle specific stuff shall be encapsulated.

Internal Interfaces

Error rendering macro 'create-from-template'

Unknown Blueprint: Blueprint id: 187e887c-f52d-4ba6-95f7-4fe0483917db, module key: de.smartics.atlassian.confluence.smartics-projectdoc-confluence-arc42:projectdoc-arc42-blueprint-doctype-interface, space: null

Table: HtmlSanityChecker internal interfaces
InterfaceDescription
build system
currently restricted to Gradle: The build system uses HtmlSC as configured in the buildscript.
local-html and local-images
HtmlSC needs access to several local files, especially the html page to be checked and to the corresponding image directories.
usage via shell
arc42 user uses a command line shell to call the HtmlSC
 

Architecture Decisions

Error rendering macro 'create-from-template'

Unknown Blueprint: Blueprint id: null, module key: de.smartics.atlassian.confluence.smartics-projectdoc-confluence-space-swdev:projectdoc-swdev-blueprint-doctype-architecture-decision, space: null