Merge pull request #9 from divio/tooltip

Tooltip

Author: mkoistinen

djangocms_file/cms_plugins.py

@@ -13,6 +13,12 @@ class FilePlugin(CMSPluginBase):
     render_template = "cms/plugins/file.html"
     text_enabled = True
 
+    fieldsets = [
+        (None, {
+            'fields': ('title', 'file', 'tooltip', 'target', )
+        })
+    ]
+
     def render(self, context, instance, placeholder):
         context.update({
             'object': instance,

djangocms_file/migrations/0003_auto__add_field_file_tooltip.py

@@ -0,0 +1,53 @@
+# -*- coding: utf-8 -*-
+from south.utils import datetime_utils as datetime
+from south.db import db
+from south.v2 import SchemaMigration
+from django.db import models
+
+
+class Migration(SchemaMigration):
+
+    def forwards(self, orm):
+        # Adding field 'File.tooltip'
+        db.add_column(u'djangocms_file_file', 'tooltip',
+                      self.gf('django.db.models.fields.CharField')(default='', max_length=255, blank=True),
+                      keep_default=False)
+
+
+    def backwards(self, orm):
+        # Deleting field 'File.tooltip'
+        db.delete_column(u'djangocms_file_file', 'tooltip')
+
+
+    models = {
+        'cms.cmsplugin': {
+            'Meta': {'object_name': 'CMSPlugin'},
+            'changed_date': ('django.db.models.fields.DateTimeField', [], {'auto_now': 'True', 'blank': 'True'}),
+            'creation_date': ('django.db.models.fields.DateTimeField', [], {'default': 'datetime.datetime.now'}),
+            'depth': ('django.db.models.fields.PositiveIntegerField', [], {}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'language': ('django.db.models.fields.CharField', [], {'max_length': '15', 'db_index': 'True'}),
+            'numchild': ('django.db.models.fields.PositiveIntegerField', [], {'default': '0'}),
+            'parent': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['cms.CMSPlugin']", 'null': 'True', 'blank': 'True'}),
+            'path': ('django.db.models.fields.CharField', [], {'unique': 'True', 'max_length': '255'}),
+            'placeholder': ('django.db.models.fields.related.ForeignKey', [], {'to': "orm['cms.Placeholder']", 'null': 'True'}),
+            'plugin_type': ('django.db.models.fields.CharField', [], {'max_length': '50', 'db_index': 'True'}),
+            'position': ('django.db.models.fields.PositiveSmallIntegerField', [], {'null': 'True', 'blank': 'True'})
+        },
+        'cms.placeholder': {
+            'Meta': {'object_name': 'Placeholder'},
+            'default_width': ('django.db.models.fields.PositiveSmallIntegerField', [], {'null': 'True'}),
+            u'id': ('django.db.models.fields.AutoField', [], {'primary_key': 'True'}),
+            'slot': ('django.db.models.fields.CharField', [], {'max_length': '255', 'db_index': 'True'})
+        },
+        u'djangocms_file.file': {
+            'Meta': {'object_name': 'File', '_ormbases': ['cms.CMSPlugin']},
+            u'cmsplugin_ptr': ('django.db.models.fields.related.OneToOneField', [], {'to': "orm['cms.CMSPlugin']", 'unique': 'True', 'primary_key': 'True'}),
+            'file': ('django.db.models.fields.files.FileField', [], {'max_length': '100'}),
+            'target': ('django.db.models.fields.CharField', [], {'default': "''", 'max_length': '100', 'blank': 'True'}),
+            'title': ('django.db.models.fields.CharField', [], {'max_length': '255', 'null': 'True', 'blank': 'True'}),
+            'tooltip': ('django.db.models.fields.CharField', [], {'max_length': '255', 'blank': 'True'})
+        }
+    }
+
+    complete_apps = ['djangocms_file']

djangocms_file/migrations_django/0002_auto_20151202_1551.py

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+from __future__ import unicode_literals
+
+from django.db import models, migrations
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('djangocms_file', '0001_initial'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='file',
+            name='tooltip',
+            field=models.CharField(help_text='Optional tooltip.', max_length=255, verbose_name='tooltip', blank=True),
+            preserve_default=True,
+        ),
+        migrations.AlterField(
+            model_name='file',
+            name='target',
+            field=models.CharField(default=b'', choices=[(b'', 'same window'), (b'_blank', 'new window'), (b'_parent', 'parent window'), (b'_top', 'topmost frame')], max_length=100, blank=True, help_text='Optional link target.', verbose_name='target'),
+            preserve_default=True,
+        ),
+        migrations.AlterField(
+            model_name='file',
+            name='title',
+            field=models.CharField(help_text='Optional title to display. If not supplied, the filename will be used.', max_length=255, null=True, verbose_name='title', blank=True),
+            preserve_default=True,
+        ),
+    ]

djangocms_file/models.py

@@ -40,14 +40,20 @@ class File(CMSPlugin):
     probably a performance concern.
     """
     file = models.FileField(_("file"), upload_to=get_plugin_media_path)
-    title = models.CharField(_("title"), max_length=255, null=True, blank=True)
+    title = models.CharField(
+        _("title"), max_length=255, null=True, blank=True,
+        help_text=_("Optional title to display. If not supplied, the filename "
+                    "will be used."))
     target = models.CharField(
         _("target"), blank=True, max_length=100, choices=((
             ("", _("same window")),
             ("_blank", _("new window")),
             ("_parent", _("parent window")),
             ("_top", _("topmost frame")),
-        )), default='')
+        )), default='', help_text=_("Optional link target."))
+    tooltip = models.CharField(
+        _("tooltip"), blank=True, max_length=255,
+        help_text=_("Optional tooltip."))
     # CMS_ICON_EXTENSIONS and CMS_ICON_PATH are assumed to be plugin-specific,
     # and not included in cms.settings -- they are therefore imported
     # from django.conf.settings

djangocms_file/templates/cms/plugins/file.html

@@ -1,7 +1,7 @@
 {% load i18n %}
 {% if object.file.url %}
 <p class="plugin_file">
-	<a href="{{ object.file.url }}"{% if object.target %} target="{{ object.target }}"{% endif %}>
+	<a href="{{ object.file.url }}"{% if object.target %} target="{{ object.target }}"{% endif %}{% if object.tooltip %} title="{{ object.tooltip }}"{% endif %}>
 		{% if object.get_icon_url %}<img src="{{ object.get_icon_url }}" alt="" />{% endif %}
 		{% if object.title %}<span class="filetitle">{{ object.title }}{% else %}{{ object.get_file_name }}{% endif %} {% if object.file_exists %}<span class="filesize">({{ object.file.size|filesizeformat }})</span>{% else %}({% trans "file missing!" %}){% endif %}{% if object.title %}</span>{% endif %}
 	</a>