Interface PageExportProcessor

All Superinterfaces:

Extension

@Experimental
public interface PageExportProcessor
extends Extension

Modifies the Markdown AST of pages before they are exported for the website. This allows elements to resolve information that is only available in-game, such as symbolic colors or whether a mod is loaded.

Processors can change the attributes of elements directly, or replace elements entirely (i.e. with their own children) using the methods of PageExportContext. They work on a copy of the page, so these modifications don't affect the in-game guide.

Processors run before images and scenes are exported, so content that is unwrapped by a processor is exported normally, and content that is removed is not exported at all.

Field Summary

Fields

Modifier and Type	Field	Description
static final ExtensionPoint<PageExportProcessor>	EXTENSION_POINT

Method Summary

Modifier and Type	Method	Description
NodeSelector	getSelector()	Returns which nodes process(PageExportContext, MdAstNode) is called for.
void	process(PageExportContext context, guideme.libs.mdast.model.MdAstNode node)	Called for every node of the page matched by getSelector(), in document order.

Methods inherited from interface Extension

onExtensionsBuilt

Field Details

EXTENSION_POINT

static final ExtensionPoint<PageExportProcessor> EXTENSION_POINT

Method Details

getSelector

NodeSelector getSelector()

Returns which nodes process(PageExportContext, MdAstNode) is called for.

Returns:

which nodes process(PageExportContext, MdAstNode) is called for

process

void process(PageExportContext context,
 guideme.libs.mdast.model.MdAstNode node)

Called for every node of the page matched by getSelector(), in document order. If the node is replaced, the nodes that replace it are processed as well.