[Bug 261847] Add icon: and image: to the AsciiDoc primer section of the FDP primer

https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=261847

            Bug ID: 261847
           Summary: Add icon: and image: to the AsciiDoc primer section of
                    the FDP primer
           Product: Documentation
           Version: Latest
          Hardware: Any
                OS: Any
            Status: New
          Keywords: accessibility
          Severity: Affects Only Me
          Priority: ---
         Component: Documentation
          Assignee: doc@FreeBSD.org
          Reporter: pauamma@gundo.com

Probably just before the Conclusion section, or perhaps (at the risk of some
repetitive text) in the links section for icons specifically, since I think
that's how they're most used.

Very rough draft language: 

> To insert an icon (small picture) as a shorthand symbol for text (for instance, an envelope in a mailto: link), use:
> 
> icon:filename_without_extension[Text description, link=https://host.example.org/some/URL]
> 
> To insert an image, use:
> 
> image::filename.extension[alt="Text description"]

Images are described in the Rosetta Stone chapter, but icons aren't. I'd want
both in the same place, but I'm not sure where (or if, in a latter step, these
chapters should get merged).

For extra credit, I'd add "always use meaningful image and icon descriptions"
or words to that effect to the style guide.

-- 
You are receiving this mail because:
You are the assignee for the bug.