Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
shenlebantongying committed Oct 23, 2024
1 parent c846c5d commit 3622bb6
Show file tree
Hide file tree
Showing 17 changed files with 20 additions and 133 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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,
supporting [multiple dictionary formats](https://xiaoyifang.github.io/goldendict-ng/dictformats/) and online
dictionaries.
GoldenDict-ng is an advanced [multi-format](https://xiaoyifang.github.io/goldendict-ng/dictformats/) dictionary lookup program.

| Linux | Windows | macOS |
|--|--|--|
Expand Down
File renamed without changes.
2 changes: 0 additions & 2 deletions thirdparty/breakpad/Readme.md

This file was deleted.

2 changes: 1 addition & 1 deletion website/docs/dictformats.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).

Expand Down
2 changes: 1 addition & 1 deletion website/docs/feedbacks.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`.

Expand Down
32 changes: 0 additions & 32 deletions website/docs/howto/how to build ffmpeg for visual studio.md

This file was deleted.

2 changes: 1 addition & 1 deletion website/docs/howto/how to customize the opencc.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
23 changes: 5 additions & 18 deletions website/docs/howto/how to debug dictionary js.md
Original file line number Diff line number Diff line change
@@ -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 inspector

Goldendict-ng has embedded an inspector, you can trigger it manually using `F12`.
GoldenDict-ng has embedded an inspector, which is actually [chromium's DevTools](DevTools). 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)
Expand All @@ -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
Expand All @@ -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)
30 changes: 0 additions & 30 deletions website/docs/howto/how to use .clang-format to format the code.md

This file was deleted.

2 changes: 1 addition & 1 deletion website/docs/howto/how to use breadpad crash analysis.md
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
4 changes: 1 addition & 3 deletions website/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,4 @@
This is the Next Generation GoldenDict.

The Best Multi-format Cross-platform Open-Source Dictionaries Lookup Program.
GoldenDict-ng is an advanced multi-format dictionaries lookup program.

## Screenshots
On Windows 11 with default theme:
Expand Down
11 changes: 5 additions & 6 deletions website/docs/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand All @@ -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).

Expand All @@ -27,18 +27,17 @@ 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).
* [Gentoo package from PG_Overlay](https://gitlab.com/Perfect_Gentleman/PG_Overlay/-/blob/master/app-text/goldendict/goldendict-9999-r6.ebuild)
* 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/-/tree/master/app-text/goldendict-ng)

Minimum supported "Linux" versions is supposedly the current Ubuntu LTS or Debian's old stable or Qt6.4.

## macOS

Uses one of the `.dmg` installers in the [Download](#download).

Requires at least macOS 12.
Requires at least macOS 13.

## Versioning and Releasing

Expand Down
2 changes: 1 addition & 1 deletion website/docs/manage_sources.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions website/docs/topic_anki.md
Original file line number Diff line number Diff line change
Expand Up @@ -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>
Expand Down
28 changes: 0 additions & 28 deletions website/docs/topic_gd-tools.md

This file was deleted.

2 changes: 1 addition & 1 deletion website/docs/topic_userstyle.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
3 changes: 0 additions & 3 deletions website/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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

0 comments on commit 3622bb6

Please sign in to comment.