Summary
Gets a link for the specified metadata (typically a document) using the
specified metadata value (by default, "RelativeFilePath") and the default settings from the
Wyam.Common.Configuration.IReadOnlySettings. This version should be used inside modules to ensure
consistent link generation. Note that you can optionally include the host or not depending
on if you want to generate host-specific links. By default, the host is not included so that
sites work the same on any server including the preview server.
Syntax
public static string GetLink(this IExecutionContext context, IMetadata metadata, string key, bool includeHost = false)
Parameters
| Name |
Type |
Description |
| context |
IExecutionContext |
The execution context. |
| metadata |
IMetadata |
The metadata or document to generate a link for. |
| key |
string |
The key at which a Wyam.Common.IO.FilePath can be found for generating the link. |
| includeHost |
bool |
If set to true the host configured in the output settings will
be included in the link, otherwise the host will be omitted and only the root path will be included (default). |
Return Value
| Type |
Description |
| string |
A string representation of the path suitable for a web link.
|
