Module: WordsHtmlGeneratorModule

Type:	htmlGenerator
Uses (at least one of):
Requires (at least one of):	JavascriptComposerModule > WordsStringComposerModule >

Properties:

active
compose
dataType
disable
enable
generate

Files

/template.html

#!
#!	Copyright 2011-2012, Marten de Vries
#!
#!	This file is part of OpenTeacher.
#!
#!	OpenTeacher is free software: you can redistribute it and/or modify
#!	it under the terms of the GNU General Public License as published by
#!	the Free Software Foundation, either version 3 of the License, or
#!	(at your option) any later version.
#!
#!	OpenTeacher is distributed in the hope that it will be useful,
#!	but WITHOUT ANY WARRANTY; without even the implied warranty of
#!	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#!	GNU General Public License for more details.
#!
#!	You should have received a copy of the GNU General Public License
#!	along with OpenTeacher.  If not, see <http://www.gnu.org/licenses/>.
#!
<!--(set_escape)-->
	html
<!--(end)-->
<!doctype html>
<html>
	<head>
		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
		<title>@!list.get("title", u"")!@</title>
		<style type='text/css'>
			body {
				font-family:Verdana, Helvetica, Arial, sans-serif;
				margin:@!margin!@;
			}

			h1 {
				font-size:x-large;
			}

			table {
				border-collapse:collapse;
				width:100%;
			}

			th {
				text-align:left;
				border-bottom:1px solid #000;
			}

			.number {
				text-align:right;
				color:#888;
				padding-left:0;
			}

			.question, #question-header {
				padding-left:1em;
			}

			.answer, #answer-header {
				padding-left:2em;
				padding-right:0;
			}

			<!--(if coloredRows)-->
			.even {
				background-color:#ddd;
			}
			<!--(end)-->

			th, td {
				padding: 0.25em;
			}
		</style>
	</head>
	<body>
		<h1>@!list.get("title", u"")!@</h1>
		<table>
			<thead>
				<tr>
					<th id='number-header'></th>
					<th id='question-header'>@!list.get("questionLanguage", u"")!@</th>
					<th id='answer-header'>@!list.get("answerLanguage", U"")!@</th>
				</tr>
			</thead>
			<tbody>
			<!--(for word in list.get("items", []))-->
				<!--(if list["items"].index(word) % 2)-->
				<tr class='even'>
				<!--(else)-->
				<tr class='odd'>
				<!--(end)-->
					<td class='number'>@!list["items"].index(word) +1!@</td>
					<td class='question'>@!compose(word.get("questions", []))!@</td>
					<td class='answer'>@!compose(word.get("answers", []))!@</td>
				</tr>
			<!--(end)-->
			</tbody>
		</table>
	</body>
</html>

/words.py

#! /usr/bin/env python3
# -*- coding: utf-8 -*-

#	Copyright 2011-2012, Marten de Vries
#	Copyright 2011, Milan Boers
#
#	This file is part of OpenTeacher.
#
#	OpenTeacher is free software: you can redistribute it and/or modify
#	it under the terms of the GNU General Public License as published by
#	the Free Software Foundation, either version 3 of the License, or
#	(at your option) any later version.
#
#	OpenTeacher is distributed in the hope that it will be useful,
#	but WITHOUT ANY WARRANTY; without even the implied warranty of
#	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
#	GNU General Public License for more details.
#
#	You should have received a copy of the GNU General Public License
#	along with OpenTeacher.  If not, see <http://www.gnu.org/licenses/>.

class WordsHtmlGeneratorModule:
	def __init__(self, moduleManager, *args, **kwargs):
		super().__init__(*args, **kwargs)
		self._mm = moduleManager

		self.type = "htmlGenerator"
		self.dataType = "words"
		self.requires = (
			self._mm.mods(type="wordsStringComposer"),
		)

	def generate(self, lesson, margin="0", coloredRows=True):
		"""Generates a html document which provides an overview of all
		   the questions and answers in `lesson`. It includes an inline
		   stylesheet.

		   - `margin` specifies the margin for the page (should be valid
		     css, e.g. 1em or 1px)
		   - `coloredRows` specifies if the odd rows should have a
		     different background colors than the even ones.

		"""
		class EvalPseudoSandbox(pyratemp.EvalPseudoSandbox):
			def __init__(self2, *args, **kwargs):
				pyratemp.EvalPseudoSandbox.__init__(self2, *args, **kwargs)

				self2.register("compose", self.compose)

		with open(self._mm.resourcePath("template.html"), encoding='UTF-8') as templateFile:
			t = pyratemp.Template(
				templateFile.read(),
				eval_class=EvalPseudoSandbox
			)
		return t(**{
			"list": lesson.list,
			"margin": margin,
			"coloredRows": coloredRows,
		})

	@property
	def compose(self):
		return self._modules.default(
			"active",
			type="wordsStringComposer"
		).compose

	def enable(self):
		global pyratemp
		try:
			import pyratemp
		except ImportError:
			return #remain inactive
		self._modules = set(self._mm.mods(type="modules")).pop()

		self.active = True

	def disable(self):
		self.active = False

		del self._modules

def init(moduleManager):
	return WordsHtmlGeneratorModule(moduleManager)