Home       Trees       Indices       Help   
Package creoleparser :: Module elements :: Class WikiElement
[hide private]
[frames] | no frames]

Class WikiElement

source code

object --+
         |
        WikiElement
Known Subclasses:
Baseclass for all wiki elements.
Instance Methods [hide private]
 
__init__(self, tag, token, child_tags)
Constructor for WikiElement objects.		 source code
 
_build(self, mo, element_store)
Returns a genshi Element that has self.tag as the outermost tag.		 source code
 
re_string(self)
The regular expression pattern that is compiled into self.regexp.		 source code
 
_process(self, mo, text, wiki_elements, element_store)
Returns genshi Fragments (Elements and text)		 source code
 
__repr__(self)
repr(x)		 source code

Inherited from object: __delattr__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __str__

Class Variables [hide private]
  append_newline = False
Determines if newlines are appended to Element(s) during processing.
Properties [hide private]

Inherited from object: __class__

Method Details [hide private]

__init__(self, tag, token, child_tags)
(Constructor)

source code 

Constructor for WikiElement objects.

Subclasses may have other keyword arguments.

Parameters:
  • tag - The xhtml tag associated with the element.
  • token - The character string (or strings) that identifies the element in wiki markup.
  • child_tags - A list of wiki_elements that will be searched for in the body of the element. The order of these elements matters, because if an element is found before the element that encloses it, the enclosing element will never be found. In cases where this imposes limits (e.g, strong and em should be allowed to nest each other), place the conflicting elements in a sublist. The parser will then find which comes first.
Overrides: object.__init__

_build(self, mo, element_store)

source code 

Returns a genshi Element that has self.tag as the outermost tag.

This methods if called exclusively by _process

Parameters:
  • mo - match object, usually the one returned by self.regexp.search(s)

re_string(self)

source code 

The regular expression pattern that is compiled into self.regexp.

The regular expression must consume the entire wiki element, including the tokens. For block elements, the newline on the last line must be consumed also. group(1) should normally be the entire string inside the tokens. If not, a custom _build method will be needed.

_process(self, mo, text, wiki_elements, element_store)

source code 

Returns genshi Fragments (Elements and text)

This is mainly for block level markup. See InlineElement for the other method.

__repr__(self)
(Representation operator)

source code 
repr(x)
Overrides: object.__repr__
(inherited documentation)

Class Variable Details [hide private]

append_newline

Determines if newlines are appended to Element(s) during processing. Should only affect readability of source xml.
Value:
False

   Home       Trees       Indices       Help   
Generated by Epydoc 3.0.1 on Sat May 31 01:15:29 2008 http://epydoc.sourceforge.net