Skip to content

Commit fd34f8f

Browse files
committed
DOC-2581: Uploadcare Plugin documentation.
1 parent 223901c commit fd34f8f

38 files changed

+349
-2
lines changed
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
<textarea id="uploadcare">
2+
<h3 style="font-size: 1.5em; margin: 20px 0;">Using the Context Toolbar for Image Editing</h3>
3+
4+
<h4 style="font-size: 1.25em; margin: 15px 0;">Adding Alt Text to Images</h4>
5+
<p style="margin: 10px 0;">To add or edit alt text for an image:</p>
6+
<ol style="margin-left: 20px;">
7+
<li>Click on the image in your document to open the context toolbar.</li>
8+
<li>Locate the <strong>Alt Text</strong> field in the toolbar.</li>
9+
<li>Enter a brief description of the image content. For example:
10+
<div style="margin: 15px 0; padding: 10px 15px; border-left: 4px solid #3498db; background-color: #f0f7fb;">
11+
<p>"A mountain landscape during sunset."</p>
12+
</div>
13+
</li>
14+
<li>The alt text is automatically saved and can be previewed by inspecting the image properties.</li>
15+
</ol>
16+
17+
<h4 style="font-size: 1.25em; margin: 15px 0;">Resizing Images</h4>
18+
<p style="margin: 10px 0;">To resize an image:</p>
19+
<ol style="margin-left: 20px;">
20+
<li>Select the image to activate the context toolbar.</li>
21+
<li>Use the width and height input fields to specify new dimensions in pixels (e.g., 600px by 400px).</li>
22+
<li>Press <strong>Enter</strong> or click outside the toolbar to apply the changes.</li>
23+
<li>The image will automatically adjust in the document. For optimal performance, use the Uploadcare <code>/resize/</code> transformation:
24+
<div style="margin: 15px 0; padding: 10px 15px; border-left: 4px solid #3498db; background-color: #f0f7fb;">
25+
<code>https://ucarecdn.com/<YOUR_IMAGE_UUID>/-/resize/600x400/</code>
26+
</div>
27+
</li>
28+
</ol>
29+
30+
<h4 style="font-size: 1.25em; margin: 15px 0;">Adjusting Image Saturation and Exposure</h4>
31+
<p style="margin: 10px 0;">To modify image saturation or exposure:</p>
32+
<ol style="margin-left: 20px;">
33+
<li>Select the image and open the context toolbar.</li>
34+
<li>Use the <strong>Saturation</strong> or <strong>Exposure</strong> sliders to adjust the values:
35+
<ul style="margin-left: 20px;">
36+
<li>Increase saturation for more vibrant colors.</li>
37+
<li>Decrease exposure for a darker image or increase it for a brighter image.</li>
38+
</ul>
39+
</li>
40+
<li>Changes are applied dynamically. To reset, click the <strong>Reset</strong> button in the toolbar.</li>
41+
<li>Example transformation for saturation:
42+
<div style="margin: 15px 0; padding: 10px 15px; border-left: 4px solid #3498db; background-color: #f0f7fb;">
43+
<code>https://ucarecdn.com/<YOUR_IMAGE_UUID>/-/saturation/120%/</code>
44+
</div>
45+
</li>
46+
</ol>
47+
48+
<h4 style="font-size: 1.25em; margin: 15px 0;">Cropping an Image</h4>
49+
<p style="margin: 10px 0;">To crop an image:</p>
50+
<ol style="margin-left: 20px;">
51+
<li>Select the image to activate the context toolbar.</li>
52+
<li>Click the <strong>Crop</strong> button to enter cropping mode.</li>
53+
<li>Adjust the cropping handles or specify exact dimensions.</li>
54+
<li>Click <strong>Apply</strong> to save the cropped image. Example transformation for cropping:
55+
<div style="margin: 15px 0; padding: 10px 15px; border-left: 4px solid #3498db; background-color: #f0f7fb;">
56+
<code>https://ucarecdn.com/<YOUR_IMAGE_UUID>/-/crop/400x400/</code>
57+
</div>
58+
</li>
59+
</ol>
60+
61+
<h4 style="font-size: 1.25em; margin: 15px 0;">Restoring Default Settings</h4>
62+
<p style="margin: 10px 0;">To reset an image to its original state:</p>
63+
<ol style="margin-left: 20px;">
64+
<li>Click the <strong>Reset</strong> button in the context toolbar.</li>
65+
<li>The image will revert to its original dimensions and appearance.</li>
66+
<li>All transformations (e.g., cropping, resizing, or adjustments) will be removed.</li>
67+
</ol>
68+
69+
<div style="margin: 15px 0; padding: 10px 15px; border-left: 4px solid #e74c3c; background-color: #fdf7f7;">
70+
<p><strong>Important:</strong> Always use descriptive alt text for accessibility and optimize image dimensions for better performance.</p>
71+
</div>
72+
</textarea>
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
tinymce.init({
2+
selector: "textarea#uploadcare",
3+
plugins: [ "uploadcare" ],
4+
uploadcare_public_key: 'your_public_key',
5+
toolbar: "uploadcare",
6+
});
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading

modules/ROOT/images/icons/blur.svg

Lines changed: 3 additions & 0 deletions
Loading

modules/ROOT/images/icons/box.svg

Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading
Lines changed: 3 additions & 0 deletions
Loading
Lines changed: 1 addition & 0 deletions
Loading

0 commit comments

Comments
 (0)