Help:Notebook

From OpenWetWare

(Difference between revisions)
Jump to: navigation, search
Current revision (14:49, 4 November 2011) (view source)
(Entry Base template page)
 
(38 intermediate revisions not shown.)
Line 1: Line 1:
-
<font size=1>< [[Help:Contents|Help]]</font>
+
[[Image:Owwnotebook icon.png]]To see an example of the new OpenWetWare Lab Notebook in action, take a look [[OpenWetWare:Software/Projects/Lab_Notebooks/Activity|here]].
-
<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.'''
 
 +
=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 (or just need help setting it up!), feel free to [[Contact_Us|contact us]].
 +
==Setting up your Lab Notebook (One-click setup)==
 +
* The easiest way to setup your lab notebook is by using the [[/One_Click_Setup|One-click setup tool]]. You simply fill in the fields of the form and click. If everything is filled in correctly, you should have your lab notebook up and running instantaneously.
-
Some OpenWetWare (OWW) users like to maintain an online lab notebook on OWW.  Here's a quick page describing how to do so easily.
+
* However, there are some '''requirements that need to be met''' before you can create notebooks anywhere:
 +
** You must obviously be a registered and logged in user of OWW.
 +
** The notebook will only be created for IGEM teams if the IGEM team page already exists for the current year.
 +
** The notebook will only be created for your Lab if the Lab page already exists.
-
==Naming==
+
<center>
-
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.  
+
{| {{table}} width="350px"
 +
|-
 +
|style="background-color:#e5edc8;" align="center" | <html><img src="/images/d/d2/Green-go.png" width="32" height="32" alt="Go" title="Go" /></html> [[/One_Click_Setup|One-click Lab Notebook Setup]]
 +
|}
-
If you are starting your own personal lab notebook, name it according to your username.  For instance, <font face="courier">'''User:OWWusername/Notebook'''</font>
+
{| {{table}} width="350px"
 +
|-
 +
|style="background-color:#c8d9dd;" align="center" | <html><img src="/images/0/05/Video-reel.png" width="32" height="32" alt="Screencasts" title="Screencasts" /></html> [[/Screencasts|View the screencasts]]
 +
|}
 +
For any help with the form or setting up the required pages, feel free to [[Contact_Us|contact us]]</center>
-
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>.
+
==Using your lab notebook==
 +
===Notebook page===
 +
* Once your notebook is set up, you can start making entries on a daily basis. By simply clicking on the calendar date you want to make an entry for, a page will automatically be created using your Entry_Base template and you can add your data by simply editing the page.
 +
[[image:notebook-help.jpg|400px|thumb|center]]
-
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>.
+
===Entry page===
 +
* If you are viewing an entry page, you can navigate to other entry pages (for example, using the links to the previous and next day's entries if they exist). These navigation links let you browse your notebook without having to jump back to the project page.
 +
[[image:entry-help.jpg|400px|thumb|center]]
-
==Starting a notebook==
+
==Naming recommendations==
-
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. 
+
* 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:
-
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 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>
-
<font face="courier">
+
===For Labs===
-
<pre>
+
:*<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>
-
<calendar>
+
:**<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>
-
name=iGEM:MIT/2006/Notebook
+
:*<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>
-
date=2006/07/01
+
:**<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>
-
view=threemonths
+
-
format=%name/%year-%month-%day
+
-
weekstart=7
+
-
</calendar>
+
-
<calendar>
+
===For iGEM Teams===
-
name=iGEM:MIT/2006/Notebook
+
<span style="font-size:10px;">(Visit the ''[[IGEM:HelpU/2008/Notebook/Project_name1|Help University]]'' example for more information regarding iGEM lab notebooks)</span>
-
date=2006/10/01
+
:*<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>
-
view=threemonths
+
:**<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>
-
format=%name/%year-%month-%day
+
:*<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_2</span>
-
weekstart=7
+
:**<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_2</span>/<span style="color:#CC9933;">Entry_Base</span>
-
</calendar>
+
-
</pre>
+
-
</font>
+
-
Using this approach has several advantages including
 
-
#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.
 
-
#You won't have to make all the links by hand, they are all autogenerated for you.
 
-
==Examples==
+
==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.
-
To see a real example of what such a notebook looks like, visit the [[iGEM:MIT/2006/Notebook|2006 MIT iGEM team's notebook]].
+
:{| {{table}} width="510px" align="center"
 +
|-
 +
|style="background-color:#e5edc8;" | '''NOTE:''' This page may not seem to have much of a purpose at the moment but we are actively working on new features for the lab notebooks that will take advantage of a central notebook page for your project(s). Stay tuned! :)
 +
|}
-
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.
+
==Project page==
-
<calendar>
+
* 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:
-
name=Help:Notebook
+
** the dynamic calendar
-
date=2007/01/01
+
** the local search box
-
view=threemonths
+
-
format=%name/%year-%m-%d
+
-
weekstart=7
+
-
</calendar>
+
-
==Other approaches==
+
:[[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]]]]
-
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.
+
==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.
-
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.
+
:[[image:norm-entpage-screen.png|left|thumb|300px|Go to and copy the [[Help:Notebook/Project_Base/Entry_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/Entry_Base|iGEM lab notebook entry template]]]]
-
==Lab Notebook Development Version Usage Tracking==
+
__NOTOC__
-
{{Special:Recentchanges/n=Notebook&limit=50}}
+

Current revision

Image:Owwnotebook icon.pngTo see an example of the new OpenWetWare Lab Notebook in action, take a look here.


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 (or just need help setting it up!), feel free to contact us.

Setting up your Lab Notebook (One-click setup)

  • The easiest way to setup your lab notebook is by using the One-click setup tool. You simply fill in the fields of the form and click. If everything is filled in correctly, you should have your lab notebook up and running instantaneously.
  • However, there are some requirements that need to be met before you can create notebooks anywhere:
    • You must obviously be a registered and logged in user of OWW.
    • The notebook will only be created for IGEM teams if the IGEM team page already exists for the current year.
    • The notebook will only be created for your Lab if the Lab page already exists.
Go One-click Lab Notebook Setup
Screencasts View the screencasts
For any help with the form or setting up the required pages, feel free to contact us

Using your lab notebook

Notebook page

  • Once your notebook is set up, you can start making entries on a daily basis. By simply clicking on the calendar date you want to make an entry for, a page will automatically be created using your Entry_Base template and you can add your data by simply editing the page.

Entry page

  • If you are viewing an entry page, you can navigate to other entry pages (for example, using the links to the previous and next day's entries if they exist). These navigation links let you browse your notebook without having to jump back to the project page.

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_2
    • http://openwetware.org/wiki/IGEM:UnivName/2008/Notebook/Project_name_2/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 not seem to have much of a purpose at the moment but we are actively working on new features for the lab notebooks that will take advantage of a central notebook page for your project(s). Stay tuned! :)

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