wml::std::logo(3)

💖 wml::std::logo — Logo Insertion 💖

okay bestie, welcome to wml::std::logo(3) from the EN Tools era — this is the little include that lets you drop logos into your WML pages and it's literally so easy. sit down, grab a strawberry 🍓, let's get into it.

---

✨ SYNOPSIS ✨

#use wml::std::logo

<logo [attributes]>

---

🌸 DESCRIPTION 🌸

This include file gives you the <logo> tag, and its whole entire job is inserting logo images. you pick which one you want with the name attribute. that's it. that's the vibe. 💅

here's the full roster of logos you can pull, with what they are and where they point:

• apache — Apache Webserver Project — http://www.apache.org/
• freebsd — FreeBSD Operating System — http://www.freebsd.org/
• gimp — GNU Image Manipulation Program — http://www.gimp.org/
• linux — Linux Operating System — http://www.linux.org/
• netbsd — NetBSD Operating System — http://www.netbsd.org/
• openbsd — OpenBSD Operating System — http://www.openbsd.org/
• php — PHP Hypertext Preprocessor — http://www.php.net/
• vim — Vi Improved Editor — http://www.vim.org/
• wml — Website META Language — https://www.shlomifish.org/open-source/projects/website-meta-language/

---

🎀 ATTRIBUTES 🎀

name

the name attribute is how you say which logo you want. valid names are the whole list up above ⬆️, and if you don't say anything, wml is the default. main character behavior honestly 👑

base

so normally the logos get copied into logo-xxxxxx.png, where xxxxxx is the name of the logo. but if you pass a base=foo attribute, the resulting files come out named foo.logo-xxxxxx.png. and ngl you can go even further — you can hand it a whole complete filename with a directory prefix. like, if you use base=../../common/foo, then the images get created as ../../common/foo.logo-xxxxxx.png. ✨

and for maximum flexibility: when no base is specified and the variable LOGO_BASE is defined — usually from inside a .wmlrc file via -LOGO_BASE~path/to/logo/dir/base — then that gets used instead. use this feature to copy the logos into a particular directory. 🫶

you can also use the variable IMAGE_BASE, which defines all the base names for images generated by WML in a single line. one line, all the bases, iconic.

format

logos come in PNG or GIF. this attribute is literally just the filename extension of the format you want, so: png or gif. default is the png extension, and you can change that default via the IMAGE_FORMAT variable. 🌈

file

this attribute defines the logo filename. it overrides all other computed values. no cap, it wins every argument. 💀

target

if you use the target attribute, it refers to a target frame or window where the hyperlink gets redirected to.

notag

this one forces <logo> to expand into absolutely nothing — so no resulting <img> tag. the image itself is still generated though, don't worry. and when you combine it with the file attribute above, you can generate images into particular files that you then use at other positions, like for instance inside <rollover> tags (peep wml::des::rollover(3)). 🦋

---

🔥 EXAMPLE 🔥

this example only copies the vim logo to $(IMAGES)/logo-vim.png and produces zero output. quiet. mysterious. slaying. 💅

<logo name=vim format=png base="$(IMAGES)/logo" notag>

---

👑 AUTHORS 👑

Ralf S. Engelschall rse@engelschall.com www.engelschall.com

Denis Barbier barbier@engelschall.com

---

💜 REQUIRES 💜

• Internal: P1, P2, P3
• External: --

---

⭐ SEE ALSO ⭐

wml(1)

---

and that's the whole page, bestie 🎀 this came out of the EN Tools era with a date of 2020-11-29 on it, so go forth and insert logos, you absolute icon. mwah 💋