diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/chart.xcf | bin | 0 -> 83901 bytes | |||
| -rw-r--r-- | doc/config/freshmemory.ini | 59 | ||||
| -rw-r--r-- | doc/config/install.txt | 23 | ||||
| -rw-r--r-- | doc/dict-format.txt | 147 | ||||
| -rw-r--r-- | doc/file-associations.txt | 29 | ||||
| -rw-r--r-- | doc/pie-chart.xcf | bin | 0 -> 94110 bytes | |||
| -rw-r--r-- | doc/study-format.txt | 169 |
7 files changed, 427 insertions, 0 deletions
diff --git a/doc/chart.xcf b/doc/chart.xcf Binary files differnew file mode 100644 index 0000000..47c1093 --- /dev/null +++ b/doc/chart.xcf diff --git a/doc/config/freshmemory.ini b/doc/config/freshmemory.ini new file mode 100644 index 0000000..0dba0eb --- /dev/null +++ b/doc/config/freshmemory.ini @@ -0,0 +1,59 @@ +[Styles] +bg-color=white +list=Normal, Example, Transcription, Big, Color1, Color2 + +Normal\font-family=Times New Roman +Normal\font-size=18 +Normal\font-bold=true +Normal\font-italic=false +Normal\color=black +Example\font-bold=false +Example\font-size=14 +Example\keyword=true +Example\keyword\color=blue +Transcription\font-family=Arial +Transcription\font-bold=false +Transcription\prefix=/ +Transcription\suffix=/ +Big\font-family=Arial +Big\font-bold=false +Big\font-size=26 +Color1\color=red +Color2\color=blue + +[Study] +random=true +new-cards-share=0.2 +scheduling-randomness=0.1 +cards-daylimit=70 +new-cards-daylimit=20 +pack-timelimit=15 +dayshift=3 + +init-easiness=2.5 +min-easiness=1.3 +max-easiness=3.2 +init-interval=1 +good-grade=4 + +dE\0=0, 0, 0, 0, 0, 0 +dE\1=0, 0, 0, 0, 0, 0 +dE\2=0, 0, -0.32, -0.14, 0, 0.1 +dE\3=0, 0, -0.32, -0.14, 0, 0.1 +dE\4=0, 0, -0.32, -0.14, 0, 0.1 +dE\5=0, 0, -0.32, -0.14, 0, 0.1 + +interval\0=0, 0, 0.9, 0.9, 0.9, 0.9 +interval\1=0, 0, 0.9, 0.9, 0.9, 0.9 +interval\2=0, 0, -1, -1, -1, -1 +interval\3=0, 0, -1, -1, -1, -1 +interval\4=0, 0, -1, -1, -1, -1 +interval\5=0, 0, -1, -1, -1, -1 + +cards\0=7, 15, 0, 0, 0, 0 +cards\1=7, 15, 0, 0, 0, 0 +cards\2=7, 15, 0, 0, 0, 0 +cards\3=7, 15, 0, 0, 0, 0 +cards\4=7, 15, 0, 0, 0, 0 +cards\5=7, 15, 0, 0, 0, 0 + diff --git a/doc/config/install.txt b/doc/config/install.txt new file mode 100644 index 0000000..15d2d1b --- /dev/null +++ b/doc/config/install.txt @@ -0,0 +1,23 @@ +System-wide settings +====================== + + freshmemory.ini + +Linux: + /etc/xdg/freshememory/ + +Windows: + Registry: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Explorer\User Shell Folders\Common AppData + +Win XP: + C:\Documents and Settings\All Users\Application Data\freshmemory + %ALLUSERSPROFILE%\Application Data + +Win Vista: +Win 7: + C:\ProgramData\freshmemory + C:\Users\All Users\freshmemory + %ALLUSERSPROFILE% + %ProgramData% (New) + +Source article: http://www.adminxp.com/windowsvista/index.php?aid=235
\ No newline at end of file diff --git a/doc/dict-format.txt b/doc/dict-format.txt new file mode 100644 index 0000000..946622f --- /dev/null +++ b/doc/dict-format.txt @@ -0,0 +1,147 @@ +Dictionary file example:
+(*.fmd)
+===============================================================
+
+Version 1.4
+
+* Added pack attribute "exact-ans":
+===============================================================
+ <pack exact-ans="true">
+ <qst>Russian</qst>
+ <ans>Finnish</ans>
+ <ans>Example</ans>
+ </pack>
+===============================================================
+
+
+
+Version 1.0
+
+* The default field ids for cards are taken from fields::field tags.
+* The question and answer field indices are defined as parameters of fileds::field tags.
+
+===============================================================
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE freshmemory-dict>
+<dict version="1.0">
+ <fields>
+ <field > Finnish </field>
+ <field > Russian </field>
+ <field style="Example"> Example </field>
+ <field > English </field>
+ <field style="Transcription"> Transcription </field>
+ </fields>
+ <packs>
+ <pack>
+ <qst>Finnish</qst>
+ <ans>Russian</ans>
+ <ans>Example</ans>
+ </pack>
+ <pack>
+ <qst>Russian</qst>
+ <ans>Finnish</ans>
+ <ans>Example</ans>
+ </pack>
+ </packs>
+ <entries>
+ <e tags="first, vaikeat sanat">
+ <f> perehtyä </f>
+ <f> ознакомиться </f>
+ </e>
+ <e tags="first">
+ <f> uhkaus </f>
+ <f> угроза </f>
+ <f> suuri uhkaus </f>
+ </e>
+ <e>
+ <f> усваивать </f>
+ </e>
+ <e>
+ <f> harrastaa </f>
+ <f> заниматься </f>
+ </e>
+ <e tags="vaikeat sanat">
+ <f> alkuperäinen </f>
+ <f> начальный, первоначальный </f>
+ <f> luen [alkuperäisen] kirjan </f>
+ </e>
+ <e>
+ <f> lunastaa </field>
+ <f> выкупать </field>
+ </e>
+ </entries>
+</dict>
+
+
+Version 0.4
+===============================================================
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE freshmemory-dict>
+<dict version="0.4" id="{550e8400-e29b-41d4-a716-446655440000}">
+ <fields>
+ <field id="{550e8400-e29b-41d4-a716-446655440001}" question="yes"> Finnish </field>
+ <field id="{550e8400-e29b-41d4-a716-446655440002}" answer="0"> Russian </field>
+ <field id="{550e8400-e29b-41d4-a716-446655440003}" answer="1" style="example"> Example </field>
+ <field id="{550e8400-e29b-41d4-a716-446655440004}"> English </field>
+ </fields>
+ <cards>
+ <c id="{770e8400-e29b-41d4-a716-446655440001}">
+ <f> perehtyä </f>
+ <f> ознакомиться </f>
+ </c>
+ <c id="{770e8400-e29b-41d4-a716-446655440002}">
+ <f> uhkaus </f>
+ <f> угроза </f>
+ <f id="{550e8400-e29b-41d4-a716-446655440003}"> suuri uhkaus </f>
+ </c>
+ <c id="{770e8400-e29b-41d4-a716-446655440003}">
+ <f> усваивать </f>
+ </c>
+ <c id="{770e8400-e29b-41d4-a716-446655440004}" comment="yes">
+ <f> harrastaa </f>
+ <f> заниматься </f>
+ </c>
+ <c id="{770e8400-e29b-41d4-a716-446655440005}">
+ <f> alkuperäinen </f>
+ <f> начальный, первоначальный </f>
+ <f> luen [alkuperäisen] kirjan </f>
+ </c>
+ <c id="{340e8422-e29b-41d4-a716-446655440123}" orig-dic="{d4fe8439-e20b-41d4-a716-2816655440173}">
+ <f orig-id="{220e8422-e29b-41d4-a716-446655440001}> lunastaa </field>
+ <f orig-id="{220e8422-e29b-41d4-a716-446655440002}"> выкупать </field>
+ </c>
+ </cards>
+</dict>
+===============================================================
+
+Version 0.3
+===============================================================
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE freshmemory-dict>
+<dict id="dic-suomi-20071108@20071112030550" version="0.3">
+ <card>
+ <qst> perehtyä </qst>
+ <ans> ознакомиться </ans>
+ </card>
+ <card>
+ <qst> uhkaus </qst>
+ <ans> угроза </ans>
+ <xmp> suuri uhkaus </xmp>
+ </card>
+ <card>
+ <ans> усваивать </ans>
+ </card>
+ <card>
+ <qst> #harrastaa </qst>
+ <ans> заниматься </ans>
+ </card>
+ <card>
+ <qst> alkuperäinen </qst>
+ <ans> начальный, первоначальный </ans>
+ <xmp> luen %alkuperäisen kirjan </xmp>
+ </card>
+ <card>
+ <qst> lunastaa </qst>
+ <ans> выкупать </ans>
+ </card>
+</dict>
diff --git a/doc/file-associations.txt b/doc/file-associations.txt new file mode 100644 index 0000000..90dffd3 --- /dev/null +++ b/doc/file-associations.txt @@ -0,0 +1,29 @@ +http://ubuntuforums.org/showthread.php?t=2003610 + + +Add MIME type +=========================== + + +<?xml version='1.0' encoding='utf-8'?> +<mime-info xmlns="http://www.freedesktop.org/standards/shared-mime-info"> + <mime-type type="application/rails"> + <comment>Rails</comment> + <glob pattern="*.rails"/> + </mime-type> +</mime-info> + + +sudo xdg-mime install --novendor ~/Documents/rails.xml + +sudo update-mime-database /usr/share/mime + +sudo gedit /usr/share/applications/rails.desktop + +In the .desktop file: + + MimeType=application/rails + +sudo xdg-desktop-menu install --novendor /usr/share/applications/rails.desktop + +sudo xdg-icon-resource install --context mimetypes --size 128 freshmemory.png application-x-fm-dictionary diff --git a/doc/pie-chart.xcf b/doc/pie-chart.xcf Binary files differnew file mode 100644 index 0000000..a27b43d --- /dev/null +++ b/doc/pie-chart.xcf 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>
+
|