[sling-whiteboard] branch master updated: Adding documentation for saving a dynamic thumbnail

[dk...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

dklco pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-whiteboard.git


The following commit(s) were added to refs/heads/master by this push:
     new a31cb82  Adding documentation for saving a dynamic thumbnail
a31cb82 is described below

commit a31cb8250d0b60b7b725a93fff8673771f75cc3f
Author: Dan Klco <kl...@adobe.com>
AuthorDate: Fri Jul 16 14:38:02 2021 -0400

    Adding documentation for saving a dynamic thumbnail
---
 org.apache.sling.thumbnails/README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/org.apache.sling.thumbnails/README.md b/org.apache.sling.thumbnails/README.md
index 8a756dc..51b6cad 100644
--- a/org.apache.sling.thumbnails/README.md
+++ b/org.apache.sling.thumbnails/README.md
@@ -48,6 +48,14 @@ Will result in the following thumbnail:
 
 ![docs/rendered.jpeg](docs/rendered.jpeg)
 
+#### Saving Thumbnails
+
+The Dynamic Transform Servlet can save the generated thumbnail for any Persistable resource type. To do so add the URL parameter `renditionName`, e.g.:
+
+http://localhost:8080/bin/sling/thumbnails/transform?resource=/content/image/test.png&format=jpeg&renditionName=myrendition.jpeg
+
+Once saved, the rendition can be access directly using the configured Rendition Path for the Resource Type or using the Transform Servlet. Note that the rendition will only be available on the resource the servlet is executed on.
+
 ### Transform Servlet
 
 The second servlet uses [Sling Context Aware Configurations](https://sling.apache.org/documentation/bundles/context-aware-configuration/context-aware-configuration.html) to generate thumbnails based on pre-defined transformation pipelines. Note that the [TransformationManager](src/main/java/org/apache/sling/thumbnails/TransformationManager.java) is useful for retrieving the available transformation pipelines for a particular resource.