diff options
author | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2024-06-21 09:41:24 +0200 |
---|---|---|
committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2024-06-21 09:41:24 +0200 |
commit | af0cb57aaf668278551454678eac60b17348b13c (patch) | |
tree | b0fbd866cfc5e605ff789de9d6d9b162094a217b /docs/content/en/functions/images | |
parent | d5542ed286746e89fb13a1f821d4955ace371773 (diff) | |
parent | 8b9803425e63e1b1801f8d5d676e96368d706722 (diff) | |
download | hugo-af0cb57aaf668278551454678eac60b17348b13c.tar.gz hugo-af0cb57aaf668278551454678eac60b17348b13c.zip |
Merge commit '8b9803425e63e1b1801f8d5d676e96368d706722'
Diffstat (limited to 'docs/content/en/functions/images')
-rw-r--r-- | docs/content/en/functions/images/Config.md | 6 | ||||
-rw-r--r-- | docs/content/en/functions/images/Dither.md | 4 | ||||
-rw-r--r-- | docs/content/en/functions/images/Filter.md | 2 | ||||
-rw-r--r-- | docs/content/en/functions/images/Padding.md | 2 | ||||
-rw-r--r-- | docs/content/en/functions/images/Process.md | 2 | ||||
-rw-r--r-- | docs/content/en/functions/images/UnsharpMask.md | 6 | ||||
-rw-r--r-- | docs/content/en/functions/images/_common/_index.md | 2 | ||||
-rw-r--r-- | docs/content/en/functions/images/_common/apply-image-filter.md | 4 |
8 files changed, 15 insertions, 13 deletions
diff --git a/docs/content/en/functions/images/Config.md b/docs/content/en/functions/images/Config.md index 0a4d225bc..89c6ad604 100644 --- a/docs/content/en/functions/images/Config.md +++ b/docs/content/en/functions/images/Config.md @@ -27,10 +27,10 @@ Supported image formats include GIF, JPEG, PNG, TIFF, and WebP. {{% note %}} This is a legacy function, superseded by the [`Width`] and [`Height`] methods for [global], [page], and [remote] resources. See the [image processing] section for details. -[`Width`]: /methods/resource/width -[`Height`]: /methods/resource/height +[`Width`]: /methods/resource/width/ +[`Height`]: /methods/resource/height/ [global]: /getting-started/glossary/#global-resource -[image processing]: /content-management/image-processing +[image processing]: /content-management/image-processing/ [page]: /getting-started/glossary/#page-resource [remote]: /getting-started/glossary/#remote-resource {{% /note %}} diff --git a/docs/content/en/functions/images/Dither.md b/docs/content/en/functions/images/Dither.md index 8084d83c1..7193ba847 100644 --- a/docs/content/en/functions/images/Dither.md +++ b/docs/content/en/functions/images/Dither.md @@ -15,6 +15,8 @@ action: toc: true --- +{{< new-in 0.123.0 >}} + ## Options colors @@ -29,7 +31,7 @@ serpentine : (`bool`) Applicable to error diffusion dithering methods, serpentine controls whether the error diffusion matrix is applied in a serpentine manner, meaning that it goes right-to-left every other line. This greatly reduces line-type artifacts. Default is `true`. strength -: (`float`) The strength at which to apply the dithering matrix, typically a value in the range [0, 1]. A value of `1.0` applies the dithering matrix at 100% strength (no modifification of the dither matrix). The `strength` is inversely proportional to contrast; reducing the strength increases the contrast. Setting `strength` to a value such as `0.8` can be useful to reduce noise in the dithered image. Default is `1.0`. +: (`float`) The strength at which to apply the dithering matrix, typically a value in the range [0, 1]. A value of `1.0` applies the dithering matrix at 100% strength (no modification of the dither matrix). The `strength` is inversely proportional to contrast; reducing the strength increases the contrast. Setting `strength` to a value such as `0.8` can be useful to reduce noise in the dithered image. Default is `1.0`. ## Usage diff --git a/docs/content/en/functions/images/Filter.md b/docs/content/en/functions/images/Filter.md index 450a64814..2961d7f47 100644 --- a/docs/content/en/functions/images/Filter.md +++ b/docs/content/en/functions/images/Filter.md @@ -40,7 +40,7 @@ To apply two or more filters, executing from left to right: You can also apply image filters using the [`Filter`] method on a `Resource` object. -[`Filter`]: /methods/resource/filter +[`Filter`]: /methods/resource/filter/ ## Example diff --git a/docs/content/en/functions/images/Padding.md b/docs/content/en/functions/images/Padding.md index 139626596..90cb6a74d 100644 --- a/docs/content/en/functions/images/Padding.md +++ b/docs/content/en/functions/images/Padding.md @@ -32,7 +32,7 @@ Create the filter: Combine with the [`Colors`] method to create a border with one of the image's most dominant colors: -[`Colors`]: /methods/resource/colors +[`Colors`]: /methods/resource/colors/ ```go-html-template {{ with resources.Get "images/original.jpg" }} diff --git a/docs/content/en/functions/images/Process.md b/docs/content/en/functions/images/Process.md index a5e4d88dd..e562f7fbf 100644 --- a/docs/content/en/functions/images/Process.md +++ b/docs/content/en/functions/images/Process.md @@ -18,7 +18,7 @@ toc: true This filter has the same options as the [`Process`] method on a `Resource` object, but using it as a filter may be more effective if you need to apply multiple filters to an image. -[`Process`]: /methods/resource/process +[`Process`]: /methods/resource/process/ The process specification is a space-delimited, case-insensitive list of one or more of the following in any sequence: diff --git a/docs/content/en/functions/images/UnsharpMask.md b/docs/content/en/functions/images/UnsharpMask.md index 57a74a54a..9ea58f2b6 100644 --- a/docs/content/en/functions/images/UnsharpMask.md +++ b/docs/content/en/functions/images/UnsharpMask.md @@ -13,11 +13,11 @@ action: toc: true --- -The sigma parameter is used in a gaussian function and affects the radius of effect. Sigma must be positive. The sharpen radius is approximately 3 times the sigma value. +The sigma argument is used in a gaussian function and affects the radius of effect. Sigma must be positive. The sharpen radius is approximately 3 times the sigma value. -The amount parameter controls how much darker and how much lighter the edge borders become. Typically between 0.5 and 1.5. +The amount argument controls how much darker and how much lighter the edge borders become. Typically between 0.5 and 1.5. -The threshold parameter controls the minimum brightness change that will be sharpened. Typically between 0 and 0.05. +The threshold argument controls the minimum brightness change that will be sharpened. Typically between 0 and 0.05. ## Usage diff --git a/docs/content/en/functions/images/_common/_index.md b/docs/content/en/functions/images/_common/_index.md index 47d5812fb..4328d4d14 100644 --- a/docs/content/en/functions/images/_common/_index.md +++ b/docs/content/en/functions/images/_common/_index.md @@ -7,7 +7,7 @@ cascade: --- <!-- -Files within this headless branch bundle are markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required. +Files within this headless branch bundle are Markdown snippets. Each file must contain front matter delimiters, though front matter fields are not required. Include the rendered content using the "include" shortcode. --> diff --git a/docs/content/en/functions/images/_common/apply-image-filter.md b/docs/content/en/functions/images/_common/apply-image-filter.md index acd3a733d..15eddb485 100644 --- a/docs/content/en/functions/images/_common/apply-image-filter.md +++ b/docs/content/en/functions/images/_common/apply-image-filter.md @@ -4,7 +4,7 @@ Apply the filter using the [`images.Filter`] function: -[`images.Filter`]: /functions/images/filter +[`images.Filter`]: /functions/images/filter/ ```go-html-template {{ with resources.Get "images/original.jpg" }} @@ -16,7 +16,7 @@ Apply the filter using the [`images.Filter`] function: You can also apply the filter using the [`Filter`] method on a `Resource` object: -[`Filter`]: methods/resource/filter +[`Filter`]: /methods/resource/filter/ ```go-html-template {{ with resources.Get "images/original.jpg" }} |