readme

garywill · Nov 13, 2022 · f4c2162 · f4c2162
1 parent 84dfa68
commit f4c2162
Show file tree

Hide file tree

Showing 3 changed files with 47 additions and 27 deletions.
diff --git a/src/README.md b/src/README.md
@@ -34,6 +34,9 @@ Search everywhere 🗺️ for everything 👨‍💻. Breadth & Focus.<br>
       * [More](#more)
       * [Even more: What's special about it](#even-more-whats-special-about-it)
       * [Safety &amp; Privacy](#safety--privacy)
+   * [FAQ](#faq)
+         * [Q: I selected text and used context menu, it won't automatically show popup until I click toolbar button (on some browsers like Chrome)](#q-i-selected-text-and-used-context-menu-it-wont-automatically-show-popup-until-i-click-toolbar-button-on-some-browsers-like-chrome)
+         * [Q: What is "Ajax-render" ?](#q-what-is-ajax-render-)
    * [List of engines](#list-of-engines)
    * [Similar tools &amp; methods comparison](#similar-tools--methods-comparison)
    * [How to edit search engines (GUI or JSON)](#how-to-edit-search-engines-gui-or-json)
@@ -58,6 +61,7 @@ Ways to use:
 
 2. Web App: For demo purpose. Web app can't function fully like extension. Web app can be used on mobile browsers.   Main site: [https://acsearch.ga ![](https://img.shields.io/website?down_message=repairing&style=flat-square&up_color=blue&url=https%3A%2F%2Facsearch.ga)](https://acsearch.ga) | Standby site: [http://acsearch.tk ![](https://img.shields.io/website?down_message=repairing&style=flat-square&up_color=blue&url=http%3A%2F%2Facsearch.tk)](http://acsearch.tk)
 
+
 ## Basic Features Demo and Screenshots
 
 | Use Extension   |  Breadth & Focus   | UI style choosable               |  
@@ -89,9 +93,9 @@ Ways to use:
 - 🖱️ Quickly use **selected text** (single-line or multi-line) as search term
   > - No in Firefox incognito mode ([bug 1380812](https://bugzilla.mozilla.org/show_bug.cgi?id=1380812))
   > - On Chrome, after clicking context menu item, click the icon on toolbar (or use keyboard shortcut) ([defect of Chrome](https://stackoverflow.com/questions/54189283/chrome-extension-open-popup-from-contentscript-file#comment95207111_54189283))
-- ⌨️ **Keyboard shortcut** (browser extension) 
+- ⌨️ **Keyboard shortcut** (browser extension). Default keys (may need changing manually):
   - Open popup. Firefox: `Ctrl+Alt+S`   Chrome & others:`Ctrl+Shift+S` 
-  - Set selected text as search term (then use open popup). Firefox: `Ctrl+Alt+D`  Chrome & others:`Ctrl+Shift+D`
+  - Set selected text as search term (then use "open popup" key). Firefox: `Ctrl+Alt+D`  Chrome & others:`Ctrl+Shift+D`
   > [change on Firefox](https://bug1303384.bmoattachments.org/attachment.cgi?id=9051647) | change on Chrome: `chrome://extensions/shortcuts` 
 - 🖱️ Use in native sidebar (Firefox only)
 - 🖥️ **Desktop** (browser extension & web app) and **mobile** (web app only)
@@ -114,6 +118,16 @@ Ways to use:
 - 🛡️ Hide HTTP Referrer by default to protect user privacy
 - 🛡️ **Client side** functions fully. No necessary server. **No** collecting user's input **nor** ad analyzing. User can even choose to disable analystics completely (analystics already disabled in incognito mode)
 
+## FAQ
+
+#### Q: I selected text and used context menu, it won't automatically show popup until I click toolbar button (on some browsers like Chrome)
+
+A: It's because of [defect of Chrome browser engine](https://stackoverflow.com/questions/54189283/chrome-extension-open-popup-from-contentscript-file#comment95207111_54189283). Please use key combination `Ctrl+Shift+D` then `Ctrl+Shift+S` (you may want to modify them) as workaround
+
+#### Q: What is "Ajax-render" ?
+
+A: "Ajax-render" is short for "**In-page**-submit-form-via-**Ajax**-then-XHR-gets-search-result-then-**render**-and-show-in-page-without-web-frame-navigation"
+
 ## List of engines
 
 60+ , currently. [See list of build-in search engines](https://github.com/garywill/BigSearch/blob/list/list.md#list-of-build-in-search-engines-in-big-search)
@@ -267,7 +281,7 @@ Engine data in full format can contain following key-values (special search meth
 
         "method": "get/post", // # optional. default is get
 
-        "charset": "UTF-8/gb2312/gb18030/big5/iso-xxxx....", // # optional. default UTF-8
+        "charset": "UTF-8/gb2312/gb18030/big5/iso-xxxx....", // # optional. default UTF-8 (NOTICE: full_url not compatible with this
 
         "allow_referer": false, // # false(default)/true optional
 
@@ -339,11 +353,7 @@ This tool still can be improved to do something more:
 
 - Improve the online editing-engine GUI 
 - Omnibox
-- Choose a fast & lightweight framework (any ideas)
-- Desktop stanalone app, opening URL with user-assigned browser
-- Mobile native app (any idea?)
 - Be compatible with others e.g. OpenSearch. Add or convert by 1-click
-- Be able to be used via CLI in terminal (nodejs)
 
 ### Technical Diagram
 

diff --git a/src/README_zh.md b/src/README_zh.md
@@ -26,14 +26,15 @@
 
 <!--ts-->
    * [开始安装使用](#开始安装使用)
-   * [老用户FAQ](#老用户faq)
-      * [Q: Chrome等浏览器中，选择文本后点击右键菜单没反应，还要点击一下工具栏按钮才打开界面](#q-chrome等浏览器中选择文本后点击右键菜单没反应还要点击一下工具栏按钮才打开界面)
    * [基本功能演示与截图](#基本功能演示与截图)
    * [功能及特性](#功能及特性)
       * [基本](#基本)
       * [更多](#更多)
       * [还有更多：特别之处](#还有更多特别之处)
       * [隐私安全](#隐私安全)
+   * [老用户FAQ](#老用户faq)
+         * [Q: Chrome等浏览器中，选择文本后点击右键菜单没反应，还要点击一下工具栏按钮才打开界面](#q-chrome等浏览器中选择文本后点击右键菜单没反应还要点击一下工具栏按钮才打开界面)
+         * [Q: 到底什么是「Ajax-render」?](#q-到底什么是ajax-render)
    * [已收录引擎](#已收录引擎)
    * [相似工具和方法比较](#相似工具和方法比较)
    * [如何编辑搜索引擎（GUI或JSON）](#如何编辑搜索引擎gui或json)
@@ -57,17 +58,6 @@
 
 2. 网页版：演示作用为主，网页版不能像扩展一样完全工作。网页版可在手机浏览器使用。 主站： [https://acsearch.ga ![](https://img.shields.io/website?down_message=repairing&style=flat-square&up_color=blue&url=https%3A%2F%2Facsearch.ga)](https://acsearch.ga) | 备用站： [http://acsearch.tk ![](https://img.shields.io/website?down_message=repairing&style=flat-square&up_color=blue&url=http%3A%2F%2Facsearch.tk)](http://acsearch.tk)
 
-## 老用户FAQ
-
-<details>
-<summary>我是老用户，点击展开</summary>
-
-### Q: Chrome等浏览器中，选择文本后点击右键菜单没反应，还要点击一下工具栏按钮才打开界面
-
-A: 这是[仅Chrome内核浏览器有的缺陷](https://stackoverflow.com/questions/54189283/chrome-extension-open-popup-from-contentscript-file#comment95207111_54189283)。请在选择了文本后，使用按键组合`Ctrl+Shift+D`然后`Ctrl+Shift+S`来作为暂时的快捷操作
-
-</details>
-
 ## 基本功能演示与截图
 
 | 使用扩展    |  可深可广   | UI风格可选 | 
@@ -99,9 +89,9 @@ A: 这是[仅Chrome内核浏览器有的缺陷](https://stackoverflow.com/questi
 - 🖱️ 将**选择**的文本(单行或多行)作为搜索词
   > - Firefox无痕模式中无 ([bug 1380812](https://bugzilla.mozilla.org/show_bug.cgi?id=1380812)).
   > - Chrome中点了右键菜单后，再点击工具栏中的图标（或使用快捷键） （[Chrome的缺陷](https://stackoverflow.com/questions/54189283/chrome-extension-open-popup-from-contentscript-file#comment95207111_54189283)）
-- ⌨️ **快捷键**（浏览器扩展）
+- ⌨️ **快捷键**（浏览器扩展）。默认为（可能需自行修改）：
   - 唤出界面。Firefox: `Ctrl+Alt+S`  Chrome及其他：`Ctrl+Shift+S` 
-  - 将选择文本设定为搜索词（然后再使用唤出界面）。Firefox: `Ctrl+Alt+D`  Chrome及其他：`Ctrl+Shift+D`
+  - 将选择文本设定为搜索词（然后再使用“唤出界面”）。Firefox: `Ctrl+Alt+D`  Chrome及其他：`Ctrl+Shift+D`
   > [Firefox更改](https://bug1303384.bmoattachments.org/attachment.cgi?id=9051647) | Chrome更改 `chrome://extensions/shortcuts` 
 - 🖱️ 在原生侧边栏里使用（仅Firefox）
 - 🖥️ **桌面**（扩展或网页）和**移动**（网页）
@@ -124,6 +114,17 @@ A: 这是[仅Chrome内核浏览器有的缺陷](https://stackoverflow.com/questi
 - 🛡️ **不**向网页注入任何代码（除搜索Ajax-render网站时外）
 - 🛡️ **纯客户端**功能完整，不需服务器。**无**搜集用户搜索内容，**无**广告兴趣分析。甚至用户可以选择完全禁止统计（无痕模式下已自动禁止）
 
+## 老用户FAQ
+
+#### Q: Chrome等浏览器中，选择文本后点击右键菜单没反应，还要点击一下工具栏按钮才打开界面
+
+A: 这是[仅Chrome内核浏览器有的缺陷](https://stackoverflow.com/questions/54189283/chrome-extension-open-popup-from-contentscript-file#comment95207111_54189283)。请在选择了文本后，使用按键组合`Ctrl+Shift+D`然后`Ctrl+Shift+S`(可能需自行修改)来作为暂时的快捷操作
+
+#### Q: 到底什么是「Ajax-render」?
+
+A: 「Ajax-render」是 **In-page**-submit-form-via-**Ajax**-then-XHR-gets-search-result-then-**render**-and-show-in-page-without-web-frame-navigation 的简称
+
+
 ## 已收录引擎
 
 目前 90+ 。[查看收录引擎列表](https://github.com/garywill/BigSearch/blob/list/list.md#list-of-build-in-search-engines-in-big-search)
@@ -278,7 +279,7 @@ JSON格式。
 
         "method": "get/post",  // # 可选 默认为get
 
-        "charset": "UTF-8/gb2312/gb18030/big5/....", // # 可选 默认UTF-8
+        "charset": "UTF-8/gb2312/gb18030/big5/....", // # 可选 默认UTF-8 (注意：不支持full_url)
 
         "allow_referer": false, // # false(default)/true 可选
 
@@ -351,11 +352,7 @@ JSON格式。
 
 - 完善编辑引擎的在线GUI 
 - Omnibox 
-- 选一个快又小的框架（any ideas?）
-- 套壳做个桌面app，调用用户指定的浏览器
-- 手机原生App（any ideas?)
 - 兼容OpenSearch等，一键自动添加或转换
-- 在终端内调用的CLI（nodejs）
 
 ### 技术框图
 

diff --git a/src/robots.txt b/src/robots.txt
@@ -0,0 +1,13 @@
+User-agent: *
+Allow: /$
+Allow: /index.php$
+Allow: /index.html$
+Disallow: /search.php$
+Disallow: *.js$
+Disallow: *.css$
+Disallow: *?
+Disallow: *
+
+User-agent: ia_archiver
+Disallow: /
+Disallow: *