Summary
Performs link validation for HTML elements such as anchors, images, and other resources.
- Assembly
- Wyam
.Html .dll - Namespace
- Wyam
.Html - Interfaces
- Base Types
-
- Object
graph BT
Type-->Base0["Object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Wyam.Common.Modules/IModule"
Type["ValidateLinks"]
class Type type-node
Syntax
public class ValidateLinks : IModuleRemarks
Both relative and absolute links can be validated, though only relative links are checked
by default due to the time it takes to check absolute links.
Methods
| Name | Value | Summary |
|---|---|---|
| AsError |
ValidateLinks |
When the validation process is complete, all the validation failures will
be output as warnings. This method can be used to report all of the failures
as errors instead (possibly breaking the generation).
|
| Execute |
IEnumerable |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
|
| Validate |
ValidateLinks |
Validates absolute (often external) links. This may add a significant delay to your
generation process so it's recommended absolute links are only checked periodically.
The default behavior is not to check absolute links. Also note that false positive
failures are common when validating external links so any links that fail the check
should be subsequently checked manually.
|
| Validate |
ValidateLinks |
Validates relative links, which is activated by default.
|