4.26. dummy
Alias: pedagogy, dummy_alias
Note: [dummy ...], [pedagogy ...] and [dummy-alias ...] are equivalent. If the tag has an endtag, you must not mix aliases between the tag and its endtag (i.e., [dummy] ... [/pedagogy] would not work).
A short description of the tag goes here. This example (dummy) is not an actual tag.
A..1. Summary
[dummy first second][/dummy] [dummy first=first_args second=second_args other_named_attributes][/dummy]
Positional parameters: The first line shows the usage with positional parameters (given in order). The second line shows usage with named parameters.
Parameters | Description | Default |
first |
The first positional parameter
|
default value if the parameter is not given |
second | Another example parameter | none |
alias1 | alias for first -- some parameters have aliases -- [dummy alias1="X"] is equivalent to [dummy first="X"] | Same default as first, of course |
Attributes | Default |
more | none |
still-more | none (requires more) |
other | none |
interpolate (body) | Yes |
reparse | No |
Other_Characteristics | |
Invalidates cache | No |
Macro | No |
Has end tag | [/dummy] |
Tag expansion example:
[dummy first=pig_latin second="Capitalize"]\ Body text acted on by the tag goes here.[/dummy] ------------------------------------------------------ OdyBay ExtTaY ActedAy OnAy YBay EThay AgTay OesGay \ EreHay.
Reading the tag expansion example:
-
format: The tag is listed first. A blank line separates it from the expanded return value.
long lines: When this document must break a line from an example because it is too wide for the page, a trailing backslash indicates the continuation. Note that such a trailing backslash is *not* part of the actual tag syntax or expansion.
ASP-like Perl call:
$Tag->dummy( { first => 'goober', second => 'foobar', more => $snafu, }, $body_text );
or similarly,
$Tag->dummy($first, $second, $attribute_hash_reference, $body_text);
A..2. Description
More detailed tag description
A..2.1. first
Section describing the first parameter
A..2.1.1. special_value
Description of treatment of the special argument. For example, giving the page tag an href of 'scan' causes it to link to a search specification rather than a page.
A..2.2. more
more is a named attribute that applies to this tag.
A..2.3. still-more
still-more is a named attribute that applies to this tag only when the more attribute has been given. It would be an error to use the still-more attribute without specifying a value for more
A..2.4. other
'other' is another named attribute that applies to this tag.