Ubuntu Manpage: wml::std::logo

NAME

       wml::std::logo - Logo Insertion

SYNOPSIS

        #use wml::std::logo

        <logo [attributes]>

DESCRIPTION

       This include file provides the "<logo>" tag to insert logo images.  The logo is selected via attribute
       "name". The following logos are available:

         Name      Inserted Hint                  Inserted URL
         --------  ------------------------------ ----------------------------
         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 selects which logo is wanted. The table above lists valid names, and wml is used
by default.

"base"
Usually the logos are copied into logo-xxxxxx.png where "xxxxxx" is the name of the logo. When you
use a "base=foo" attribute, then the resulting files are named foo.logo-xxxxxx.png. Actually you can
even use a complete filename including a directory prefix, i.e. when you use "base=../../common/foo"
attribute, then the images are created as ../../common/foo.logo-xxxxxx.png.

And for most flexibility when no base is specified and the variable "LOGO_BASE" is defined (usually
from within a .wmlrc file via "-LOGO_BASE~path/to/logo/dir/base") it is used. Use this feature to
copy the logos to a particular directory.

You may also use the variable "IMAGE_BASE" which defines in a single line all base names for images
generated by WML.

"format"
Logos are available in PNG or GIF formats. This attribute is the filename extension of the desired
format, i.e. respectively "png" and "gif". Default is "png" extension ; this default can be changed
via the "IMAGE_FORMAT" variable.

"file"
This attribute defines the logo filename. It overrides all other computed values.

"target"
If the "target" attribute is used, it refers to a target frame or window where the hyperlink is
redirected to.

"notag"
This forces "<logo>" to expand to nothing, i.e. no resulting "<img>" tag. The image itself is still
generated. In combination with the above "file" attribute this can be used to generate images to
particular files which can be used at other positions, for instance inside "<rollover>" (see
wml::des::rollover(3)) tags.

EXAMPLE

       This example only copy the vim logo to "$(IMAGES)/logo-vim.png" without any output:

        <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: --