macro::FullSearchWithDescriptionsCS Namespace Reference

Classes

class  Node

Functions

def execute
def formatContext
def pageListWithContext
def search_box
def sortResults
def topoSort
def visit

Variables

list Dependencies = ["pages"]

Function Documentation

def macro::FullSearchWithDescriptionsCS::execute (   macro,
  needle 
)

Definition at line 284 of file FullSearchWithDescriptionsCS.py.

def macro::FullSearchWithDescriptionsCS::formatContext (   self,
  macro,
  page,
  context,
  maxlines 
)
Format search context for each matched page

Try to show first maxlines interesting matches context.

Definition at line 240 of file FullSearchWithDescriptionsCS.py.

def macro::FullSearchWithDescriptionsCS::pageListWithContext (   self,
  macro,
  request,
  formatter,
  info = 1,
  context = 180,
  maxlines = 1,
  paging = True,
  hitsFrom = 0,
  hitsInfo = 0 
)
Format a list of found pages with context

The default parameter values will create Google-like search
results, as this is the most known search interface. Good
interface is familiar interface, so unless we have much better
solution (we don't), being like Google is the way.

@param request: current request
@param formatter: formatter to use
@param info: show match info near the page link
@param context: how many characters to show around each match.
@param maxlines: how many contexts lines to show.
@param paging: toggle paging
@param hitsFrom: current position in the hits
@param hitsInfo: toggle hits info line
@rtype: unicode
@return formatted page list with context

Definition at line 87 of file FullSearchWithDescriptionsCS.py.

def macro::FullSearchWithDescriptionsCS::search_box (   type,
  macro 
)
Make a search box

Make both Title Search and Full Search boxes, according to type.

@param type: search box type: 'titlesearch' or 'fullsearch'
@rtype: unicode
@return: search box html fragment

Definition at line 39 of file FullSearchWithDescriptionsCS.py.

def macro::FullSearchWithDescriptionsCS::sortResults (   display_results  ) 

Definition at line 227 of file FullSearchWithDescriptionsCS.py.

def macro::FullSearchWithDescriptionsCS::topoSort (   dependencies  ) 

Definition at line 190 of file FullSearchWithDescriptionsCS.py.

def macro::FullSearchWithDescriptionsCS::visit (   dependencies,
  terminals,
  dependency,
  list,
  dead 
)

Definition at line 212 of file FullSearchWithDescriptionsCS.py.


Variable Documentation

Definition at line 36 of file FullSearchWithDescriptionsCS.py.

 All Classes Namespaces Files Functions Variables


roswiki
Author(s): Kenneth Conley
autogenerated on Fri Jan 11 11:46:29 2013