|
Size: 961
Comment: New format.
|
Size: 1181
Comment: replaced inline formatting w/ tables
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 1: |
| # see dtrecon as an exmaple | ## 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 3: | Line 8: |
| command - 1/2 sentence summary = Synopsis = command [argA] -flag1 [arg2] -flag2 [arg3] [<options>] = Positional Arguments = || [argA] || description || = Required Flagged Arguments = || -flag1 [arg1] || description || || -flag2 [arg2] || description || = Optional Flagged Arguments = || -flag3 [arg3] || description || || -flag4 [arg4] || 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 = JaneSmith = Links = FreeSurfer, FsFast = References = ["References/Lastname###"] = Reporting Bugs = Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> = Methods Description = |
|
| Line 4: | Line 58: |
| command - 1/2 sentence summary }}} = Synopsis = {{{ command arg1 -i <arg2> -o <arg3> [<options>] |
description description |
| Line 11: | Line 62: |
| = Positional Arguments = {{{ arg1 Description }}} = Required Flagged Arguments = {{{ -i <arg2> -o <arg3> arg3 }}} = Optional Flagged Arguments = {{{ -f <fvalue> description description -g <gvalue> description description }}} = Outputs = {{{ volume1 - description volume2 - description }}} = Example 1 = {{{ command foo -i f -o out }}} = Example 2 = {{{ command foo -i f -o out -f fvalue }}} = See Also = ["othercommand1"] ["othercommand2"] = Author = JaneSmith = Links = FreeSurfer = References = ## For example: ["Belliveau1991"] NameYear = Reporting Bugs = Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> |
|
| Line 71: | Line 63: |
| ## For example: CategoryFreeSurferCommandVolumeConversion Category''Stream''Function |
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 |
-flag2 [arg2] |
description |
Optional Flagged Arguments
-flag3 [arg3] |
description |
-flag4 [arg4] |
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