Skip to content

Commit 32c649c

Browse files
committed
upgrade english doc 2
1 parent 972ea4c commit 32c649c

19 files changed

+96
-158
lines changed
File renamed without changes.

doc/doc_admin.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@
5353
导出内置词典:
5454

5555
```
56-
python export_builtin_dic.py
56+
python script/export_builtin_dic.py
5757
```
5858

5959
内置词典导出到django-mdict/export/,export.txt是导出的文本,data是导出的资源,导出后不支持mathjax,wrap脚本goldendict支持,mdict不支持。

doc/doc_anki.md

-3
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,6 @@ anki-connect:[https://github.com/FooSoft/anki-connect](https://github.com/FooS
99
自动复制:自动将当前展开词条的词头无样式复制到卡片正面,将当前展开词条的内容带样式复制到卡片背面。
1010
复制时词条中有未展开的内容,复制后将无法展开。如果HTML结构较复杂,复制耗时会很长。
1111

12-
手动复制:手动选择内容复制,粘贴时ctrl+v是带样式粘贴,ctrl+shift+v是纯文本粘贴,
13-
或者鼠标右键选择粘贴或粘贴为纯文本,再手机上通过长按调出鼠标右键。
14-
1512
带样式复制会丢失部分样式。且仅能显示在线图片,不支持图片和音频的插入,anki不支持base64图片的显示。不支持ckeditor5的浏览器中无法使用(cefpython无法使用)。
1613

1714
![图片](img/img080901.png?raw=true)

doc/doc_en/doc_admin.md

+13-10
Original file line numberDiff line numberDiff line change
@@ -5,31 +5,34 @@ Enter the background admin interface
55
[http://127.0.0.1:18000/admin/](http://127.0.0.1:18000/admin/)
66

77
* return to home page
8-
<br />In the admin, click View Site at the top of the page to return to the main page.
8+
<br>In the admin, click View Site at the top of the page to return to the main page.
99

1010
* MDICT/Mdict dictionary:
11-
<br />No need to add dictionaries manually. Only used to modify dictionary name, dictionary sorting, and whether to enable the dictionary.
11+
<br>No need to add dictionaries manually. Only used to modify dictionary name, dictionary sorting, and whether to enable the dictionary.
1212

1313
* MDICT/built-in entries:
14-
<br />Add entries from the built-in dictionary, support images and rich text, and support LaTex formulas.
14+
<br>Add entries from the built-in dictionary, support images and rich text, and support LaTex formulas.
1515

1616
* LaTex formula insertion:
17-
<br />Method 1. Click the latex formula button (button with the summation symbol) to insert the formula; <br />Method 2. Enter manually and wrap the formula with $.
17+
<br>Method 1. Click the latex formula button (button with the summation symbol) to insert the formula; <br />Method 2. Enter manually and wrap the formula with $.
1818

1919
* Custom command:
20-
<br />[link]The entry name to be jumped[/link]<br /> [wrap]The content to be folded[/wrap]<br /> Custom command insertion:<br /> 1. Select the text, click the L button, the text will be automatically wrapped with [link], and the selected text will be displayed as an entry jump. <br />2. Select the text, click the W button, the text will be automatically wrapped with [wrap], and the selected text will be folded.
20+
<br> [link]The target entry[/link]
21+
<br> [wrap]The content to be folded[/wrap]
22+
<br> Custom command insertion:
23+
<br> 1. Select the text, click the L button, the text will be automatically wrapped with [link], and the selected text will be displayed as an entry jump. <br />2. Select the text, click the W button, the text will be automatically wrapped with [wrap], and the selected text will be folded.
2124

2225
* MDICT/Online Dictionary:
23-
<br />Add an online dictionary and replace the characters to be queried in the URL with %WORD%. Some websites do not support displaying in iframes. In this case, you need to remove the check box for opening in iframes.
26+
<br>Add an online dictionary and replace the characters to be queried in the URL with %WORD%. Some websites do not support displaying in iframes. In this case, you need to remove the check box for opening in iframes.
2427

2528
* MDICT/tag
26-
<br />Create tags for built-in terms.
29+
<br>Create tags for built-in terms.
2730

2831
* MDICT/Dictionary Grouping
29-
<br />Create a dictionary group and then add the dictionary to the group.
32+
<br>Create a dictionary group and then add the dictionary to the group.
3033

3134
* Enable/disable all dictionaries
32-
<br />On the Mdict dictionary page, check the check box before the ID, select all dictionaries on the first page, click on the right side of the execute button to select all XXX Mdict dictionaries, select EnableAllDics/DisableAllDics in the action drop-down box, and finally click the execute button.
35+
<br>On the Mdict dictionary page, check the box before the ID, select all dictionaries on the first page, click on the right side of the execute button to select all XXX Mdict dictionaries, select EnableAllDics/DisableAllDics in the action drop-down box, and finally click the execute button.
3336

3437
### Built-in dictionary
3538

@@ -49,7 +52,7 @@ Export the built-in dictionary:
4952

5053

5154
```
52-
python export_builtin_dic.py
55+
python script/export_builtin_dic.py
5356
```
5457

5558
The built-in dictionary is exported to django-mdict/export/, export.txt is the exported text, and data is the exported resource. Mathjax is not supported after export. The wrap script goldendict supports it, but mdict does not.

doc/doc_en/doc_anki.md

-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@ The front side of the card can only be pasted as plain text, and the back side o
88

99
Automatic copy: Automatically copy the prefix of the currently expanded entry to the front of the card without style, and copy the content of the currently expanded entry to the back of the card with style. There is unexpanded content in the entry when copying, and it cannot be expanded after copying. If the HTML structure is complex, copying will take a long time.
1010

11-
Manual copy: Manually select the content to copy. When pasting, ctrl+v is to paste with style, ctrl+shift+v is to paste as plain text, or right-click the mouse and select paste or paste as plain text, and then long press on the mobile phone to bring up the right-mouse button.
12-
1311
Copying with styles will lose some styles. And it can only display online images, and does not support the insertion of images and audio. Anki does not support the display of base64 images. It cannot be used in browsers that do not support ckeditor5 (cefpython cannot be used).
1412

1513
![图片](../img/img080901.png?raw=true)

doc/doc_en/doc_deploy.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,13 @@
66

77
### Running on wsl
88

9-
It is recommended to deploy to wsl1 under windows. Wsl2 reads windows files slower than wsl1, causing the query speed to be about 1/20-1/10 slower. In addition, the problem of IP access must be solved.
9+
It is recommended to deploy to wsl1 on windows. Wsl2 reads Windows files slower than wsl1, causing the query speed to be about 1/20-1/10 slower. In addition, the problem of IP access must be solved.
1010

1111
1. Install wsl, system ubuntu.
1212

1313
[https://docs.microsoft.com/en-us/windows/wsl/install-win10](https://docs.microsoft.com/en-us/windows/wsl/install-win10)
1414

15-
2. Switch to the root user. Django needs to be installed under the root user.
15+
2. Switch to the root user. Django needs to be installed with the root user.
1616

1717

1818
```
@@ -27,7 +27,7 @@ sudo apt-get install dos2unix
2727
dos2unix init_wsl.sh init_server.sh init_server_brew.sh init_server_yum.sh init_server_apt.sh django-mdict.conf run_server.sh run_server_brew.sh run_server_yum.sh run_server_apt.sh mdict/readlib/pyx/build.sh
2828
```
2929

30-
4. Run run_server.sh, the default port is 8000, this script is suitable for ubuntu (centos needs to run run_server_yum.sh).
30+
4. Run run_server.sh, the default port is 18000, this script is suitable for ubuntu (centos needs to run run_server_yum.sh).
3131

3232

3333
```
@@ -82,7 +82,7 @@ Finally, you are asked to enter your django username and password.
8282

8383
6. Set up wsl auto-start script
8484

85-
Run shell:startup under windows to create the script file ubuntu.vbs with the following content:
85+
Run shell:startup on Windows to create ubuntu.vbs with the following content:
8686

8787

8888
```
@@ -96,15 +96,15 @@ Among them, ubuntu is the name of the distribution version. Use the command wsl
9696

9797

9898
```
99-
启动apache
99+
Start apache:
100100
sudo service apache2 start
101-
重启apache
101+
Restart apache:
102102
sudo service apache2 restart
103-
停止apache
103+
Stop apache:
104104
sudo service apache2 stop
105105
```
106106

107-
The location of the apache error log on ubuntu /var/log/apache2/error.log
107+
The location of the apache error log on ubuntu is /var/log/apache2/error.log
108108

109109
### Delete duplicate dictionaries records in database
110110

@@ -133,7 +133,7 @@ for dic in all_dics:
133133

134134
1. Install docker and run
135135

136-
2. Delete the .git and huaci folders in the root directory
136+
2. Delete the .git and deprecated folders in the root directory
137137

138138
3. Run the following command in wsl to convert the format (or manually convert the format with notepad++)
139139

doc/doc_en/doc_es.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ If you skip this step, the built-in standard tokenizer will be used.
3737

3838
4. (Skipable) It is recommended that es allocate 4g or more memory during query and indexing, modify the parameters -Xms1g and -Xmx1g in config/jvm.options, change 1 to 4, and restart es to take effect.
3939

40-
8.10.2 SSL needs to be turned off. The following settings in config/elasticsearch.yml are set to false, xpack.security.enabled, xpack.security.enrollment.enabled, xpack.security.http.ssl:xpack.security.transport.ssl.
40+
8.10.2 needs to turn off SSL. The following settings in config/elasticsearch.yml are set to false, xpack.security.enabled, xpack.security.enrollment.enabled, xpack.security.http.ssl:xpack.security.transport.ssl.
4141

4242
5. Run elasticsearch/bin/elasticsearch.bat to start es.
4343

@@ -53,11 +53,11 @@ If you skip this step, the built-in standard tokenizer will be used.
5353

5454
[http://127.0.0.1:18000/mdict/es/](http://127.0.0.1:18000/mdict/es/)
5555

56-
When performing full-text query, eselasticsearch.bat needs to be running all the time, otherwise the query will have no results. If it needs to be turned on all the time, it needs to be set to start at boot.
56+
When performing full-text query, eselasticsearch.bat needs to be running all the time, otherwise the query will have no results.
5757

5858
### Install xapian
5959

60-
* Install using apt-get under ubuntu
60+
* Install with apt-get on ubuntu
6161

6262

6363
```
@@ -87,14 +87,12 @@ There is a problem with the phrase query of zim, and the impact is not avoided.
8787

8888
* Dictionary grouping and starting and stopping a certain dictionary only modify the values in the database. You need to click the Start and Stop Index button to set the index of the corresponding dictionary to on or off. Note that starting and stopping a large number of indexes may be time-consuming. It's very long (the end of the circle indicates that the start and stop are completed, and the specific progress can be viewed in the ES window prompt).
8989

90-
* Entries that appear frequently have high scores and will be ranked first. Therefore, a large number of encyclopedia mdx entries may appear in the front row, causing interference to the results. At this time, these dictionaries can be indexed by starting and stopping the index. No inquiry is made.
90+
* Entries that appear frequently have high scores and will be ranked first. Therefore, a large number of encyclopedia mdx entries may appear in the front pages, causing interference to the results. At this time, these dictionaries can be indexed by starting and stopping the index. No inquiry is made.
9191

92-
* There are three columns of icons in front of the dictionary name in the dictionary list. The first column sets whether it is enabled, and then click the start and stop index button to apply the changes to the es index. The second column indicates whether the es index is enabled for the current dictionary. The green check mark indicates that it is enabled, and the red check mark indicates whether the es index is enabled. The cross indicates that it is closed, the third column is the current status of the index, the gray question mark indicates that it is unknown, the gray cloud indicates that es cannot be accessed, the green sun indicates that the index exists and is running, the orange moon indicates that the index exists but is closed, and the red cross indicates that the index does not exist.
92+
* There are three columns of icons in front of the dictionary name in the dictionary list. The first column sets whether it is enabled, and then click the start and stop index button to apply the changes to the es index. The second column indicates whether the es index is enabled for the current dictionary. The green check mark indicates that it is enabled, and the red check mark indicates that is disenabled. The cross indicates that it is closed, the third column is the current status of the index, the gray question mark indicates that it is unknown, the gray cloud indicates that es cannot be accessed, the green sun indicates that the index exists and is running, the orange moon indicates that the index exists but is closed, and the red cross indicates that the index does not exist.
9393

9494
* You can use kibana to view specific information about elasticsearch.
9595

96-
* Open a dictionary in the dictionary list from the main query interface and perform a sequential query on the dictionary. Open a dictionary in the dictionary list from the full-text search page and perform a full-text search on the dictionary.
97-
9896
### es index operation
9997

10098
* Create index
@@ -202,7 +200,7 @@ discovery.type: single-node
202200

203201
* When creating indexes for a large number of dictionaries, it gets stuck, CPU usage is 0%, and no error is reported.
204202

205-
1. The reason is unknown. Try selecting a piece of text in the command line window and right-clicking to copy it. The operation may be restored.
203+
1. Try selecting a piece of text in the command line window and right-clicking to copy it. The operation may be restored.
206204

207205
* show connectionError
208206

doc/doc_en/doc_func.md

+14-14
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ django-mdict
7575

7676
iframe-resizer:[https://github.com/davidjbradshaw/iframe-resizer](https://github.com/davidjbradshaw/iframe-resizer)
7777

78-
The entries are displayed using iframe, and the height is set using iframe-resizer.
78+
The entries are displayed using iframe, and the height is set by iframe-resizer.
7979

8080
Advantages: Entries are completely isolated, js and css will not affect each other.
8181

@@ -97,15 +97,15 @@ django-mdict/mdict/media/readmdict_py3.zip/readmdict_py3.py modified readmdict.p
9797

9898
The function of django-mdict/mdict/readlib/src/readmdict.py is to search mdict.
9999

100-
django-mdict/mdict/readlib/pyx/readmdict.pyx is the cython version of readmdict_seach.py. Run build.bat or build.sh to compile. The compiled library file will be copied to /django-mdict/mdict/readlib/lib /.
100+
django-mdict/mdict/readlib/pyx/readmdict.pyx is the cython version of readmdict_seach.py. Run build.bat or build.sh to compile. The compiled library file will be copied to /django-mdict/mdict/readlib/lib/.
101101

102102
### zim parsing
103103

104104
ZIM file format: [https://openzim.org/wiki/ZIM_file_format](https://openzim.org/wiki/ZIM_file_format)
105105

106106
github ZIMply: [https://github.com/kimbauters/ZIMply](https://github.com/kimbauters/ZIMply)
107107

108-
django-mdict/mdict/mdict-utils/readzim.py is modified from zipply.py.
108+
django-mdict/mdict/mdict-utils/readzim.py is modified from zimply.py.
109109

110110
Some terms cannot be found during the current search, and full-text search is required. Full-text search requires xapian to be installed, and manual compilation is required under windows. After running django-mdict, ZIM's built-in index will be extracted and saved as an idx file. Extracting the index is similar to file copying, and the speed depends on the maximum read and write speed of the hard disk.
111111

@@ -131,11 +131,11 @@ github hanzi_chaizi:[https://github.com/howl-anderson/hanzi_chaizi](https://gi
131131

132132
github chaizi:[https://github.com/kfcd/chaizi](https://github.com/kfcd/chaizi)
133133

134-
Open dictionary network split word dictionary: [http://kaifangcidian.com/han/chaizi](http://kaifangcidian.com/han/chaizi)
134+
online dictionary: [http://kaifangcidian.com/han/chaizi](http://kaifangcidian.com/han/chaizi)
135135

136-
django-mdict/mdict/mdict_utils/chaizi_reverse.py modifies chaizi.py so that it can be reverse-checked. For example, if you enter Shantiao, you will get Shima and Shima.
136+
django-mdict/mdict/mdict_utils/chaizi_reverse.py modifies chaizi.py so that it can be reverse-search.
137137

138-
The split-character reverse search only supports common characters. The query function integrates the split-word reverse search. If you query Shanniao, it will return Shanniao, Shima, and 匌. If you query Wangba, it will return Wangba,兲, and Ding.
138+
When you search 山鸟, you will get 山鸟, 嶋 and .
139139

140140
### Part retrieval and full Song font
141141

@@ -145,15 +145,15 @@ pdawiki component retrieval and full Song font: [https://www.pdawiki.com/forum/f
145145

146146
Integrated component retrieval and full Song font. Since chrome does not support fonts larger than 30MB, FSung-2.ttf and FSung-F.ttf were split. The full Song font size is 138MB.
147147

148-
Parts retrieval is more accurate than splitting words and searching backwards. For example, if you enter Shanniao, you will get 勋, 匌 and 㠀.
148+
Parts retrieval is more accurate than characters splitting. For example, if you enter 山鸟, you will get 山鸟, 嶋, 嶌 and 㠀.
149149

150150
The parts search currently contains 173334 Chinese characters.
151151

152152
### character conversion
153153

154-
Opencc-python-reimplemented is used for traditional and simplified conversion.
154+
Opencc-python-reimplemented is used for traditional and simplified chinese conversion.
155155

156-
Some of the characters copied from the PDF are full-width characters. When querying, the characters will be queried once as full-width characters, and then converted into half-width characters and queried again.
156+
Some of the characters copied from the PDF are full-width characters. When querying, the characters will be queried once as full-width characters, and then queried as half-width characters.
157157

158158
Japanese hiragana and katakana are automatically converted, and half-width katakana will be converted to full-width katakana.
159159

@@ -171,11 +171,11 @@ Query history will not be saved by default. You need to modify history_enable in
171171

172172
The query history is stored in the history.dat file in the root directory. The first column is the time, and the second column is the query entry.
173173

174-
Click the Download Query History button in the settings to generate a file in csv format. Note that opening Excel directly may result in garbled characters. You need to use notepad++ or other tools to change the encoding format to UTF-8 with BOM first.
174+
Click the Download Query History button in the settings to generate a file in csv format (utf-8).
175175

176-
View the word cloud generated by query history under mdict/wordcloud/, and you can select the time range in the settings in the upper right corner.
176+
The word cloud generated by query history can be viewed on mdict/wordcloud/.
177177

178-
Delete the saved query history and directly delete all dat files starting with history in the root directory.
178+
Delete all history*.dat files in the root directory to delete query history.
179179

180180
### Other
181181

@@ -195,7 +195,7 @@ Keyword highlighting for full-text search is implemented using mark.js.
195195

196196
mark.js:[https://github.com/julmot/mark.js](https://github.com/julmot/mark.js)
197197

198-
Querying the historical word cloud is implemented using wordcloud2.js.
198+
Word cloud is implemented using wordcloud2.js.
199199

200200
wordcloud2.js:[https://github.com/timdream/wordcloud2.js](https://github.com/timdream/wordcloud2.js)
201201

@@ -207,7 +207,7 @@ Markdown document display is implemented using marked.js.
207207

208208
marked.js:[https://github.com/markedjs/marked](https://github.com/markedjs/marked)
209209

210-
Anki card printing is implemented by calling anki-connect.
210+
Anki card creation is implemented by calling anki-connect.
211211

212212
anki-connect:[https://github.com/FooSoft/anki-connect](https://github.com/FooSoft/anki-connect)
213213

0 commit comments

Comments
 (0)