Differences between revisions 5 and 29 (spanning 24 versions)
Revision 5 as of 2004-08-04 11:25:27
Size: 961
Editor: DavidTuch
Comment: New format.
Revision 29 as of 2004-09-01 15:00:21
Size: 1686
Editor: DavidTuch
Comment:
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
# see dtrecon as an exmaple ## 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
##
## See HelpOnCommandTemplate for description of formatting

'''Index'''
[[TableOfContents]]

Line 3: Line 14:
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 =
FreeSurfer, FsFast

= Methods Description =
Line 4: Line 61:
command - 1/2 sentence summary
}}}
= Synopsis =
{{{
command arg1 -i <arg2> -o <arg3> [<options>]
description
description
Line 11: Line 65:
= 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
Line 64: Line 66:
## For example: ["Belliveau1991"]
 NameYear
["References/Lastname###"]
Line 68: Line 69:
 Report bugs to <analysis-bugs@nmr.mgh.harvard.edu> Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>
Line 70: Line 71:
= Category =
## For example: CategoryFreeSurferCommandVolumeConversion
 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

FreeSurfer, FsFast

Methods Description

description
description

References

["References/Lastname###"]

Reporting Bugs

Report bugs to <analysis-bugs@nmr.mgh.harvard.edu>

Author/s

JaneSmith

CommandTemplate (last edited 2008-04-29 11:45:05 by localhost)