Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

GraFx/Genie #217

Merged
merged 20 commits into from
Nov 7, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
8281874
removed banner
BramVerniest Jul 5, 2023
d2f1d46
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Jul 6, 2023
ffe895b
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Jul 27, 2023
7914653
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Aug 1, 2023
20bdc2d
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Aug 3, 2023
3192428
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Aug 15, 2023
6a77f31
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Aug 15, 2023
590c645
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Aug 16, 2023
3537195
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Aug 28, 2023
50e6f8f
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Aug 28, 2023
bdaf66f
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Sep 6, 2023
1e49de3
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Sep 11, 2023
9adba55
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Sep 12, 2023
ef17ff6
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Sep 25, 2023
df84753
Merge branch 'main' of https://github.com/chili-publish/grafx-documen…
BramVerniest Oct 16, 2023
f13e9f3
correction for fonts
BramVerniest Oct 16, 2023
5031723
Genie in action
BramVerniest Oct 16, 2023
61e2327
remove helper functions from this branch
BramVerniest Oct 18, 2023
5c4c25d
grafx-geniet and changed icons
BramVerniest Nov 7, 2023
f90b987
Merge branch 'main' into GraFx/Genie
BramVerniest Nov 7, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/GraFx-Fonts/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,4 @@ erDiagram
GraFx-Publisher-Fonts {
has fonts
}
```
```
Binary file modified docs/GraFx-Studio/concepts/actions/actioncode.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion docs/GraFx-Studio/concepts/actions/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,6 @@ The second tab in the Trigger popup screen shows the Action editor.

Enter your JavaScript code that should be executed.

![screenshot](actioncode.png)
![image](actioncode.png)

See further [How to create an action](/GraFx-Studio/guides/actions/create/) and [Intro to writing JavaScript](/GraFx-Studio/guides/actions/javascript/)
Binary file added docs/GraFx-Studio/concepts/grafx-genie/action.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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 docs/GraFx-Studio/concepts/grafx-genie/genie2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
57 changes: 57 additions & 0 deletions docs/GraFx-Studio/concepts/grafx-genie/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
# GraFx Genie for Actions (experimental)

!!! example "Experimental"
To give you early access to the latest and greatest, we will release some features as "**Experimental**". This means you can use them, but the final implementation might change. So don't use this in production.

## Introduction

You need to write an Action, to make your template into a Smart Template.

Challenge: You don't know how to write JavaScript code, to make this happen.

GraFx Genie is your go-to smart assistant for crafting [actions](/GraFx-Studio/guides/actions/create/) to support your templates.

It's designed to assist you in creating actions, which play a vital role within triggers. See also: [Introduction to Actions](/GraFx-Studio/concepts/actions/)

## Example

You have a retail template. A variable field allows the users of the template to enter a discount percentage.
When the discount drops below — let's say — 30%, you (as a template designer) want to show an extra asset, to hi-light the steep discount.

![image](template.png)

A variable makes sure a user can change the discount.

![image](variable.png)

Now, let's make an action, that will be triggerd with a variable value changes.

![image](trigger.png)

To create the action, click on the Action tab.

![image](action.png)

You can now ask Genie to write the script for you.

Click on the GraFx Genie icon.

![image](genie-icon.png)

![image](genie1.png)

And ask Genie what functionality you need in your Smart Template

![image](genie2.png)

Genie will now suggest a JavaScript you can use to perform the functionality.

![image](action2.png)

As you see, Genie knows about the context. Without specifiing that discount is a variable name, it will understand and use this information to write the script.

If you're not 100% convinced, you can still tweak the script, or ask a Developer colleague to take a look for the final touches.

The result:

![image](genie-in-action.gif)
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -185,6 +185,7 @@ nav:
- 'Snapping': 'GraFx-Studio/concepts/snapping/index.md'
- 'Shapes': 'GraFx-Studio/concepts/shapes/index.md'
- 'Actions': 'GraFx-Studio/concepts/actions/index.md'
- 'GraFx Genie': 'GraFx-Studio/concepts/grafx-genie/index.md'
- 'Action Helper Functions': 'GraFx-Studio/concepts/helper-functions/index.md'
- 'Variables': 'GraFx-Studio/concepts/variables/index.md'
- 'Crop': 'GraFx-Studio/concepts/crop/index.md'
Expand Down
Loading