Function Example
(One intermediate revision by one user not shown) | |||
Line 1: | Line 1: | ||
− | {{DavinciWiki_Function}} | + | {{DavinciWiki_Function| |
+ | This has a basic description of what the function does and how and when it should be used. It may contain more detailed information on what operations the function is performing to help the user better understand the proper time to use the function. It may also conatin links to the [[:category:Glossary|glossary]]. | ||
+ | | | ||
+ | This has the general input and output values in easy to understand terms. This is useful to get a general idea of what type of data the function accepts and returns. | ||
+ | | | ||
+ | The detailed syntax of arguments following the standard syntax defined for davinci. A detailed page containing the [[Syntax|syntax]] can be found in the glossary. Along with the syntax of the funciton, possible values for every input will be given. | ||
+ | | | ||
+ | One or two examples of how a the function is used step by step will be demonstrated, including what data is input and returnted. This section may not have every possible usage but it will contain the most commonly used. | ||
+ | | | ||
+ | If the result of the function is best explained by an example image, one or more may be shown to emphasize the point. | ||
+ | | | ||
+ | If the function is user defined, a list of major sub functions will also be given. These will be links to other functions in the DavinciWiki. | ||
+ | | | ||
+ | Also a list of related functions will usually be given. If the function that you are viewing does not perform exactly the right task, you may want to check this area to see if one of the related functions performs the desired operation. | ||
+ | | | ||
+ | If the function is user defined then a link to download the davinci script text file will be given, which can immedtiately loaded in davinci. | ||
+ | }} | ||
[[Category:Glossary]] | [[Category:Glossary]] |
Latest revision as of 15:21, 24 March 2006
Contents: Description, Arguments, Usage, Examples, Images, Sub-Functions, Related Functions Supported Under Version: >1.69 Current Davinci Version: 2.27 64-bit Safe: No
Description This has a basic description of what the function does and how and when it should be used. It may contain more detailed information on what operations the function is performing to help the user better understand the proper time to use the function. It may also conatin links to the glossary.
Arguments and Return Values This has the general input and output values in easy to understand terms. This is useful to get a general idea of what type of data the function accepts and returns.
Usage The detailed syntax of arguments following the standard syntax defined for davinci. A detailed page containing the syntax can be found in the glossary. Along with the syntax of the funciton, possible values for every input will be given.
Examples One or two examples of how a the function is used step by step will be demonstrated, including what data is input and returnted. This section may not have every possible usage but it will contain the most commonly used.
Images If the result of the function is best explained by an example image, one or more may be shown to emphasize the point. |
DavinciWiki Mini-Nav Bar Contents
Contact Developers
All other topics
Major Sub-Functions If the function is user defined, a list of major sub functions will also be given. These will be links to other functions in the DavinciWiki.
Related Functions Also a list of related functions will usually be given. If the function that you are viewing does not perform exactly the right task, you may want to check this area to see if one of the related functions performs the desired operation.
Recent Core Changes Modified On: 03-24-2006 |