Added side bar help to convert's file format list, recent document, document type and metadata set and type views

apps/converter/__init__.py

@@ -1,7 +1,11 @@
 from django.utils.translation import ugettext_lazy as _
 
+from navigation.api import register_sidebar_template
+
 TRANFORMATION_CHOICES = {
     u'rotate': u'-rotate %(degrees)d'
 }
 
 formats_list = {'text': _('file formats'), 'view': 'formats_list', 'famfam': 'pictures'}
+
+register_sidebar_template(['formats_list'], 'converter_file_formats_help.html')

apps/converter/templates/converter_file_formats_help.html

@@ -0,0 +1,5 @@
+{% load i18n %}
+<div class="block notice">
+<h4>{% trans "Help" %}</h4>
+<p>{% blocktrans %}These are the file formats supported by the currently selected converter backend.  In this case: '{{ backend }}'{% endblocktrans %}</p>
+</div>

apps/converter/views.py

@@ -42,7 +42,8 @@ def formats_list(request):
                 'name': _(u'description'),
                 'attribute': lambda x: x[1]
             }
-        ]
+        ],
+        'backend': GRAPHICS_BACKEND,
     }
 
     return render_to_response('generic_list.html', context,

apps/documents/__init__.py

@@ -3,7 +3,8 @@ from django.core.urlresolvers import reverse
 from django.conf import settings
 
 from navigation.api import register_links, register_top_menu, \
-    register_model_list_columns, register_multi_item_links
+    register_model_list_columns, register_multi_item_links, \
+    register_sidebar_template
 from main.api import register_diagnostic, register_tool
 from permissions.api import register_permission, set_namespace_title
 from tags.widgets import get_tags_inline_widget_simple
@@ -178,3 +179,6 @@ register_model_list_columns(Document, [
     ])
 
 register_top_menu('documents', link={'famfam': 'page', 'text': _(u'documents'), 'view': 'document_list_recent'}, children_path_regex=[r'^documents/[^t]', r'^metadata/[^s]', r'comments'], position=0)
+
+register_sidebar_template(['document_list_recent'], 'recent_document_list_help.html')
+register_sidebar_template(['document_type_list'], 'document_types_help.html')

apps/documents/templates/document_types_help.html

@@ -0,0 +1,5 @@
+{% load i18n %}
+<div class="block notice">
+<h4>{% trans "What are document types?" %}</h4>
+<p>{% blocktrans %}Document types define a class that represents a broard group of documents, such as: invoices, regulations or manuals.  The advantage of using document types are: assigning a list of typical filenames for quick renaming during creation, as well as assigning default metadata types and sets to it.{% endblocktrans %}</p>
+</div>

apps/documents/templates/recent_document_list_help.html

@@ -0,0 +1,5 @@
+{% load i18n %}
+<div class="block notice">
+<h4>{% trans "What are recent documents?" %}</h4>
+<p>{% blocktrans %}Here you will find the latest {{ recent_count }} documents you have either created or edited in any way.{% endblocktrans %}</p>
+</div>

apps/documents/views.py

@@ -53,6 +53,7 @@ from documents.conf.settings import ZOOM_MAX_LEVEL
 from documents.conf.settings import ZOOM_MIN_LEVEL
 from documents.conf.settings import ROTATION_STEP
 from documents.conf.settings import PRINT_SIZE
+from documents.conf.settings import RECENT_COUNT
 
 from documents.literals import PERMISSION_DOCUMENT_CREATE, \
     PERMISSION_DOCUMENT_PROPERTIES_EDIT, \
@@ -921,7 +922,10 @@ def document_list_recent(request):
     return document_list(
         request,
         object_list=[recent_document.document for recent_document in RecentDocument.objects.filter(user=request.user)],
-        title=_(u'recent documents')
+        title=_(u'recent documents'),
+        extra_context={
+            'recent_count': RECENT_COUNT
+        }
     )
 
 

apps/metadata/__init__.py

@@ -1,6 +1,7 @@
 from django.utils.translation import ugettext_lazy as _
 
-from navigation.api import register_links, register_multi_item_links
+from navigation.api import register_links, register_multi_item_links, \
+    register_sidebar_template
 from permissions.api import register_permission, set_namespace_title
 from documents.models import Document
 from metadata.models import MetadataType, MetadataSet
@@ -63,3 +64,6 @@ register_links(['setup_metadata_set_delete', 'setup_metadata_set_edit', 'setup_m
 
 metadata_type_setup_views = ['setup_metadata_type_list', 'setup_metadata_type_edit', 'setup_metadata_type_delete', 'setup_metadata_type_create']
 metadata_set_setup_views = ['setup_metadata_set_list', 'setup_metadata_set_edit', 'setup_metadata_set_delete', 'setup_metadata_set_create']
+
+register_sidebar_template(['setup_metadata_type_list'], 'metadata_type_help.html')
+register_sidebar_template(['setup_metadata_set_list'], 'metadata_set_help.html')

apps/metadata/templates/metadata_set_help.html

@@ -0,0 +1,5 @@
+{% load i18n %}
+<div class="block notice">
+<h4>{% trans "What are metadata sets?" %}</h4>
+<p>{% blocktrans %}A metadata set is a group of one or more metadata types.  Metadata sets are useful when creating new documents; selecing a metadata set automatically attaches it's member metadata types to said document.{% endblocktrans %}</p>
+</div>

apps/metadata/templates/metadata_type_help.html

@@ -0,0 +1,5 @@
+{% load i18n %}
+<div class="block notice">
+<h4>{% trans "What are metadata types?" %}</h4>
+<p>{% blocktrans %}A metadata type defines the characteristics of a value of some kind that can be attached to a document.  Examples of metadata types are: a client name, a date, or a project to which several documents belong.  A metadata type's name is the internal identifier with which it can be referenced to by other modules such as the indexing module, the title is the value that is shown to the users, the default value is the value an instance of this metadata type will have initially, and the lookup value turns an instance of a metadata of this type into a choice list which options are the result of the lookup's code execution.{% endblocktrans %}</p>
+</div>