Initial mirror commitHEADmaster

1 files changed, 169 insertions, 0 deletions

diff --git a/doc/study-format.txt b/doc/study-format.txt
new file mode 100644
index 0000000..bca1f3e
--- /dev/null
+++ b/doc/study-format.txt
@@ -0,0 +1,169 @@
+=================================================================

+Study file example

+==================================================================

+

+Version 1.4

+==========================

+

+* Removed card-based interval: <r ... c= />

+* Removed <delay /> tag (in the end)

+* Grades changed: ("2" removed)

+    - 0 -> 1

+    - 1 -> 2

+    - 2 -> 3

+* Added level param: <r l="3" ... />

+    Add to old tags using interval:

+        - i=0, c=7 -> i=<unknown>, l=2 (short learning)

+        - i=0, c=15 -> i=<incorrect>, l=2 (short learning)

+        - i>0 (also 0.9 days) -> l=10 (repeating)

+    "Learning" (10 min) interval was not used before. Level "long learning" (3) will not be added.

+

+

+

+*** dictionary.fms ****

+=================================================================================

+<?xml version="1.0" encoding="UTF-8"?>

+<!DOCTYPE freshmemory-study>

+<study version="1.4">

+    <pack id="Finnish Russian Example">

+        <cur-card id="hiilivety"/>

+        <c id="kukkaro">

+            <r d="2009-10-05T17:05:16" l="10" g="4" e="2.5" rt="3.7" at="4.7" i="2.68" />

+            <r d="2009-10-06T17:05:16" l="10" g="4" e="2.5" rt="2.1" at="3.2" i="5.68" />

+            <r d="2009-10-07T17:05:16" l="10" g="4" e="2.5" rt="4.8" at="8.7" i="8.68" />

+        </c>

+        <c id="reunaviiva">

+            <r d="2009-10-05T17:05:16" l="2" g="1" e="2.18" rt="4.7" at="6.1" i="0.000157"/>

+            <r d="2009-10-05T17:07:52" l="3" g="4" e="2.4" rt="5.4" at="7.1" i="0.9" />

+            <r d="2009-10-07T17:05:16" l="10" g="4" e="2.4" rt="5.3" at="10.3" i="2.52" />

+        </c>

+        <c id="mitä parhain">

+            <r d="2009-10-06T17:05:16" l="10" g="4" e="2.5" rt="3.5" at="7.9" i="5.68" />

+            <r d="2009-10-07T17:05:16" l="2" g="2" e="2.5" rt="5.1" at="12.6" i="0.00032" />

+        </c>

+    </pack>

+</study>

+

+

+

+Version 1.2

+==========================

+

+* The card-based interval cannot be "after all" (-1).

+

+

+Version 1.1

+==========================

+

+* Saved current selected card for Spaced repetition (it's not yet in the study history):

+    - tag <cur-card> in the beginning of <pack> tag.

+* New fields:

+    * c = card-based interval

+       - If 'c' attribute is present, then 'i' (day interval) == 0.

+       - Either 'c' or 'i' (day interval) can be present at the same time.

+    * rt = recall time

+    * at = full answer time

+* Remaining card-based intervals are saved as separate last study record:

+    - <delay c="8"/>

+* If the card-based interval is after all cards, it is == -1.

+* Attribute order changed:

+    - <r d= g= e= rt= at= [ic]= />

+

+*** dictionary.fms ****

+=================================================================================

+<?xml version="1.0" encoding="UTF-8"?>

+<!DOCTYPE freshmemory-study>

+<study version="1.0">

+    <pack id="Finnish Russian Example">

+        <cur-card id="hiilivety"/>

+        <c id="kukkaro">

+            <r d="2009-10-05T17:05:16" g="4" e="2.5" rt="3.7" at="4.7" i="2.68" />

+            <r d="2009-10-06T17:05:16" g="4" e="2.5" rt="2.1" at="3.2" i="5.68" />

+            <r d="2009-10-07T17:05:16" g="4" e="2.5" rt="4.8" at="8.7" i="8.68" />

+        </c>

+        <c id="reunaviiva">

+            <r d="2009-10-05T17:05:16" g="0" e="2.18" rt="4.7" at="6.1" c="7" />

+            <r d="2009-10-05T17:07:52" g="4" e="2.4" rt="5.4" at="7.1" i="0.9" />

+            <r d="2009-10-07T17:05:16" g="4" e="2.4" rt="5.3" at="10.3" i="2.52" />

+        </c>

+        <c id="mit� parhain">

+            <r d="2009-10-06T17:05:16" g="4" e="2.5" rt="3.5" at="7.9" i="5.68" />

+            <r d="2009-10-07T17:05:16" g="1" e="2.5" rt="5.1" at="12.6" c="15" />

+            <delay c="4"/>

+        </c>

+    </pack>

+</study>

+

+

+

+Version 1.0

+==========================

+

+* The study file contains the whole history of repetitions.

+* Card interval delays are not saved!!! The delayed cards will be shown first at the next session.

+* Packs and cards are matched with the dictionary file by IDs (open strings)

+    - Pack ID is space delimited list of its field names: question, main answer, other answers.

+    - Card ID is its question

+* New cards can be seen with the study history (only 1 record)

+* Study record fields:

+    d = date

+    i = next interval (days)

+    g = grade

+    e = easiness

+    t = answering time (seconds)

+

+*** dictionary.fms ****

+=================================================================================

+<?xml version="1.0" encoding="UTF-8"?>

+<!DOCTYPE freshmemory-study>

+<study version="1.0">

+    <pack id="Finnish Russian Example">

+        <c id="kukkaro">

+            <r d="2009-10-05T17:05:16" i="2.68" g="4" e="2.5" t="4.7"/>

+            <r d="2009-10-06T17:05:16" i="5.68" g="4" e="2.5" t="3.2"/>

+            <r d="2009-10-07T17:05:16" i="8.68" g="4" e="2.5" t="4.8"/>

+        </c>

+        <c id="reunaviiva">

+            <r d="2009-10-05T17:05:16" i="0" g="0" e="2.18" t="6.1"/>

+            <r d="2009-10-05T17:07:52" i="1" g="4" e="2.4" t="5.4"/>

+            <r d="2009-10-07T17:05:16" i="2.52" g="4" e="2.4" t="5.3"/>

+        </c>

+        <c id="mit� parhain">

+            <r d="2009-10-06T17:05:16" i="5.68" g="4" e="2.5" t="3.5"/>

+        </c>

+    </pack>

+</study>

+

+

+Version 0.4

+==========================

+

+* Active deadline must not be saved! Shifted active deadline is forgotten after a spacedrep session is closed.

+* Status of unrepeated card can be seen after loading.

+* Postponing length (Num of cards) is saved in cards section

+* Fresh cards can be regenerated at new spacedrep start.

+* The default question-answer pair is the first two fields of the dictionary.

+* Reversed two first fields are defined by argument s:rev="yes".

+

+*** .config/freshmemory/{550e8400-e29b-41d4-a716-446655440001}.fms ****

+=================================================================================

+<?xml version="1.0" encoding="UTF-8"?>

+<!DOCTYPE freshmemory-study>

+<study version="0.4">

+    <unrep added="2008-09-23T21:47:28" used="7" />

+    <unrep qst="{550e8400-e29b-41d4-a716-446655440002}" ans="{550e8400-e29b-41d4-a716-446655440001}"

+        added="2008-09-23T21:47:28" used="15" />

+	<c id="{220e8400-e29b-41d4-a716-446655440001}" name="table">

+        <s qst="{550e8400-e29b-41d4-a716-446655440001}" ans="{550e8400-e29b-41d4-a716-446655440002}"

+        last="2008-09-23T21:47:28" grd="4" eas="2.5472" int="5.32" />

+        <s qst="{550e8400-e29b-41d4-a716-446655440002}" rev="yes"

+        last="2008-06-04T13:26:05" grd="5" eas="3.2" int="0" cards="3" />

+    </c>

+    <c id="{220e8400-e29b-41d4-a716-446655440001}" name="ball">

+        <s last="2008-09-23T21:47:28" grd="4" eas="2.5472" int="5.32" />

+        <s rev="yes" last="2008-06-04T13:26:05" grd="5" eas="3.2" int="0" cards="3" />

+        <s qst="{550e8400-e29b-41d4-a716-446655440002}" ans="{550e8400-e29b-41d4-a716-446655440001}"

+            last="2008-07-14T18:03:22" grd="4" eas="2.4" int="4.6" />

+    </c>

+</study>

+