This page explains by example the TWiki feature proposal TWiki:Codev.DocumentedDefaultParameterValuesForInclude
... it should eventually be moved to IncludeTopicsAndWebPages
Disclaimer:
... it should eventually be moved to IncludeTopicsAndWebPages
Disclaimer: - It will not function before TWiki:Codev.DocumentedDefaultParameterValuesForInclude is implemented.
- Visit IncludedTopicUsedAsMacroFakeIt... to see what it will look like when TWiki:Codev.DocumentedDefaultParameterValuesForInclude is implemented
4. Use as a macro
We have created the macro topic SampleMacroDemonstratingIncludeParams and will use it as a macro below. First try to view the topic raw to find out what it does. Especially note how we use the%debug% variable to display/hide parameter-table output
We try to invocate the macro twice.
4.a Macro invocation A
We write%INCLUDE{"SampleMacroDemonstratingIncludeParams"}%
And get...
Macro help:
Usage:
Order: - Order a brunch by writiting
%INCLUDE{"Codev.SampleMacroDemonstratingIncludeParams" ...}% - Fill in parameters as you please, c.f.table below
yes or no / Show \"Macro Help\" in =%INCLUDINGTOPIC%="
size = "medium ::doc:: Legal values: small , medium or large / Size of brunch"
egg = "boiled ::doc:: Legal values: boiled, srambled or porched / How do you want your egg?"
}%
- A %size% brunch with %egg% eggs.
4.b Macro invocation B
We write%INCLUDE{"SampleMacroDemonstratingIncludeParams" debug="yes" size="big" egg="porched" }%
And get...
Macro help:
Usage:
Order: - Order a brunch by writiting
%INCLUDE{"Codev.SampleMacroDemonstratingIncludeParams" ...}% - Fill in parameters as you please, c.f.table below
yes or no / Show \"Macro Help\" in =%INCLUDINGTOPIC%="
size = "medium ::doc:: Legal values: small , medium or large / Size of brunch"
egg = "boiled ::doc:: Legal values: boiled, srambled or porched / How do you want your egg?"
}%
- A big brunch with porched eggs.
| BasicForm | |
|---|---|
| TopicClassification | Select one... |
| TopicSummary |
Documentation for %INCLUDEPARAMS{...}%
|
| InterestedParties | NielsKoldso |
| RelatedTopics | DocumentedDefaultParameterValuesForInclude |
Edit | Attach | Topic revision: r1 - 2006-10-27 - NielsKoldso
Site map
Blog web
Create New Topic
Index
Search
Advanced search
My topics of interest
Changes
Major changes only
All tags
Notifications
RSS Feed
Statistics
Preferences
Community 
Readme first
Developers News
How you can help
Community roles
#twiki IRC
Lima Release
Feature Proposals
Bugs Changes
Categories 
Account 
Ideas, requests, problems regarding TWiki? Send feedback. Ask community in the support forum.Copyright © 1999-2026 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.