recipes
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
recipes [2018/11/28 14:42] – itkachenko | recipes [2021/08/05 13:35] – emozolyak | ||
---|---|---|---|
Line 1: | Line 1: | ||
+ | {{ :: | ||
======Recipes====== | ======Recipes====== | ||
- | The recipe allows you to initialize a set of values to a certain group of registers. There are several options for using recipes: | ||
- | * placing | + | The recipe allows you to initialize |
- | * activation of the recipe | + | * Recipes can be applied either by selecting an entry in the recipe |
+ | * Recipes can be edited right on the dashboard with a quick edit method (not going back to the main recipe | ||
+ | * Recipes can be visible or not for different users. Some recipes can be ' | ||
+ | * Recipe list can be used as a handy tool for analysing user choice from different options. In this case recipe names in the list or category serve as a placeholders | ||
- | Recipes | + | ===== Recipes |
- | {{ : | + | The recipe management |
- | Recipes can have sub-categories, | + | {{ :: |
- | {{ :recipes2.png?direct |category}} | + | The main spots of the recipe management page are: |
+ | - Import/ | ||
+ | - Add recipe button | ||
+ | - Recipe | ||
+ | - ' | ||
+ | - Checkbox for selecting export candidates | ||
+ | - Common (non-locked) recipe list. | ||
+ | - Edit/ | ||
- | And also be available to specific users. | + | {{ :: |
- | {{ : | + | ===== Recipe setup===== |
- | When placing a list of recipes | + | The //Basic// tab: |
+ | ***Title** - this title will be seen in the selection lists and setup page | ||
+ | ***Description** - user comments for the recipe | ||
+ | ***Disable** checkbox - hides this recipe from the list | ||
+ | ***Lock** - prevent the recipe from editing by non-admin users | ||
+ | ***Registers 1..4 / Value / Description** - this set of the registers will be initialized with the respective values upon invoking recipe. The description given here will be used to show the comments in the quick edit window (right | ||
+ | ***Delete** button deletes the register //n// from the list | ||
+ | ***Add register to recipe** button expands the list with a new entry | ||
- | * Category of recipes, or a complete list of all categories | + | {{ :: |
- | * Drop-down or multiline list | + | |
- | * Number of the register where the recipe number will change. (changing this register can be monitored in scripts when you need to perform some actions associated with this recipe) | + | |
- | * Whether to apply the recipe immediately or not (in the second case, only the register number will change where the current recipe number is stored) | + | |
- | {{ :recipe4.png?direct |dashboard}} | + | The // |
+ | {{ :: | ||
- | To apply recipes within scripts, the **ApplyRecipe (recipeId, userId)** function is used. [[http:// | + | ===== Using recipe on the dashboard ===== |
+ | |||
+ | When placing a recipes selection listbox on a dashboard, there are some specific attributes you must specify: | ||
+ | |||
+ | * // | ||
+ | * The // | ||
+ | * '// | ||
+ | * '// | ||
+ | |||
+ | |||
+ | {{ :: | ||
+ | |||
+ | If the user has right to edit the recipe, he can do this right in the selectoin box: | ||
+ | |||
+ | {{ quick_rcp_apply_edit.gif |}} | ||
+ | |||
+ | ===== Using recipes in scripts ===== | ||
+ | |||
+ | To apply recipes within scripts, the **ApplyRecipe (recipeId, userId)** function is used. [[working_with_recipes|See here]]. | ||
+ | |||
+ | <code lua> | ||
+ | function | ||
+ | local id = GetReg(" | ||
+ | ApplyRecipe(id, userId) | ||
+ | AddInfoMessage(" | ||
+ | end | ||
+ | </ | ||
+ | |||
+ | {{ recipe_in_scripts.gif |}} |
recipes.txt · Last modified: 2022/01/15 15:41 by 127.0.0.1