Changes between Version 6 and Version 7 of FullHistory

Timestamp:

Aug 21, 2006, 5:27:18 PM (18 years ago)

Author:

utrebe

Comment:

A lot of changes due to SoC end

FullHistory

@@ -3 +3 @@
 
 == Current status ==
-'''Features: getting there''' (8.08.2006)
+'''Features: almost there''' (21.08.2006)
 
-At this stage none of the samples below work. Code is experimental and does not work. This status will change as soon as I get the API and the generic functions working.
+At the moment the contrib.history is quite usefull. Examples below should work.
+
+'''NOTE: Comparing and merging should be done by user and is not automated (yet).'''
+
+'''WARNING!!! Names of functions may change. Please check this page for any changes.'''
 
 === Get the code ===
@@ -17 +21 @@
 
 ||'''Task'''||'''Status'''||
-||Getting the code to work genericaly (on every given model)||DONE|| 
-||Getting the code to a working state||DONE||
+||Getting the code to work genericaly (on every given model)||'''DONE'''|| 
+||Getting the code to a working state||'''DONE'''||
+||Getting the API to work as described below||'''DONE'''||
+||Unit tests||(under way)||
 ||Author handling (default Anonymous)|| ||
-||Unit tests|| ||
-||Getting the API to work as described below|| ||
-||Admin UI integration|| ||
+||Admin UI integration||(later) ||
 
 
@@ -46 +50 @@
     title = models.CharField(maxlength=100)
     content = models.TextField()
-    date = models.dateField()
+    date = models.DateField(auto_now=True)
 
     class History:
@@ -52 +56 @@
 }}}
 
-When this is done every "Post" object will be saved to a "appname_history" table when created, changed or deleted. 
+When this is done every "Post" object will be saved to a "django_history_log" table when created, changed or deleted. 
 
-=== API (not working at the moment) ===
+=== API ===
 For this functionality to be really usefull I need to create some listing, reverting and other functions.
 
-'''Listing all revisions of an object:'''
+'''List of all revisions of an object:'''
 {{{
 #!python
-rev_list = poll1.revisions.all()
+from django.contrib.history.models import ChangeLog
+
+post = Post(author="Mort", title="Discworld is down!", content="Well, it's rather complicated...")
+post.save()
+
+rev_list = ChangeLog.objects.list_history(post) # Returns a complete list of versions for this object
+}}}
+
+'''List of latest 3 revisions of an object:'''
+{{{
+#!python
+rev_list = ChangeLog.objects.list_history(post, offset=3) # Returns a list of latest 3 versions for this object
 }}}
 
@@ -66 +81 @@
 {{{
 #!python
-rev_list = poll1.revisions.by_date(datetime(2006, 07, 08))
+rev_list = ChangeLog.objects.version_by_date(post, datetime(2006, 07, 08))
 }}}
 
@@ -72 +87 @@
 {{{
 #!python
-rev_list = poll1.revisions.get(offset=3)
+rev_list = ChangeLog.objects.get_version(post, offset=3)
 }}}
 
@@ -78 +93 @@
 {{{
 #!python
-rev_list = poll1.revisions.get(id=222)
+rev_list = ChangeLog.objects.get_version(poll, revision=222)
 }}}
 
@@ -84 +99 @@
 {{{
 #!python
-poll1 = poll1.revisions.revert_to(id=222)
+# NOT IMPLEMENTED!!! User should do the mreging, comparing and reverting manualy.
 }}}