Skip to content

Commit

Permalink
[TASK] Add alt text documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fseipel committed Nov 11, 2024
1 parent 8bdd338 commit 7d7df39
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 2 deletions.
36 changes: 35 additions & 1 deletion docs/alt-text-generation.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,38 @@ nav_order: 3
permalink: /alt-text-generation
---

# Alt Text Generation
# Alt Text Generation

The AI Tools extension provides automated generation of alternative text for images, making your website more accessible and SEO-friendly. This feature can be used both for individual images and in batch mode for entire folders.

## Quick Generation

The quickest way to generate an alternative text is:

![Screenshot of generate button](docs/assets/quick-generate.png){: width="400" }

1. Open an image in the TYPO3 backend
1. Click the "Generate" button next to the alternative text field
1. The AI will automatically generate an appropriate alternative text for your image

## Advanced Options

For more control over the generation process:

![Screenshot of generate button](docs/assets/full-generate.png){: width="600" }

1. Click on the cogwheel icon next to the generate button to open the advanced options
1. Choose from the predefined prompts or customize the prompt
1. Generate the alternative text
1. Save or generate translations for the other languages on the website

## Batch Folder Processing

To process multiple images at once:

![Screenshot of the context menu](docs/assets/context-menu.png)

1. Navigate to the file list module in TYPO3 backend
1. Right-click on a folder containing images
1. Select "Generate A.I. Metadata" from the context menu
1. Choose your generation options in the dialog
Binary file added docs/assets/context-menu.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 docs/assets/full-generate.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 docs/assets/quick-generate.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/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ composer require pagemachine/ai-tools

## Initial Configuration

1. Create a new server entry in the `AI Tools` > `Servers` backendmodule
1. Create a new server entry in the `AI Tools` > `Servers` backend module
1. Fill in the required fields (API key, etc.) and save the server
1. Select the prefered server for each task in the the `AI Tools` > `Settings` module and save
1. Create predefined prompts in the `AI Tools` > `Templates` module
Expand Down

0 comments on commit 7d7df39

Please sign in to comment.