clash_for_windows_pkg icon indicating copy to clipboard operation
clash_for_windows_pkg copied to clipboard

[Feature Request]: Tip on every setting entry

Open Lemmingh opened this issue 2 years ago • 1 comments

功能描述

Wrandz 在 https://github.com/Fndroid/clash_for_windows_pkg/issues/3421#issuecomment-1242970675 写道:

CFW 有没有可能在按钮的旁边加上一些提示,提示这个功能主要是为了解决哪类问题而加的。

为所有设置项添加悬浮提示。不妨参考 Microsoft Office,呈现:

  • 该设置的概述。

  • 可选值的意义。

  • 文档链接。

2022-09-12_Excel Version 2208 - Options - General

目前,仅 Mixin 有类似的提示:

2022-09-12_CFW 0.20.2 - General - Mixin

背景

CFW 收到过大量的日经问题。用户提交这些 issue 的原因往往是:

  • 找不到文档,读不懂文档。

  • 搜不出已有 issue,不知道该查什么。

如果在 UI 上提供对相关功能的简介,帮助理解,那么,多数用户就能直达解决方案,不必创建新 issue。

其他内容

No response

Lemmingh avatar Sep 12 '22 04:09 Lemmingh

0.20.4 仍然有明显的改进空间。

在面向用户的技术文档中,通常:

  • 使用流畅自然的陈述或祈使语气

  • 写短句

  • 规范拼写

  • 避免读者陌生的缩写(尤其是拉丁缩写)

  • 避免行话(例如,leverage 是行话,而 take advantage of 是人话)

  • 避免字面重复

详见 Chicago Style 和 Microsoft Style。

我提几个建议。

Security > Core Secret

Set Clash Core's secret to a random RFC 4122 version 4 UUID, so that Clash REST API cannot be accessed arbitrarily.

The value is stored in the Home Directory/config.yaml.

For details, see Clash documentation:

General > Settings Editor

Text editor used by Settings.

For Custom, the command should only return control after the edited file is closed. For example:

  • code --wait

  • subl --wait

General > Random Mixed Port

Turn on to generate a new proxy server port number when the app starts.

The value is shown as Port in General, and is stored as mixed-port in the Home Directory/config.yaml.

General > Lightweight Mode

Turn on to terminate app processes after closing the dashboard, but keep Clash Core running in the background. Most of the features provided by CFW will be unavailable then.

Relies on the Service Mode.

For details, see docs.

System Proxy > Type

Windows accepts an HTTP endpoint or PAC (proxy auto-configuration) script. The HTTP mode is generally sufficient.

For details, see:

System Proxy > Bypass Domain/IPNet

Bypass (don't use) the proxy server when visiting certain addresses.

The interpretation of this list is OS-dependent and app-dependent. In other words, your operating systems and applications may evaluate the rules differently.

For details, see:

System Proxy > Specify Protocol

Turn on to forcibly add scheme to the system proxy settings.

This is not for general-purpose use, and indeed violates the current spec of Windows. Consider it only when an old Python program has trouble.

For details, see:

System Proxy > PAC Content

Learn PAC

%mixed-port% is the placeholder of the Port in General.

Profiles > Parsers

Modify and customize your profiles after download but before Diff.

Lemmingh avatar Sep 29 '22 05:09 Lemmingh