update docs

README.md

@@ -4,9 +4,7 @@
 [![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=xiaoyifang_goldendict&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=xiaoyifang_goldendict)
 [![Build](https://github.com/xiaoyifang/goldendict-ng/actions/workflows/PR-check-cmake.yml/badge.svg)](https://github.com/xiaoyifang/goldendict-ng/actions/workflows/PR-check-cmake.yml)
 
-The Next Generation GoldenDict. A feature-rich open-source dictionary lookup program,
+GoldenDict-ng is an advanced dictionary lookup program, supporting [many formats](https://xiaoyifang.github.io/goldendict-ng/dictformats/).
-supporting [multiple dictionary formats](https://xiaoyifang.github.io/goldendict-ng/dictformats/) and online
-dictionaries.
 
 | Linux | Windows | macOS |
 |--|--|--|
@@ -20,7 +18,7 @@ dictionaries.
 
 [General discussions](https://github.com/xiaoyifang/goldendict-ng/discussions)
 
-# Some significant features of this fork
+# Some features compared to the original GoldenDict
 
 - webengine with latest html/css feature support
 - support >4GB dictionary

redist/io.github.xiaoyifang.goldendict_ng.metainfo.xml

@@ -14,10 +14,8 @@
   </categories>
   <description>
     <p>
-      GoldenDict-ng is a feature-rich dictionary lookup program, supporting multiple
+      GoldenDict-ng is a advanced dictionary lookup program, supporting many
-      dictionary formats, featuring perfect article rendering with the complete
+      dictionary formats.
-      markup, illustrations and other content retained, and allowing you to type
-      in words without any accents or correct case.
     </p>
   </description>
   <screenshots>

thirdparty/breakpad/Readme.md

@@ -1,2 +0,0 @@
-This is is a placeholder for breakpad.
-the lib and include files will be copied here with vcpkg.

website/docs/dictformats.md

@@ -34,7 +34,7 @@ Various special "dictionaries" can be added, such as Programs, TTS, Morphology,
 
 ### Converting between formats
 
-Goldendict does not provide any dictionary modification functionality.
+GoldenDict-ng does not provide any dictionary modification functionality.
 
 To convert between formats, try tools like [pyglossary](https://github.com/ilius/pyglossary).
 

website/docs/feedbacks.md

@@ -8,7 +8,7 @@ Report any bugs & dysfunctions to [issues list](<https://github.com/xiaoyifang/g
 
 Attach your version info in menu "About" -> "Copy version info".
 
-Goldendict can be started with "--log-to-file" that will creates "gd_log.txt" in configuration folder and store various warnings, errors and debug messages.
+GoldenDict-ng can be started with "--log-to-file" that will creates "gd_log.txt" in configuration folder and store various warnings, errors and debug messages.
 
 On windows, try open command line and starts goldendict with `goldendict --log-to-file`.
 

website/docs/howto/how to build ffmpeg for visual studio.md

@@ -1,32 +0,0 @@
-# Use vcpkg to build ffmpeg(on Windows).
-
-Steps:
-
-1. follow the instructions at https://trac.ffmpeg.org/wiki/CompilationGuide/vcpkg
-
-   
-2. run the command 
-```
-vcpkg.exe install ffmpeg[core,avcodec,avdevice,avfilter,avformat,speex,avresample,mp3lame,opus,sdl2,swresample,vorbis]:x64-windows-rel 
-```
-
-3. copy dll and libs in vcpkg\installed\x64-windows-rel to goldendict's winlibs\lib\msvc
-
-**Pros**: Can be compiled with speex.
-
-# Alternative method 
-simply download ffmpeg from the official website: https://github.com/BtbN/FFmpeg-Builds/releases
-Then replace the dlls and libs in the winlibs\lib\msvc.
-
-**Cons**: Seems to be missing libspeex or I just downloaded the wrong package.
-
-**Pros**: Easy to manage.
-
-
-## conan
-  
-  conan does not seem to have the libspeex option yet.
-
-
-## Links worth checking
-https://stackoverflow.com/a/44556505/968188

website/docs/howto/how to customize the opencc.md

@@ -16,6 +16,6 @@ t2s.json
 
 ![image](https://user-images.githubusercontent.com/105986/192209129-ebc9efe7-ce82-4d4d-ad52-1b3c33eaf270.png)
 
-3. search `丑` in Goldendict-ng will also show the result of `美`
+3. search `丑` in GoldenDict-ng will also show the result of `美`
 
 any other valid opencc configuration solutions should also work here.

website/docs/howto/how to debug dictionary js.md

@@ -1,27 +1,14 @@
-# How to debug dictionary javascript
-
-- [How to debug dictionary javascript](#how-to-debug-dictionary-javascript)
-  - [background](#background)
-  - [goldendict-ng inspector](#goldendict-ng-inspector)
-  - [How to navigate to the specified element](#how-to-navigate-to-the-specified-element)
-  - [Modify the css style](#modify-the-css-style)
-  - [check javascript events](#check-javascript-events)
-  - [reproduce the issue in the goldendit](#reproduce-the-issue-in-the-goldendit)
-
-
 ## background
 When some js functions do not work as expected, this article tries to give a debug solution to pinpoint the problem.
 
+## Web inspector (DevTools)
 
-
+GoldenDict-ng has embedded an inspector, which is actually [chromium's DevTools](https://developer.chrome.com/docs/devtools). You can trigger it manually using `F12`.
-## goldendict-ng inspector
-
-Goldendict-ng has embedded an inspector, you can trigger it manually using `F12`.
 
 Screenshot:
 ![Inspector](../img/inspector.png)
 
-## How to navigate to the specified element
+## Navigate to the specified element
 
 Click the find element and move mouse to the specified element, click the element will navigate the source panel to the very place.
 ![steps](../img/inspector-steps.png)
@@ -32,7 +19,7 @@ you can play around with the css to modify the appearance of the html and check
 
 ![style](../img/inspector-style.png)
 
-## check javascript events
+## Check javascript events
 
 - navigate to the specified element
 - check eventlisterner panel
@@ -47,7 +34,7 @@ If some desired event does not triggered , it can first check does the event lis
 ![breakpoint](../img/inspector-breakpoint.png)
 
 
-## reproduce the issue in the goldendit
+## Reproduce the issues
 
 following your normal operations and debugging the javascript code and pay attention to the console output. Whether any errors happened.
 ![Alt text](../img/inspector-console.png)

website/docs/howto/how to use .clang-format to format the code.md

@@ -1,30 +0,0 @@
-# Goal
-
-
-the project has included a .clang-format as the code guideline.
-
-# How to use this file
-
-
-## CommandLine
-
-Stash changes via `git add files` then `git-clang-format`
-
-<https://clang.llvm.org/docs/ClangFormat.html#git-integration>
-
-## QtCreator:
-
-Check the steps in the following webpage.
-https://doc.qt.io/qtcreator/creator-indenting-code.html#automatic-formatting-and-indentation
-
-## Visual Studio(Newer Version)
-
-visual studio will automatically detect this file and apply the format guideline.
-
-
-# Fix  warnings reported by SonarCloud
-
-After PR submitted , a SonarCloud analysis will take place. Fix all the warnings introduced by your PR.
-Previous code may also have many warnings ,can be left alone.
-![image](https://user-images.githubusercontent.com/105986/226776188-e23c4da0-4ea5-4c53-86eb-5a3da971b691.png)
-

website/docs/howto/how to use breadpad crash analysis.md

@@ -1,7 +1,7 @@
 Introduction
 ----------------------
 
-Goldendict-ng has provide an option to build the application with [breakpad](https://docs.sentry.io/platforms/native/guides/breakpad/)
+GoldenDict-ng has provide an option to build the application with [breakpad](https://docs.sentry.io/platforms/native/guides/breakpad/)
 
 `CONFIG+=use_breakpad` to enable this feature.
 

website/docs/index.md

@@ -1,6 +1,18 @@
-This is the Next Generation GoldenDict.
+GoldenDict-ng is an advanced dictionary lookup program.
 
-The Best Multi-format Cross-platform Open-Source Dictionaries Lookup Program.
+## Features
+
+* Supports many dictionary formats, such as MDX, DSL, StarDict, Zim...
+* Presents lookup results of multiple dictionaries in the same page
+* Supports special types of "dictionaries", such as external program, website, audio files...
+* Lots of auxiliary features
+    * Popup window
+    * Full text search
+    * Anki integration
+    * Transliteration for some languages
+    * Word stemming and spelling correction via Hunspell's morphology analysis 
+    * Unicode case, diacritics, punctuation and whitespace folding (e.g. typing 'Grussen' would yield 'grüßen' in German dictionaries).
+    * ...
 
 ## Screenshots
 On Windows 11 with default theme:
@@ -18,3 +30,5 @@ On Linux with custom Qt color theme
 ## Project history
 
 This project is forked from the original GoldenDict which was developed at <http://goldendict.org/>
+
+The `-ng` in name means "next generation".

website/docs/install.md

@@ -4,7 +4,7 @@
 
 ## Download
 
-Goldendict-ng is available pre-built for Windows and macOS. It is available in a few Linux/Unix repos and FlatHub.
+GoldenDict-ng is available pre-built for Windows and macOS. It is available in a few Linux/Unix repos and FlatHub.
 
 * [Latest stable version](https://github.com/xiaoyifang/goldendict/releases/latest) 
 * [Pre-release test builds](https://github.com/xiaoyifang/goldendict/releases).
@@ -16,7 +16,7 @@ Because it is open source, you can always [build it for yourself](howto/build_fr
 Choose either
 
 * `****-installer.exe ` for traditional installer experience
-* `****.7z` for simply unzip and run experience
+* `****-installer.7z` for simply unzip and run experience
 
 If Qt's version is not changed, you can also download a single `goldendict.exe` and drop it into previous installation's folder (If uncertain, don't do this).
 
@@ -27,10 +27,9 @@ Requires Windows 10 (1809 or later).
 <a href='https://flathub.org/apps/io.github.xiaoyifang.goldendict_ng'><img width='240' alt='Download on Flathub' src='https://dl.flathub.org/assets/badges/flathub-badge-en.svg'/></a>
 
 * See the right side for available packages in various Linux distros.
-* In Gnu Guix, goldendict-ng is available at the [ajattix repository](https://codeberg.org/hashirama/ajattix)
 * In Debian 12 and Ubuntu 23.04, `goldendict-webengine` is available (For later versions it is `goldendict-ng`).
-* Pre-built binary is also available from [archlinuxcn's repo](https://github.com/archlinuxcn/repo/tree/master/archlinuxcn/goldendict-ng-git).
+* For ArchLinux, pre-built binary is available from [archlinuxcn's repo](https://github.com/archlinuxcn/repo/tree/master/archlinuxcn/goldendict-ng-git).
-* [Gentoo package from PG_Overlay](https://gitlab.com/Perfect_Gentleman/PG_Overlay/-/blob/master/app-text/goldendict/goldendict-9999-r6.ebuild)
+* [Gentoo package from PG_Overlay](https://gitlab.com/Perfect_Gentleman/PG_Overlay/-/tree/master/app-text/goldendict-ng)
 
 Minimum supported "Linux" versions is supposedly the current Ubuntu LTS or Debian's old stable or Qt6.4.
 
@@ -38,7 +37,7 @@ Minimum supported "Linux" versions is supposedly the current Ubuntu LTS or Debia
 
 Uses one of the `.dmg` installers in the [Download](#download).
 
-Requires at least macOS 12.
+Requires at least macOS 13.
 
 ## Versioning and Releasing
 

website/docs/manage_sources.md

@@ -24,7 +24,7 @@ GoldenDict will scan these folders and add found dictionaries into dictionaries
 
 Similar to Files, you can either add a folder which contains sound files or a `.zip` archive which contains the sound files.
 
-Goldendict will search through the sound file names when querying words.
+GD will search through the sound file names when querying words.
 
 ## Morphology
 

website/docs/topic_anki.md

@@ -46,9 +46,9 @@ the back template
 
 ## Using URI schemes
 
-`goldendict://word` link can be use to query a word directly on Goldendict.
+`goldendict://word` link can be use to query a word directly on GoldenDict-ng.
 
-On your Anki card's template, you can add the code below to have a "1 click open in Goldendict" card.
+On your Anki card's template, you can add the code below to have a "1 click open in GoldenDict-ng" card.
 
 ```
 <a href="goldendict://{{Front}}">{{Front}}</a>

website/docs/topic_gd-tools.md

@@ -1,28 +0,0 @@
-# GoldenDict tools
-
-A set of helpful programs to enhance goldendict for immersion learning.
-
-
-# prerequisite
-1. install [gd-tools](https://codeberg.org/hashirama/gd-tools) and configure it according to its README
-
-# features:
-- japanese sentence spliting, making each part of the sentence clickable
-![Alt](https://codeberg.org/hashirama/gd-tools/raw/branch/main/misc/marisa.gif)
-
-## How to setup:
-Open GoldenDict, press "Edit" > "Dictionaries" > "Programs" and add the installed executables. Set type to html. Command Line: gd-tools <name of the program> --word %GDWORD% --sentence %GDSEARCH%. Optionally add arguments, such as: gd-tools marisa --word %GDWORD% --sentence %GDSEARCH% . These programs are treated as dictionaries and you can add them under "Dictionaries" or "Groups".
-<br><br>
-please notice that gd-tools does works in windows, and we have an [installer](https://www.mediafire.com/file/h1v7owj7np9j7wg/gd-tools_windows.zip/file) for it, you can install and then come back to the previous instruction.
-And if you're at Gnu Guix, install it from our [channel](https://codeberg.org/hashirama/ajattix) <br><br>
-other features:
-- kanji stroke order: for those who want to know how to write a character
-- image searching
-and much more, please see our list [here](https://codeberg.org/hashirama/gd-tools/src/branch/main/README.md#table-of-contents)
-
-# Misc
-we have a mandarin version of gd-marisa, which relies on mecab (unix only) : <br><br>
-![image](https://codeberg.org/hashirama/gd-tools/raw/branch/main/misc/mandarin.png)
-
-# Notes
-This article was written by 柱間(developer of gd-tools).

website/docs/topic_userstyle.md

@@ -25,7 +25,7 @@ Under GoldenDict's configuration folder, you can create a "styles" folder for "A
 Folder structure like below will create two “addon” styles to switch in settings -> appearances.
 
 ```
-.    <- Goldendict's configuration folder
+.    <- GD's configuration folder
 ├── config
 └── styles
     ├── dark

website/mkdocs.yml

@@ -50,15 +50,12 @@ nav:
   - Related tools:
       - Anki Integration: topic_anki.md
       - OCR Integration: howto/ocr.md
-      - gd-tools: topic_gd-tools.md
   - Report Bugs & Feedbacks: feedbacks.md
   - Development Info:
     - Start develop: developer.md
     - Build from source: howto/build_from_source.md
     - Architecture: architecture.md
     - Customize the opencc: howto/how to customize the opencc.md
-    - Use .clang-format: howto/how to use .clang-format to format the code.md
     - Breadpad crash analysis: howto/how to use breadpad crash analysis.md
-    - Build ffmpeg on Windows: howto/how to build ffmpeg for visual studio.md
     - Update the crowdin.ts file: howto/how to update crowdin.ts file.md