From a96d8edba55ab9592e07ad121a648845aeda4f05 Mon Sep 17 00:00:00 2001 From: KemoNine Date: Thu, 23 Mar 2023 13:13:23 -0400 Subject: [PATCH] add note to contributing faq about use of images and the 'figure' short code --- content/faq/contributing.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/content/faq/contributing.md b/content/faq/contributing.md index 79a83db..56fe82e 100644 --- a/content/faq/contributing.md +++ b/content/faq/contributing.md @@ -250,4 +250,21 @@ If you are cross referencing information you can use the following code. Please use this format for cross references between content pages. It helps us better manage cross references between content pages over time. +{{< end_section >}} + +## Images +{{< back_to_top>}} + +When adding images to a page the page must be setup as a `Page Bundle` and the images stored in the page's bundle. + +We have setup a short code that we ask authors to use for adding images. This shortcode will handle ensuring the appropriate `alt-text` is added to the image. + +You can use the shortcode using the following pattern: + +{{< figure src="[filename]" alt="[alt-text]" caption="[visible-caption]" >}} + +Where `[filename]` is the filename, including extension, of the image file. `[alt-text]` is the `img` tag's `alt-text` attribute value. `[visible-caption]` is the text that is shown just underneath each image as a caption. + +Please note: we *require* contributors include `alt-text` on all images if not using the `figure` short code. + {{< back_to_top >}}