Skip to content

Commit

Permalink
Update ankiweb_description.html with info on snapshots
Browse files Browse the repository at this point in the history
  • Loading branch information
Stvad committed Mar 9, 2019
1 parent 5a1844d commit d53f382
Showing 1 changed file with 36 additions and 12 deletions.
48 changes: 36 additions & 12 deletions misc/ankiweb_description.html
Original file line number Diff line number Diff line change
@@ -1,9 +1,23 @@
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.
CrowdAnki is a plugin for <a href="http://ankisrs.net/"
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.

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

The current workflow could be described as following:
<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
touch - please ping me on Github: <a href="https://github.com/Stvad/CrowdAnki" rel="nofollow">https://github.com/Stvad/CrowdAnki</a><b></b></b>

<b>If you would like to support the plugin - please consider <a href="https://www.patreon.com/bePatron?u=13102903"
rel="nofollow"> becoming a Patron!</a></b>

<a href="https://www.patreon.com/bePatron?u=13102903" rel="nofollow"><img
src="https://c5.patreon.com/external/logo/become_a_patron_button.png"></a>

<b>Suggested collaboration workflow (a more detailed version is available on <a
href="https://github.com/Stvad/CrowdAnki" rel="nofollow">Github</a>):</b>

The current workflow could be described as following:
<ul>
<li>The user creates or imports a deck inside of Anki.</li>
<li>Makes some modification to it (i.e. to notes, deck settings, deck structure or note models).</li>
Expand All @@ -14,25 +28,35 @@
</ul>

<b>Export</b>

To perform the export go to menu File>Export

To perform the export go to menu <code>File&gt;Export</code>
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.

<b>Import</b>

To perform the import go to menu File>"CrowdAnki: Import from disk" and select the directory where the deck is stored.
To perform the import go to menu <code>File&gt;CrowdAnki: Import from
disk</code> and select the directory where the deck is stored.

<b>Import from Github</b>

To get the deck from Github go to menu File>"CrowdAnki: Import from Github" and enter Github username and repository name in suggested format.
So, for example, to get my git deck (https://github.com/Stvad/Software_Engineering__git) you would need to enter Stvad/Software_Engineering__git.
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.
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.

<b>Things to note for the Import:</b>

<ul>
<li>Automatic backup would be triggered prior to the import;</li>
<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>
<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>
</ul>
To get more information or get in touch with author, please visit https://github.com/Stvad/CrowdAnki
To get more information or get in touch with author, please visit <a href="https://github.com/Stvad/CrowdAnki"
rel="nofollow">https://github.com/Stvad/CrowdAnki</a>

<b><a href="#snapshots" id="snapshots">Snapshots</a></b>
<b>CrowdAnki</b> can help you preserve <strong>the history of edits for your decks</strong>.
It does this by exporting them in a specified location and creating a git commit each time you do a snapshot.
You can take snapshots manually via <code>File &gt; CrowdAnki: Snapshot</code> menu action.
Or you can enable automated snapshots in plugin configuration. You can find more details on how to do it <a
href="https://github.com/Stvad/CrowdAnki/blob/master/crowd_anki/config.md">here</a>.
Other things you can <a
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.

<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
touch - please ping me on Github: <a href="https://github.com/Stvad/CrowdAnki" rel="nofollow">https://github.com/Stvad/CrowdAnki</a></b>

0 comments on commit d53f382

Please sign in to comment.