Struct WikitextSettings

pub struct WikitextSettings {
    pub mode: WikitextMode,
    pub layout: Layout,
    pub enable_page_syntax: bool,
    pub use_include_compatibility: bool,
    pub use_true_ids: bool,
    pub isolate_user_ids: bool,
    pub minify_css: bool,
    pub allow_local_paths: bool,
    pub interwiki: InterwikiSettings,
}

Settings to tweak behavior in the ftml parser and renderer.

Fields

mode: WikitextMode

What mode we’re running in.

layout: Layout

What layout we’re targeting.

For instance, generating Wikidot’s legacy HTML structure.

enable_page_syntax: bool

Whether page-contextual syntax is permitted.

This currently refers to:

• Include
• Module
• Table of Contents
• Button

use_include_compatibility: bool

Whether a literal [[include]] is permitted.

If this is true, then [[include]] is treated as an alias for [[include]], which is necessary for Wikidot compatibility.

It is off by default.

use_true_ids: bool

Whether IDs should have true values, or be excluded or randomly generated.

In the latter case, IDs can be used for navigation, for instance the table of contents, but setting this to true is needed in any context where more than one instance of rendered wikitext could be emitted.

isolate_user_ids: bool

Whether to prefix user IDs with u-.

This is a behavior found in Wikidot (although implemented incompletely) which prefixes IDs in HTML elements provided by the user with u- to ensure isolation.

minify_css: bool

Whether to minify CSS in <style> blocks.

allow_local_paths: bool

Whether local paths are permitted.

This should be disabled in contexts where there is no “local context” to which these paths could be interpreted. For instance, on pages you can reference an attached file, but on an arbitrary forum thread no such file can exist.

This applies to:

• Files
• Images

interwiki: InterwikiSettings

What interwiki prefixes are supported.

All instances of $$ in the destination URL are replaced with the link provided in the interwiki link. For instance, [wikipedia:SCP_Foundation SCP Wiki], then $$ will be replaced with SCP_Foundation.

Notes

• These are matched case-sensitively.
• Prefixes may not contain colons, they are matched up to the first colon, and any beyond that are considered part of the link.
• By convention, prefixes should be all-lowercase.

Implementations

impl WikitextSettings

pub fn from_mode(mode: WikitextMode, layout: Layout) -> Self

Returns the default settings for the given WikitextMode.

Trait Implementations

impl Clone for WikitextSettings

fn clone(&self) -> WikitextSettings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for WikitextSettings

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for WikitextSettings

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WikitextSettings

fn eq(&self, other: &WikitextSettings) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for WikitextSettings

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for WikitextSettings

impl StructuralPartialEq for WikitextSettings