diff options
Diffstat (limited to 'examples/enginio/quick/image-gallery/doc/src/image-gallery.qdoc')
| -rw-r--r-- | examples/enginio/quick/image-gallery/doc/src/image-gallery.qdoc | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/examples/enginio/quick/image-gallery/doc/src/image-gallery.qdoc b/examples/enginio/quick/image-gallery/doc/src/image-gallery.qdoc index 418a724..923b300 100644 --- a/examples/enginio/quick/image-gallery/doc/src/image-gallery.qdoc +++ b/examples/enginio/quick/image-gallery/doc/src/image-gallery.qdoc @@ -38,28 +38,28 @@ \section1 Backend configuration The Enginio backend needs to be set up to get this example working. - Go to the Enginio Dashboard and create a new backend with 'Image Gallery' template. + Go to the Enginio Dashboard and create a new backend with the \c{Image Gallery} template. - The template will construct a new custom backend by executing steps: + The template will construct a new custom backend by executing the following steps: \list - \li Create a new object type "objects.image" (on the Object Types page). + \li Create a new object type \c objects.image (on the \gui{Object Types} page). Add two properties to the image object: - name:"name", type: "String" and name: "file", type: "Ref" with target "files". + \c {name:"name"}, \c {type: "String"} and \c {name: "file"}, \c {type: "Ref"} with \c {target "files"}. - \li Add a file processor by clicking the "file" property. - Choose "Image processor" and in "Variants" enter: + \li Add a file processor by clicking the \c file property. + Choose \gui {Image processor}, and in \gui Variants enter: \code { "thumbnail": { "crop":"100x100" } } \endcode This JSON snippet triggers the server to generate thumbnails for all uploaded images. - In the image gallery, the thumbnails will be used in the list view. The full image will be shown + In the image gallery the thumbnails will be used in the list view. The full image will be shown when the thumbnail is clicked. \endlist - Copy the backend Id from the Enginio dashboard. + Copy the \e {backend id} from the Enginio dashboard. They need to be entered into the example when it is executed for the first time. \section1 The example code @@ -76,15 +76,15 @@ Thus the image's thumbnail is fetched by each delegate. \note in a real application it might be necessary to cache the images. - The Component.onCompleted function is used to fetch the image. + The \c Component.onCompleted function is used to fetch the image. When the delegate is created, it has the JSON image object data. - The information needed is the "file.id" reference. - The "file" property was introduced in the backend setup section. Every + The information needed is the \c file.id reference. + The \c file property was introduced in the backend setup section. Every object (files are just objects) contains an ID that uniquely identifies the image file. - The image's thumbnail-url is retrieved using the ID ("variant": "thumbnail"). + The thumbnail url of the image is retrieved using the ID ("variant": "thumbnail"). \snippet image-gallery/image-gallery.qml image-fetch - The meta-information about each image is displayed in simple Text elements. + The meta-information about each image is displayed in simple \c Text elements. For the filename, it is possible to directly reference the \c name property as defined in the JSON. \qml |