|
Size: 1285
Comment: added comment to refer to HelpOnCommandTemplate
|
Size: 1686
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## Note: This page was created with the CommandTemplate ## ## If you're modifying this page please take a look at the ## latest version of CommandTemplate to ensure that you're ## using the latest version of the CommandTemplate ## |
|
| Line 2: | Line 8: |
| ## ## Note: If you are modifying this page please refer to the ## CommandTemplate page and confirm that this page has the latest ## CommandTemplate formatting |
'''Index''' [[TableOfContents]] |
| Line 8: | Line 14: |
| {{{ | |
| Line 10: | Line 15: |
| }}} | |
| Line 13: | Line 17: |
| {{{ command [argA] -flag1 [arg2] -flag2 [arg3] [<options>] }}} |
command argA argB -flag1 arg1 -flag2 arg2 [-flag3 arg3] [-flag4 arg4] |
| Line 17: | Line 19: |
| = Positional Arguments = {{{ [argA] description }}} |
= Arguments = == Positional Arguments == || argA || brief description || detailed description (eg, help file information) || || argB || brief description || detailed description (eg, help file information) || |
| Line 23: | Line 24: |
| = Required Flagged Arguments = {{{ -flag1 [arg1] description description |
== Required Flagged Arguments == || -flag1 arg1 || brief description || detailed description (eg, help file information) || || -flag2 arg2 || brief description || detailed description (eg, help file information) || |
| Line 29: | Line 28: |
| -flag2 [arg2] description description }}} = Optional Flagged Arguments = {{{ -flag3 [arg3] description description -flag4 [arg4] description description }}} |
== Optional Flagged Arguments == || -flag3 arg3 || brief description ||detailed description (eg, help file information) || || -flag4 arg4 || brief description ||detailed description (eg, help file information) || |
| Line 46: | Line 33: |
| {{{ volume1 - description volume2 - description }}} |
|| volume1 || description || || volume2 || description || |
| Line 54: | Line 39: |
| = Example 1 = {{{ |
= Examples = == Example 1 == |
| Line 59: | Line 44: |
| }}} | |
| Line 61: | Line 45: |
| = Example 2 = {{{ |
== Example 2 == |
| Line 66: | Line 49: |
| }}} | = Bugs = None |
| Line 71: | Line 56: |
| = Author/s = JaneSmith |
|
| Line 76: | Line 58: |
= Methods Description = {{{ description description }}} |
|
| Line 83: | Line 71: |
| = Methods Description = {{{ description description }}} = Category = Category``Stream``Function |
= Author/s = JaneSmith |
Index TableOfContents
Name
command - 1/2 sentence summary
Synopsis
command argA argB -flag1 arg1 -flag2 arg2 [-flag3 arg3] [-flag4 arg4]
Arguments
Positional Arguments
argA |
brief description |
detailed description (eg, help file information) |
argB |
brief description |
detailed description (eg, help file information) |
Required Flagged Arguments
-flag1 arg1 |
brief description |
detailed description (eg, help file information) |
-flag2 arg2 |
brief description |
detailed description (eg, help file information) |
Optional Flagged Arguments
-flag3 arg3 |
brief description |
detailed description (eg, help file information) |
-flag4 arg4 |
brief description |
detailed description (eg, help file information) |
Outputs
volume1 |
description |
volume2 |
description |
Description
description
Examples
Example 1
command foo -i f -o out
description
Example 2
command foo -i f -o out -f fvalue
description
Bugs
None
See Also
["othercommand1"], ["othercommand2"]
Links
Methods Description
description description
References
["References/Lastname###"]
Reporting Bugs
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>