Difference between revisions of "StemNode User Manual"
| Line 1: | Line 1: | ||
| − | + | ==Getting Started== | |
| − | |||
| − | + | === Setting up an Account === | |
| − | + | Editing requires a user account and login. Use your real first name and surname(s), including spaces, as your username. This ensures that when you edit a review, your name shows up correctly. For example use "John Doe" instead of "johndoe" because you want your name to show up as "John Doe" in the list of authors of a manual. | |
| − | |||
| − | === | + | === Starting a New Manual === |
| − | + | At the upper right of the page you can for the piece of equipment or method you are looking for. For equipment search "[Model] - [Manufacturer]". If the equipment page does not exist then you will see the option to "Create" the page above the search results. Click the "Create - [Model]-[Manufacturer]" option (It important that you search by "[Model]-[Manufacturer]" so that the pages are titled according to that standard). You will be taken to a page to edit the source code. In a separate tab, go open the [[Outline for Lab Equipment Manual]] (or [[Outline for a Method]] if appropriate) , click "View Source" and copy and paste the source code into the new page you are creating. This provides tables and an outline structure to get started, as well as ensures that you are credited as an author on the manual. Clicking "Create" at the top of the page then takes you from the source code to a visual editor that is much more similar to a word processor. | |
| − | Equipment | + | == Guidelines for Writing Equipment Manuals and Methods == |
| + | Please use the predefined [[Outline for Lab Equipment Manual]] [[Outline for a Method|or]] | ||
| + | [[Outline for a Method]] when making a new page. The easiest way is to copy and paste the source code. | ||
| + | |||
| + | More detail is better. Many sources give equipment troubleshooting in brief, or methods in brief, but this may lead to problems and confusion. We encourage writing methods in procedural form (SOPs) to with numbered steps. It is OK if these steps may not be repeated identically in all labs; the detail will help others adapt methods and save them time.' | ||
| + | |||
| + | == Advanced Editing == | ||
| + | Mediawiki help pages are available for navigating software features. Most users will prefer to use the visual editor which is similar to using a word processor, however [https://www.mediawiki.org/wiki/Help:Formatting basic formatting code] is helpful for advanced users. | ||
| + | |||
| + | '''Adding Youtubes;''' Videos can be added using the source code below. The "video ID" corresponds with what comes after the equals sign in the URL of the video. For example [https://www.youtube.com/watch?v=I2aFnPihzao www.youtube.com/watch?v=I2aFnPihzao] is embeded with the code <nowiki><youtube>I2aFnPihzao</youtube></nowiki>. | ||
| + | <nowiki><youtube> Video ID </youtube></nowiki> | ||
Latest revision as of 04:03, 6 March 2019
Contents
Getting Started
Setting up an Account
Editing requires a user account and login. Use your real first name and surname(s), including spaces, as your username. This ensures that when you edit a review, your name shows up correctly. For example use "John Doe" instead of "johndoe" because you want your name to show up as "John Doe" in the list of authors of a manual.
Starting a New Manual
At the upper right of the page you can for the piece of equipment or method you are looking for. For equipment search "[Model] - [Manufacturer]". If the equipment page does not exist then you will see the option to "Create" the page above the search results. Click the "Create - [Model]-[Manufacturer]" option (It important that you search by "[Model]-[Manufacturer]" so that the pages are titled according to that standard). You will be taken to a page to edit the source code. In a separate tab, go open the Outline for Lab Equipment Manual (or Outline for a Method if appropriate) , click "View Source" and copy and paste the source code into the new page you are creating. This provides tables and an outline structure to get started, as well as ensures that you are credited as an author on the manual. Clicking "Create" at the top of the page then takes you from the source code to a visual editor that is much more similar to a word processor.
Guidelines for Writing Equipment Manuals and Methods
Please use the predefined Outline for Lab Equipment Manual or Outline for a Method when making a new page. The easiest way is to copy and paste the source code.
More detail is better. Many sources give equipment troubleshooting in brief, or methods in brief, but this may lead to problems and confusion. We encourage writing methods in procedural form (SOPs) to with numbered steps. It is OK if these steps may not be repeated identically in all labs; the detail will help others adapt methods and save them time.'
Advanced Editing
Mediawiki help pages are available for navigating software features. Most users will prefer to use the visual editor which is similar to using a word processor, however basic formatting code is helpful for advanced users.
Adding Youtubes; Videos can be added using the source code below. The "video ID" corresponds with what comes after the equals sign in the URL of the video. For example www.youtube.com/watch?v=I2aFnPihzao is embeded with the code <youtube>I2aFnPihzao</youtube>.
<youtube> Video ID </youtube>
