gwsumm.tabs.misc module

This module defines some utility Tab subclasses, including HTTP error handlers.

class gwsumm.tabs.misc.AboutTab(*args, **kwargs)

Bases: Tab

Page describing how the containing HTML pages were generated

type = 'about'

write_html(config=[], prog=None, **kwargs)

Write the HTML page for this Tab.

Parameters:

maincontentstr, ~MarkupPy.markup.page

simple string content, or a structured page of markup to embed as the content of the #main div.

titlestr, optional, default: {parent.name}

level 1 heading for this Tab.

subtitlestr, optional, default: {self.name}

level 2 heading for this Tab.

tabs: `list`, optional

list of top-level tabs (with children) to populate navbar

ifostr, optional

prefix for this IFO.

ifomapdict, optional

dict of (ifo, {base url}) pairs to map to summary pages for other IFOs.

help_str, ~MarkupPy.markup.page, optional

non-menu content for navigation bar

csslist, optional

list of resolvable URLs for CSS files. See gwsumm.html.CSS for the default list.

jslist, optional

list of resolvable URLs for javascript files. See gwumm.html.JS for the default list.

aboutstr, optional

href for the ‘About’ page

footerstr, ~MarkupPy.markup.page

external link, if applicable (linked from an icon in the footer)

issuesbool or str, default: True

print link to github.com issue tracker for this package

**inargs

other keyword arguments to pass to the :meth:`~Tab.build_inner_html` method

class gwsumm.tabs.misc.Error404Tab(*args, **kwargs)

Bases: Tab

Custom HTTP 404 error page

type = '404'

write_html(config=[], top=None, **kwargs)

Write the HTML page for this Tab.

Parameters:

maincontentstr, ~MarkupPy.markup.page

simple string content, or a structured page of markup to embed as the content of the #main div.

titlestr, optional, default: {parent.name}

level 1 heading for this Tab.

subtitlestr, optional, default: {self.name}

level 2 heading for this Tab.

tabs: `list`, optional

list of top-level tabs (with children) to populate navbar

ifostr, optional

prefix for this IFO.

ifomapdict, optional

dict of (ifo, {base url}) pairs to map to summary pages for other IFOs.

help_str, ~MarkupPy.markup.page, optional

non-menu content for navigation bar

csslist, optional

list of resolvable URLs for CSS files. See gwsumm.html.CSS for the default list.

jslist, optional

list of resolvable URLs for javascript files. See gwumm.html.JS for the default list.

aboutstr, optional

href for the ‘About’ page

footerstr, ~MarkupPy.markup.page

external link, if applicable (linked from an icon in the footer)

issuesbool or str, default: True

print link to github.com issue tracker for this package

**inargs

other keyword arguments to pass to the :meth:`~Tab.build_inner_html` method