Merge branch 'master' into search

Author: albanm

LICENSE.txt

@@ -0,0 +1,60 @@
+
+Description
+===========
+
+Djity Portal (referred to as Djity to make things shorter), is an open source Web development framework and Website engine built on top of Django (http://www.djangoproject.com/). It's purpose is to help us (and maybe you !) build dynamic Web applications and publish them effortlessly on the Web.
+
+Djity comes with a lot of things pre-processed for you: front-end site administration in AJAX, applications contained in tabulations, contextual portlets, skeletons for new applications and projects, shortcuts for asynchronous communications, Javascript libraries, a shared client and server side context dictionary, installation and documentation utilities, on page WYSIWYG HTML edition, easy internationalization, theming, etc.
+
+A lot of the boilerplate stuff is taken care of. Applications can be exchanged and plugged on a server. That's nice, but of course there is a down side: all this comes with technical choices, constraints and an homogenized look and feel. Your choice !
+
+We are focused on Web development using the latest standards (HTML5, CSS3, etc.), compatibility with older browsers is not a priority.
+
+WARNING ! Djity is still in an early development phase. If you are willing to look into it you should be prepared for gaps in functionalities and documentation, and for the occasional bug.
+
+General info
+============
+
+Authors:
+ * Youen Péron (youen.peron<at>gmail.com)
+ * Alban Mouton (alban.mouton<at>gmail.com)
+
+License: GPL v3
+
+Links
+=====
+
+Homepage (roadmap, bug reports, etc.): http://redmine.djity.net/projects/djityportal
+Git page (forks, patches, etc.): https://github.com/djity/djity
+Official documentation: http://pypi.python.org/pypi/djity
+
+Features
+========
+
+ * Projects tree (multiple projects on the same site, with different styles,
+   users, etc.)
+ * Users management (subscriptions, login, roles in projects, etc.)
+ * 100% Ajax interface
+ * Pluggable applications (instanciated in tabs of projects)
+ * Easy generation of new Django instances and applications (using Skeleton)
+ * Easy Ajax application developement (custom shortcuts and proxy objects based
+   on Dajax and Dajaxice, integration of jquery and jquery-ui)
+ * Enriched contextual dictionary both server and client side (with information about the current session,
+   project, tab, users permissions, etc)
+ * Online edition of the styles of the projects (using a custom themeroller
+   inspired by jquery-ui)
+ * Contextual portlets (per project and per instance of application in a
+   project)
+ * Easy internationalization of interface and user content (using i18n, django-localeurl and django-transmeta)
+ * Rich WYSIWYG HTML edition wherever you want it (using eLRTE)
+
+Incoming features
+=================
+
+ * Online administration of the portlets
+ * Fully themable projects (not just some style parameters, but also the layouts)
+ * Easy migration of data between versions (probably using South)
+ * Integrated search engine (probably using Haystack)
+ * User identification through OpenID
+ * Recent advanced Web standards (PUSH, Websockets, etc)
+ * Open data linking using standard ontologies (FOAF, SIOC, etc)

README

@@ -0,0 +1,8 @@
+# -*- coding:utf-8 -*-
+pip_name = "djity"
+version = '0.2'
+description = "A Web framework built on Django to create rapidly dynamic applications"
+author = "Youen Péron and Alban Mouton"
+author_email = "contact@djity.net"
+url = "http://redmine.djity.net/projects/djityportal"
+

README.rst

@@ -0,0 +1,62 @@
+"""
+Ajax views for {application_name}.
+"""
+
+from django.utils.translation import ugettext_lazy as _
+from django.utils.translation import activate, get_language
+from djity.utils.decorators import djity_view
+from djity.utils.security import sanitize
+from djity.transmeta import get_value,set_value
+
+
+from dajaxice.core import dajaxice_functions
+register = lambda name:dajaxice_functions.register_function('{package_name}.ajax',name)
+
+# permission needed to access a view can be 'view', 'edit', 'manage'
+@djity_view(perm='view')
+def example_ajax(request,js_target,text,context=None):
+    """
+    This function simply transforms a text in upper case and put it in a div given as js_target
+
+    Arguments:
+     * context - standard Djity context built by decorator djity_view using session and url data
+     * js_target - Proxy object to generate javascript code. Functions called on js_target here will be translated in javascript onto the object passed as target.
+     * text - text to make upper case
+    """
+    text = text.upper()
+    js_target.text(text)
+    js_target.message(_("%s written by ajax function !") % text)
+    # If you want to reload the page and send a message to display after you can do:
+    # js_target.message(_"%s written by ajax function !" % text, post=True)
+    # js_target.reload()
+    # your view work with js_target and return nothing
+
+#register your view in dajaxice
+register('example_ajax')
+
+# save the message in the database
+@djity_view(perm='edit')
+def save_message(request,js_target,html,lang,context=None):
+    #get the {module_name}.models.{class_name} for this view from the context
+    module = context['module']
+    #filter script tag with the sanitize function
+    message = sanitize(html)
+    # set the message in the specific language
+    set_value(module,'message',lang,message)
+    module.save()
+    js_target.message(_("your message '%(text)s' is save in the database for language code %(lang)s") %{{'text':html,'lang':lang}})
+register('save_message')
+
+# get the message in a lang for international editing
+@djity_view(perm='edit')
+def get_message(request,js_target,lang,context=None):
+    module = context['module']
+    # get the message for a specific languange
+    message = get_value(module,'message',lang)
+    # call the javascript editor methode with the message as parameter
+    js_target.set_html(message)
+
+register('get_message')
+    
+    
+

djity/__init__.py

@@ -1,32 +1,72 @@
+"""
+Models for Djity application {application_name}
+"""
+
 from django.db import models
 
 from djity.project.models import Module
 from djity.utils.inherit import SuperManager
 from djity.utils import djreverse
-
+from djity.utils.security import sanitize
+from djity.portlet.models import TemplatePortlet, TextPortlet
+from djity.transmeta import TransMeta
 
 class {class_name}(Module):
     """
     Main class of this new Djity application. This class acts like a proxy between
-    your application and Djity, allowing Djity to manage his modules in a
+    your application and Djity, allowing Djity to manage its modules in a
     standard way.
 
     At creation, this application simply displays a message in a tab.
     """
     #get the module manager
     objects = SuperManager()
 
+    #use transmeta for international message
+    __metaclass__ = TransMeta
+    
     message = models.CharField(max_length=200, default='Hello World !')
 
-    def subnav(self,project_name):
+    class Meta:
+        #specify that the field 'message' is translatable
+        translate = ('message',)
+        
+
+    def save(self,*args,**kwargs):
         """
-        return sub navigation list
+        Redefine save() from Module in order to attach portlets at creation.
         """
-        return []
+        # Is the module new ?
+        new = (self.id == None)
+
+        super({class_name},self).save(*args, **kwargs)
+
+        if new:
+            #A standard text portlet, its content will be automatically editable
+            TextPortlet(content=sanitize("This is a tab level text portlet edit me !"), container=self,position="left", rel_position=0).save()
+
+            # A standard template portlet, it will simply render a template
+            TemplatePortlet(template="{package_name}/{module_name}_portlet.html",container=self,position="right",rel_position=0).save()
+
+            # A custom template defined in models.py of the application
+            {class_name}Portlet(container=self,position="right",rel_position=0).save()
+    
 
     def djity_url(self,context):
         """
         return the application's start page
         """
         return djreverse('{module_name}-main',context)
 
+class {class_name}Portlet(TemplatePortlet):
+    def save(self,*args,**kwargs):
+        # Is the portlet new ?
+        new = (self.id == None)
+
+        super({class_name}Portlet,self).save(*args, **kwargs)
+        
+        if new:    
+            self.onload = "$('.{module_name}-load-portlet').{module_name}_widget();" 
+            self.template = "{package_name}/{module_name}_portlet2.html"
+            super({class_name}Portlet,self).save(*args, **kwargs)
+

djity/application_skeleton/{package_name}/ajax.py_tmpl

@@ -0,0 +1,18 @@
+$.widget("ui.{module_name}_widget", 
+{{
+
+_init:function()
+	  {{
+		   dj.remote('{package_name}.example_ajax',
+		   {{
+				js_target:this,
+				text:this.element.text(),
+			}});
+	   }},
+text : function(text)
+		//callback function
+	   {{
+		   this.element.text('from ajax: ' +text);
+	   }}
+}});
+

djity/application_skeleton/{package_name}/models.py_tmpl

@@ -0,0 +1,41 @@
+{{% extends "djity/base.html" %}}
+
+{{% block module_head %}}
+
+<script type="text/javascript" src="{{{{STATIC_URL}}}}/{package_name}/js/{module_name}.js"></script>
+{{% endblock %}}
+
+
+{{% block module_onload %}}
+
+//Send the message to the notify framework 
+dj.message("{{{{message}}}}");
+
+//If user can edit apply the editor widget
+if( dj.context.perm.edit )
+{{
+    $('#{module_name}-message').editable({{
+        // No rich editor
+        simple:true,
+        // The ajax function to save the message
+        save_function:'{package_name}.save_message',
+        // The ajax function to get the message in a specific language
+        get_function:'{package_name}.get_message',
+        // The message language (if the message haven't the version of the current language)
+        lang:dj.context.{package_name}_lang
+    }});
+}}
+
+
+{{% endblock %}}
+
+{{% block body %}}
+
+<p>Your message  is  :  <span id="{module_name}-message">{{{{message}}}}</span> </p>
+
+<p>You can edit message : click it!</p>
+
+
+
+{{% endblock %}}
+

djity/application_skeleton/{package_name}/media/.gitignore renamed to djity/application_skeleton/{package_name}/static/.gitignore

@@ -0,0 +1,14 @@
+{{% extends "djity/portlet/portlet.html" %}}
+
+{{% block class%}}{module_name}-portlet {{{{block.super}}}}{{% endblock %}}
+{{% block content %}}
+<p>This is a template portlet !</p>
+
+<p>Members of this project:
+<ul>
+{{% for member in project.get_members %}}
+<li>{{{{member.user}}}}</li>
+{{% endfor %}}
+</ul>
+</p>
+{{% endblock %}}

djity/application_skeleton/{package_name}/media/css/setup_trap renamed to djity/application_skeleton/{package_name}/static/{package_name}/css/setup_trap

@@ -0,0 +1,6 @@
+{{% extends "djity/portlet/portlet.html" %}}
+
+{{% block class%}}{module_name}-load-portlet {{{{block.super}}}}{{% endblock %}}
+{{% block content %}}
+This is another template portlet !
+{{% endblock %}}

djity/application_skeleton/{package_name}/media/images/setup_trap renamed to djity/application_skeleton/{package_name}/static/{package_name}/images/setup_trap

@@ -3,6 +3,7 @@ from django.contrib import messages
 from django.utils.translation import ugettext_lazy as _
 
 from djity.utils.decorators import djity_view
+from djity.transmeta import get_lang_version
 
 @djity_view()
 def {module_name}_view(request,context=None):
@@ -11,11 +12,12 @@ def {module_name}_view(request,context=None):
     """
     # Get the current instance of the module to render
     {module_name} = context['module']
+    context['{package_name}_lang'] =  get_lang_version({module_name},'message')
     # fetch its message
     message = _({module_name}.message)
     # will display a notification
     messages.add_message(request,messages.INFO,unicode(message))
     # update djity's context for templates to render correctly
     context.update({{'view':'{module_name}','message':message}})
-    # render the template en return it
+    # render the template and return it
     return render_to_response('{package_name}/{module_name}.html',context)