Difference between revisions of "StemNode User Manual"

Latest revision as of 04:03, 6 March 2019

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>

@@ Line 1: / Line 1: @@
+==Getting Started==
-===Getting Started Editing===
+=== Setting up an Account ===
-'''Setting up an Account''' - Editing requires a user account and login.  This login is separate from your stemnode.org 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.
+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.
-'''Do's'''- Use the predefined outlines when making a new method. Copy and paste the source code from the appropriate outline to start;<br/>
+=== Starting a New Manual ===
-[[Outline for a Technological Process Node]] (for circular nodes)<br/>
+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.
-[[Outline for a Natural Process Node]] (for circular nodes)<br/>
-[[Outline for a Storage Node]] (for square nodes)<br/>
-[[Outline for a Flow]] (for both informational and physical flows)<br/>
-All can be changed to use terminology which fits the specific process or flow, however the general format should be adhered to in order to keep a consistent layout of information for all nodes and flows.
+== 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.
-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. This manual covers specifically how the mediawiki software is used for stemnode.
+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.'
-===Guidelines for Writing Reviews===
+== Advanced Editing ==
--Write at the level appropriate to the associated node(s). Content associated with subsystem nodes should not be duplicated at the parent level node, although brief summaries of the subsystems are typically appropriate. The interaction of two nodes within a system should be covered at the parent level node. Also, makes and models of subsystems should be specified at the parent level node while how the subsystems works should be specified in the relevant subsystem wiki.
+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.
--Often times reviews should have longer and more detailed titles than the nodes which they link from. This is because the system diagrams have context that imply many things wheras the reviews are out of context and a single review can be linked to multiple nodes. When a succinct name for a process does not exist you should lead the title with it's primary output (e.g. "Yogurt production" has a primary output of "Yogurt"). When a product can be made from different inputs, use the format "[Primary Output] from [Primary Input]" in the name of the review.
+'''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>
--Ensure the reviews can remain relevant to the node(s) they are associated with by keeping content generalized only to the level of that node.  The interaction of two nodes needs to be written about at the review associated with the parent level node.
--Give yourself and other authors credit by including <code><nowiki>{{Template:CiteAuthors}}</nowiki></code> as the top line in the source code of each review.