- Namespace
- Statiq
.Core - Interfaces
- Base Types
-
- object
- Module
Syntax
public class GenerateRedirects : Module, IModuleRemarks
When content moves you need some way to redirect from the old location to the new location. This is especially true when moving content from one publishing system to another that might have different conventions for things like paths.
This module lets you manage redirected content by generating special pages that contain a "meta refresh tag". This tag tells client browsers that the content has moved and to redirect to the new location. Google and other search engines also understand meta refresh tags and will adjust their search indexes accordingly.
Alternatively (or additionally), you can also create host-specific redirect files to control redirection on the server.
By default, this module will read the paths that need to be redirected from the
RedirectFrom metadata key. One or more paths can be specified in this metadata and
corresponding redirect files will be created for each.
This module outputs any meta refresh pages as well as any additional redirect files you specify. It does not output the original input files.
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| Always |
GenerateRedirects |
Always creates any additional output documents even if there are no redirected paths.
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
|
| ExecuteInputAsync |
Task |
Executes the module.
Inherited from Module
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| IncludeHost |
GenerateRedirects |
Indicates whether the host should be automatically included in generated redirect links.
|
| WithAdditionalOutput |
GenerateRedirects |
Adds additional output files that you specify by supplying a delegate that takes a dictionary
of redirected paths to destination URLs.
|
| WithAdditionalOutput |
GenerateRedirects |
Adds additional output files that you specify by supplying a delegate that takes a dictionary
of redirected paths to destination URLs.
|
| WithAdditionalOutput |
GenerateRedirects |
Adds additional output files that you specify by supplying a delegate that takes a dictionary
of redirected paths to destination URLs.
|
| WithAdditionalOutput |
GenerateRedirects |
Adds additional output files that you specify by supplying a delegate that takes a dictionary
of redirected paths to destination URLs.
|
| WithMetaRefreshPages |
GenerateRedirects |
Controls whether meta refresh pages are output.
|
| WithPaths |
GenerateRedirects |
Controls where the redirected paths come from. By default, values from the metadata
key
RedirectFrom are used.
|