li.cil.manual.api.manual

Interface ContentProvider

All Known Implementing Classes:

ConfigContentProvider, ResourceContentProvider

public interface ContentProvider

This interface allows implementation of content providers for the manual.

Content providers can be used to provide possibly dynamic page content for arbitrary paths. Note that content providers have lower priority than content found in resource packs, i.e. content providers will only be queried for missing pages, so to speak.

See Also:

ResourceContentProvider

Method Summary

Modifier and Type	Method and Description
java.lang.Iterable<java.lang.String>	getContent(java.lang.String path) Called to get the content of a path pointed to by the specified path.

Method Detail

getContent

@Nullable
java.lang.Iterable<java.lang.String> getContent(java.lang.String path)

Called to get the content of a path pointed to by the specified path.

This should provide an iterable over the lines of a Markdown document (with the formatting provided by the in-game manual, which is a small subset of "normal" Markdown).

If this provider cannot provide the requested path, it should return null to indicate so, allowing other providers to be queried.

Parameters:

path - the path to the manual page we're looking for.

Returns:

the content of the document at that path, or null.