Differences between revisions 4 and 5
Deletions are marked like this. Additions are marked like this.
Line 16: Line 16:
 * Acronyms in WikiName``s should be capitalized. For example,
   '''Right''': CleanNMRSpectrum [[BR]]
   '''Wrong''': Clean``Nmr``Spectrum
 * Acronyms in WikiName``s should ''not'' be capitalized. For example,
   '''Right''': Clean``Nmr``Spectrum [[BR]]
   '''Wrong''': Clean
NMRSpectrum [[BR]]
 Words containing acronyms are actually not CamelCase.

1. Linking

  • With the exception of the ToDo page, 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


4. Formatting

  • Acronyms in WikiNames should not be capitalized. For example,

    • Right: CleanNmrSpectrum BR Wrong: CleanNMRSpectrum BR

    Words containing acronyms are actually not CamelCase.

  • Use non-CamelCase WikiNames for commands. For example,

    • Right: ["mri_convert"] BR Wrong: MriConvert BR

    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.

  • Use CamelCase for subtopics related to a command. For example,

  • The citation style for attached references is described in detail in the ["References"] section.

5. Page Layout

  • Use a single page with headlines (see HelpOnHeadlines) for a sequence of actions, for example, for a WorkFlow or a step-by-step tutorial.

  • 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

StyleGuidelines (last edited 2008-04-29 11:46:06 by localhost)