Skip to content

Commit d53f382

Browse files
committed
Update ankiweb_description.html with info on snapshots
1 parent 5a1844d commit d53f382

File tree

1 file changed

+36
-12
lines changed

1 file changed

+36
-12
lines changed

misc/ankiweb_description.html

Lines changed: 36 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,23 @@
1-
CrowdAnki is a plugin for http://ankisrs.net/ that allows users to import and export decks/notes and all relevant information in a hierarchical JSON format. The main purpose is to facilitate crowdsourcing for Anki decks and notes.
1+
CrowdAnki is a plugin for <a href="http://ankisrs.net/"
2+
rel="nofollow">http://ankisrs.net/</a> that allows users to import and export decks/notes and all relevant information in a hierarchical JSON format. The main purpose is to facilitate crowd-sourcing for Anki decks and notes.
23

3-
<b>Suggested collaboration workflow</b>
4+
Starting with version 0.6 it also features a close integration with Git.
5+
Providing you with an ability to <b>automatically maintain history of edits</b> for your decks.
6+
See more details <a href="#snapshots">below</a>.
47

5-
The current workflow could be described as following:
8+
<b>Please note that I can't reply to your comments here (and I'm not getting notified about them). If you want to get in
9+
touch - please ping me on Github: <a href="https://github.com/Stvad/CrowdAnki" rel="nofollow">https://github.com/Stvad/CrowdAnki</a><b></b></b>
10+
11+
<b>If you would like to support the plugin - please consider <a href="https://www.patreon.com/bePatron?u=13102903"
12+
rel="nofollow"> becoming a Patron!</a></b>
13+
14+
<a href="https://www.patreon.com/bePatron?u=13102903" rel="nofollow"><img
15+
src="https://c5.patreon.com/external/logo/become_a_patron_button.png"></a>
616

17+
<b>Suggested collaboration workflow (a more detailed version is available on <a
18+
href="https://github.com/Stvad/CrowdAnki" rel="nofollow">Github</a>):</b>
19+
20+
The current workflow could be described as following:
721
<ul>
822
<li>The user creates or imports a deck inside of Anki.</li>
923
<li>Makes some modification to it (i.e. to notes, deck settings, deck structure or note models).</li>
@@ -14,25 +28,35 @@
1428
</ul>
1529

1630
<b>Export</b>
17-
18-
To perform the export go to menu File>Export
19-
31+
To perform the export go to menu <code>File&gt;Export</code>
2032
Select the deck (note: export of "All decks" is not supported, you need to select a specific deck) and the export format "CrowdAnki JSON representation". After pressing the Export button - select directory where the result should be stored.
2133

2234
<b>Import</b>
23-
24-
To perform the import go to menu File>"CrowdAnki: Import from disk" and select the directory where the deck is stored.
35+
To perform the import go to menu <code>File&gt;CrowdAnki: Import from
36+
disk</code> and select the directory where the deck is stored.
2537

2638
<b>Import from Github</b>
2739

28-
To get the deck from Github go to menu File>"CrowdAnki: Import from Github" and enter Github username and repository name in suggested format.
29-
So, for example, to get my git deck (https://github.com/Stvad/Software_Engineering__git) you would need to enter Stvad/Software_Engineering__git.
40+
To get the deck from Github go to menu File&gt;"CrowdAnki: Import from Github" and enter Github username and repository name in suggested format.
41+
So, for example, to get my git deck (<a href="https://github.com/Stvad/Software_Engineering__git" rel="nofollow">https://github.com/Stvad/Software_Engineering__git</a>) you would need to enter Stvad/Software_Engineering__git.
3042

3143
<b>Things to note for the Import:</b>
32-
3344
<ul>
3445
<li>Automatic backup would be triggered prior to the import;</li>
3546
<li>If note model for the note has changed, or if note model itself changed in a way that it's not easy to update it automatically: you would be prompted with the window, that will ask you to specify correspondence between old and new model;</li>
3647
<li>If the note was moved to another deck in JSON file, on import all cards from that note (except the ones, that are in dynamic decks) will be moved to the specified deck.</li>
3748
</ul>
38-
To get more information or get in touch with author, please visit https://github.com/Stvad/CrowdAnki
49+
To get more information or get in touch with author, please visit <a href="https://github.com/Stvad/CrowdAnki"
50+
rel="nofollow">https://github.com/Stvad/CrowdAnki</a>
51+
52+
<b><a href="#snapshots" id="snapshots">Snapshots</a></b>
53+
<b>CrowdAnki</b> can help you preserve <strong>the history of edits for your decks</strong>.
54+
It does this by exporting them in a specified location and creating a git commit each time you do a snapshot.
55+
You can take snapshots manually via <code>File &gt; CrowdAnki: Snapshot</code> menu action.
56+
Or you can enable automated snapshots in plugin configuration. You can find more details on how to do it <a
57+
href="https://github.com/Stvad/CrowdAnki/blob/master/crowd_anki/config.md">here</a>.
58+
Other things you can <a
59+
href="file:///Users/sitalov/Dropbox/SoftwareEngineering/Projects/Anki/CrowdAnki/crowd_anki/config.md">configure</a> is the location of the snapshot and what decks should be included into it.
60+
61+
<b>Please note that I can't reply to your comments here (and I'm not getting notified about them). If you want to get in
62+
touch - please ping me on Github: <a href="https://github.com/Stvad/CrowdAnki" rel="nofollow">https://github.com/Stvad/CrowdAnki</a></b>

0 commit comments

Comments
 (0)