How to Create a Protocol

Tips for Design

You should generally organize a protocol to have sections that are relevant from this list:

  • Supplies (materials, strains, primers)
  • Step-by-step instructions for each step
  • Expected results (quantitative information, graphics, images)
  • Common problems and troubleshooting
  • Spreadsheets for calculations

Include instructions that reference specific reagents (strains, primers, etc.) for performing positive and negative control reactions. It is very important and can save a great deal of time if you run these reactions to diagnose bad reagents or a general problem with carrying out the protocol versus a problem with applying it in a specific case.

These protocols are public, so don't post passwords, protected information, or copyrighted material. Use the internal Barrick Lab web pages for that.

How to Create a New Protocol / Wiki Page

  1. Navigate to the page that will link to your new page.
  2. Edit this page.
    • Add a link using this syntax:
      [[TopicName][Link Text]]
    • TopicName should be a WikiWord that is descriptive of the new topic. Many topics on the Barrick Lab pages begin with certain words indicating how they are categorized, e.g. "Protocol", "Reference", "Internal".
    • Link Text will be the text of the hyperlink that appears on the web page.
    • Save your edit.
  3. Now, a red link to your new page should appear when you view this page.
  4. Click on the red link and you will be taken to the edit window for your new page!

How to Add Images

  1. Click the "attach" link at the bottom of your page
  2. Choose your image file:
    • Avoid spaces in the file name. Use underscores instead.
    • Under "Properties" check the box called "Create a link to the attached file."
  3. After you click "Upload file" your image will appear at the bottom of the page after a bullet point.
  4. Now edit the page and move the tag to where you want it displayed in the page.

Tips:

  • If you accidentally forget to hide the attachment, you can click on the attach link and then edit the properties of the file you uploaded at any later time.
  • You can refer to an image that is attached to a different page with this syntax:
     <img src="%PUBURL%/%WEB%/OtherTopic/image.jpg"> 

Further Tips for Editing the Wiki

Try editing a page where you see what you want to do and copying the syntax!! Monkey see, Monkey do.

Or, you could read the TWiki Reference Manual. (Useful sections: Shorthand | Variables | Icons)

Edit | Attach | Print version | History: r6 < r5 < r4 < r3 < r2 | Backlinks | Raw View | Raw edit | More topic actions...

 Barrick Lab  >  ProtocolList  >  ProtocolHowTo

Topic revision: r5 - 24 Mar 2016 - 16:21:00 - Main.JeffreyBarrick
 
This site is powered by the TWiki collaboration platformCopyright ©2017 Barrick Lab contributing authors. Ideas, requests, problems? Send feedback