t.l.m.ManConverter(object) : class documentation

Part of twisted.lore.man2lore View Source View In Hierarchy

Convert a man page to the Lore format.
Instance VariablestpState variable for handling text inside a TP token. It can take values from 0 to 3:
  • 0: when outside of a TP token.
  • 1: once a TP token has been encountered. If the previous value was 0, a definition list is started. Then, at the first line of text, a definition term is started.
  • 2: when the first line after the TP token has been handled. The definition term is closed, and a definition is started with the next line of text.
  • 3: when the first line as definition data has been handled.
(type: int )
Method convert Undocumented
Method lineReceived Undocumented
Method continueReceived Undocumented
Method closeTags Undocumented
Method paraCheck Undocumented
Method macro_TH Undocumented
Method macro_SH Undocumented
Method macro_B Undocumented
Method macro_NM Undocumented
Method macro_NS Undocumented
Method macro_OO Undocumented
Method macro_OC Undocumented
Method macro_OP Undocumented
Method macro_FL Undocumented
Method macro_AR Undocumented
Method macro_PP Undocumented
Method macro_IC Undocumented
Method macro_TP Handle TP token: start a definition list if it's first token, or close previous definition data.
Method macro_BL Undocumented
Method macro_EL Undocumented
Method macro_IT Undocumented
Method text Handle a line of text without detected token.
def convert(self, inf, outf): (source)
Undocumented
def lineReceived(self, line): (source)
Undocumented
def continueReceived(self, cont): (source)
Undocumented
def closeTags(self): (source)
Undocumented
def paraCheck(self): (source)
Undocumented
def macro_TH(self, line): (source)
Undocumented
def macro_SH(self, line): (source)
Undocumented
def macro_B(self, line): (source)
Undocumented
def macro_NM(self, line): (source)
Undocumented
def macro_NS(self, line): (source)
Undocumented
def macro_OO(self, line): (source)
Undocumented
def macro_OC(self, line): (source)
Undocumented
def macro_OP(self, line): (source)
Undocumented
def macro_FL(self, line): (source)
Undocumented
def macro_AR(self, line): (source)
Undocumented
def macro_PP(self, line): (source)
Undocumented
def macro_IC(self, line): (source)
Undocumented
def macro_TP(self, line): (source)
Handle TP token: start a definition list if it's first token, or close previous definition data.
def macro_BL(self, line): (source)
Undocumented
def macro_EL(self, line): (source)
Undocumented
def macro_IT(self, line): (source)
Undocumented
def text(self, line): (source)
Handle a line of text without detected token.
API Documentation for Twisted, generated by pydoctor at 2011-10-27 15:57:47.