org.fusesource.scalate.wikitext

SwizzleLinkFilter

case class SwizzleLinkFilter(sourceDirectories: Traversable[File], extensions: Set[String]) extends Filter with Product with Serializable

Converts links used in wiki notation to find the template or wiki markup files on the file system.

Wiki links tend to assume a single name is unique per wiki space; but when converting wiki pages to URIs or files and directories you often want to move the wiki files into directory trees. This filter will fix up these bad links, searching for wiki files in your source tree and swizzling the generated links to use those.

Linear Supertypes
Serializable, Serializable, Product, Equals, Filter, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. SwizzleLinkFilter
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Filter
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SwizzleLinkFilter(sourceDirectories: Traversable[File], extensions: Set[String])

Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  6. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  7. def clone(): AnyRef

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

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

    Definition Classes
    AnyRef

  9. val extensions: Set[String]

  10. def filter(context: RenderContext, html: String): String

    Lets fix up any links which are local and do notcontain a file extension

    Lets fix up any links which are local and do notcontain a file extension

    Definition Classes
    SwizzleLinkFilter → Filter

  11. def finalize(): Unit

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

  12. def findWikiFile(link: String, requestUri: String): Option[File]

    Finds a wiki File from a link name by starting at the root directories and navigating through all files until we find a file name that matches the given link (without an extension)

  13. def findWikiFileUri(link: String, requestUri: String): Option[String]

    Finds a wiki URI from a link name by starting at the root directories and navigating through all files until we find a file name that matches the given link (without an extension)

  14. def findWikiFileWith[T](link: String, requestUri: String)(fn: (File, File) ⇒ T): Option[T]

    Attributes
    protected

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

    Definition Classes
    AnyRef → Any

  16. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

  17. val linkRegex: Regex

    Attributes
    protected

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

    Definition Classes
    AnyRef

  19. final def notify(): Unit

    Definition Classes
    AnyRef

  20. final def notifyAll(): Unit

    Definition Classes
    AnyRef

  21. val sourceDirectories: Traversable[File]

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

    Definition Classes
    AnyRef

  23. def transformLink(link: String, requestUri: String): String

    If a link is external or includes a dot then assume its OK, otherwise append html extension

  24. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

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

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Filter

Inherited from AnyRef

Inherited from Any

Ungrouped