wikitext

Class WikiText

lucee.Component
    extended by wikitext.WikiText

Copyright 2015 Ortus Solutions, Corp www.ortussolutions.com Manage the wikitext library

Class Attributes:
  • singleton
  •  
  • synchronized : false
  •  
  • accessors : true
  •  
  • persistent : false
  •  
    Property Summary
    type property default serializable required
    any javaloader


    • access = public
    • returntype = any
    • inject = loader@cbjavaloader
    true false
    any parserLibPath
          The location of the parser's library.

    • access = public
    • returntype = any
    true false
    any translators
          Available Translators array.

    • access = public
    • returntype = any
    true false
    any wikiConfig
          Wiki Configuration object.

    • access = public
    • returntype = any
    true false
    Constructor Summary
    init()
          Constructor.
    Method Summary
    any configure([struct settings='[runtime expression]'])
         Configure the Wiki Converter Driver, usually called after construction when a system is ready to startup the engine.
    string getJavaloader()
    string getParserLibPath()
    string getTranslators()
    string getWikiConfig()
    any setJavaloader(any javaloader)
    any setParserLibPath(any parserLibPath)
    any setTranslators(any translators)
    any setWikiConfig(any wikiConfig)
    any toHTML(any markup)
         Convert wiki text and return a structure with two keys: [wikiModel=The java wiki model object, html=the converted html string].
    any toWiki(any translator, any html)
         Convert an HTML string to wiki syntax.
     
    Methods inherited from class lucee.Component
    None

    Constructor Detail

    init

    public init()

    Constructor


    Property Detail

    javaloader

    property any javaloader

    Attributes:
    access - public
    required - false
    returntype - any
    inject - loader@cbjavaloader
    serializable - true

    parserLibPath

    property any parserLibPath

    The location of the parser's library

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    translators

    property any translators

    Available Translators array

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    wikiConfig

    property any wikiConfig

    Wiki Configuration object

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    Method Detail

    configure

    public any configure([struct settings='[runtime expression]'])

    Configure the Wiki Converter Driver, usually called after construction when a system is ready to startup the engine

    Parameters:
    settings

    getJavaloader

    public string getJavaloader()


    getParserLibPath

    public string getParserLibPath()


    getTranslators

    public string getTranslators()


    getWikiConfig

    public string getWikiConfig()


    setJavaloader

    public any setJavaloader(any javaloader)

    Parameters:
    javaloader

    setParserLibPath

    public any setParserLibPath(any parserLibPath)

    Parameters:
    parserLibPath

    setTranslators

    public any setTranslators(any translators)

    Parameters:
    translators

    setWikiConfig

    public any setWikiConfig(any wikiConfig)

    Parameters:
    wikiConfig

    toHTML

    public any toHTML(any markup)

    Convert wiki text and return a structure with two keys: [wikiModel=The java wiki model object, html=the converted html string]

    Parameters:
    markup

    toWiki

    public any toWiki(any translator, any html)

    Convert an HTML string to wiki syntax translator.hint The wiki syntax to use. It must be using a valid translator. [WIKIPEDIA,GOOGLECODE,JSPWIKI,MOINMOIN,TRAC] html.hint The html string to convert

    Parameters:
    translator
    html