about_the_class:style_guide
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
about_the_class:style_guide [2010/04/03 07:18] cbrumbau Reorganize, reduce and revise article content |
about_the_class:style_guide [2015/07/28 05:54] (current) ceisenhart ↷ Page moved from style_guide to about_the_class:style_guide |
||
|---|---|---|---|
| Line 8: | Line 8: | ||
| Refer to the [[wiki:syntax|formatting syntax]] guide for any questions regarding formatting syntax. | Refer to the [[wiki:syntax|formatting syntax]] guide for any questions regarding formatting syntax. | ||
| + | |||
| + | |||
| + | ===== Where to try things out ===== | ||
| + | |||
| + | If you want to test your changes before editing a wiki page you can do so at the [[playground:playground]]. | ||
| + | |||
| + | ===== Editing an article ===== | ||
| + | * First navigate to the editor page using the pencil icon at the side of the page. | ||
| + | * Make your edits in the text box. | ||
| + | * For small changes like spelling errors or fixing capitalization choose 'minor changes'. | ||
| + | * For more significant changes provide a brief summary. | ||
| + | * Click the preview button to see your changes, review them to ensure they are as you expect. | ||
| + | * Click the save button to update the wiki. | ||
| ===== How to format articles ===== | ===== How to format articles ===== | ||
| Line 15: | Line 28: | ||
| * Does a page already exist that would be suitable for the new content? Use the search function at the top of the page or view all of the pages available on the wiki using the "Index" button at the bottom of the page to check. | * Does a page already exist that would be suitable for the new content? Use the search function at the top of the page or view all of the pages available on the wiki using the "Index" button at the bottom of the page to check. | ||
| * Will the new content have enough material (now or at some point in the future when more content will be added) to warrant the creation of a new article? | * Will the new content have enough material (now or at some point in the future when more content will be added) to warrant the creation of a new article? | ||
| + | |||
| + | ==== Creating a new article ==== | ||
| In order to add a new article, follow these steps: | In order to add a new article, follow these steps: | ||
| - Navigate to an article that already exists that you would like to link to your new article. | - Navigate to an article that already exists that you would like to link to your new article. | ||
| - | - Add the internal link to your new page in that article. | + | - Add the internal link to your new page in that article by surrounding the desired page name with braces. |
| + | Ex. [[playground:playground]] | ||
| - Follow the link to your new article and click on the "Create new page" button. | - Follow the link to your new article and click on the "Create new page" button. | ||
| + | |||
| + | ==== Adding a file ==== | ||
| + | |||
| + | In order to add an file (.pdf etc), follow these steps: | ||
| + | - Edit the page where the file should be linked. | ||
| + | - Click the 'Add images and other files' button (fourth icon from the right). | ||
| + | - A new window will open displaying the media files. | ||
| + | - Upload the file to the media files. | ||
| + | - Select the uploaded file. | ||
| ==== Article formatting ==== | ==== Article formatting ==== | ||
| Line 98: | Line 123: | ||
| <code> | <code> | ||
| ===== References ===== | ===== References ===== | ||
| + | <refnotes>notes-separator: none</refnotes> | ||
| ~~REFNOTES cite~~ | ~~REFNOTES cite~~ | ||
| </code> | </code> | ||
| Line 105: | Line 131: | ||
| ===== Formatting ===== | ===== Formatting ===== | ||
| - | ==== Protocols ==== | + | ==== Gene symbols ==== |
| - | When listing any form of protocol, please use a numbered list. A numbered list is created by indenting the text by two spaces and using a dash for the list element. Refer to the syntax below: | + | When referring to a gene symbol (not the gene name), please use italics. Refer to the example syntax below: |
| <code> | <code> | ||
| - | An ordered/numbered list: | + | The sonic hedgehog gene, //Shh//, is a part of the hedgehog signaling pathway and plays a role in vertibrate organogenesis. |
| - | - List element 1 | + | |
| - | - List element 2 | + | |
| - | - etc. | + | |
| </code> | </code> | ||
| Line 122: | Line 145: | ||
| </code> | </code> | ||
| - | ==== Gene symbols ==== | + | ==== Protocols ==== |
| - | When referring to a gene symbol (not the gene name), please use italics. Refer to the example syntax below: | + | When listing any form of protocol, please use a numbered list. A numbered list is created by indenting the text by two spaces and using a dash for the list element. Refer to the syntax below: |
| <code> | <code> | ||
| - | The sonic hedgehog gene, //Shh//, is a part of the hedgehog signaling pathway and plays a role in vertibrate organogenesis. | + | An ordered/numbered list: |
| + | - List element 1 | ||
| + | - List element 2 | ||
| + | - etc. | ||
| </code> | </code> | ||
about_the_class/style_guide.1270279134.txt.gz · Last modified: 2010/04/03 07:18 by cbrumbau
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial-Share Alike 3.0 Unported
