org.mmbase.framework
Class DocumentationRenderer

java.lang.Object
  org.mmbase.framework.AbstractRenderer
      org.mmbase.framework.WrappedRenderer
          org.mmbase.framework.CachedRenderer
              org.mmbase.framework.DocumentationRenderer

All Implemented Interfaces:

Renderer

public class DocumentationRenderer
extends CachedRenderer

Currently renders documentation directly from subversion, using an XSLT to convert docbook to HTML. The idea is that a fall-back could be added to render the documenation from the xml's in a/the jar.

Since:

MMBase-1.9.1

Version:

$Id: DocumentationRenderer.java 37278 2009-07-27 12:11:20Z michiel $

Author:

Michiel Meeuwissen

Nested Class Summary

Nested classes/interfaces inherited from interface org.mmbase.framework.Renderer

Renderer.Type

Field Summary

Fields inherited from class org.mmbase.framework.WrappedRenderer

wrapped

Fields inherited from class org.mmbase.framework.AbstractRenderer

type

Constructor Summary

DocumentationRenderer(Renderer.Type t, Block parent)

Method Summary

Parameter<?>[]	getParameters() A renderer may need certain parameters.
Renderer	getWraps()
void	setDocbook(String s)
void	setModule(String m)
void	setProject(String p)
void	setRepository(String r)

Methods inherited from class org.mmbase.framework.CachedRenderer

getCacheFile, getETagFile, getExpiresFile, getKey, readETag, readExpires, render, renderFile, renderWrappedAndFile, setDirectory, setExpires, setIncludeRenderTime, setTimeout, setWait, toString, writeETag, writeExpires, writeRenderTime

Methods inherited from class org.mmbase.framework.WrappedRenderer

getUri, setWraps, setWrapsBlock

Methods inherited from class org.mmbase.framework.AbstractRenderer

decorateIntro, decorateOutro, getBlock, getType, getUri

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DocumentationRenderer

public DocumentationRenderer(Renderer.Type t,
                             Block parent)

Method Detail

setDocbook

public void setDocbook(String s)

setModule

public void setModule(String m)

setRepository

public void setRepository(String r)

setProject

public void setProject(String p)

getParameters

public Parameter<?>[] getParameters()

Description copied from interface: Renderer

A renderer may need certain parameters. These are added to the block-parameters. This method is called on instantation of the renderer.

Specified by:

getParameters in interface Renderer

Overrides:

getParameters in class WrappedRenderer

getWraps

public Renderer getWraps()

Overrides:

getWraps in class WrappedRenderer