1. Ivan Zakrevsky
  2. django-versioning
  3. Issues
Issue #1 new

Documentation?

Anonymous created an issue

Hi,

There doesn't appear to be any documentation for this project (apart from the notes in the README).

Are there more detailed documentation somewhere else? (e.g. how to plug into your views, retrieve specific versions, or view diffs?)

Cheers, Victor

Comments (3)

  1. Trey Hunner

    Documentation for integration with South would be great also. Mostly it would be nice to know whether South integration is possible and whether it's trivial or some extra work between migrations is required.

  2. Nick Boyles

    I agree that having a full documentation would be amazing. There are also a view changes to the url patterns in Django 1.5 that had to be changed to get it to show up in the admin.

    I would like to know the syntax to generate the diffs between versions to display those to the users without having to access the admin site

    Thanks

  3. Ivan Zakrevsky repo owner

    Are there more detailed documentation somewhere else?

    -- Unfortunately, I have no free time on documenting. But django-versioning is too simple, and follows to KISS principle. README is ample. Much is clear from the tests.

    Maybe someday in the future I will write documentation. Currently I haven't a free time.

    (e.g. how to plug into your views, retrieve specific versions, or view diffs?)

    I would like to know the syntax to generate the diffs between versions to display those to the users without having to access the admin site

    -- see in README this section:

    wiki/templates/wiki/article_detail.html::
    
        ...
        <a href="{% url versioning_revision_list content_type=contenttype_id object_id=article.pk %}">View the list of revisions.</a>
        ...
    

    Of course, user should to have permissions on versioned content object:

    • "wiki.browse_revision_article"

    • "wiki.reapply_revision_article"

    You can also view revisions in admin, by clicking "History" button on change object page.

    There are also a view changes to the url patterns in Django 1.5

    -- currently fully tested for django 1.6. I've wrote tests for all views.

  4. Log in to comment