caktus / django-scribbler Goto Github PK

(This may be fixed by #26, but I don't want it to be forgotten so logging it on its own also.)

If a scribble is blank (scribble model or model field), then it can't be edited any more. Hovering over it does not highlight it if it is empty...

Rendering for the preview for the below resulted in a 500 error, which left the front end broken.

     Blip {% now 'Y' %} {{ STATIC_URL|u }}

Allow the client's text to be translated and displayed to the end user in their preferred language.

The details of how that would work can be fleshed out. We'd need to store each scribble in multiple languages, and provide a way for translators to conveniently go through scribbles that have been added or edited and create or edit the translations.

Some content might take a while to change and it would be nice to have a way to save a draft possibly with HTML5 local storage.

For example, tab complete on {% comment %} should also fill out {% endcomment %} and move the cursor in the middle.

Currently the scribbles highlight on hover but it would be helpful to have something the user could do which would clearly reveal areas which can be edited.

Currently the editor customization and top menu code live in scribbler.js along with their initialization. This means that you can't have any JS run prior to initializing these elements. It would be easier to customize these as their own plugins (such as a new menu item or editor button) if they were written separately, loaded, then initialized.

Extra padding occurs around any window size <= 767px.

Ensure proper permission checks are in place and respected for displaying the form and on receiving the edits.

I'm considering changing how CodeMirror, RequireJS and jQuery are bundled to use Bower. This would replace the libs directory with a components directory. For the end user this would not have much of an impact but it would make it easier for us to upgrade these dependencies as new versions are published.

The preview form doesn't validate when a scribble matching the url/slug exists.

The current documentation asks users to use RequireJS to lazily load all of the necessary JS requirements. It might be easier/more familiar for users to include a single optimized JS file built with r.js.

Currently scribblers are unique by url and slug and there is no way to use the same scribble on multiple pages.

We should add some tests for the Javascript.

For large blocks of content it might be helpful to be able to break the editor off into a new window to make it full screen and side-by-side with the content similar to the Chrome developer tools.

The context of rendering a scribble is limited to what is given by the content processors. Users editing a scribble will likely want to know what variables are available to them.

CodeMirror has a nice demo for JS autocompletion http://codemirror.net/demo/complete.html It would be awesome to do something similar for available Django template tags/filters.

Wishlist type issue. Since we have a nice top menu we could have items for user preferences and there might be people who want to change the theme. http://codemirror.net/demo/theme.html Currently we aren't bundling all of the themes but this would be possible with #30.

@kmtracey noted that since the wrappers around the scribbles, form and previews are <div>s that forces them to a block layout. Perhaps these should be changed to <span>s to lessen the chance of impacting the page rendering.

The code edit close link is not getting floated to the right when integrating scribbler into a new site. The right-float for the example site is coming from close.less in the example project's styles (under example/static/less/bootstrap). For reasons I don't understand I'm also seeing both the X and the "close" text overlaid on each other when the link is not floated right...forcing the float right makes the "close" text go away.

Something we have discussed, it creating the ability for users to be able to tell who has made the most recent changes on the page. While we could get quite complicated in implementing this, I'd like it to start out with the following:

• List of most recent changes
• Username associated with that change
• Possibly a timestamp for when the change was made

Both the username and timestamp to live directly next to the change it is associated this.

Also, a good place to put this would be in the newly created pull out menu at the top of the page. Here is an example of how it might read:

Last 3 changes to page:
'header' scribble by juliaelman on 12/31/2012 at 12:31PM
'header' scribble by csmith on 12/05/2012 at 09:02AM
'days_log' scribble by kmtracey on 11/22/2012 at 3:13PM

If the pages content is rather long, then the content is visible behind the CodeMirror editor.

See this screenshot to view what is happening.

If a user does not have permission to edit/add scribbles, but does have permission to edit a field on the page that is in a scribble_field tag, they can bring up the editor for that field, but cannot preview or save any changes.

Preview view is checking specifically for the scribbler.change_scribble and scribbler.add_scribble permissions. If the user does not have one of those, forbidden is returned. If the preview does not succeed, save is not allowed.

Possible ways to fix:

1 - Expand information POSTed to preview to include the actual model being edited, and have preview check for permissions on that model instead of hard-coding the scribbler model.

2 - Remove permission checking from preview. Preview isn't actually making any changes so why does it need to check for the permission to do so? Ultimately the save will fail if the user really does not have permission to save what they are previewing.

3 - Require that the user must have scribble field permissions even when editing non-scribble fields. This would need to be noted in doc and enforced in scribble_field tag and save view.

I'm leaning towards option 2...it's easiest and I don't see why preview needs to be doing permission checking?

The README references http://scribbler-mlavin.dotcloud.com/ which is down due to dotcloud cutting their free tier.

Save button needs a disabled state for when the current template content is not valid.

#63 adds two more stings to be translated and I'm pretty sure we can get them figured out correctly even with out limited knowledge of French. I also found what I believe is a typo in the "Save as Draft" translation which should read "Sauvegarder comme brouillon" rather than "Sauvergarder comme brouillon" (extra r).

There might be a use-case for full page scribbles as a contrib.flatpages replacement.

slug/url combination should be unique.

Right now, the auto-complete function only works if the context variable does not contain a closing bracket.

The current RequireJS configuration loads jQuery from the Google CDN (which should probably be changed to a local version) even if a valid jQuery version already exists. This could cause problems with other jQuery plugins/code on the page.

One solution would be to use jQuery/RequireJS as recommended here http://requirejs.org/docs/jquery.html. Another would be to conditionally check for jQuery as in this solution http://stackoverflow.com/a/12268213/61539

Future task but needs some kind of a solution eventually. Users will want to put images into the scribble content and there needs to be some way to do that. This might be a plug-in which is enabled for scribbler or hooks for an existing Django app.

Save button currently doesn't function. Needs to be connected to save/edit view.

We need a log out button for when the user is done editing and wanting to log out. Probably just place it in the bar with the "SAVE", "SAVE AS DRAFT" and close buttons for now.

Caching needs to be put in place to ensure that using the project won't slam the database.

Users should have some indication that there are unsaved changes so that they don't close the editor thinking they have been saved.

If MySQL has a default encoding of UTF8 the unique_together index key is too long for the Scribble model:

class Scribble(models.Model):

   ...

    slug = models.SlugField(max_length=255, blank=True, default="")
    url = models.CharField(max_length=255, blank=True, default="")
    content = models.TextField(blank=True, default="")

   ...

    class Meta(object):
        unique_together = ('slug', 'url')

and migrate results in this error:

django.db.utils.DatabaseError: (1071, 'Specified key was too long; max key length is 1000 bytes')

Neither field is more than 255 characters, but with UTF8 encoding MySQL reserves 3 bytes for each character. And as the unique_together is set for two fields, that's 255 x 2 x 3 = 1530.

Currently the preview view returns the template error information but it's not used in any useful way on the client side. This information needs to be displayed to the user so they can fix template problems.

South migrations should be created for current models prior to the initial release.

The below template fragment describes the problem.

...
{% scribble 'test' %}
<a href="/another-page/">Clicking this link will show the scribble editor before navigating to /another-page/</a>

<a href="#other-section">Clicking this link will show the scribble editor, but not navigate within the page</a>
{% endscribble %}
...

Need some basic docs prior to initial release.

The auto-draft/auto-restore is quite aggressive. There should be a way to discard an unwanted draft so that it is not continually restored.

Similar to the problem in #16 there is a problem with the editor z-index and items can appear in front of the editor content when it scrolls up.

CodeMirror will be included in the distribution but it should be easy to update in the repo and easy to use your own version (most likely a documentation issue).

The styles under "Mixins - Twitter Bootstrap" in styles.less are being applied globally. I think that they should only be applied to Scribbler-specific classes and ids.

When a content editor is logged in they can't click on links in the editable content because clicking on the area opens the editor.

CodeMirror v3.0 is out now and has some improvements to the gutter model and inline widgets that could be helpful for us.

There should be a way to delete a scribble which would restore the default scribble text. Needs to be clear to the user that this is what will happen.