GoldenDict-ng

https://github.com/xiaoyifang/goldendict-ng
Admin
GoldenDict-ng is an advanced dictionary lookup program supporting many dictionary formats with...
Tokens:18,200
Snippets:296
Trust Score:7.8
License:GPL-3.0
Update:1 month ago
Show doc for...
Tokens:
Raw
### Build component and examples

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/thirdparty/qtsingleapplication/INSTALL.TXT

Standard build commands for the component and its examples.

```bash
qmake
make          [or nmake if your are using Microsoft Visual C++]
```

--------------------------------

### Start local development server

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/README.md

Run this command to start the MkDocs development server and preview the documentation locally.

```bash
mkdocs serve
```

--------------------------------

### Initialize virtual environment and install dependencies

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/README.md

Use these commands to set up the Python virtual environment and install the required mkdocs-material theme.

```bash
cd ./website
python3 -m venv ./venv/
source ./venv/bin/activate
# source ./venv/bin/activate.fish
pip3 install mkdocs-material
```

--------------------------------

### Install SoMaJo dependency

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/how to add a program as dictionary.md

Install the required Python library for the tokenizer script.

```bash
pip install -U SoMaJo
```

--------------------------------

### Build Qt Designer plugin

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/thirdparty/qtsingleapplication/INSTALL.TXT

Commands to build and install the Qt Designer plugin.

```bash
qmake
make           [or nmake if your are using Microsoft Visual C++]
```

--------------------------------

### Metadata File Placement Example

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/manage_groups.md

Example file structure showing the placement of metadata.toml files alongside dictionary files.

```text
.
├── Cambridge
│    ├── metadata.toml     (A)
│    ├── Cambridge.idx
│    ├── Cambridge.info
│    ├── Cambridge.syn
│    └── Cambridge.dict.dz
└── Collins
     ├── metadata.toml
     ├── res.zip
     └── Collins.dsl       (B)
```

--------------------------------

### Build Project with CMake

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/build_from_source.md

Standard commands to configure, build, and install the project using CMake.

```shell
cd goldendict-ng && mkdir build_dir
# config step
cmake -S . -B build_dir
      -G "Ninja"/"Unix Makefiles"/"Xcode"...  (Optional)
      --install-prefix=/usr/local/            (Optional)
      -DCMAKE_BUILD_TYPE=Release              (Optional)

# actual build
cmake --build build_dir
      --parallel 7  (Optional if Ninja was chosen)

cmake --install ./build_dir/
```

--------------------------------

### Install Debian/Ubuntu Dependencies

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/build_from_source.md

Installs the required development libraries and build tools on Debian-based systems.

```shell
sudo apt-get install build-essential ninja-build \
libvorbis-dev zlib1g-dev libhunspell-dev x11proto-record-dev \
libxtst-dev liblzo2-dev libbz2-dev libavutil-dev libavformat-dev \
libeb16-dev libzstd-dev libxkbcommon-dev libxapian-dev libzim-dev \
libopencc-dev libfmt-dev qt6-5compat-dev qt6-base-dev qt6-multimedia-dev \
qt6-speech-dev qt6-svg-dev qt6-tools-dev qt6-tools-dev-tools \
qt6-webchannel-dev qt6-webengine-dev
```

--------------------------------

### URL Scheme Example

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/cli.md

Example of using the URL scheme to trigger a popup lookup.

```text
goldendict://hello?target=popup
```

--------------------------------

### Install OCR Dependencies

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/ocr.md

Command to install Tesseract and screenshot utilities on Ubuntu or Debian systems.

```bash
sudo apt update
sudo apt install tesseract-ocr tesseract-ocr-eng tesseract-ocr-chi-sim  spectacle
```

--------------------------------

### Configure VCPKG Dependency Management

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Handles vcpkg toolchain setup on Windows, including fetching dependencies if not already configured.

```cmake
if (WIN32)
    option(WITH_VCPKG_BREAKPAD "build with Breakpad support for VCPKG build only" OFF)
    if (DEFINED CMAKE_TOOLCHAIN_FILE)
        message(STATUS "Using toolchain file: ${CMAKE_TOOLCHAIN_FILE}")
    else ()
        message(STATUS "CMAKE_TOOLCHAIN_FILE is not set. Try fetching cached vcpkg.")
        include(FetchContent)
        FetchContent_Declare(
                vcpkg-export
                URL https://github.com/xiaoyifang/goldendict-ng/releases/download/vcpkg_260318_7de07c3862ae2154bd78b92044bb99af6c523917/goldendict-ng-vcpkg-export.zip
                URL_HASH SHA512=0E1268CA82DB28C16373ACCA71797F9061ED88ACDBA983783F4AD501D4B767D129D6B4E24A0EE95D868350707BEC28B9A4654307343E314E459CBE2D0185DCD9
        )
        FetchContent_MakeAvailable(vcpkg-export)
        set(VCPKG_MANIFEST_MODE OFF CACHE BOOL "disable existing manifest mode caused by the existrance of vcpkg.json" FORCE)
        set(CMAKE_TOOLCHAIN_FILE "${CMAKE_BINARY_DIR}/_deps/vcpkg-export-src/scripts/buildsystems/vcpkg.cmake")
    endif ()
    if (WITH_VCPKG_BREAKPAD)
        list(APPEND VCPKG_MANIFEST_FEATURES "breakpad")
    endif ()
endif ()
```

--------------------------------

### Folder Structure for Auto Grouping

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/manage_groups.md

Example directory layout demonstrating how dictionary files are organized into parent folders for automatic grouping.

```text
.
├── English<>Chinese
│   ├── Cambridge
│   │   ├── Cambridge.dict.dz
│   │   ├── Cambridge.idx
│   │   ├── Cambridge.info
│   │   └── Cambridge.syn
│   ├── Collins
│   │   ├── Collins.dsl
│   │   └── res.zip
│   └── Oxford
│       ├── Oxford.css
│       ├── Oxford.mdd
│       └── Oxford.mdx
└── English<>Russian
    ├── dsl
    │   ├── dictA.dsl
    │   └── dictB.dsl
    └── zim
        ├── Wikipedia_ru.slob
        └── Wikipedia.zim
```

```text
.
├─epistularum
│   └─Japanese   <- Group
│       └─DictA  <- Dict Files's container folder
|          └─ DictA Files
├─Mastameta
│   └─Japanese   <- Group
|       └─DictB  <- Dict Files's container folder
|          └─ DictB Files
```

--------------------------------

### Configure Flatpak Environment Variables

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_wayland.md

Use the flatpak override command to force X11 mode for the Flatpak installation.

```bash
# Force X11 mode for Flatpak
flatpak override --env=GOLDENDICT_FORCE_XCB=1 io.github.xiaoyifang.goldendict_ng
```

--------------------------------

### Custom System Shortcut Command

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_wayland.md

Example command for binding a system-level shortcut to trigger a lookup in GoldenDict.

```bash
goldendict "selection"
```

--------------------------------

### Configure Qt Path for Windows

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/build_from_source.md

Specifies the Qt installation directory for CMake on Windows systems.

```shell
-DCMAKE_PREFIX_PATH=F:\Qt\6.4.1\msvc2019_64
```

--------------------------------

### Google Breakpad Symbol File Format

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/how to use breadpad crash analysis.md

Example content of a symbol file generated by dump_syms, showing the module and code ID information.

```text
MODULE windows x86_64 904B2C52C1EC411D9D0271445CAD6DCD2 GoldenDict.pdb
INFO CODE_ID 645510C96CC000 GoldenDict.exe
```

--------------------------------

### Clean Build Artifacts

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/thirdparty/qtsingleapplication/INSTALL.TXT

Execute this command to remove files placed outside the package directory during installation and building.

```bash
make distclean [or nmake if your are using Microsoft Visual C++]
```

--------------------------------

### Configure CMake Prefix Path for VS Code

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/developer.md

Use this argument in the CMake Tools extension configuration to point to the Qt installation directory.

```cmake
-DCMAKE_PREFIX_PATH={Your Qt install path}\6.7.2\msvc2019_64
```

--------------------------------

### Customize Interface Styles

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_userstyle.md

Example Qt Style Sheet rules for modifying the GoldenDict application interface, such as toolbars, buttons, and input fields.

```css
/* Change main window background */
QMainWindow {
  background-color: #f0f0f0;
}

/* Change toolbar style */
QToolBar {
  background-color: #333;
  border: none;
  padding: 4px;
}

/* High contrast toolbar buttons */
QToolBar QPushButton {
  background-color: #4CAF50;
  color: white;
  border: 2px solid #388E3C;
  border-radius: 4px;
  padding: 6px 12px;
  font-weight: bold;
  min-width: 80px;
}

QToolBar QPushButton:hover {
  background-color: #45a049;
  border-color: #2E7D32;
}

QToolBar QPushButton:pressed {
  background-color: #388E3C;
  border-color: #1B5E20;
}

/* Change general button style */
QPushButton {
  background-color: #3498db;
  color: white;
  border: none;
  border-radius: 3px;
  padding: 5px 10px;
  font-weight: bold;
}

QPushButton:hover {
  background-color: #2980b9;
}

/* Change input box style */
QLineEdit {
  border: 1px solid #bdc3c7;
  border-radius: 3px;
  padding: 5px;
  background-color: white;
}

/* Change list and tree view style */
QListWidget, QTreeWidget {
  background-color: white;
  border: 1px solid #bdc3c7;
  border-radius: 3px;
}

QListWidget::item:selected, QTreeWidget::item:selected {
  background-color: #bbdefb;
  color: #2c3e50;
}
```

--------------------------------

### Injecting Interactive Functionality into Dictionary Articles

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_userstyle.md

This script demonstrates DOM manipulation, event handling, and UI injection within dictionary articles. It includes examples for audio button effects, link behavior modification, custom toolbar creation, and global text highlighting.

```javascript
// Execute when page is loaded
window.addEventListener('DOMContentLoaded', function() {
  // Example 1: Add click effect to all audio buttons
  const audioButtons = document.querySelectorAll('.playSound');
  audioButtons.forEach(button => {
    button.addEventListener('click', function() {
      // Add click animation effect
      this.style.transform = 'scale(0.95)';
      setTimeout(() => {
        this.style.transform = 'scale(1)';
      }, 100);
    });
  });

  // Example 2: Add new window opening functionality to all links
  const links = document.querySelectorAll('a');
  links.forEach(link => {
    link.setAttribute('target', '_blank');
    link.setAttribute('rel', 'noopener noreferrer');
  });

  // Example 3: Add custom toolbar
  const toolbar = document.createElement('div');
  toolbar.style.cssText = `
    position: fixed;
    top: 10px;
    right: 10px;
    background: rgba(255, 255, 255, 0.9);
    padding: 5px;
    border-radius: 5px;
    box-shadow: 0 2px 5px rgba(0,0,0,0.2);
    z-index: 1000;
  `;
  
  const button = document.createElement('button');
  button.textContent = 'Toggle Theme';
  button.style.cssText = `
    padding: 5px 10px;
    border: none;
    border-radius: 3px;
    background: #3498db;
    color: white;
    cursor: pointer;
  `;
  
  button.addEventListener('click', function() {
    document.body.classList.toggle('dark-theme');
  });
  
  toolbar.appendChild(button);
  document.body.appendChild(toolbar);
});

// Example 4: Define global function for other scripts to use
function highlightText(text) {
  const elements = document.querySelectorAll('p, span, div');
  elements.forEach(element => {
    if (element.textContent.includes(text)) {
      element.innerHTML = element.innerHTML.replace(
        new RegExp(text, 'gi'),
        '<mark style="background-color: yellow;">$&</mark>'
      );
    }
  });
}
```

--------------------------------

### Integrate component into project

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/thirdparty/qtsingleapplication/INSTALL.TXT

Add this line to your .pro file to include the component.

```qmake
include(your-install-dir/some-package/src/some-package.pri)
```

--------------------------------

### Create Script File

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/ocr.md

Command to initialize the script file using the Nano text editor.

```bash
nano ~/ocr_translate.sh
```

--------------------------------

### Initialize Project and Standards

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Sets project version, language standards, and platform-specific language requirements.

```cmake
file(READ "VERSION" PROJECT_VERSION_ST)
string(STRIP "${PROJECT_VERSION_ST}" PROJECT_VERSION_ST)
project(goldendict-ng
        VERSION ${PROJECT_VERSION_ST}
        LANGUAGES CXX C)

if (APPLE)
    enable_language(OBJCXX)
    set(CMAKE_OBJCXX_STANDARD 17)
endif ()

set(CMAKE_C_STANDARD 17)
set(CMAKE_CXX_STANDARD 17)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
```

--------------------------------

### Configure Qt from source with proprietary codec support

Source: https://github.com/xiaoyifang/goldendict-ng/wiki/Useful-links

Use this command to configure a custom Qt build on Windows that includes support for MP4 and other proprietary codecs.

```bash
 configure -opensource -confirm-license -verbose -platform win32-msvc2019 -release -mp -icu -qt-pcre -qt-zlib -openssl -opengl dynamic -qt-freetype -qt-harfbuzz -qt-libpng -qt-libjpeg -no-sql-mysql -qt-sqlite -qt-tiff -qt-webp -webengine-proprietary-codecs -nomake tests -nomake examples -prefix "E:\Qt\Qt5.15.2_custom\5.15.2\msvc2017_64" -skip qtdoc -skip qtquickcontrols -skip qtscript -skip qtxmlpatterns -I D:\tools\icu4c-69_1-Win64-MSVC2019\include -L D:\tools\icu4c-69_1-Win64-MSVC2019\lib64 -I D:\tools\OpenSSL-Win64\include -L D:\tools\OpenSSL-Win64\lib
```

--------------------------------

### Register Documentation for Qt Versions Prior to 4.4

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/thirdparty/qtsingleapplication/INSTALL.TXT

Use these commands in a terminal to register the documentation file for older Qt Assistant versions.

```bash
cd your-install-dir/some-package/doc/html/
assistant -addContentFile some-package.dcf
```

--------------------------------

### Configure Qt Dependencies

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Finds required Qt6 components and sets up the standard project environment.

```cmake
set(GD_QT_COMPONENTS Concurrent Core5Compat LinguistTools Multimedia PrintSupport WebEngineWidgets Widgets Svg Xml)

if (WITH_TTS)
    list(APPEND GD_QT_COMPONENTS TextToSpeech)
endif ()

find_package(Qt6 6.2 REQUIRED COMPONENTS ${GD_QT_COMPONENTS})

qt_standard_project_setup()
set(CMAKE_AUTORCC ON) # not included in the qt_standard_project_setup
```

--------------------------------

### Configure VLC for Linux/macOS

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/ui_audioengine.md

Uses the dummy interface to play audio without a GUI window.

```bash
vlc --intf dummy --play-and-exit --no-video
```

--------------------------------

### Run host programs via flatpak-spawn

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_flatpak.md

Use flatpak-spawn to execute commands on the host system from within the Flatpak sandbox.

```bash
flatpak-spawn --host --directory=${the external program's pwd will be set to this value} ${The actual commands}
```

```bash
flatpak-spawn --host --directory=. trans -no-ansi %GDWORD%
```

--------------------------------

### Hide website element via external script

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_website_scripting.md

Example of a JavaScript file content used to hide a specific banner element on a website.

```javascript
// Example: Hide a specific element
document.addEventListener('DOMContentLoaded', function() {
    var element = document.getElementById('annoying-banner');
    if (element) {
        element.style.display = 'none';
    }
});
```

--------------------------------

### CLI Usage

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/cli.md

Command line interface for controlling GoldenDict-ng startup behavior.

```APIDOC
## CLI Usage

### Description
Control GoldenDict-ng behavior at startup using command line arguments.

### Usage
`goldendict [options] [word]`

### Options
- `--help` / `-h`: Show help message and exit
- `--version` / `-v`: Print version and diagnosis info
- `--log-to-file` / `-l`: Save debug messages to gd_log.txt
- `--reset-window-state` / `-r`: Reset window state to defaults
- `--no-tts`: Disable Text-to-Speech
- `--group-name <name>` / `-g`: Change dictionary group for main window
- `--popup-group-name <name>` / `-p`: Change dictionary group for popup window
- `--scanpopup` / `-s`: Force word translation in popup window
- `--popup`: Alias for --scanpopup
- `--main-window` / `-m`: Force word translation in main window
- `--toggle-popup` / `-t`: Toggle the scan popup window

### Positional Arguments
- `word`: Word or sentence to query at startup
```

--------------------------------

### Define Third-Party Sources

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Lists source files for the QtSingleApplication library.

```cmake
set(QSINGLEAPP_SOURCE_FILES
        thirdparty/qtsingleapplication/src/qtlocalpeer.cpp
        thirdparty/qtsingleapplication/src/qtlocalpeer.h
        thirdparty/qtsingleapplication/src/qtsingleapplication.cpp
        thirdparty/qtsingleapplication/src/qtsingleapplication.h
)
```

--------------------------------

### Modify website background via direct script

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_website_scripting.md

Example of direct JavaScript code entered into the Script column to change the body background color.

```javascript
document.addEventListener('DOMContentLoaded', function() {
    document.body.style.backgroundColor = '#f0f0f0';
});
```

--------------------------------

### Define Addon Styles Directory Structure

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_userstyle.md

Create a styles directory within the configuration folder to organize multiple theme variants.

```text
.
├── config
└── styles
    ├── dark
    │   ├── article-style.css
    │   └── qt-style.css
    └── light
        ├── article-style.css
        └── qt-style.css
```

--------------------------------

### Customize Dictionary Article Styles

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_userstyle.md

Example CSS rules for modifying the appearance of dictionary entries, including background colors, typography, and UI elements like audio buttons.

```css
/* Change article background color */
body {
  background-color: #f5f5f5;
  color: #333;
}

/* Change heading styles */
h1, h2, h3 {
  color: #2c3e50;
  font-family: Arial, sans-serif;
  margin-top: 1em;
  margin-bottom: 0.5em;
}

/* Change dictionary entry style */
.article {
  padding: 10px;
  border-radius: 5px;
  background-color: #fff;
  box-shadow: 0 1px 3px rgba(0,0,0,0.1);
}

/* Change link style */
a {
  color: #3498db;
  text-decoration: none;
}

a:hover {
  text-decoration: underline;
}

/* Change audio button style */
.playSound {
  background-color: #e74c3c;
  color: white;
  border: none;
  border-radius: 3px;
  padding: 2px 6px;
  cursor: pointer;
}

.playSound:hover {
  background-color: #c0392b;
}

/* Change definition list style */
dl {
  margin: 0;
  padding: 0;
}

dt {
  font-weight: bold;
  margin-top: 0.5em;
}

dd {
  margin-left: 1em;
  margin-bottom: 0.5em;
}

/* Change example sentences style */
.example {
  font-style: italic;
  color: #7f8c8d;
  margin-left: 1em;
}
```

--------------------------------

### Copy plugin DLL for Visual Studio

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/thirdparty/qtsingleapplication/INSTALL.TXT

Path reference for manually copying the plugin DLL.

```text
%QTDIR%\plugins\designer\some-component.dll
```

```text
C:\Program Files\Trolltech\Qt VS Integration\plugins
```

--------------------------------

### Configure FFplay for Windows

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/ui_audioengine.md

Requires an absolute path to the FFplay executable.

```cmd
"C:\ffmpeg\bin\ffplay.exe" -autoexit -nodisp
```

--------------------------------

### Configure MPV for Windows

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/ui_audioengine.md

Requires an absolute path to the MPV executable.

```cmd
"C:\Program Files\mpv\mpv.exe" --no-video --no-audio-display --no-config
```

--------------------------------

### Create a Python tokenizer script

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/how to add a program as dictionary.md

A script that accepts a word as a command-line argument and prints tokenized output.

```python
from somajo import SoMaJo
import sys

tokenizer = SoMaJo("de_CMC", split_camel_case=True)

# note that paragraphs are allowed to contain newlines
paragraphs = [sys.argv[1]]
sentences = tokenizer.tokenize_text(paragraphs)
for sentence in sentences:
    for token in sentence:
        if token.token_class=='regular':
            print(f"{token.text}")
```

--------------------------------

### Include header files

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/thirdparty/qtsingleapplication/INSTALL.TXT

Standard ways to include component headers in source files.

```cpp
#include <SomeClass>
```

```cpp
#include <some-class.h>
```

--------------------------------

### Configure Windows Specifics

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Sets the Windows application icon resource file.

```cmake
if (WIN32)
    set(WINDOWS_ICON_RC icons/programicon.rc)
endif ()
```

--------------------------------

### Configure UI Search Paths

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Sets the search path for automatic UI file discovery.

```cmake
set(CMAKE_AUTOUIC_SEARCH_PATHS "${CMAKE_CURRENT_SOURCE_DIR}/src/ui/")
```

--------------------------------

### Configure VLC for Windows

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/ui_audioengine.md

Requires an absolute path to the executable on Windows systems.

```cmd
"C:\Program Files\VideoLAN\VLC\vlc.exe" --intf dummy --play-and-exit --no-video
```

--------------------------------

### Basic CLI Usage

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/cli.md

General syntax for invoking the GoldenDict-ng executable with options and a target word.

```bash
goldendict [options] [word]
```

--------------------------------

### Link Libraries

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Configures Qt and platform-specific libraries for the target.

```cmake
target_link_libraries(${GOLDENDICT} PRIVATE
        Qt6::Xml
        Qt6::Concurrent
        Qt6::Core5Compat
        Qt6::Multimedia
        Qt6::PrintSupport
        Qt6::WebEngineWidgets
        Qt6::Widgets
        Qt6::Svg
        $<$<BOOL:${WITH_TTS}>:Qt6::TextToSpeech>
        $<$<PLATFORM_ID:Windows>:dwmapi>
)
```

--------------------------------

### Configure MPV for Linux/macOS

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/ui_audioengine.md

Plays audio without video output or configuration file loading.

```bash
mpv --no-video --no-audio-display --no-config
```

--------------------------------

### Configure macOS Specifics

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Handles macOS source files and application icon resources.

```cmake
if (APPLE)
    file(GLOB_RECURSE MACOS_SOURCE_FILES CONFIGURE_DEPENDS src/**/*.mm)

    set(MACOS_APP_ICON ${CMAKE_SOURCE_DIR}/icons/macicon.icns)
    set_source_files_properties(${MACOS_APP_ICON} PROPERTIES MACOSX_PACKAGE_LOCATION "Resources")
endif ()
```

--------------------------------

### Configure FFplay for Linux/macOS

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/ui_audioengine.md

Plays audio automatically and exits upon completion without displaying a window.

```bash
ffplay -autoexit -nodisp
```

--------------------------------

### Custom Dictionary Icon File Structure

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/dictformats.md

Place the icon file with the same basename as the main dictionary file in the same directory.

```text
.
├── My_best_dictionary.mdx <- the main dictionary file
└── My_best_dictionary.svg <- the icon
```

--------------------------------

### Set Include Directories

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Specifies header search paths for the project.

```cmake
target_include_directories(${GOLDENDICT} PRIVATE
        ${PROJECT_SOURCE_DIR}/thirdparty/qtsingleapplication/src
        ${PROJECT_SOURCE_DIR}/src/
        ${PROJECT_SOURCE_DIR}/src/common
        ${PROJECT_SOURCE_DIR}/src/dict
        ${PROJECT_SOURCE_DIR}/src/dict/utils
        ${PROJECT_SOURCE_DIR}/src/ui
)
```

--------------------------------

### Reset window state

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/cli.md

Restore the application window state to default settings.

```bash
goldendict --reset-window-state
```

--------------------------------

### Define Build Options

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Configures optional features for the build process, such as multimedia support and platform-specific flags.

```cmake
option(WITH_FFMPEG_PLAYER "Enable support for FFMPEG player. Note: This is useless for Qt >= 6.8" ON)
option(WITH_QT_MULTIMEDIA "Enable support for Qt Multimedia player" ON)
option(WITH_EPWING_SUPPORT "Enable epwing support" ON)
option(WITH_ZIM "enable zim support" ON)
option(WITH_TTS "enable QTexttoSpeech support" OFF)

option(WITH_X11 "Experimental flag. Don't disable this. Disable means pure Wayland." ON)

# options for linux packaging


## This should be avoided because of small regressions, as some scripts and icons themes assume the binary name and resources folder to be `goldendict`
option(USE_ALTERNATIVE_NAME "For Linux, change the binary name and resource folder to goldendict-ng to parallel install with the original GD" OFF)
```

--------------------------------

### Force XWayland / X11 Mode

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_wayland.md

Run the application in X11 mode to enable global hotkeys and the Scan Flag feature.

```bash
env GOLDENDICT_FORCE_XCB=1 goldendict
```

--------------------------------

### Discover Source Files

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Recursively finds source files with automatic dependency tracking.

```cmake
file(GLOB_RECURSE ALL_SOURCE_FILES CONFIGURE_DEPENDS src/*.cc src/*.hh src/*.ui src/*.c)
```

--------------------------------

### Create a directory junction on Windows using cmd

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_move_index_folder.md

Use the mklink command with the /J switch to create a directory junction, which does not require administrator privileges.

```bat
mklink /J "C:\Users\USERNAME\Application Data\GoldenDict\index" "D:\gd-ng\index_new"
```

--------------------------------

### Manage Translation Files

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Locates translation files, sets their output directory based on the platform, and processes them using Qt tools.

```cmake
# include all *ts files under locale
file(GLOB TRANS_FILES "locale/*.ts")

if (WIN32)
    # Put generated files to output dir's locale
    set_source_files_properties(${TRANS_FILES} PROPERTIES OUTPUT_LOCATION "${GD_WIN_OUTPUT_DIR}/locale")
else ()
    set_source_files_properties(${TRANS_FILES} PROPERTIES OUTPUT_LOCATION "${CMAKE_CURRENT_BINARY_DIR}/locale")
endif ()

qt_add_translations(${GOLDENDICT} TS_FILES ${TRANS_FILES}
        QM_FILES_OUTPUT_VARIABLE qm_files
        LUPDATE_OPTIONS "-no-ui-lines -locations none -no-obsolete")

add_dependencies(${GOLDENDICT} "release_translations")
```

--------------------------------

### Query a word in main window

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/cli.md

Perform a lookup for a specific word directly in the main application window.

```bash
goldendict hello
```

--------------------------------

### Enable debug logging

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/cli.md

Save debug output to a log file named gd_log.txt in the configuration directory.

```bash
goldendict --log-to-file
```

--------------------------------

### Unpack archive on Windows

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/thirdparty/qtsingleapplication/INSTALL.TXT

Command to extract the package using infozip tools on Windows.

```bash
cd your-install-dir
unzip some-package.zip
```

--------------------------------

### List of default OpenCC configuration files

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/how to customize the opencc.md

The currently supported OpenCC configuration files used by GoldenDict-ng.

```text
s2tw.json
s2hk.json
t2s.json
```

--------------------------------

### Define Executable and Sources

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Adds the executable target and associates all source files and resources.

```cmake
qt_add_executable(${GOLDENDICT})

target_sources(${GOLDENDICT} PRIVATE
        icons/flags.qrc
        resources.qrc
        src/scripts/scripts.qrc
        src/stylesheets/css.qrc
        ${ALL_SOURCE_FILES}
        ${MACOS_SOURCE_FILES}
        ${MACOS_APP_ICON}
        ${QSINGLEAPP_SOURCE_FILES}
        ${WINDOWS_ICON_RC}
)
```

--------------------------------

### Configure Qt Compiler Definitions

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Sets compiler definitions for Qt compatibility and strict mode based on the detected Qt version.

```cmake
# Disable deprecated staffs for Qt<=6.7 (Bump this if ever consider bump Qt version)
target_compile_definitions(${GOLDENDICT} PRIVATE
        QT_DISABLE_DEPRECATED_UP_TO=0x060700
        QT_NO_DEPRECATED_WARNINGS
)

# make life harder https://doc.qt.io/qt-6/qtglobal.html#QT_ENABLE_STRICT_MODE_UP_TO
if (Qt6Widgets_VERSION VERSION_GREATER_EQUAL 6.8.2)
    target_compile_definitions(${GOLDENDICT} PRIVATE
            QT_ENABLE_STRICT_MODE_UP_TO=0x060800
    )
endif ()
```

--------------------------------

### Remove Documentation for Qt Versions Prior to 4.4

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/thirdparty/qtsingleapplication/INSTALL.TXT

Use these commands in a terminal to remove the documentation file for older Qt Assistant versions.

```bash
cd your-install-dir/some-package/doc/html/
assistant -removeContentFile some-package.dcf
```

--------------------------------

### Analyze Crash Dumps with Google minidump_stackwalk

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/how to use breadpad crash analysis.md

Command to process the dump file against the organized symbols directory.

```text
minidump_stackwalk.exe  -s a.dmp symbols > a.txt
```

--------------------------------

### Generate Version Information

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Uses Git to determine the current build hash and branch, writing the information to version.txt.

```cmake
block() # generate version.txt
    string(TIMESTAMP build_time UTC)
    find_package(Git)
    set(GIT_HASH "")
    if (EXISTS "${CMAKE_SOURCE_DIR}/.git" AND GIT_FOUND)
        execute_process(
                COMMAND ${GIT_EXECUTABLE} -C "${CMAKE_SOURCE_DIR}" rev-parse --short=10 HEAD
                OUTPUT_STRIP_TRAILING_WHITESPACE
                OUTPUT_VARIABLE GIT_HASH)
        execute_process(
                COMMAND ${GIT_EXECUTABLE} -C "${CMAKE_SOURCE_DIR}" rev-parse --abbrev-ref HEAD
                OUTPUT_STRIP_TRAILING_WHITESPACE
                OUTPUT_VARIABLE GIT_BRANCH)
    endif ()
    
    if (GIT_HASH)
        file(WRITE "${CMAKE_SOURCE_DIR}/version.txt" "${PROJECT_VERSION}-${GIT_HASH} (${GIT_BRANCH}) at ${build_time}")
    else ()
        file(WRITE "${CMAKE_SOURCE_DIR}/version.txt" "${PROJECT_VERSION} at ${build_time}")
    endif ()
endblock()
```

--------------------------------

### List exported document paths

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_flatpak.md

List directories exported to the Flatpak application via the file chooser.

```bash
flatpak documents --columns=id,origin,application
```

--------------------------------

### GNOME Screenshot Command

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/ocr.md

Alternative screenshot command for GNOME desktop environments.

```bash
gnome-screenshot -a -f /tmp/tmp.just_random_name.png
```

--------------------------------

### Analyze Crash Dumps with Mozilla/Rust Tools

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/how to use breadpad crash analysis.md

Use dump_syms to generate symbol files and minidump-stackwalk to process the crash dump into a readable text file.

```sh
.\dump_syms.exe goldendict.pdb > goldendict.sym

.\minidump-stackwalk.exe .\crash.dmp .\goldendict.sym > f.txt
```

--------------------------------

### Configuration Folder Structure

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_userstyle.md

The expected layout of files within the GoldenDict configuration directory.

```text
.
├── config
├── article-style.css
├── article-style-print.css (affecting styles when printing)
├── article-script.js
└── qt-style.css
```

--------------------------------

### Make Script Executable

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/ocr.md

Command to grant execution permissions to the created shell script.

```bash
chmod +x ~/ocr_translate.sh
```

--------------------------------

### Unpack archive on Unix/Mac

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/thirdparty/qtsingleapplication/INSTALL.TXT

Commands to extract the package on Unix-based systems.

```bash
cd your-install-dir
gunzip some-package.tar.gz
tar xvf some-package.tar
```

--------------------------------

### Force Native Wayland Mode

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_wayland.md

Explicitly set the environment variable to run the application as a native Wayland client.

```bash
env GOLDENDICT_FORCE_WAYLAND=1 goldendict
```

--------------------------------

### Directory Structure for Google Breakpad Analysis

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/howto/how to use breadpad crash analysis.md

Required folder hierarchy for organizing the dump file and symbol files when using Google's minidump_stackwalk.

```text
GoldDict.exe
a.dmp                 (A)
symbols
└─GoldenDict.pdb    (B)
    └─904B2C52C1EC411D9D0271445CAD6DCD2   (C)
         └─GoldenDict.sym
```

--------------------------------

### Metadata Configuration for Auto Grouping

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/manage_groups.md

TOML configuration file format used to define dictionary categories for automatic grouping.

```toml
categories = [ "English", "Russian", "Chinese" ]

# the following `langfrom` , `langto` fields have not been supported yet.
[metadata]
name = "New Name"
langfrom = "English"
langto = "Russian"
```

```toml
categories = ["en-zh", "汉英词典"]
```

```toml
categories = ["图片词典", "en-zh", "汉英词典"]
```

--------------------------------

### Manage directory junctions on Windows using PowerShell

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/website/docs/topic_move_index_folder.md

Use the New-Item cmdlet to create a junction and Remove-Item to delete the link without affecting the target files.

```powershell
New-Item -ItemType Junction -Path "C:\Users\USERNAME\Application Data\GoldenDict\index" -Target "D:\gd-ng\index_new"
```

```powershell
Remove-Item "C:\Users\USERNAME\Application Data\GoldenDict\index"
```

--------------------------------

### Include Platform-Specific Dependencies

Source: https://github.com/xiaoyifang/goldendict-ng/blob/staged/CMakeLists.txt

Conditionally includes dependency and packaging scripts based on the target operating system.

```cmake
if (LINUX OR BSD)
    include(cmake/Deps_Linux.cmake)
    include(cmake/Package_Linux.cmake)
elseif (WIN32)
    include(cmake/Deps_Vcpkg.cmake)
    include(cmake/Package_Windows.cmake)
else ()
    include(cmake/Deps_macOS.cmake)
    include(cmake/Package_macOS.cmake)
endif ()

feature_summary(WHAT ALL DESCRIPTION "Build configuration:")
```
Tokens:
Raw