Redirect Class


Handles redirected content by creating pages with meta refresh tags or other redirect files.
Base Types
  • Object
graph BT Type-->Base0["Object"] Type-.->Interface0["IModule"] click Interface0 "/api/Wyam.Common.Modules/IModule" Type["Redirect"] class Type type-node


public class Redirect : IModule


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.


Name Value Summary
Execute(IReadOnlyList<IDocument>, IExecutionContext) IEnumerable<IDocument>
This should not be called directly, instead call IExecutionContext.Execute() if you need to execute a module from within another module.
IncludeHost(bool) Redirect
Indicates whether the host should be automatically included in generated redirect links.
WithAdditionalOutput(FilePath, Func<IDictionary<FilePath, string>, string>) Redirect
Adds additional output files that you specify by supplying a delegate that takes a dictionary of redirected paths to destination URLs.
WithMetaRefreshPages(bool) Redirect
Controls whether meta refresh pages are output.
WithPaths(DocumentConfig) Redirect
Controls where the redirected paths come from. By default, values from the metadata key RedirectFrom are used.