Skip to content

Commit

Permalink
feature/add_united_entry_doc (#2298)
Browse files Browse the repository at this point in the history
* add macos detailed build documentation

* feature/add_united_entry_doc
  • Loading branch information
feloxx authored Nov 26, 2022
1 parent 7ad46f3 commit 563440f
Show file tree
Hide file tree
Showing 21 changed files with 454 additions and 282 deletions.
75 changes: 75 additions & 0 deletions en_us/docs/Users/United Entry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
# United Entry

VNote supports not only `search` in the left navigation bar, but also quick search in the `United Entry` in a command only way.

Use an `Entry command` + `Search criteria` can quickly search notes folder or notes and files.

## Activation

By default, the shortcut key `Ctrl+G, G` is used to activate it. After triggering, you can see the following interface:

You can also change the `"UnitedEntry": "Ctrl+G, G"` in the configuration file to replace it with the shortcut you are used to.

![](vx_images/440002199826920.png)

When entering the corresponding `Entry command`, the unified entrance will be automatically filtered, and the effect is as follows:

![](vx_images/290853408616012.png)

After entering a command, adding a `Space` will trigger a two-paragraph display, usually for detailed help.


![](vx_images/469734231941763.png)

![](vx_images/21594495890167.png)

## Command Introduction

VNote provides the following `Entry command` to complete the quick query.

| Entry Command | Description |
| ------------- | ---------------------------------------------------- |
| a | Search for files by content in all notebooks |
| c | Search for files by tag in current notebook |
| d | Search for files by content in current notebook |
| e | Search for folders/files by name in current notebook |
| f | Search for files by content in current folder |
| find | Search for files in notebook |
| g | Search for files by content in buffers |
| help | help |
| q | Search for folders/files by name in all notebooks |
| r | Search for folders/files by name in current folder |
| t | Search for files by name in buffers |
| v | Search for files by tag in current folder |
| w | Search for notebooks by name in all notebooks |
| z | Search for files by tag in all notebooks |

## Example

Find all folders/files containing `02` in all notebooks:

![](vx_images/403493324576809.png)

Find the file containing `task` in the current buffer:

![](vx_images/229624223123287.png)

Search all notebooks for notes containing the keyword `interface`:

![](vx_images/78884071937631.png)

Search all tags for notes that belong to the keyword `java` tag:

![](vx_images/123313881807817.png)

## Location

<mark>WARNING! This varies by operating system.</mark>

### macos

When the search result is found, you need to press the `Tab` key, move the cursor position to the search result bar below, and then press `Enter` to locate the corresponding target.

### windows

After the search in win, it will stay in the first place in the result bar by default. You can directly press `Enter` to locate the first place. You can also move and reposition.
292 changes: 151 additions & 141 deletions en_us/docs/Users/vx.json
Original file line number Diff line number Diff line change
@@ -1,141 +1,151 @@
{
"created_time": "2018-11-24T11:06:19Z",
"files": [
{
"attachment_folder": "",
"created_time": "2018-11-24T11:05:58Z",
"id": "5",
"modified_time": "2021-07-11T08:59:08Z",
"name": "Welcome.md",
"signature": "115802545470579",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:08:25Z",
"id": "6",
"modified_time": "2021-07-11T09:02:39Z",
"name": "Why VNote.md",
"signature": "105073717165171",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:09:23Z",
"id": "7",
"modified_time": "2021-07-12T12:41:51Z",
"name": "Get Started.md",
"signature": "24504425659507",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:22:16Z",
"id": "15",
"modified_time": "2021-07-13T12:08:47Z",
"name": "Frequently Asked Questions.md",
"signature": "20733444373619",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2022-04-09T01:41:06Z",
"id": "55",
"modified_time": "2022-04-09T01:56:04Z",
"name": "Data Migration.md",
"signature": "177743127602",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:13:02Z",
"id": "8",
"modified_time": "2021-07-12T12:50:26Z",
"name": "Notes Management.md",
"signature": "120883491781747",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2021-07-12T00:48:35Z",
"id": "9",
"modified_time": "2021-07-12T01:40:43Z",
"name": "Configuration.md",
"signature": "99992770854003",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:15:19Z",
"id": "10",
"modified_time": "2021-07-11T09:41:37Z",
"name": "Snippet.md",
"signature": "72273051925619",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:17:11Z",
"id": "11",
"modified_time": "2021-07-11T09:44:41Z",
"name": "Template.md",
"signature": "42783806471283",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:18:17Z",
"id": "12",
"modified_time": "2022-08-12T13:11:39Z",
"name": "Themes and Styles.md",
"signature": "2110466178163",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2021-08-14T00:40:43Z",
"id": "13",
"modified_time": "2021-08-14T01:11:21Z",
"name": "Image Host.md",
"signature": "12865064287347",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2021-08-29T03:24:23Z",
"id": "14",
"modified_time": "2021-08-29T03:44:20Z",
"name": "Export.md",
"signature": "51292136684659",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2021-12-23T07:29:06Z",
"id": "49",
"modified_time": "2021-12-27T04:00:43Z",
"name": "Task.md",
"signature": "177733903682",
"tags": [
]
}
],
"folders": [
],
"id": "4",
"modified_time": "2021-05-12T12:13:25Z",
"signature": "23349079456883",
"version": 3
}
{
"created_time": "2018-11-24T11:06:19Z",
"files": [
{
"attachment_folder": "",
"created_time": "2018-11-24T11:05:58Z",
"id": "5",
"modified_time": "2021-07-11T08:59:08Z",
"name": "Welcome.md",
"signature": "115802545470579",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:08:25Z",
"id": "6",
"modified_time": "2021-07-11T09:02:39Z",
"name": "Why VNote.md",
"signature": "105073717165171",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:09:23Z",
"id": "7",
"modified_time": "2021-07-12T12:41:51Z",
"name": "Get Started.md",
"signature": "24504425659507",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:22:16Z",
"id": "15",
"modified_time": "2021-07-13T12:08:47Z",
"name": "Frequently Asked Questions.md",
"signature": "20733444373619",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2022-04-09T01:41:06Z",
"id": "55",
"modified_time": "2022-04-09T01:56:04Z",
"name": "Data Migration.md",
"signature": "177743127602",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:13:02Z",
"id": "8",
"modified_time": "2021-07-12T12:50:26Z",
"name": "Notes Management.md",
"signature": "120883491781747",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2021-07-12T00:48:35Z",
"id": "9",
"modified_time": "2021-07-12T01:40:43Z",
"name": "Configuration.md",
"signature": "99992770854003",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:15:19Z",
"id": "10",
"modified_time": "2021-07-11T09:41:37Z",
"name": "Snippet.md",
"signature": "72273051925619",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:17:11Z",
"id": "11",
"modified_time": "2021-07-11T09:44:41Z",
"name": "Template.md",
"signature": "42783806471283",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2018-11-24T12:18:17Z",
"id": "12",
"modified_time": "2022-08-12T13:11:39Z",
"name": "Themes and Styles.md",
"signature": "2110466178163",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2021-08-14T00:40:43Z",
"id": "13",
"modified_time": "2021-08-14T01:11:21Z",
"name": "Image Host.md",
"signature": "12865064287347",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2021-08-29T03:24:23Z",
"id": "14",
"modified_time": "2021-08-29T03:44:20Z",
"name": "Export.md",
"signature": "51292136684659",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2021-12-23T07:29:06Z",
"id": "49",
"modified_time": "2021-12-27T04:00:43Z",
"name": "Task.md",
"signature": "177733903682",
"tags": [
]
},
{
"attachment_folder": "",
"created_time": "2022-11-26T09:17:13Z",
"id": "65",
"modified_time": "2022-11-26T09:37:43Z",
"name": "United Entry.md",
"signature": "207324035799449",
"tags": [
]
}
],
"folders": [
],
"id": "4",
"modified_time": "2021-05-12T12:13:25Z",
"signature": "23349079456883",
"version": 3
}
Binary file added en_us/docs/Users/vx_images/123313881807817.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en_us/docs/Users/vx_images/21594495890167.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en_us/docs/Users/vx_images/229624223123287.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en_us/docs/Users/vx_images/290853408616012.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en_us/docs/Users/vx_images/403493324576809.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en_us/docs/Users/vx_images/440002199826920.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en_us/docs/Users/vx_images/469734231941763.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added en_us/docs/Users/vx_images/78884071937631.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified vx_notebook/notebook.db
Binary file not shown.
Loading

0 comments on commit 563440f

Please sign in to comment.