gwsumm.html.html5 module¶
HTML5-specific extensions
- gwsumm.html.html5.comments_box(name, identifier=None, title=None, url=None)[source]¶
Generate a Disqus comments box
- gwsumm.html.html5.dialog_box(content, title, id_, btntxt)[source]¶
Generate a dialog box to be loaded modal atop the main page
- Parameters:
- contentstr
either raw markdown text or the path to a file containing markdown, this will be rendered in HTML as the contents of the dialog box
- titlestr
title to display atop the dialog box
- id_str
unique identifier for the dialog box
- btntxtstr
text (usually a single character) to appear inside a sticky button that opens the dialog box
- Returns:
- page~MarkupPy.markup.page
fully rendered HTML containing the dialog box
- gwsumm.html.html5.ldvw_qscan(channel, time, fmin=10, fmax='inf', qmin=4, qmax=100)[source]¶
Generate a Q-scan through LIGO DataViewer Web (LDVW)
- gwsumm.html.html5.load(url, id_='main', error=False, success=None)[source]¶
Construct the HTML script required to load a url into the HTML element with the given unique
id_.
- gwsumm.html.html5.load_state(url)[source]¶
Construct the HTML script required to load the Tab HTML for a given :class:`~gwsumm.state.core.SummaryState`
- Parameters:
- urlstr
path (relative to <base>) of HTML to load
- id_str, optional, default: ‘#main’
<div> ‘id’ in which to load HTML
- Returns:
- HTMLstr
HTML one-liner with script loading