Module: UserDocumentationWrapperModule

Type:	userDocumentationWrapper
Uses (at least one of):
Requires (at least one of):	MetadataModule >

Properties:

active
disable
enable
wrap

Files

/userDocumentationWrapper.py

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

#	Copyright 2011-2013, 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/>.

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

		self.type = "userDocumentationWrapper"
		self.requires = (
			self._mm.mods(type="metadata"),
		)

	def wrap(self, html):
		metadata = self._modules.default("active", type="metadata").metadata

		t = pyratemp.Template(filename=self._mm.resourcePath("wrapper.html"))
		return t(**{
			"content": html,
			"QColor": QtGui.QColor,
			"hue": metadata["mainColorHue"],
		})

	def enable(self):
		global pyratemp, QtGui
		try:
			from PyQt5 import QtGui
			import pyratemp
		except ImportError:
			return

		self._modules = next(iter(self._mm.mods(type="modules")))

		self.active = True

	def disable(self):
		self.active = False

		del self._modules

def init(moduleManager):
	return UserDocumentationWrapperModule(moduleManager)

/wrapper.html

<!doctype html>
<!--
	Copyright 2011, Milan Boers
	Copyright 2011-2013, 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/>.

	This is also the license for the image files that are in the
	subdirectory 'static'. (Those are all used by this file.)
-->
<html>
	<head>
		<title>OpenTeacher - Documentation</title>
		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
		<style>
			html, body {
				background-color:@!QColor.fromHsv(hue, 44, 229).name()!@;
				margin:0 3%;
				font-family:Verdana, Geneva, sans-serif;
				color:@!QColor.fromHsv(hue, 64, 64).name()!@;
				font-size:12px;
			}
			h1
			{
				font-weight:bold;
				margin:0;
				padding-bottom:0.75em;
			}
			#content {
				background-color:@!QColor.fromHsv(hue, 12, 255).name()!@;
				padding:1em;
				padding-bottom:0;
				margin:1em 1em 2em 0;
				box-shadow:10px 10px 10px #888;
				-webkit-box-shadow:10px 10px 10px #888;
				border-radius: 15px;
				border:1px solid @!QColor.fromHsv(hue, 26, 184)!@;
			}
			.docThumb {
				width:80%;
				box-shadow:10px 10px 10px #888;
				-webkit-box-shadow:5px 5px 5px #888;
			}
			p, li {
				margin:0;
				padding-bottom:1em;
			}
			img {
				margin:1em 0 1.5em 0;
			}
		</style>
	</head>
	<body>
		<div id="content">
			$!content!$
		</div>
	</body>
</html>