From 01fff0783f9a9807d9282ba49c92dcb68f00ef38 Mon Sep 17 00:00:00 2001 From: vabene1111 Date: Tue, 29 Jul 2025 18:04:40 +0200 Subject: [PATCH] additions to help page --- vue3/src/components/dialogs/HelpDialog.vue | 138 ++++++++++++++++++++- 1 file changed, 135 insertions(+), 3 deletions(-) diff --git a/vue3/src/components/dialogs/HelpDialog.vue b/vue3/src/components/dialogs/HelpDialog.vue index a4725cbd0..d7daa4782 100644 --- a/vue3/src/components/dialogs/HelpDialog.vue +++ b/vue3/src/components/dialogs/HelpDialog.vue @@ -22,8 +22,15 @@ - - + + + + + + + + + @@ -58,7 +65,8 @@

All your data is stored in a Space where you can invite other people to collaborate on your recipe database. Typcially the members of a space belong to one family/household/organization.

-

While everyone can access all recipes by default, Books, Shopping Lists and Mealplans are not shared by default. You can share them with other members of your space +

While everyone can access all recipes by default, Books, Shopping Lists and Mealplans are not shared by default. You can share them with other + members of your space using the settings.

You can create and be a member of multiple spaces. Switch between them freely using the navigation or space settings. Depending @@ -70,6 +78,130 @@ {{ $t('Invites') }} + +

Recipes are the foundation of your Tandoor space. A Recipe has one or more steps that contain ingredients, instructions and other information. + Ingredients in turn consist of an amount, a unit and a food, allowing recipes to be scaled, nutrition's to be calculated and shopping to be organized. +

+ +

Besides manually creating them you can also import them from various different places. +

+

Recipes, by default, are visible to all members of your space. Setting them to private means only you can see it. After setting it to private you + can manually specify the people who should be able to view the recipe. + You can also create a share link for the recipe to share it with everyone that has access to the link. +

+

+ + {{ $t('Create') }} + {{ $t('Search') }} + + + +

The Recipe importer is one of the most powerful features of Tandoor and allows you to quickly add recipes in multiple different ways. +

+ +

The easiest is to import from a URL. If that is not enough you can also import from an Image or PDF file using AI. +

+

If you already have an existing Recipe database in another format there is also a good chance Tandoor will have an + importer for that program. +

+

+ + {{ $t('Import') }} + + + +

Units allow you to measure how much of something you need in a recipe or on a shopping list. + They are also essential for the calculation of Properties. +

+ +

Setting a base unit allows you to name your Unit however you want (e.g. grams, g, G, gram) while allowing Tandoor + to automatically convert between the units in the same system (weight/volume, e.g. from g to kg or from cup to pint). +

+

Additionally you can use custom unit conversion to convert between volume and weight trough the specific density + of a food (e.g. 1 cup of flour = 120 g). These conversions are used to calculate the Properties for a Recipe + and might allow cosmetic display changes later. +

+ + + + {{ $t('Unit') }} + + + {{ $t('Conversion') }} + + + + +

Foods have multiple uses in Tandoor. Their most important task is to be part of recipe ingredients together with an amount and + a unit. +

+ +

Using the Food editor you can also add properties to a food or link the food to another recipe or external URL. +

+

Foods are also used or created when adding entries to the shopping list. +

+ + + + {{ $t('Food') }} + + + + +

Keywords are a very flexible Tool to help you organize your recipe collection. + Keywords can quickly be created when editing a Recipe by just typing into the Keywords field or they can + be created trough the Keyword Editor. +

+ +

Typical keywords include meal types (breakfast, lunch, dinner, ...), couise (american, italian, ...) or diet (vegan, vegetarian, ..). + +

+

Tip: Using Emojis in Keywords makes them easy to recognize. +

+ + + + {{ $t('Keyword') }} + + + + +

A Recipe consists of multiple Steps. +

+ +

Each Step has Ingreditens (which are at least a Food but typically consist of amount, + Unit and Food). A Step can also contain instuctions, times, files or link to another Recipe. +

+

Additionally a Recipe can have Properties, Comments, Keywords and more. +

+ + + + + +

The Properties system allows you to add additional data to your Foods and Recipes in the respective editors. + Most commonly you would use this to add nutrition facts but the system can also be used to track prices, + dietary points or any other kind of property. +

+ +

You first need to create the Property Types that you need (e.g. Carbohydrates, Sugar, Price, Points, ..). + Setting the FDC ID for a Property Type allows Tandoor to connect your custom Property Type to a property in the FDC database. + You can then go to a Food, set its FDC ID and Tandoor can automatically pull the properties you want from the FDC database. +

+

When adding a Property to the Recipe it will just be staticly displayed in the Recipe view. + Adding properties to a Foods will allow Tandoor to calculate the properties for all the Ingredients in a Recipe based + on the Foods and their respective Units and Amounts. +

+ +

Food Properties are entered based on a certain amount of food (often 100 g). Unit Conversions allow Tandoor to + calculate the property amount if a Food is given in a different unit (e.g. 1kg or 1 cup). +

+ + + {{ $t('Property') }} + + +