Commit 17a8287e authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Add a documentation page in the Help node.

parent d5a71bb5
......@@ -4,6 +4,7 @@
import os
import plugin_dbui as dbui
def about():
fn = os.path.join("applications",
request.application,
......@@ -12,6 +13,17 @@ def about():
return open(fn, 'rb').read()
def documentations():
di = {}
di["epydoc_dbui"] = URL('static', 'plugin_dbui/docs/epydoc/index.html')
di["epydoc_track_publication"] = URL('static', 'docs/epydoc/index.html')
di["js_mathjax"] = URL('static', 'plugin_mathjax/docs/html/index.html')
di["png_db"] = URL('static', 'docs/database.png')
return di
def index():
session.role = ''
return LOAD('plugin_dbui', 'index', vars=request.vars)
......@@ -33,12 +45,5 @@ def user():
return dict(form=auth())
def schema():
""" expose http://.../default/schema and display the database schema.
"""
return IMG(_src=URL("static", "docs/database.png"), _height="99%")
def versions():
return dbui.get_versions()
......@@ -114,6 +114,7 @@
'Direct access to the table: ': 'Accès direct à la table : ',
'Direction': 'Direction',
'Directors': 'Directeurs',
'documentations': 'documentations',
'Domain': 'Domaine',
'done!': 'done!',
'Dry Run': 'Essai à blanc',
......
......@@ -69,6 +69,7 @@ if session.role in (ADMIN, USER):
# help node
#
aboutLeaf = dbui.Panel(autoLoad=URL('default', 'about'), autoScroll=True)
documentationsLeaf = dbui.Panel(autoLoad=URL('default', 'documentations'), autoScroll=True)
schemaLeaf = dbui.Panel(autoLoad=URL('default', 'schema'), autoScroll=True)
versionLeaf = dbui.Panel(autoLoad=URL('default', 'versions'))
......@@ -77,7 +78,7 @@ helpNode.add_child(T('about'), aboutLeaf)
helpNode.add_child(T('versions'), versionLeaf)
if session.role == ADMIN:
helpNode.add_child(T('database schema'), schemaLeaf)
helpNode.add_child(T('documentations'), documentationsLeaf)
helpNode.sort_children()
......
......@@ -4,7 +4,7 @@
<style type="text/css">
.my-h2,
.my-li,
.my-p,
.my-p,
.my-ul {font-family: Liberation Sherif, Sherif;
font-size: 11px;
list-style-type: none;}
......@@ -13,19 +13,19 @@
margin-bottom: 2ex;
margin-left: 3%;
margin-top: 3ex;}
.my-h3 {font-family: Liberation Sans, Sans;
margin-left: 3%;
margin-top: 3ex;}
.my-li {margin-left: 9%;
margin-right: 9%;
margin-right: 9%;
text-align: justify;}
.my-p {margin-left: 3%;
margin-right: 10%;
text-align: justify;}
.my-small-cap {font-variant: small-caps;}
</style>
......@@ -33,35 +33,55 @@
</head>
<body>
<h2 class="my-h2 my-small-cap">Base de donnée des publications</h2>
<p class="my-p">Permet de recenser la production scientifique d'une organisation
composée d'équipes et de projets et d'en extraire des listes
ou des métriques. Seul les méta-données des documents sont stocké dans la base
de donnée.</p>
<h3 class="my-h3 my-small-cap">Composants logiciel open source</h3>
<p class="my-p">Ce logiciel s'appuit sur les logiciels open source suivant :</p>
<br>
<ul class="my-ul">
<li class="my-li"><a href="http://www.sencha.com/" target="_blank">Ext JS</a></li>
<li class="my-li"><a href="http://www.mathjax.org/" target="_blank">MathJax</a></li>
<li class="my-li">plugin dbui</li>
<li class="my-li"><a href="http://www.python.org/" target="_blank">Python</a></li>
<li class="my-li"><a href="http://web2py.com/" target="_blank">Web2py</a></li>
<li class="my-li">
<a href="http://www.sencha.com/" target="_blank">
Ext JS
</a>
</li>
<li class="my-li">
<a href="http://www.mathjax.org/" target="_blank">
MathJax
</a>
</li>
<li class="my-li">
<a href="https://marprod.in2p3.fr/plugin_dbui_book" target="_blank">
plugin dbui
</a>
</li>
<li class="my-li">
<a href="http://www.python.org/" target="_blank">
Python
</a>
</li>
<li class="my-li">
<a href="http://web2py.com/" target="_blank">
Web2py
</a>
</li>
</ul>
<h3 class="my-h3 my-small-cap">Auteur</h3>
<ul class="my-ul">
<li class="my-li">Renaud Le Gac</li>
<ul>
<h3 class="my-h3 my-small-cap">Contributeurs</h3>
<h3 class="my-h3 my-small-cap">Licence</h3>
<p class="my-p">Ce logiciel est distribué sous la licence opence source
<p class="my-p">Ce logiciel est distribué sous la licence opence source
<a href="http://www.cecill.info/" target="_blank">CeCILL</a>.</p>
<br>
<p class="my-p">&copy; 2010 - 2013 Renaud Le Gac</p>
</body>
</html>
\ No newline at end of file
--------------------------------- CHANGELOG ----------------------------------
HEAD
- Consolidation version.
- Migrate to plugin_dbui 0.4.12.1: replace local_import by the conventional
import statement, new syntax for the linked comboxes, and use the filter
CLEAN_SPACES.
......@@ -16,6 +17,7 @@ HEAD
- Remove the dot in the review abbreviation (CLEAN_PAPER_EDITOR)
- Review the documentaion of the python modules using epytext.
- All documantations have been moved to "static/docs".
- Add a leaf Help/documentations and remove the leaf database schema.
- Add the script buildVersion which is quite useful to build
epydoc documentation.
- First draft of a tool to find duplicate entries.
......
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<style type="text/css">
.my-h2,
.my-li,
.my-p,
.my-ul {font-family: Liberation Sherif, Sherif;
font-size: 11px;
list-style-type: disc;}
.my-h2 {font-family: Liberation Sans, Sans;
margin-bottom: 2ex;
margin-left: 3%;
margin-top: 3ex;}
.my-h3 {font-family: Liberation Sans, Sans;
margin-bottom: 2ex;
margin-left: 3%;
margin-top: 3ex;}
.my-li {margin-left: 9%;
margin-right: 9%;
text-align: justify;}
.my-p {margin-left: 3%;
margin-right: 10%;
text-align: justify;}
.my-small-cap {font-variant: small-caps;}
</style>
</head>
<body>
<h2 class="my-h2 my-small-cap">Documentations</h2>
<ul class="my-ul">
<li class="my-li">
<a href="{{=png_db}}" target="_blank">Schéma</a> de la base de donnée
</li>
</ul>
<h3 class="my-h3 my-small-cap">Manuel utilisateurs</h3>
<ul class="my-ul">
<li class="my-li">
<a href="https://marprod.in2p3.fr/dbui_book/default/chapter/29" target="_blank">
plugin dbui
</a>
</li>
<li class="my-li">
<a href="http://web2py.com/book" target="_blank">
web2py
</a>
</li>
</ul>
<h3 class="my-h3 my-small-cap">Documentation du code python (epydoc)</h3>
<ul class="my-ul">
<li class="my-li">
<a href="{{=epydoc_track_publication}}" target="_blank">
track publications
</a>
</li>
<li class="my-li">
<a href="{{=epydoc_dbui}}" target="_blank">
plugin dbui
</a>
</li>
<li class="my-li">
<a href="http://www.web2py.com/examples/static/epydoc/index.html" target="_blank">
web2py
</a>
</li>
</ul>
<h3 class="my-h3 my-small-cap">Documentation du code javascript</h3>
<ul class="my-ul">
<li class="my-li">
<a href="http://docs.sencha.com/ext-js/3-4/" target="_blank">
Ext JS
</a>
</li>
<li class="my-li">
<a href="{{=js_mathjax}}" target="_blank">MathJax</a>
</li>
<li class="my-li">
plugin dbui
</li>
</ul>
</body>
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment