Trait

razie.wiki.mods

WikiMod

Related Doc: package mods

Permalink

trait WikiMod extends AnyRef

extensibility - mods can mess with wikis. can add/interpret properties, filter html etc

There is a mod wiki and a mod prop. The modProp can tranform sections/tags while the modWiki transforms all wiki

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WikiMod
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def isInterested(we: WikiEntry): Boolean

    Permalink

    is mod interested in topic - you could look at tags, props or content

    is mod interested in topic - you could look at tags, props or content

    note that for modProp you don't need to be interested

  2. abstract def modName: String

    Permalink

    the name of the mod

  3. abstract def modProps: Seq[String]

    Permalink

    the wiki properties recognied by the mod - this is used by the parser and filtered through here.

    the wiki properties recognied by the mod - this is used by the parser and filtered through here.

    The idea is to allow you to define your own properties that you handle

    Note that for modProp you don't need to be interested

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  6. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  7. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  8. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  9. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  10. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  11. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  12. def modActions(we: WikiEntry): List[(String, String, String)]

    Permalink

    special actions available for this wiki?

    special actions available for this wiki?

    main actions are "edit", "view" - which you could overwrite

    returns

    more special actions, map(name,lavel,URL)

  13. def modPostHtml(we: WikiEntry, html: String): String

    Permalink

    modify the resulting html of formatting the page

    modify the resulting html of formatting the page

    returns

    the new html

  14. def modPreHtml(we: WikiEntry, content: Option[String]): Option[String]

    Permalink

    modify the content of the page before MARKDOWN formatting for rendering (but after internal formatting and parsing)

    modify the content of the page before MARKDOWN formatting for rendering (but after internal formatting and parsing)

    we

    the page in the context of which the transformation is required

    content

    an optional different content. Implementations are supposed to start with content.orElse(Some(we.content)).map{c=>

    returns

    None if no changed are desired

  15. def modPreParsing(we: WikiEntry, content: Option[String]): Option[String]

    Permalink

    modify the content of the page before parsing - you shouldn't really use this !

    modify the content of the page before parsing - you shouldn't really use this !

    we

    the page in the context of which the transformation is required

    content

    an optional different content. Implementations are supposed to start with content.orElse(Some(we.content)).map{c=>

    returns

    None if no changed are desired

  16. def modProp(prop: String, value: String, we: Option[WikiEntry]): String

    Permalink

    modify a prop - during parsing, if you recognize this property, you can transform its value

    modify a prop - during parsing, if you recognize this property, you can transform its value

    The idea is to allow you to define your own properties that you handle - i.e. a JSON formatter or the on.snow modules for mod.book

  17. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  18. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  19. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  20. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  21. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  22. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  23. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  24. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped