Bug 261847 - Add icon: and image: to the AsciiDoc primer section of the FDP primer
Summary: Add icon: and image: to the AsciiDoc primer section of the FDP primer
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Some People
Assignee: Sergio Carlavilla Delgado
URL:
Keywords: accessibility
Depends on:
Blocks:
 
Reported: 2022-02-10 00:10 UTC by Pau Amma
Modified: 2023-09-20 07:41 UTC (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Pau Amma 2022-02-10 00:10:40 UTC
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.
Comment 1 Pau Amma 2022-02-10 23:56:03 UTC
(In reply to PauAmma from comment #0)

dbaio just pointed out to me that the FDP uses font icons, not image icons, so the above applies only to images, not icons.
Comment 2 commit-hook freebsd_committer freebsd_triage 2023-09-20 07:39:57 UTC
A commit in branch main references this bug:

URL: https://cgit.FreeBSD.org/doc/commit/?id=2cfe75b557140446dfdfd081d87f9a4ac6f2880b

commit 2cfe75b557140446dfdfd081d87f9a4ac6f2880b
Author:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
AuthorDate: 2023-09-20 07:38:41 +0000
Commit:     Sergio Carlavilla Delgado <carlavilla@FreeBSD.org>
CommitDate: 2023-09-20 07:38:41 +0000

    FDP: Add subsection about images and icons

    PR:                     261847
    Reviewed by:            bcr@
    Differential Revision:  https://reviews.freebsd.org/D41775

 .../fdp-primer/asciidoctor-primer/_index.adoc      | 83 ++++++++++++++++++++++
 1 file changed, 83 insertions(+)
Comment 3 Sergio Carlavilla Delgado freebsd_committer freebsd_triage 2023-09-20 07:41:23 UTC
Done.