TWiki>
Codev Web>ChangeProposal>FeatureRequest>DocumentedDefaultParameterValuesForInclude>VarINCLUDEPARAMS>IncludedTopicUsedAsMacro (27 Oct 2006, NielsKoldso)EditAttach
Codev Web>ChangeProposal>FeatureRequest>DocumentedDefaultParameterValuesForInclude>VarINCLUDEPARAMS>IncludedTopicUsedAsMacro (27 Oct 2006, NielsKoldso)EditAttach This page explains by example the TWiki feature proposal TWiki:Codev.DocumentedDefaultParameterValuesForInclude... 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 | Print version | History: r1 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r1 - 27 Oct 2006 - 16:22:31 - NielsKoldso
-
Codev Web
-
Readme first
-
Developers News
-
Changes
-
Major Only
- All Webs
-
RSS Feed
-
Search
- Advanced
-
Topics of interest
-
Categories
-
All tags? / My tags
Create New Topic
Georgetown
TWiki 4.2.2- TWiki community
- TWiki marketing
- TWiki advocacy
- TWiki deployment
- Dev questions
- TWiki competition
- Usability
- Security
- Community
- How you can help
- Community roles
-
Answer Support questions
- Community
- #twiki (IRC)
- — logs
- Meet others
- Webs
-
Blog
- Codev
- Main
- Plugins
- Sandbox
- Support
- TWiki
- TWiki01
- TWiki02
- TWiki03
- TWiki04
- TWiki04x01
- TWiki04x02
 |
|
Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback