Help:Notebook

From OpenWetWare

(Difference between revisions)
Jump to: navigation, search
(New Lab Notebook tutorial)
Line 1: Line 1:
-
<font size=1>< [[Help:Contents|Help]]</font>
+
=Lab Notebook Tutorial=
 +
:By the end of this tutorial, you should have an online lab notebook up and running. If you have feedback regarding any step in this tutorial or any of the lab notebook features, feel free to [[Contact_Us|contact us]].
-
<html><img src="/images/e/e1/Important-orange.png" width="32" height="32" alt="Important" title="Important"  align="left" style="margin: 5px;"/></html>
 
-
'''Please note. Although there are a lot of good things one can do using the instructions below, please be aware that we're in the midst of revising our documentation as we move to a new OpenWetWare.org Lab Notebook initiative.'''
 
 +
==Setting up your Lab Notebook==
 +
* To set up your lab notebook you'll first need to create a few pages and put them in the right places. As soon as they are set up, you'll be a click away from creating new lab notebook entries.
 +
* The required pages are:
 +
*# '''The Notebook page'''
 +
*# '''The Project page'''
 +
*# '''The Entry Base template page'''
-
Some OpenWetWare (OWW) users like to maintain an online lab notebook on OWW.  Here's a quick page describing how to do so easily.
+
*By putting these pages in their proper places you will not only keep [[OpenWetWare:Tidy|OWW tidy]], but you'll also be able to take full advantage of the features we've built into the lab notebook.
-
==Naming==
+
* By simply copying and pasting the wikitext that you'll find in our templates, you will have your lab notebook working in no time. It's as simple as 1, 2, 3!
-
Given that there are several lab notebooks on OWW and that every article in OWW must have a unique name, it helps to name your lab notebook such that it tells everyone else that it's yours.  That way, others know to respect those pages (i.e. not edit them).  It also prevents clashing of different lab notebooks which might have similar page names.
+
-
If you are starting your own personal lab notebook, name it according to your username. For instance, <font face="courier">'''User:OWWusername/Notebook'''</font>.  
+
:{| style="border: 0px;"
 +
| align="center" style="background-color:#EEEEEE;"| 1 || align="center"| || align="center" style="background-color:#EEEEEE;"| 2 || align="center"| || align="center" style="background-color:#EEEEEE;"| 3
 +
|-
 +
| align="center"| Create page || align="center"| [[image:arrow_right.png]] || align="center"| Copy template code || align="center"| [[image:arrow_right.png]] || align="center"| Paste into new page & Save
 +
|}
-
If a group of OWW users are sharing a lab notebook, name it according to your group. For instance, <font face="courier">'''BEInG:Notebook'''</font>. 
+
==Naming recommendations==
 +
* If you plan to work on more than one project, we recommend that you set up a separate project page for each project and compile them in your notebook page. You can do this quite easily by keeping your online lab notebook organized as shown below:
-
If you are an iGEM team, name it according to your institution and the year.  For instance, <font face="courier">'''iGEM:MIT/2006/Notebook'''</font>.
+
===For Users===
 +
:*<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>User:John_Q._Smith/<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_1</span>
 +
:**<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>User:John_Q._Smith/<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_1</span>/<span style="color:#CC9933;">Entry_Base</span>
 +
:*<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>User:John_Q._Smith/<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_2</span>
 +
:**<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>User:John_Q._Smith/<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_2</span>/<span style="color:#CC9933;">Entry_Base</span>
-
==Starting a notebook==
+
===For Labs===
-
One easy way of starting a lab notebook is via the calendar extension in OWW. It will autogenerate links to all the days of a month.
+
:*<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>LabName:<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_1</span>
 +
:**<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>LabName:<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_1</span>/<span style="color:#CC9933;">Entry_Base</span>
 +
:*<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>LabName:<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_2</span>
 +
:**<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>LabName:<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_2</span>/<span style="color:#CC9933;">Entry_Base</span>
-
Add the code below to your primary notebook page.  Be sure and replace <font face="courier">'''iGEM:MIT/2006/Notebook'''</font> with your own notebook name. Also replace the date with the date relevant to when you want your lab notebook to start. If you have spaces in your notebook name, replace them with underscores '_' in the code below.  
+
===For iGEM Teams===
 +
<span style="font-size:10px;">(Visit the ''[[IGEM:HelpU/2008/Notebook/Project_name1|Help University]]'' example for more information regarding iGEM lab notebooks)</span>
 +
:*<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>IGEM:UnivName/2008/<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_1</span>
 +
:**<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>IGEM:UnivName/2008/<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_1</span>/<span style="color:#CC9933;">Entry_Base</span>
 +
:*<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>IGEM:UnivName/2008/<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_1</span>
 +
:**<span style="color:#666666;"><nowiki>http://openwetware.org/wiki/</nowiki></span>IGEM:UnivName/2008/<span style="color:maroon;">Notebook</span>/<span style="color:green;">Project_name_1</span>/<span style="color:#CC9933;">Entry_Base</span>
-
<font face="courier">
 
-
<pre>
 
-
<calendar>
 
-
name=iGEM:MIT/2006/Notebook
 
-
date=2006/07/01
 
-
view=threemonths
 
-
format=%name/%year-%month-%day
 
-
weekstart=7
 
-
</calendar>
 
-
<calendar>
+
==Notebook page==
-
name=iGEM:MIT/2006/Notebook
+
* This page is where you should list all your projects. Even if you have only one!
-
date=2006/10/01
+
** Create the Notebook page in the proper hierarchy as displayed in the naming recommendation section above.
-
view=threemonths
+
-
format=%name/%year-%month-%day
+
-
weekstart=7
+
-
</calendar>
+
-
</pre>
+
-
</font>
+
-
Using this approach has several advantages including
+
:{| {{table}} width="510px" align="center"
-
#All the links will have the same naming convention.  This reduces the likelihood of inconsistent naming and makes it easier to find other pages.
+
|-
-
#Navigating between notebook pages is easy.  Each notebook page will include a backlink to the main notebook page and the main notebook page will link to everything.
+
|style="background-color:#e5edc8;" | '''NOTE:''' This page may be a bit dull now, but we are working on some features that will make this page your dashboard from where you can manage/overview your project(s)
-
#You won't have to make all the links by hand, they are all autogenerated for you.
+
|}
-
==Examples==
+
==Project page==
 +
* The notebook page is where you will find some of the tools/features that allow you to maneuver around your lab notebook. The two most important tools at the moment are:
 +
** the dynamic calendar
 +
** the local search box
-
To see a real example of what such a notebook looks like, visit the [[iGEM:MIT/2006/Notebook|2006 MIT iGEM team's notebook]].
+
:[[image:norm-projpage-screen.png|left|thumb|300px|Go to and copy the [[Help:Notebook/Project_Base|Standard project template]]]]
 +
[[image:igem-projpage-screen.png|none|thumb|300px|Go to and copy the [[IGEM:HelpU/2008/Notebook/Project_name1|iGEM project template]]]]
-
With the help of templates, you can also easily add absolute and relative navigation links to all your notebook pages. Click on the January 1st page below to see an example.
+
==Entry Base template page==
-
<calendar>
+
* The Entry Base template page is what your entry pages will look like when they are created. By making changes to the Entry Base template page, all subsequent entry pages you create will reflect these changes.
-
name=Help:Notebook
+
-
date=2007/01/01
+
-
view=threemonths
+
-
format=%name/%year-%m-%d
+
-
weekstart=7
+
-
</calendar>
+
-
==Other approaches==
+
:[[image:norm-entpage-screen.png|left|thumb|300px|Go to and copy the [[Help:Notebook/Project_Base|Standard lab notebook entry template]]]]
 +
[[image:igem-entpage-screen.png|none|thumb|300px|Go to and copy the [[IGEM:HelpU/2008/Notebook/Project_name1|iGEM lab notebook entry template]]]]
-
This approach to maintaining a lab notebook may not work for you.  You're free to use other approaches, but please name your notebook pages in such a way that they are easily identifiable as yours.  It helps to make it obvious to everyone which pages they should and should not edit.
 
-
To see more of what the Calendar extension can do, visit the [[Calendar:Template|calendar template]].  For instance, you can display an entire year at a time if you wish.
+
__NOTOC__
-
 
+
-
 
+
-
==Lab Notebook Development Version Usage Tracking==
+
-
{{Special:Recentchanges/n=Notebook&limit=50}}
+

Revision as of 02:01, 7 April 2008

Lab Notebook Tutorial

By the end of this tutorial, you should have an online lab notebook up and running. If you have feedback regarding any step in this tutorial or any of the lab notebook features, feel free to contact us.


Setting up your Lab Notebook

  • To set up your lab notebook you'll first need to create a few pages and put them in the right places. As soon as they are set up, you'll be a click away from creating new lab notebook entries.
  • The required pages are:
    1. The Notebook page
    2. The Project page
    3. The Entry Base template page
  • By putting these pages in their proper places you will not only keep OWW tidy, but you'll also be able to take full advantage of the features we've built into the lab notebook.
  • By simply copying and pasting the wikitext that you'll find in our templates, you will have your lab notebook working in no time. It's as simple as 1, 2, 3!
1 2 3
Create page image:arrow_right.png Copy template code image:arrow_right.png Paste into new page & Save

Naming recommendations

  • If you plan to work on more than one project, we recommend that you set up a separate project page for each project and compile them in your notebook page. You can do this quite easily by keeping your online lab notebook organized as shown below:

For Users

  • http://openwetware.org/wiki/User:John_Q._Smith/Notebook/Project_name_1
    • http://openwetware.org/wiki/User:John_Q._Smith/Notebook/Project_name_1/Entry_Base
  • http://openwetware.org/wiki/User:John_Q._Smith/Notebook/Project_name_2
    • http://openwetware.org/wiki/User:John_Q._Smith/Notebook/Project_name_2/Entry_Base

For Labs

  • http://openwetware.org/wiki/LabName:Notebook/Project_name_1
    • http://openwetware.org/wiki/LabName:Notebook/Project_name_1/Entry_Base
  • http://openwetware.org/wiki/LabName:Notebook/Project_name_2
    • http://openwetware.org/wiki/LabName:Notebook/Project_name_2/Entry_Base

For iGEM Teams

(Visit the Help University example for more information regarding iGEM lab notebooks)

  • http://openwetware.org/wiki/IGEM:UnivName/2008/Notebook/Project_name_1
    • http://openwetware.org/wiki/IGEM:UnivName/2008/Notebook/Project_name_1/Entry_Base
  • http://openwetware.org/wiki/IGEM:UnivName/2008/Notebook/Project_name_1
    • http://openwetware.org/wiki/IGEM:UnivName/2008/Notebook/Project_name_1/Entry_Base


Notebook page

  • This page is where you should list all your projects. Even if you have only one!
    • Create the Notebook page in the proper hierarchy as displayed in the naming recommendation section above.
NOTE: This page may be a bit dull now, but we are working on some features that will make this page your dashboard from where you can manage/overview your project(s)

Project page

  • The notebook page is where you will find some of the tools/features that allow you to maneuver around your lab notebook. The two most important tools at the moment are:
    • the dynamic calendar
    • the local search box
Go to and copy the Standard project template
Go to and copy the Standard project template
Go to and copy the iGEM project template
Go to and copy the iGEM project template

Entry Base template page

  • The Entry Base template page is what your entry pages will look like when they are created. By making changes to the Entry Base template page, all subsequent entry pages you create will reflect these changes.


Personal tools