You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
* Fix broken link on homepage
* Merge instructions on running from source
* Bump version number
* Version bump reverted to reflect historical practice
* Merged new bookmarklet section
Copy file name to clipboardExpand all lines: docs/importers/index.md
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -7,4 +7,4 @@ has_children: true
7
7
8
8
# Importers
9
9
10
-
Importers are a central feature of VocabSieve, as they enable asynchronous workflows. Importers can be accessed through the "Import" option on the menu bar. As of version 0.11, there are three importers.
10
+
Importers are a central feature of VocabSieve, as they enable asynchronous workflows. Importers can be accessed through the "Import" option on the menu bar. As of version 0.11, there are three importers.
Copy file name to clipboardExpand all lines: docs/index.md
+8-7Lines changed: 8 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -3,25 +3,26 @@ title: Home
3
3
layout: default
4
4
nav_order: 1
5
5
---
6
+
6
7
# Home
7
8
8
9
Welcome to VocabSieve manual.
9
10
10
11
## Quickstart
11
12
12
-
Go to [Installation]({{site.baseurl}}/installation.html) and [Configuration]({{site.baseurl}}/configuration.html)
13
+
Go to [Installation]({{site.baseurl}}/installation.html) and [Configuration]({{site.baseurl}}/configuration)
13
14
if you are already familiar with immersion and Anki and just want to quickly set up VocabSieve. If you already have VocabSieve set up, you may want to look at [Resources]({{site.baseurl}}/resources.html) to find dictionaries and other files to use with VocabSieve.
14
15
15
16
## Community support
16
17
17
18
You can join FreeLanguageTools chatrooms on multiple platforms. All chatrooms are bridged, so you will not miss any answers by choosing to use one over the other. Please be civil and do not post adult content.
| Discord (_proprietary with history of anti-user behavior_) |<https://discord.gg/DNSsTtHRxz>|
24
25
25
26
## Contributing
26
27
27
-
This manual is rather rudimentary as this point. You can edit it [on GitHub](https://github.com/FreeLanguageTools/vocabsieve/tree/master/docs) and submit a pull request. Alternatively you can also edit it locally and send the edited files to the chat for someone to pick it up. Unfortunately we do not have the resources needed to properly host and maintain a wiki that is impervious to spam. We apologize for the increased barrier to contributing, but this is what has to be done.
28
+
This manual is rather rudimentary as this point. You can edit it [on GitHub](https://github.com/FreeLanguageTools/vocabsieve/tree/master/docs) and submit a pull request. Alternatively you can also edit it locally and send the edited files to the chat for someone to pick it up. Unfortunately we do not have the resources needed to properly host and maintain a wiki that is impervious to spam. We apologize for the increased barrier to contributing, but this is what has to be done.
@@ -24,6 +24,7 @@ If you use other distributions, you should run it from an AppImage distributed o
24
24
If you prefer to install it anyways, you can use `pip3 install vocabsieve` (add `-–user` if appropriate). (**Note**: Newer versions of Python will stop you from installing into your global Python environment by default. You may need to create a virtual environment). This will install a desktop file which you should be able to see from your launcher menu. If you do not use a desktop environment, you can launch it through the command line `vocabsieve`.
25
25
26
26
If you want to test the latest features, you can go to [CI artifacts page](https://nightly.link/FreeLanguageTools/vocabsieve/workflows/build-binaries/master) page to obtain the latest builds, but they are not guaranteed to run. If you notice anything wrong from those builds, open an issue on GitHub. Ensure you are using the latest nightly build before reporting anything.
27
+
27
28
</details>
28
29
29
30
### Windows
@@ -34,6 +35,7 @@ Go to the [Github releases page](https://github.com/FreeLanguageTools/vocabsieve
34
35
<summary> Click to open instructions to download test releases </summary>
35
36
36
37
If you want to test the latest features, you can go to [CI artifacts page](https://nightly.link/FreeLanguageTools/vocabsieve/workflows/build-binaries/master) page to obtain the latest builds, but they are not guaranteed to run. If you notice anything wrong from those builds, open an issue on GitHub. Note: ensure you are using the latest nightly build before reporting anything.
38
+
37
39
</details>
38
40
39
41
{: .note}
@@ -53,8 +55,19 @@ Open a new terminal window and type the following command
53
55
<summary> Click to open instructions to download test releases </summary>
54
56
55
57
If you want to test the latest features, you can go to [CI artifacts page](https://nightly.link/FreeLanguageTools/vocabsieve/workflows/build-binaries/master) page to obtain the latest builds, but they are not guaranteed to run. If you notice anything wrong from those builds, open an issue on GitHub. Note: ensure you are using the latest nightly build before reporting anything.
58
+
56
59
</details>
57
60
61
+
### Running from source (Advanced)
62
+
63
+
To run from source:
64
+
65
+
1. Set up a virtual environment `python3 -m venv env`
66
+
2.`pip install -r requirements.txt`
67
+
3.`python3 vocabsieve.py`
68
+
69
+
For debugging purposes, set the environmental variable `VOCABSIEVE_DEBUG` to any value. This will create a separate profile (settings and databases for records and dictionaries) so you may perform tests without affecting your normal profile. For each different value of `VOCABSIEVE_DEBUG`, a separate profile is generated. This can be any number or string.
70
+
58
71
## AnkiConnect (Required for card creation)
59
72
60
73
Download and install [Anki desktop](https://apps.ankiweb.net/) (Not mobile or Anki Universal). Skip if you already installed it.
@@ -64,15 +77,90 @@ Then, install the [AnkiConnect](https://ankiweb.net/shared/info/2055492159) addo
64
77
{: .important }
65
78
**MacOS users**: You must have Anki open on the foreground (i.e. visible on your desktop), or otherwise [disable the App Nap feature](https://github.com/FooSoft/anki-connect#notes-for-macos-users). If you do not do this, AnkiConnect will not respond and will cause this program to be very slow and/or unresponsive.
66
79
67
-
## Browser extension (Optional)
68
-
69
-
{: .note}
70
-
The browser extension should work as is, but is mostly unmaintained
-[Chrome/Chromium](https://chrome.google.com/webstore/detail/click-copy-sentence/klhlkoabjmofmjkhbmelmfnhkbjaohdj) (incl. derivatives such as Edge, Brave, etc.)
77
-
78
-
Note that if you have local ebook files to read, you can use the built-in reader too, accessible by the "Reader" button on the menu bar. When using the reader, you do not need the browser extension.
80
+
## Vocabsieve bookmarklet
81
+
82
+
This bookmarklet allows you to copy the sentence as well as the word under cursor with one click to the word, without selecting anything (only works for languages that use space to separate words).
83
+
84
+
### Usage
85
+
86
+
Select the following code and drag it to the bookmark toolbar. Alternatively, copy the code, create a bookmark, and paste the code into the URL field in the popup window.
0 commit comments