def _main_frame(self, name, description, highlight, imgname=None):
"""This is part of the nav.rst page in the reST formatting."""
text = []
highlight = highlight and 'Yes' or 'No'
text.append(self.heading('Overivew', 2))
text.append(self.br())
text.append(self.p('**Description**:\n %s' % description))
text.append(self.p('\n**Using syntax highlighting**:\n %s' % \
highlight))
text.append(self.p('\n**Oracle Encoding**:\n %s' % self.cfg.ora_encoding))
text.append(self.p('\n**Web Character set**:\n %s' % self.cfg.webEncoding))
if not self.notNulls:
text.append(self.p('\n**Constraints**:\n NOT NULL constraints '\
'are skipped. This information is kept in colums list. One '\
'can enable its listing by `--not-nulls` option when '\
'generating these docs.\n'))
# create a note for DDL script dependencies...
text.append(self.p('\n' +\
RIP.note('Obtaining the DDL script depends on the '\
'DBMS_METADATA package. So this is limited only to users '\
'with EXECUTE privilege on this package.')))
return ''.join(text)
def table(self, name, headers, rows, width=None, anchor=None,
heading_level=3):
"""The 'columns need to be as 'wide' as the widest
data element within a cell.
So we need to run through all the elements first, find the
'widest' element and then padd everything to match that.
If anchor is passed, an anchor to the table is created above
the name section header.
heading_level is the level of the name/title of the table being
created.
"""
return RIP.table(name, headers, rows, anchor, heading_level)
def i(self, text):
return RIP.emphasis(text)
def href(self, label, text=None):
return RIP.ref(label, text)
def doc(self, label, text=None):
"""For Cross-referencing to documents"""
return RIP.doc(label, text)
def heading(self, text, level):
"""The heading is offset by 2 line breaks from whatever follows"""
return RIP.header(text, level)
def download_href(self, path, text):
return RIP.download(path, text)
def anchor(self, text):
return RIP.anchor(text)
