# myflow-user-guide

**Repository Path**: myrestop/myflow-user-guide

## Basic Information

- **Project Name**: myflow-user-guide
- **Description**: RunFlow用户操作手册
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: https://myrest.top/zh-cn/guide/myflow/user
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2023-11-07
- **Last Updated**: 2024-05-02

## Categories & Tags

**Categories**: Uncategorized

**Tags**: myrest, runflow, Documentation, guide, user

## README

# Welcome To Our RunFlow User Guide

In this documentation, you will learn our RunFlow's some general rules and tips.

## Introduction

RunFlow is a powerful efficiency tool that can be combined with many plugins, and it's running based on keywords, a keyword mean a function.

You can also pin a keyword to the tab (if keyword support), doing this you don't need always input the keyword to trigger the feature.

> The keyword can be at the front, or the post (but need a whitespace to separate). In RunFlow, we have a feature that is `special keyword`, when a keyword starts with symbol not letter or digit, we mark it as a `special keyword`, and if the `special keyword` worked at the post case, you don't need a whitespace to separate they.

> The keyword `*` mean this function don't need a keyword to trigger, it will always trigger whatever you input.

> If you haven't installed it yet, you can download and install it from [here](https://myrest.top/myflow).

## General Constraints

The example usage in the plugin description page, you may see some special characters, like `[]|{}`, `[]` means an optional parameter, `|` means or,  `{}` means a parameter need user input. And all the usage cases are based on the default keyword (because we allow you to customize keywords).

> Example: `timer [{name}] {date}` means name is a optional parameter, but you must input a date parameter to start a timer.

In searching action, `?` means match one any character, `*` means match any number of characters.

## Hotkey Tips

- press `Alt` to open the result context menu (if result has multiple operations)

- in result list, you can press `Tab` to get the selected result suggestion text.

- for refreshable results, press the arrow `Left` to go back to the previous one, and the arrow `Right` to go forward to the next one

### Switch Pinned Keyword

Use `Alt+LEFT` switch to the previous pinned keyword, `Alt+RIGHT` switch to the next pinned keyword.

And you can also use `Ctrl+{number}` switch to the specified indexed pinned keyword, like `Ctrl+0` switch to the first, `Ctrl+1` switch to the second, `Ctrl+9` switch to the last pinned keyword. And in here, `Alt` has another wonderful usage, press with `Alt`, whether the action window is visible or not, it always shows, for example: `Ctrl+Alt+2`, app will show the action window and switch to the third pinned keyword even if it is hidden.

> In macOS, the `Ctrl` is instead by `Command` key.

## Other Tips

- At action input field, you can input by dragging text or file (ensure the action window is pinned).

- Input multiple line content, you can press `Ctrl+Enter` or `Shift+Enter` to break content to a new line.

- To toggle action window visible, you can press `Windows/Meta+Space` on Windows and Linux, or `Command+Space` on macOS.

- You can customize all the hot events, includes hotkeys, hot corners and CRON expression etc.

- You can import data and export data (before import data, must ensure the database is empty).

- You can let the pinned tab to run in a separate window.

## Sync Data

Go to **Settings** -> **Data Sync**, enable the blew available data sync service(s).

**Local sync service:** is a builtin simple data sync service, we'll write the **encrypted** data change log to your chose directory, and read log also from this directory, so to synchronize data across platforms you also should add the directory to third-party cloud service, like Onedrive, Google Drive, iCloud, Dropbox or any other cloud service providers.

## Focused Mode

This feature need keyword support, you will always work under the function of this keyword without other keywords disturbed while you enter the focused keyword.

To exit the focused mode, you can type `exit` (you can customize this text at general settings page) or press `Esc` key.

## Multi Language Support

Our official app and plugins will support both english and simplified chinese languages, if you are a traditional chinese user, you can install our [Chinese Processor](https://myrest.top/store/plugin?id=top.myrest.myflow.chinese), it can convert simplified chinese to traditional or traditional to simplified.

> We will strongly suggest plugin developer to support english language.

### More Language Request

If you request more languages support, you can go to the [plugin store](https://myrest.top/store/plugin) to find a plugin which suitable for you and support translate language.

> If your language is arranged from right to left, our app ui may not support it very well.

### Scheduled Tasks

In the settings page of hot events, we can use Cron expressions to set scheduled tasks, such as regularly cleaning the computer recycle bin, and recreating file indexes, etc.

Here is a brief explanation of the cron expression:

| second(0-59) | minute(0-59) | hour(0-23) | day-of-month(1-31) | month(1-12) | week(0-7, both 0 and 7 are sunday) | explanation                    |
|--------------|--------------|------------|--------------------|-------------|------------------------------------|--------------------------------|
| 0            | 0            | 12         | *                  | *           | *                                  | executing at 12:00 every day   |
| 0            | 0            | 12         | *                  | *           | 1                                  | executing at 12:00 every month |

> [Learn more information about cron](https://en.wikipedia.org/wiki/Cron).