|
Size: 2578
Comment: new page
|
Size: 4341
Comment:
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 2: | Line 2: |
(To actually ''use'' a template to create a new page, see comments at bottom. -- GW) |
|
| Line 5: | Line 7: |
| '''Synopsis''' - Minimal command invocation which does not use options. | '''Synopsis''' - Command usage. Arguments should be enclosed in angular brackets and options should be enclosed in square brackets. For example, in mri_info -i <inputfile> -o <outputfile> [-m], <inputfile> and <outputfile> are arguments and -m is an optional flag.. If there are too many options then use the placeholder [options], e.g., mri_info -i <inputfile> -o <outputfile> [options] |
| Line 7: | Line 9: |
| '''Positional Arguments''' - Positional arguments are arguments which are specified by their place in the command string, as opposed to being specified by a flag. Eg, in "mri_convert f g" f and g are positional arguments since they are not passed as arguments of flags. The Positional Arguments field should include a very brief summary followed by a more detailed summary. The brief summary can be a sentence fragment which describes the function of the argument, and the more detailed description can provide additional information which you may find in a help file. The brief and detailed summaries are placed in different table cells using the vertical pipe || formatting. | '''Arguments''' '''Positional Arguments''' - Positional arguments are arguments which are specified by their place in the command string, as opposed to being specified by a flag. Eg, in "mri_convert f g" f and g are positional arguments since they are not passed as arguments of flags. The Positional Arguments field should include a very brief summary followed by a more detailed summary. The brief summary can be a sentence fragment which describes the function of the argument, and the more detailed description can provide additional information which you may find in a help file. The brief and detailed summaries are placed in different table cells using the vertical pipe || formatting. |
| Line 9: | Line 12: |
| '''Required Flagged Arguments''' - Flagged arugments which are required. The Required Flagged Arguments field should include a very brief summary followed by a more detailed summary. The brief and detailed summaries are placed in different table cells using the vertical pipe || formatting. | '''Required Flagged Arguments''' - Flagged arugments which are required. The Required Flagged Arguments field should include a very brief summary followed by a more detailed summary. The brief and detailed summaries are placed in different table cells using the vertical pipe || formatting. |
| Line 11: | Line 14: |
| '''Optional Flagged Arguments''' - Flagged arguments which are not required. The Optional Flagged Arguments field should include a very brief summary followed by a more detailed summary. The brief and detailed summaries are placed in different table cells using the vertical pipe || formatting. | '''Optional Flagged Arguments''' - Flagged arguments which are not required. The Optional Flagged Arguments field should include a very brief summary followed by a more detailed summary. The brief and detailed summaries are placed in different table cells using the vertical pipe || formatting. |
| Line 13: | Line 16: |
| '''Outputs''' - Name and description of volumes ouput by the command. | '''Outputs''' - Name, description, and file format of volumes ouput by the command. |
| Line 15: | Line 18: |
| '''Description''' - Description of command. | '''Description''' - Detailed description of command including relevant concepts. |
| Line 17: | Line 20: |
| '''Examples''' - Commonly used examples for the commands. | '''Examples''' '''Example 1''' - Example of common usage for command. |
| Line 19: | Line 23: |
| '''Bugs''' - Known bugs. Note that bugs should not be reported here by users. Rather, bug reports should be addressed to the relevant support line. None |
'''Example 2''' - Example with more options. '''Bugs''' - Known bugs. Note that bugs should not be reported here. Rather, bug reports should be sent to the relevant support line. |
| Line 24: | Line 29: |
| '''Links''' - Relecant links on FreeSurferWiki. | '''Links''' - Relevant links on FreeSurferWiki. Useful for providing links to concepts. |
| Line 26: | Line 31: |
| '''Methods Description''' - Description of command which would be suitable for publication in a manuscript. As much as possible, the text should be copy-and-pastable into the Methods section of the manuscript. No Wiki formmating should be used in this section. | '''Methods Description''' - Description of command which would be suitable for publication in a scientific manuscript. As much as possible, the text should be copy-and-pastable into the Methods section of a manuscript. This section should be written in past tense to conform to the style of a scientific manuscript. No Wiki formmating should be used in this section. |
| Line 30: | Line 35: |
| '''Reporting Bugs''' - Where to report bugs. | '''Reporting Bugs''' - Where to report bugs. See FreeSurferSupport. |
| Line 32: | Line 37: |
| '''Author/s''' - Author/s of command. | '''Author/s''' - Author/s of command. The Author name should be the author's WikiUserName. In Unix, you can see who last modified a command by typing {{{ls -l `which COMMMAND`}}} where {{{COMMAND}}} is the name of the command. |
| Line 34: | Line 39: |
| = Create new page from template = 1. Perform any procedure that provokes moin moin to offer to create a new page. For example, on an existing page, insert the wiki page name of the new page you want to create (which will become a link to your new page). This is described here: HelpForBeginners, but basically you insert a name with embedded capitals like this: My''''''New''''''Page. Save and then view this existing page. 2. When viewing the just-edited existing page, your new wiki page name will not yet perform as a link (because as yet the new page has not been created) but will have a question mark "?" link beside it. Clicking on that "?" will invoke a page that offers to create your new page from scratch, or from a list of template pages. Click on one of the template links (for example Command''''''Template) to create your new template-based page. -- GW |
This page provides a description of the headings in the CommandTemplate. Adherence to the this format helps maintain a consistent style specification across all of the commands in FreeSurfer.
(To actually use a template to create a new page, see comments at bottom. -- GW)
Name - Name of command followed by a dash (-) followed by a very brief summary. Eg, mri_info - provides informtion about volume.
Synopsis - Command usage. Arguments should be enclosed in angular brackets and options should be enclosed in square brackets. For example, in mri_info -i <inputfile> -o <outputfile> [-m], <inputfile> and <outputfile> are arguments and -m is an optional flag.. If there are too many options then use the placeholder [options], e.g., mri_info -i <inputfile> -o <outputfile> [options]
Arguments
Positional Arguments - Positional arguments are arguments which are specified by their place in the command string, as opposed to being specified by a flag. Eg, in "mri_convert f g" f and g are positional arguments since they are not passed as arguments of flags. The Positional Arguments field should include a very brief summary followed by a more detailed summary. The brief summary can be a sentence fragment which describes the function of the argument, and the more detailed description can provide additional information which you may find in a help file. The brief and detailed summaries are placed in different table cells using the vertical pipe || formatting.
Required Flagged Arguments - Flagged arugments which are required. The Required Flagged Arguments field should include a very brief summary followed by a more detailed summary. The brief and detailed summaries are placed in different table cells using the vertical pipe || formatting.
Optional Flagged Arguments - Flagged arguments which are not required. The Optional Flagged Arguments field should include a very brief summary followed by a more detailed summary. The brief and detailed summaries are placed in different table cells using the vertical pipe || formatting.
Outputs - Name, description, and file format of volumes ouput by the command.
Description - Detailed description of command including relevant concepts.
Examples
Example 1 - Example of common usage for command.
Example 2 - Example with more options.
Bugs - Known bugs. Note that bugs should not be reported here. Rather, bug reports should be sent to the relevant support line.
See Also - Related commands in FreeSurfer.
Links - Relevant links on FreeSurferWiki. Useful for providing links to concepts.
Methods Description - Description of command which would be suitable for publication in a scientific manuscript. As much as possible, the text should be copy-and-pastable into the Methods section of a manuscript. This section should be written in past tense to conform to the style of a scientific manuscript. No Wiki formmating should be used in this section.
References - Relevant references. The reference can be posted in the ["References"] section.
Reporting Bugs - Where to report bugs. See FreeSurferSupport.
Author/s - Author/s of command. The Author name should be the author's WikiUserName. In Unix, you can see who last modified a command by typing ls -l `which COMMMAND` where COMMAND is the name of the command.
Create new page from template
1. Perform any procedure that provokes moin moin to offer to create a new page. For example, on an existing page, insert the wiki page name of the new page you want to create (which will become a link to your new page). This is described here: HelpForBeginners, but basically you insert a name with embedded capitals like this: MyNewPage. Save and then view this existing page.
2. When viewing the just-edited existing page, your new wiki page name will not yet perform as a link (because as yet the new page has not been created) but will have a question mark "?" link beside it. Clicking on that "?" will invoke a page that offers to create your new page from scratch, or from a list of template pages. Click on one of the template links (for example CommandTemplate) to create your new template-based page.
-- GW