Merge pull request #246 from terasum/develop

README.md

@@ -39,42 +39,40 @@ Medict 是一个跨平台的词典 APP, 主要支持 \*.mdx/\*.mdd 词典格式,
 
 ## 界面预览
 
+# Medict 界面介绍
 
+Medict 是一个跨平台的词典 APP, 主要支持 \*.mdx/\*.mdd 词典格式, 目前支持 v1.x 和 v2.0 格式的词典。
 
-### 英汉
+## 下载与更新
 
-**OALE8**
+目前 Medict 正在紧张开发阶段，版本为自动打包滚动发布，请自行到 https://github.com/terasum/medict/releases 页面寻找最新开发版本, 所有版本均有打包日期，选择最新版本即可。
 
-- 支持图片展开
-- 支持 jquery
-- 支持跳转
+## 界面概览
 
-<img src="https://tva1.sinaimg.cn/large/008i3skNly1gst1zj6bdbj313n0u0grs.jpg" alt="image-20210725115204014" style="zoom: 33%;" />
+软件目前包括 “词典”，“翻译”，“插件”，“设置” 四个界面，其中“插件”目前尚在开发当中。
 
+### 词典界面
 
+<img src="src/renderer/assets/docs/pic_dict_window.jpg" alt="词典界面" style="zoom: 23%;" />
 
-### 汉英
+### 翻译界面
 
-**新世纪汉英大辞典**
+<img src="src/renderer/assets/docs/pic_translate_window.jpg" alt="翻译界面" style="zoom: 23%;" />
 
-<img src="https://tva1.sinaimg.cn/large/008i3skNly1gst22mzl8cj313n0u0n3c.jpg" alt="image-20210725115503487" style="zoom: 33%;" />
+### 设置界面
 
-### 日语
+<img src="src/renderer/assets/docs/pic_settings_window.jpg" alt="设置界面" style="zoom: 23%;" />
 
-**新日汉大辞典**
 
-- 支持字体
+## 步骤 2: 查词
 
-<img src="https://tva1.sinaimg.cn/large/008i3skNly1gst1vdd6lyj613n0u0tef02.jpg" alt="image-20210725114802241" style="zoom: 33%;" />
-
-
-
-## 图片词库
+1. 选择词典并输入目标词（模糊）
 
-**大英漢词典**
+<img src="src/renderer/assets/docs/pic_usage_step1.jpg" alt="pic_usage_step1.jpg" style="zoom:23%;" />
 
-<img src="https://tva1.sinaimg.cn/large/008i3skNly1gst1wfn7ffj313n0u0qd3.jpg" alt="image-20210725114905767" style="zoom: 33%;" />
+2. 在左边栏选择你想要查的具体词汇, 如果该词汇和其他词汇同一个意思（即@@Link==） 则直接展示该同意义词汇
 
+<img src="src/renderer/assets/docs/pic_usage_step2.jpg" alt="pic_usage_step2.jpg" style="zoom:23%;" />
 
 
 ## 下载
@@ -84,42 +82,24 @@ Medict 是一个跨平台的词典 APP, 主要支持 \*.mdx/\*.mdd 词典格式,
 
 ## 使用步骤
 
+## 选择添加并使用词典
+
 ### 步骤1: 添加词典
 
 1. 点击右上角设置
 2. 点击下方 "+" 号
 
-<img src="https://tva1.sinaimg.cn/large/008i3skNly1gst2568g8dj313n0u0wi1.jpg" alt="image-20210725115729944" style="zoom: 33%;" />
-
-
+<img center src="src/renderer/assets/docs/pic_add_dict_btn.jpg" alt="pic_add_dict_btn.jpg" style="zoom: 23%;" />
 
 3. 在弹出框中填写词典信息
 4. 选择词典文件
 
-注意：mdx文件所在的文件夹中的js/css/font文件均会被拷贝到缓存文件夹中，请把一个独立词典放在一个独立的文件夹中，并将相关资源放在一起。
-
-注意： mdx/mdd 本身不会被拷贝，删除之后，词典将无法找到该mdx文件
-
 
+<img center src="src/renderer/assets/docs/pic_add_dict_modal.jpg" alt="pic_add_dict_modal.jpg" style="zoom:23%;" />
 
-<img src="https://tva1.sinaimg.cn/large/008i3skNly1gst27etnrgj613n0u0afx02.jpg" alt="image-20210725115939188" style="zoom:33%;" />
-
-
-
-## 步骤2: 查词
-
-1. 选择词典并输入目标词（模糊）
-
-<img src="https://tva1.sinaimg.cn/large/008i3skNly1gst2anwbx3j313n0u0jz4.jpg" alt="image-20210725120246204" style="zoom:33%;" />
-
-
-
-2. 在左边栏选择你想要查的具体词汇
-
-   如果该词汇和其他词汇同一个意思（即@@Link==） 则直接展示该同意义词汇
-
-   <img src="https://tva1.sinaimg.cn/large/008i3skNly1gst2katvp6j313n0u010a.jpg" alt="image-20210725121201887" style="zoom:33%;" />
+**注意:** mdx文件所在的文件夹中的js/css/font文件均会被拷贝到缓存文件夹中，请把一个独立词典放在一个独立的文件夹中，并将相关资源放在一起。
 
+**注意:** mdx/mdd 本身不会被拷贝，删除之后，词典将无法找到该mdx文件
 
 
 ## Q&A
@@ -129,7 +109,6 @@ Medict 是一个跨平台的词典 APP, 主要支持 \*.mdx/\*.mdd 词典格式,
 目前 oale8 词典这种内嵌发音按钮的，将音频资源嵌入在mdd文件中的词典是可以支持发音的，但是目前采用的是js替换的方式完成，不一定适用于所有词典，需要case by case 调试
 
 
-
 ### 跳转问题
 
 目前有两种跳转：

package.json

@@ -1,7 +1,7 @@
 {
   "name": "medict",
   "productName": "medict",
-  "version": "2.0.8",
+  "version": "2.0.9",
   "description": "Medict an elegant dictionary app",
   "main": ".webpack/main",
   "scripts": {
@@ -98,17 +98,20 @@
     "@types/koa-pino-logger": "^3.0.0",
     "@types/koa-static": "^4.0.1",
     "@types/lodash": "^4.14.170",
+    "@types/markdown-it": "^12.2.3",
     "@types/rimraf": "^3.0.1",
     "@types/tmp": "^0.2.0",
     "@typescript-eslint/eslint-plugin": "^4.28.1",
     "@typescript-eslint/parser": "^4.29.1",
     "chai": "^4.3.4",
+    "copy-webpack-plugin": "^9.0.1",
     "css-loader": "^5.0.0",
     "electron": "13.3.0",
     "electron-squirrel-startup": "^1.0.0",
     "eslint": "^7.29.0",
     "eslint-plugin-import": "^2.20.0",
     "fork-ts-checker-webpack-plugin": "^6.2.12",
+    "html-loader": "^2.1.2",
     "jest": "^27.0.6",
     "jest-mock-axios": "^4.4.0",
     "mini-css-extract-plugin": "^2.4.2",
@@ -146,6 +149,7 @@
     "koa-static": "^5.0.0",
     "lodash": "^4.17.21",
     "lowdb": "^2.1.0",
+    "markdown-loader": "^6.0.0",
     "normalize.css": "^8.0.1",
     "rimraf": "^3.0.2",
     "tmp": "^0.2.1",

src/apis/google_translate.ts

@@ -7,6 +7,20 @@ export async function translate(
     query: string
 
 ) {
+    if (from == "zh") {
+        from = 'zh-CN'
+    }
+    if (from == "jp") {
+        from = 'ja'
+    }
+
+    if (to == "zh") {
+        to = 'zh-CN'
+    }
+    if (to == "jp") {
+        to = 'ja'
+    }
+
     // @ts-ignore
     let request = google_translate(query, { from: from, to: to, tld: 'cn' })
     return request

src/renderer/assets/docs/baidu_translate_config.md

@@ -0,0 +1 @@
+# Baidu 翻译 API申请与配置

src/renderer/assets/docs/faq.md

@@ -0,0 +1,12 @@
+# FAQ
+
+### 发音问题
+
+目前 oale8 词典这种内嵌发音按钮的，将音频资源嵌入在 mdd 文件中的词典是可以支持发音的，但是目前采用的是 js 替换的方式完成，不一定适用于所有词典，需要 case by case 调试
+
+### 跳转问题
+
+目前有两种跳转：
+
+1. @@Link 的跳转，自动跳转，但是如果出现跳转环路，会停止跳转，直接展示 @@Link==
+2. 内部跳转即 `<a href="entry://">` 的方式，如果 entry 中间是完整词条，可以支持跳转，如果是特殊词条，目前还不支持

src/renderer/assets/docs/index.md

@@ -0,0 +1,35 @@
+# Medict 界面介绍
+
+Medict 是一个跨平台的词典 APP, 主要支持 \*.mdx/\*.mdd 词典格式, 目前支持 v1.x 和 v2.0 格式的词典。
+
+## 下载与更新
+
+目前 Medict 正在紧张开发阶段，版本为自动打包滚动发布，请自行到 https://github.com/terasum/medict/releases 页面寻找最新开发版本, 所有版本均有打包日期，选择最新版本即可。
+
+## 界面概览
+
+软件目前包括 “词典”，“翻译”，“插件”，“设置” 四个界面，其中“插件”目前尚在开发当中。
+
+### 词典界面
+
+<img src="pic_dict_window.jpg" alt="词典界面" style="zoom: 23%;" />
+
+### 翻译界面
+
+<img src="pic_translate_window.jpg" alt="翻译界面" style="zoom: 23%;" />
+
+### 设置界面
+
+<img src="pic_settings_window.jpg" alt="设置界面" style="zoom: 23%;" />
+
+
+## 步骤 2: 查词
+
+1. 选择词典并输入目标词（模糊）
+
+<img src="pic_usage_step1.jpg" alt="pic_usage_step1.jpg" style="zoom:23%;" />
+
+2. 在左边栏选择你想要查的具体词汇, 如果该词汇和其他词汇同一个意思（即@@Link==） 则直接展示该同意义词汇
+
+<img src="pic_usage_step2.jpg" alt="pic_usage_step2.jpg" style="zoom:23%;" />
+

src/renderer/assets/docs/license.md

@@ -0,0 +1,11 @@
+# 软件开源协议信息
+
+```
+Copyright 2019-2021 terasum (Chen Quan)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+```

src/renderer/assets/docs/select_and_use_dict.md

@@ -0,0 +1,23 @@
+# 词典配置使用说明
+
+## 选择添加并使用词典
+
+### 步骤1: 添加词典
+
+1. 点击右上角设置
+2. 点击下方 "+" 号
+
+<img center src="pic_add_dict_btn.jpg" alt="pic_add_dict_btn.jpg" style="zoom: 23%;" />
+
+3. 在弹出框中填写词典信息
+4. 选择词典文件
+
+
+<img center src="pic_add_dict_modal.jpg" alt="pic_add_dict_modal.jpg" style="zoom:23%;" />
+
+**注意:** mdx文件所在的文件夹中的js/css/font文件均会被拷贝到缓存文件夹中，请把一个独立词典放在一个独立的文件夹中，并将相关资源放在一起。
+
+**注意:** mdx/mdd 本身不会被拷贝，删除之后，词典将无法找到该mdx文件
+
+
+

src/renderer/assets/docs/terms_and_service.md

@@ -0,0 +1,13 @@
+# 免责与隐私保护声明
+
+本免责及隐私保护声明(以下简称“隐私声明”或“本声明”)适用于软件 Medict (以下简称 "Medict" ) 在您阅读本声明后若不同意此声明中的任何条款，或对本声明存在质疑，请立刻停止使用本软件。若您已经开始或正在使用 Medict 软件，则表示您已阅读并同意本声明的所有条款之约定。
+
+1. 您通过安装 Medict 软件并使用 Medict 软件提供的服务与功能即表示您已经同意与软件作者立本协议。软件作者可随时执行全权决定更改“条款”。如“条款”有任何变更，软件官方发布网站 (https://gihtub.com/terasum/medict) 上刊载公告作为通知。经修订的“条款”一经在官方网站上公布后，立即自动生效。
+
+2. 一切因使用 Medict 软件而引致之任何意外、疏忽、合约毁坏、诽谤、版权或知识产权侵犯及其所造成的损失(包括在非官方站点下载Medict 软件而感染电脑病毒)，软件作者概不负责，亦不承担任何法律责任。
+
+3. 用户对使用 Medict 软件自行承担风险，我们不做任何形式的保证, 因网络状况、通讯线路等任何技术原因而导致用户不能正常升级更新，作者也不承担任何法律责任。
+
+4. Medict 软件尊重并保护所有用户的个人隐私权，不会窃取任何用户计算机中的信息, 亦不会将用户文件上载至互联网服务器。
+
+5. Medict 以 MIT 协议发布, 软件著作权属软件作者所有。

src/renderer/assets/docs/youdao_traslate_config.md

@@ -0,0 +1 @@
+# 有道翻译 API申请与配置

src/renderer/components/FooterBar.vue

@@ -3,22 +3,22 @@
     <span
       class="hyperlink"
       data-href="https://github.com/terasum/medict/"
-      @click="onclickHyperlink"
+      @click="onClickHyperLink"
       >star项目</span
     >
 
     <span class="split-line"></span>
     <span
       class="hyperlink"
       data-href="https://github.com/terasum/medict/issues"
-      @click="onclickHyperlink"
+      @click="onClickHyperLink"
       >问题反馈与建议</span
     >
     <span class="split-line"></span>
     <span
       class="hyperlink"
-      data-href="https://github.com/terasum/medict"
-      @click="onclickHyperlink"
+      data-href="/docs"
+      @click="onClickInternalLink"
       >使用说明</span
     >
   </div>
@@ -36,15 +36,22 @@ export default Vue.extend({
   computed: {},
   watch: {},
   methods: {
-    onclickHyperlink(event: any) {
+    onClickHyperLink(event: any) {
       if (event && event.target) {
         if (event.target.dataset && event.target.dataset.href) {
-          console.log(`clicked ${event.target.dataset.href}`);
           AsyncMainAPI.openUrlOnBrowser(event.target.dataset.href);
         }
       }
       console.log(event);
     },
+    onClickInternalLink(event: any) {
+      if (event && event.target) {
+        if (event.target.dataset && event.target.dataset.href) {
+        this.$router.replace({ path: event.target.dataset.href });
+        }
+      }
+      console.log(event);
+    },
   },
   mounted() {},
 });

src/renderer/routes.ts

@@ -4,6 +4,7 @@ import DictionaryView from './view/Preference/DictionarySettingsView.vue';
 import DebugView from './view/Preference/DebugView.vue';
 import SettingsView from './view/Preference/AppSettings.vue';
 import PluginsWindow from './view/PluginsWindow.vue';
+import DocsWindow from './view/DocsWindow.vue';
 import TranslateWindow from './view/TranslateWindow.vue';
 import AboutView from './view/Preference/AboutView.vue';
 import TranslateSettingView from './view/Preference/TranslateSettingView.vue';
@@ -12,6 +13,7 @@ export default [
   { path: '/', component: MainWindow },
   { path: '/translate', component: TranslateWindow },
   { path: '/plugins', component: PluginsWindow },
+  { path: '/docs', component: DocsWindow },
   {
     path: '/preference',
     component: PreferenceWindow,