|
Size: 1052
Comment: Improved formatting.
|
Size: 1285
Comment: added comment to refer to HelpOnCommandTemplate
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| ## See HelpOnCommandTemplate for description of formatting ## ## Note: If you are modifying this page please refer to the ## CommandTemplate page and confirm that this page has the latest ## CommandTemplate formatting |
|
| Line 2: | Line 8: |
command - quick summary |
{{{ command - 1/2 sentence summary }}} |
| Line 6: | Line 13: |
| command argA argB -flag1 <arg1> -flag2 <arg2> -flag3 <arg3> | {{{ command [argA] -flag1 [arg2] -flag2 [arg3] [<options>] }}} |
| Line 9: | Line 18: |
| || argA || || Description || || argB || || Description || |
{{{ [argA] description }}} |
| Line 16: | Line 24: |
| || -flag1 <arg1> || || Description || |
{{{ -flag1 [arg1] description description |
| Line 19: | Line 29: |
| || - flag2 <arg2> || || Description || |
-flag2 [arg2] description description }}} |
| Line 23: | Line 35: |
| {{{ -flag3 [arg3] description description |
|
| Line 24: | Line 40: |
| || -flag3 <arg3> || || Description || |
-flag4 [arg4] description description }}} |
| Line 28: | Line 46: |
| || file1 || Description || | {{{ volume1 - description volume2 - description }}} |
| Line 31: | Line 51: |
| || file2 || Description || | = Description = description |
| Line 34: | Line 55: |
| || command argA argB -flag1 foo -flag2 goo || || Description || |
{{{ command foo -i f -o out description }}} |
| Line 38: | Line 62: |
| || command argA argB -flag1 foo -flag2 goo -flag3 hoo || || Description || |
{{{ command foo -i f -o out -f fvalue description }}} |
| Line 42: | Line 69: |
| || ["command2"] || || ["command3"] || |
["othercommand1"], ["othercommand2"] |
| Line 45: | Line 71: |
| = Author = JaneSmith |
= Author/s = JaneSmith |
| Line 49: | Line 75: |
| Command``Guide | FreeSurfer, FsFast |
| Line 52: | Line 78: |
| ## For example: ["References/Belliveau1991"] ["References/NameYear"] |
["References/Lastname###"] |
| Line 56: | Line 81: |
| Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> | Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> = Methods Description = {{{ description description }}} |
| Line 59: | Line 90: |
| ## For example: CategoryFreeSurferCommandVolumeConversion Category``Stream``Command |
Category``Stream``Function |
Name
command - 1/2 sentence summary
Synopsis
command [argA] -flag1 [arg2] -flag2 [arg3] [<options>]
Positional Arguments
[argA] description
Required Flagged Arguments
-flag1 [arg1] description description -flag2 [arg2] description description
Optional Flagged Arguments
-flag3 [arg3] description description -flag4 [arg4] description description
Outputs
volume1 - description volume2 - description
Description
description
Example 1
command foo -i f -o out description
Example 2
command foo -i f -o out -f fvalue description
See Also
["othercommand1"], ["othercommand2"]
Author/s
Links
References
["References/Lastname###"]
Reporting Bugs
Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Methods Description
description description
Category
CategoryStreamFunction