Page History

Document Properties Marker

override	false

Short Description

The introduction to the architecture documentation lists the driving forces that software architects must consider in their decisions. This includes on the one hand the fulfillment of functional requirements of the stakeholders, on the other hand the fulfillment of or compliance with required constraints, always in consideration of the architecture goals.

Doctype

swad-section

hide

Name

Introduction and Goals

Parent

Parent Property

parent-doctype	swad
property-name	Name

Tags

Tag List

property	Tags

Iteration


value	filled

Sort Key

010

hide

Docsubtype

swad-section-introduction

hide

View Source

view source

hide

Section

title	Description
tags	SWAD

Section

title	Requirements Overview
tags	SWAD

Section

level	2
title	Basic Usage

A user configures the location (directory and filename) of an HTML file
and the corresponding images directory.
HtmlSC performs various checks on the HTML and
reports its results either on the console or as HTML report.

HtmlSC can run from the command line or as Gradle-plugin.

Section

level	2
title	Terminology: What Can Go Wrong in HTML Files?

Apart from purely syntactical errors, many things can go wrong in html, especially with respect to hyperlinks, anchors and id’s - as those are often manually maintained.

Section

numbering	false
level	3
title	Broken Cross References:: Cross-references (internal links) can be broken, e.g. due to missing or misspelled link-target.

See BrokenCrossReferencesChecker.

Section

numbering	false
level	3
title	Missing local resources: Referenced local resources (other than images) can be missing or misspelled.

See MissingLocalResourcesChecker.

Section

numbering	false
level	3
title	Duplicate link targets: link-targets can occur several times with the same name - so the browser cannot know which is the desired target

See DuplicateLinkTargetsChecker.

Section

numbering	false
level	3
title	Illegal links:: The links (aka anchors or URIs) can contain illegal characters or violate HTML link syntax.

See <<IllegalLinkChecker>>

Section

numbering	false
level	3
title	Broken external links: External links can be broken due to myriads of reasons: misspelled, link-target currently offline, illegal link syntax.

See BrokenExternalLinksChecker.

Section

numbering	false
level	3
title	Missing Alt Attribute in Image Tags: Images missing an alt-attribute.

Checking and reporting these errors and flaws is the central business requirement of HtmlSC.

Important terms (domain terms) of html sanity checking is documented in a (small) domain model.

Section

level	2
title	General Functionality

Display Table

doctype	requirement
select	Identifier, Name, Description
sort-by	Identifier
where	$<Type> = [General]
header-translations	Name=Functionality, Identifier=ID
table-caption	Table 1. General Functionality

Section

level	2
title	Types of Sanity Checks

Display Table

doctype	requirement
select	Identifier, Name, Description
sort-by	Identifier
where	$<Type> = [Required Sanity Check]
header-translations	Identifier=ID, Name=Check
table-caption	Table 2. Required Checks

Display Table

doctype	requirement
select	Identifier, Name, Description
sort-by	Identifier
where	$<Type> = [Optional Sanity Check]
header-translations	Identifier=ID, Name=Check
table-caption	Table 3. Optional Checks

Section

level	2
title	Reporting and Output Requirements

Display Table

doctype	requirement
select	Identifier, Name, Description
sort-by	Identifier
where	$<Type> = [Reporting]
header-translations	Identifier=ID, Name=Requirement
table-caption	Table 4. Reporting Requirements

Section

title	Quality Goals
tags	SWAD

Display Table

doctype	quality-target
render-no-hits-as-blank	true
select	Priority, Quality, Name
sort-by	Priority, Sort Key, Name
where	$[Priority]: [1 TO 5]
header-translations	Name=Scenario,Quality=Quality-Goal
table-caption	Table 5. Quality Goals

Section

title	Stakeholders
tags	SWAD

Display Table

doctype	role, stakeholder
render-no-hits-as-blank	true
select	Name, Short Description, Requirements, Doctype
sort-by	Sort Key, Name
where	$<Tags> = [primary]
header-translations	Name=Role, Short Description=Description, Requirements=Goal/Intention, Doctype=Type
table-caption	Table 6. Stakeholder

Section

title	Subordinate Sections

Display Table

doctype	section
render-no-hits-as-blank	true
select	Name, Short Description
restrict-to-immediate-children	true
sort-by	Sort Key, Name

Section

required-permissions	write-access
title	Notes

Section

title	References

Section

title	Resources

Space shortcuts

Child pages

Versions Compared

Old Version 3

New Version Current

Key