Differences between revisions 7 and 10 (spanning 3 versions)

1. Linking

With the exception of the ToDo page and your WikiHomePage, please do not link to documentation in your personal homepages. Rather, you are encouraged to incorporate your documentation into the wiki.

2. Modifications

Please provide a comment with any modifications.

3. Templates

The wiki uses the following Templates

HomepageTemplate: Outline for Homepages.
CommandTemplate: Style specification for commands.
ReferenceTemplate: Citation style.
WorkFlowTemplate: Outline for WorkFlows.

Anchor(Formatting)

4. Formatting

Acronyms in WikiNames should not be capitalized. For example,
- Right: CalculateRoiStatistics BR Wrong: CalculateROIStatistics BR
Words containing acronyms are actually not CamelCase.
However, acronyms alone should be capitalized. For example,
- Right: ROI BR Wrong: Roi BR
Commands should use the same case as that of the actual command. For example,
- Right: ["mri_convert"] BR Wrong: MriConvert BR
There are some cases where a term is both an application and a command. For example, TkMedit refers to the application and ["tkmedit"] refers to the actual command. Use CamelCase or not depending on wheter you are referring to the application or the command.
Use CamelCase for subtopics related to a command. For example,
- Right: TkMeditGuide BR Wrong: tkmeditguide or tkmeditGuide
Use bold font for menu commands. For example,
- Right: File->Load Overlay data BR Wrong: File->Load Overlay data
The citation style for attached references is described in detail in the ["References"] section.

5. Page Layout

Use subpages (see HelpOnEditing/SubPages) to organize material which cannot fit on a single page.

6. Encyclopedias

To create an encyclopedia reference, create a page for the term, e.g., ["fMRI"], and then link to the encyclopedia reference from that page.

Mathematics BR MathworldBR [http://www.mathworld.com] BR BR MR Physics BR Amersham Health Medcyclopaedia BR [http://www.amershamhealth.com/medcyclopaedia] BR

-  ⇤ ← Revision 7 as of 2004-08-07 02:45:46 → 
  Size: 2074
  Editor: DavidTuch
  Comment: fixed typo
+   ← Revision 10 as of 2004-08-11 13:51:34 → ⇥
  Size: 2254
  Editor: DavidTuch
  Comment: added style recommendation for menu commands
-Deletions are marked like this.
+Additions are marked like this.
 Line 17:
-   '''Right''': Clean``Nmr``Spectrum [[BR]]
   '''Wrong''': CleanNMRSpectrum [[BR]]
+   '''Right''': Calculate``Roi``Statistics [[BR]]
   '''Wrong''': Calculate``ROI``Statistics [[BR]]
 Line 21:
- * Use non-CamelCase WikiName``s for commands. For example,
+ * However, acronyms alone should be capitalized. For example,
   '''Right''': ROI [[BR]]
   '''Wrong''': Roi [[BR]]

 * Commands should use the same case as that of the actual command.  For example,
-Line 24:
+Line 28:
- There are some cases where a term is both a concept and a command. For example, TkMedit refers to the application and ["tkmedit"] refers to the actual command. Use CamelCase or not depending on wheter you are referring to the concept or the command.
+ There are some cases where a term is both an application and a command. For example, TkMedit refers to the application and ["tkmedit"] refers to the actual command. Use CamelCase or not depending on wheter you are referring to the application or the command.
-Line 30:
+Line 34:
+ * Use '''bold''' font for menu commands. For example,
   '''Right''': '''File->Load Overlay data''' [[BR]]
   '''Wrong''': File->Load Overlay data
-Line 33:
+Line 41:
- * Use a single page with headlines (see HelpOnHeadlines) for a sequence of actions, for example, for a WorkFlow or a step-by-step tutorial.