2012-10-05 23:28:47 +02:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
|
|
|
|
|
|
"""
|
|
|
|
|
***************************************************************************
|
|
|
|
|
Help2Html.py
|
|
|
|
|
---------------------
|
|
|
|
|
Date : August 2012
|
|
|
|
|
Copyright : (C) 2012 by Victor Olaya
|
|
|
|
|
Email : volayaf at gmail dot com
|
|
|
|
|
***************************************************************************
|
|
|
|
|
* *
|
|
|
|
|
* This program 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 2 of the License, or *
|
|
|
|
|
* (at your option) any later version. *
|
|
|
|
|
* *
|
|
|
|
|
***************************************************************************
|
|
|
|
|
"""
|
|
|
|
|
|
|
|
|
|
__author__ = 'Victor Olaya'
|
|
|
|
|
__date__ = 'August 2012'
|
|
|
|
|
__copyright__ = '(C) 2012, Victor Olaya'
|
2013-10-01 20:52:22 +03:00
|
|
|
|
2012-10-05 23:28:47 +02:00
|
|
|
# This will get replaced with a git SHA1 when you do a git archive
|
2013-10-01 20:52:22 +03:00
|
|
|
|
2012-10-05 23:28:47 +02:00
|
|
|
__revision__ = '$Format:%H$'
|
|
|
|
|
|
2012-09-15 18:25:25 +03:00
|
|
|
import pickle
|
2013-09-12 13:19:00 +02:00
|
|
|
from processing.tools.system import *
|
2012-09-15 18:25:25 +03:00
|
|
|
import os
|
2013-09-23 13:31:47 +02:00
|
|
|
import codecs
|
2013-05-24 00:38:29 +02:00
|
|
|
|
2012-09-15 18:25:25 +03:00
|
|
|
|
2013-10-01 20:52:22 +03:00
|
|
|
class Help2Html:
|
|
|
|
|
|
|
|
|
|
ALG_DESC = 'ALG_DESC'
|
|
|
|
|
ALG_CREATOR = 'ALG_CREATOR'
|
|
|
|
|
ALG_HELP_CREATOR = 'ALG_HELP_CREATOR'
|
2012-09-15 18:25:25 +03:00
|
|
|
|
|
|
|
|
def getHtmlFile(self, alg, helpFile):
|
|
|
|
|
if not os.path.exists(helpFile):
|
|
|
|
|
return None
|
|
|
|
|
self.alg = alg
|
2013-10-01 20:52:22 +03:00
|
|
|
f = open(helpFile, 'rb')
|
2012-09-15 18:25:25 +03:00
|
|
|
self.descriptions = pickle.load(f)
|
2013-10-01 20:52:22 +03:00
|
|
|
s = '<html><body><h2>Algorithm description</h2>\n'
|
|
|
|
|
s += '<p>' + self.getDescription(self.ALG_DESC) + '</p>\n'
|
|
|
|
|
s += '<h2>Input parameters</h2>\n'
|
2012-09-15 18:25:25 +03:00
|
|
|
for param in self.alg.parameters:
|
2013-10-01 20:52:22 +03:00
|
|
|
s += '<h3>' + param.description + '</h3>\n'
|
|
|
|
|
s += '<p>' + self.getDescription(param.name) + '</p>\n'
|
|
|
|
|
s += '<h2>Outputs</h2>\n'
|
2012-09-15 18:25:25 +03:00
|
|
|
for out in self.alg.outputs:
|
2013-10-01 20:52:22 +03:00
|
|
|
s += '<h3>' + out.description + '</h3>\n'
|
|
|
|
|
s += '<p>' + self.getDescription(out.name) + '</p>\n'
|
2014-03-28 11:49:12 +02:00
|
|
|
s += '<br>'
|
|
|
|
|
s += '<p align="right">Algorithm author: ' + self.getDescription(self.ALG_CREATOR) + '</p>'
|
|
|
|
|
s += '<p align="right">Help author: ' + self.getDescription(self.ALG_HELP_CREATOR) + '</p>'
|
2013-10-01 20:52:22 +03:00
|
|
|
s += '</body></html>'
|
|
|
|
|
filename = tempFolder() + os.sep + 'temphelp.html'
|
|
|
|
|
tempHtml = codecs.open(filename, 'w', encoding='utf-8')
|
2012-09-15 18:25:25 +03:00
|
|
|
tempHtml.write(s)
|
2013-09-23 13:31:47 +02:00
|
|
|
tempHtml.close()
|
2012-09-15 18:25:25 +03:00
|
|
|
|
|
|
|
|
return filename
|
|
|
|
|
|
|
|
|
|
def getDescription(self, name):
|
2013-10-01 20:52:22 +03:00
|
|
|
if name in self.descriptions:
|
2013-10-12 10:48:14 +02:00
|
|
|
return self.descriptions[name].replace("\n", "<br>")
|
2012-09-15 18:25:25 +03:00
|
|
|
else:
|
2013-10-01 20:52:22 +03:00
|
|
|
return ''
|
