|
Size: 1971
Comment: Changed WikICase to CamelCase.
|
← Revision 15 as of 2008-04-29 11:46:06 ⇥
Size: 3025
Comment: converted to 1.6 markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 1: | Line 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. |
#pragma section-numbers on |
| Line 4: | Line 3: |
| = Modifications = * Please provide a comment with any modifications. |
<<Navigation(children)>> |
| Line 7: | Line 5: |
| = Templates = | ''' Index ''' <<TableOfContents>> == Templates == |
| Line 14: | Line 15: |
| [[Anchor(Formatting)]] = Formatting = * Capitalize acronyms in WikiName``s. For example, '''Right''': CleanNMRSpectrum [[BR]] '''Wrong''': Clean``Nmr``Spectrum |
<<Anchor(Formatting)>> == Formatting == * Acronyms in WikiName``s should ''not'' be capitalized. For example, '''Right''': Calculate``Roi``Statistics <<BR>> '''Wrong''': Calculate``ROI``Statistics <<BR>> Words containing acronyms are actually not CamelCase. |
| Line 20: | Line 22: |
| * Use non-CamelCase WikiName``s for commands. For example, '''Right''': ["mri_convert"] [[BR]] '''Wrong''': Mri``Convert [[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. |
* 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''': Mri``Convert <<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 whether you are referring to the application or the command. |
| Line 26: | Line 32: |
| '''Right''': TkMeditGuide [[BR]] | '''Right''': TkMeditGuide <<BR>> |
| Line 29: | Line 35: |
| * The citation style for attached references is described in detail in the ["References"] section. | * Use '''bold''' font for menu commands. For example, '''Right''': '''File->Load Overlay data''' <<BR>> '''Wrong''': File->Load Overlay data |
| Line 31: | Line 39: |
| = 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. |
* The citation style for attached references is described in detail in the [[References]] section. <<Anchor(Graphics)>> == Graphics == * Adding graphics to a page is simple. Go to the page you want to add the graphics to. Click on Attach``File and upload the graphics file. Then add the line `attac``hment:filename.ext` in the source for the page. * You should not incorporate graphics by linking to an http address, even if the address is located inside the wiki. * If you think a graphic may be valuable to other pages, for example, if it's a commonly used icon, then you can add it to a central page. For example, see [[Icons]]. Other users can then link to that image using the wiki address, e.g., `attachment:WikiPage/filename.ext`. == 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. == Modifications == * Please provide a comment with any modifications. == Page Layout == |
| Line 35: | Line 59: |
| = 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. |
== 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. |
| Line 38: | Line 62: |
| '''Mathematics''' [[BR]] Mathworld[[BR]] [http://www.mathworld.com] [[BR]] [[BR]] '''MR Physics''' [[BR]] Amersham Health Medcyclopaedia [[BR]] [http://www.amershamhealth.com/medcyclopaedia] [[BR]] |
'''Mathematics''' <<BR>> Mathworld<<BR>> [[http://www.mathworld.com]] <<BR>> <<BR>> '''MR Physics''' <<BR>> Amersham Health Medcyclopaedia <<BR>> [[http://www.amershamhealth.com/medcyclopaedia]] <<BR>> |
Index
1. Templates
The wiki uses the following Templates
HomepageTemplate: Outline for Homepages.
CommandTemplate: Style specification for commands.
ReferenceTemplate: Citation style.
WorkFlowTemplate: Outline for WorkFlows.
2. Formatting
Acronyms in WikiNames should not be capitalized. For example,
Right: CalculateRoiStatistics
Wrong: CalculateROIStatistics
Words containing acronyms are actually not CamelCase.
- However, acronyms alone should be capitalized. For example,
Right: ROI
Wrong: Roi
- Commands should use the same case as that of the actual command. For example,
Right: mri_convert
Wrong: MriConvert
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 whether you are referring to the application or the command.
Use CamelCase for subtopics related to a command. For example,
Right: TkMeditGuide
Wrong: tkmeditguide or tkmeditGuide
Use bold font for menu commands. For example,
Right: File->Load Overlay data
Wrong: File->Load Overlay data
The citation style for attached references is described in detail in the References section.
3. Graphics
Adding graphics to a page is simple. Go to the page you want to add the graphics to. Click on AttachFile and upload the graphics file. Then add the line attachment:filename.ext in the source for the page.
- You should not incorporate graphics by linking to an http address, even if the address is located inside the wiki.
If you think a graphic may be valuable to other pages, for example, if it's a commonly used icon, then you can add it to a central page. For example, see Icons. Other users can then link to that image using the wiki address, e.g., attachment:WikiPage/filename.ext.
4. 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.
5. Modifications
- Please provide a comment with any modifications.
6. Page Layout
Use subpages (see HelpOnEditing/SubPages) to organize material which cannot fit on a single page.
7. 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
Mathworld
http://www.mathworld.com
MR Physics
Amersham Health Medcyclopaedia
http://www.amershamhealth.com/medcyclopaedia