CAZypedia needs your help! We have many unassigned GH, PL, CE, AA, GT, and CBM pages in need of Authors and Responsible Curators.
Scientists at all career stages, including students, are welcome to contribute to CAZypedia. Read more here, and in the 10th anniversary article in Glycobiology.
New to the CAZy classification? Read this first.
*
Consider attending the 15th Carbohydrate Bioengineering Meeting in Ghent, 5-8 May 2024.

Difference between revisions of "Help:Getting Started Guide"

From CAZypedia
Jump to navigation Jump to search
 
(40 intermediate revisions by the same user not shown)
Line 1: Line 1:
This page provides a step-by-step guide for getting yourself up and running as a CAZypedia [[Responsible Curator]] or [[Author]].  If you have already established yourself on CAZypedia and are looking for specific help on editing/authoring pages see [[Help:Editing]] instead.
+
''This page provides a step-by-step guide for getting yourself up and running as a ''CAZypedia'' [[Responsible Curator]] or [[Author]].  If you have already established yourself on ''CAZypedia'' and are looking for specific help on editing/authoring pages see [[Help:Contents]] instead.''
  
== Getting started ==
+
== Obtain a user account ==
* If you haven't already done so, open this page in the [http://www.mozilla.com/firefox/ Mozilla FireFox] browser.
+
'''You must have a user account to contribute to ''CAZypedia''.  Due to spam attacks, creation of user accounts on ''CAZypedia'' by individuals in the community has been disabled.  If you have recently been contacted by one of the [[Board of Curators|Senior Curators]] and asked to begin work on ''CAZypedia'', please contact the [[User:Hbrumer3|Primary Curator]] when you are ready to start; an account will then be created for you. Once you have a user account, please continue with the steps below.'''
 +
 
 +
== Getting ready ==
 +
* If you haven't already done so, open this page in the [http://www.mozilla.com/firefox/ Mozilla FireFox] browser ''(Javascript should be  enabled)''.
 
** If you don't have [http://www.mozilla.com/firefox/ FireFox], you can get it [http://www.mozilla.com/firefox/ here].
 
** If you don't have [http://www.mozilla.com/firefox/ FireFox], you can get it [http://www.mozilla.com/firefox/ here].
** ''(Yes, you can work on CAZypedia in Microsoft Internet Explorer, but it is very inferior, especially when editing CAZypedia pages.  <u>Please</u> use [http://www.mozilla.com/firefox/ FireFox].)''
+
*** CAZypedia also works well with [http://www.seamonkey-project.org/ SeaMonkey], [http://www.apple.com/safari/ Safari], or [http://www.google.com/chrome Google Chrome].
 +
*** ''(Yes, you can work on ''CAZypedia'' in Microsoft Internet Explorer, but it is very inferior, especially when editing ''CAZypedia'' pages.  In IE, you '''will not''' be able to use CAZypedia's advanced editor, [[Help:Editing#Making_life_a_bit_easier:_The_wikEd_editor_in_CAZypedia|wikEd]].  '''Please''' use [http://www.mozilla.com/firefox/ FireFox], or one of the other preferred browsers.)''
  
 
* In [http://www.mozilla.com/firefox/ FireFox], right-click on this link and select "Open Link in New Tab": [[Special:Userlogin]]
 
* In [http://www.mozilla.com/firefox/ FireFox], right-click on this link and select "Open Link in New Tab": [[Special:Userlogin]]
** '''Opening pages on multiple tabs allows you to quickly jump back-and-forth to read these instructions while as you do other stuff.'''
+
** '''Opening pages on multiple tabs allows you to quickly jump back-and-forth to read these instructions while you do other stuff.'''
  
 +
<!-- Commented out 2 July 2009 by HB
 
== Create a new user account ==
 
== Create a new user account ==
 
* Click on the new tab in your browser ("Log in / create account - CAZypedia").
 
* Click on the new tab in your browser ("Log in / create account - CAZypedia").
Line 19: Line 24:
 
* Enter your current E-mail address.
 
* Enter your current E-mail address.
  
* Pick a reasonably strong password.
+
* Pick a strong password.
  
 
* Type the two words shown in the red captcha box above.  (Click on the (?) button in the red box if you need help with the captcha).
 
* Type the two words shown in the red captcha box above.  (Click on the (?) button in the red box if you need help with the captcha).
  
 
* Click the "Create account" button.
 
* Click the "Create account" button.
 +
-->
  
=== Set your account preferences ===
+
== Set your account preferences ==
 
* If you are not logged in, click the "Log in" link at the top right of the page and do so.
 
* If you are not logged in, click the "Log in" link at the top right of the page and do so.
  
Line 36: Line 42:
 
* Click "Save".
 
* Click "Save".
  
== Make biography for yourself on your userpage ==
+
* '''Also:  If you received a randomly generated password from ''CAZypedia'' by e-mail, you may change it to something that suits you better on your preferences page.  However, please make sure to choose a [http://www.microsoft.com/security/online-privacy/passwords-create.aspx strong password].''' ''(If this link is broken, just google "Strong password" for tips).''
 +
 
 +
== Make a biography for yourself on your userpage ==
 +
* Take a moment to read this page on how to use the editor: [[Help:Editing]] (right click and "Open Link in New Tab").
 +
 
 +
* See [[:Category:Contributors|biographies from other contributors]] for examples (right click and "Open Link in New Tab").  [[User:Gerlind Sulzenbacher|Gerlind Sulzenbacher's]] biography is particularly exemplary; we would like all contributors to have biographical pages with a similar amount of information as hers.
 +
 
 
* If you are not logged in, click the "Log in" link at the top right of the page and do so.
 
* If you are not logged in, click the "Log in" link at the top right of the page and do so.
  
* Click on "My talk" at the top of the page.  A box will open for you start editing the page.
+
* Click on your '''username''' at the top of the page (NOTE: Do '''not''' click on "'''my talk'''" - this is a different page, used as a discussion forum).  A box will open for you start editing the page.
** ''Unsure of how to edit/add text?''
 
*** Take a moment to read this page on how to use the editor [[Help:Editing]] (right click and "Open Link in New Tab").
 
*** See [[:Category:Contributors|biographies from other contributors]] for examples (right click and "Open Link in New Tab").  Some good examples of suitable content are [[User:Withers]] and [[User:hbrumer3]].  Note that you can "borrow" and re-write text from these pages to help while you learn how to format text.
 
  
 
* When you've got some text in place, click the "Save Page" button at the bottom.  It's OK to start with a few words (like your name) just to test it out.
 
* When you've got some text in place, click the "Save Page" button at the bottom.  It's OK to start with a few words (like your name) just to test it out.
  
* ''Not happy?''  Just click the "Edit" tab at the top of the page and change it!  ''(Again and again and again...)''
+
* ''Not happy?''  Just click the "Edit" tab at the top of the page and change it - you can repeat this process again and again and again... It is understood that ''CAZypedia'' is a "work in progress," so don't worry about getting it perfect or complete on the first edit.
  
* '''Important:'''  Your userpage page is the place where the [[Board of Curators]] would like you to demonstrate that you are credible expert in the field.  Please make sure that your bio page is professional; it will be linked from whichever pages your are associated with, and all your edits in CAZypedia will be automatically logged in the history with links to your userpage.
+
* '''Important:'''  Your userpage page is the place where the [[Board of Curators]] would like you to demonstrate that you are credible expert in the field.  Please make sure that your bio page is professional; it will be linked from whichever pages you are associated with, and all your edits in ''CAZypedia'' will be automatically logged in the history with links to your userpage.
 +
 
 +
* '''It is also highly recommended to enrich your userpage''' with a photo, as well as links to your academic homepage and the userpages of other CAZypedians with whom you may have worked.  You can even include a short publication list.  See [[User:Masafumi Hidaka|Masafumi Hidaka's userpage]] for a great example of these.
  
 
<blockquote>
 
<blockquote>
'''''A little handy tip:'' You can always have more than one browser window/tab open at a time to look at examples in CAZypedia while you edit another page.  You can even open two pages for editing (or "view source") at the same time, so you can copy & paste wiki-text from one to the other.  This is a great way to get going quickly on the way to making nice-looking CAZypedia pages.'''
+
'''''A little handy tip:'' You can always have more than one browser window/tab open at a time to look at examples in ''CAZypedia'' while you edit another page.  You can even open two pages for editing (or "view source") at the same time, so you can copy & paste wiki-text from one to the other.  This is a great way to get going quickly on the way to making nice-looking ''CAZypedia'' pages.'''
 
</blockquote>
 
</blockquote>
  
 
== Start curating or authoring your page! ==
 
== Start curating or authoring your page! ==
*  Have a look at some other GH pages (yes...right click, open in new tab...): [[:Category:Glycoside Hydrolase Families]]
+
*  Have a look at some other [[:Category:Curator approved|Curator Approved]] GH pages by following this link (''yes...right click, open in new tab...''): [[:Category:Curator approved]]
 +
 
  
 
=== For [[Responsible Curator|Responsible Curators]] ===
 
=== For [[Responsible Curator|Responsible Curators]] ===
 
When you are ready to create the entry for which you are responsible please follow these simple steps:
 
When you are ready to create the entry for which you are responsible please follow these simple steps:
  
* If, for example, you are in charge of family GH213, type "Glycoside Hydrolase Family 213" into the '''search box''' on the left side of the page.  '''Make sure your spelling is accurate.'''
+
* If, for example, you are in charge of family GH213, type ''Glycoside Hydrolase Family 213'' into the '''search box''' in the top right corner of the page.  '''Make sure your spelling is accurate.'''
  
* CAZYpedia will say "There is no page titled "Glycoside Hydrolase Family 213". You can create this page."
+
* ''CAZypedia'' will say "There is no page titled ''Glycoside Hydrolase Family 213''. You can create this page."
  
 
* Click the "create this page" link and an empty template will automatically load.
 
* Click the "create this page" link and an empty template will automatically load.
Line 79: Line 91:
 
''Make sure to read [[Help:Editing]] and [[Help:References]] carefully for information on how to make pages and insert literature references.  Both links are always one click away through the [[Help:Contents|Help!]] link in the left Navigation box.  [[Help:Editing]] is always available at the bottom of the editing window when it's open.''  
 
''Make sure to read [[Help:Editing]] and [[Help:References]] carefully for information on how to make pages and insert literature references.  Both links are always one click away through the [[Help:Contents|Help!]] link in the left Navigation box.  [[Help:Editing]] is always available at the bottom of the editing window when it's open.''  
 
</blockquote>
 
</blockquote>
 +
  
 
=== For [[Author|Authors]] ===
 
=== For [[Author|Authors]] ===
If you have been invited by a [[Responsible Curator]] to act as an [[Author]] on a CAZypedia entry, your assigned page should already be in place.
+
If you have been invited by a [[Responsible Curator]] to act as an [[Author]] on a ''CAZypedia'' entry, your assigned page should already be in place.
  
* If, for example, you are an [[Author]] of the family GH213 entry, type "Glycoside Hydrolase Family 213" into the '''search box''' on the left side of the page.
+
* If, for example, you are an [[Author]] of the family GH213 entry, type ''Glycoside Hydrolase Family 213'' into the '''search box''' in the top right corner of the page.
** If CAZypedia says "There is no page titled "Glycoside Hydrolase Family 213". You can create this page.", DO NOT CLICK THE LINK.  Instead, check your spelling.  If you still can't find the page, immediately contact the page's [[Responsible Curator]], i.e. the person who invited to to contribute.
+
** If ''CAZypedia'' says "There is no page titled ''Glycoside Hydrolase Family 213''. You can create this page.", DO NOT CLICK THE LINK.  Instead, check your spelling.  If you still can't find the page, immediately contact the page's [[Responsible Curator]], i.e. the person who invited you to contribute.
  
 
* Click the "Watch" tab at the top of the page (''Important!'').
 
* Click the "Watch" tab at the top of the page (''Important!'').
Line 94: Line 107:
 
</blockquote>
 
</blockquote>
  
=== * A little handy tip (redux) ===
+
== * A little handy tip (redux) ==
''' You can always have more than one browser window/tab open at a time to look at examples in CAZypedia while you edit another page.  You can even open two pages for editing (or "view source") at the same time, so you can copy & paste wiki-text from one to the other.  This is a great way to get going quickly on the way to making nice-looking CAZypedia pages.'''
+
''' You can always have more than one browser window/tab open at a time to look at examples in ''CAZypedia'' while you edit another page.  You can even open two pages for editing (or "view source") at the same time, so you can copy & paste wiki-text from one to the other.  This is a great way to get going quickly on the way to making nice-looking ''CAZypedia'' pages.'''

Latest revision as of 09:24, 23 February 2012

This page provides a step-by-step guide for getting yourself up and running as a CAZypedia Responsible Curator or Author. If you have already established yourself on CAZypedia and are looking for specific help on editing/authoring pages see Help:Contents instead.

Obtain a user account

You must have a user account to contribute to CAZypedia. Due to spam attacks, creation of user accounts on CAZypedia by individuals in the community has been disabled. If you have recently been contacted by one of the Senior Curators and asked to begin work on CAZypedia, please contact the Primary Curator when you are ready to start; an account will then be created for you. Once you have a user account, please continue with the steps below.

Getting ready

  • If you haven't already done so, open this page in the Mozilla FireFox browser (Javascript should be enabled).
    • If you don't have FireFox, you can get it here.
      • CAZypedia also works well with SeaMonkey, Safari, or Google Chrome.
      • (Yes, you can work on CAZypedia in Microsoft Internet Explorer, but it is very inferior, especially when editing CAZypedia pages. In IE, you will not be able to use CAZypedia's advanced editor, wikEd. Please use FireFox, or one of the other preferred browsers.)
  • In FireFox, right-click on this link and select "Open Link in New Tab": Special:Userlogin
    • Opening pages on multiple tabs allows you to quickly jump back-and-forth to read these instructions while you do other stuff.


Set your account preferences

  • If you are not logged in, click the "Log in" link at the top right of the page and do so.
  • Click on "My preferences" at the top right of the page.
  • Check that your "Real Name" and "E-mail Address" are correct (under the "User profile" tab).
  • Check all of the boxes in the "E-mail" options box.
  • Click "Save".
  • Also: If you received a randomly generated password from CAZypedia by e-mail, you may change it to something that suits you better on your preferences page. However, please make sure to choose a strong password. (If this link is broken, just google "Strong password" for tips).

Make a biography for yourself on your userpage

  • Take a moment to read this page on how to use the editor: Help:Editing (right click and "Open Link in New Tab").
  • If you are not logged in, click the "Log in" link at the top right of the page and do so.
  • Click on your username at the top of the page (NOTE: Do not click on "my talk" - this is a different page, used as a discussion forum). A box will open for you start editing the page.
  • When you've got some text in place, click the "Save Page" button at the bottom. It's OK to start with a few words (like your name) just to test it out.
  • Not happy? Just click the "Edit" tab at the top of the page and change it - you can repeat this process again and again and again... It is understood that CAZypedia is a "work in progress," so don't worry about getting it perfect or complete on the first edit.
  • Important: Your userpage page is the place where the Board of Curators would like you to demonstrate that you are credible expert in the field. Please make sure that your bio page is professional; it will be linked from whichever pages you are associated with, and all your edits in CAZypedia will be automatically logged in the history with links to your userpage.
  • It is also highly recommended to enrich your userpage with a photo, as well as links to your academic homepage and the userpages of other CAZypedians with whom you may have worked. You can even include a short publication list. See Masafumi Hidaka's userpage for a great example of these.

A little handy tip: You can always have more than one browser window/tab open at a time to look at examples in CAZypedia while you edit another page. You can even open two pages for editing (or "view source") at the same time, so you can copy & paste wiki-text from one to the other. This is a great way to get going quickly on the way to making nice-looking CAZypedia pages.

Start curating or authoring your page!


For Responsible Curators

When you are ready to create the entry for which you are responsible please follow these simple steps:

  • If, for example, you are in charge of family GH213, type Glycoside Hydrolase Family 213 into the search box in the top right corner of the page. Make sure your spelling is accurate.
  • CAZypedia will say "There is no page titled Glycoside Hydrolase Family 213. You can create this page."
  • Click the "create this page" link and an empty template will automatically load.
  • Go through the template and delete all the text as instructed in the template.
  • Change the Responsible Curator and Author(s) in the header to the appropriate people (of which you should be one...).
  • Click the "Save page" button.
  • Important: Click the "Watch" tab at the top of the page.
  • Finally...your authors and/or yourself should open the page for editing (click the tab at the top of the page) and start producing content!

Make sure to read Help:Editing and Help:References carefully for information on how to make pages and insert literature references. Both links are always one click away through the Help! link in the left Navigation box. Help:Editing is always available at the bottom of the editing window when it's open.


For Authors

If you have been invited by a Responsible Curator to act as an Author on a CAZypedia entry, your assigned page should already be in place.

  • If, for example, you are an Author of the family GH213 entry, type Glycoside Hydrolase Family 213 into the search box in the top right corner of the page.
    • If CAZypedia says "There is no page titled Glycoside Hydrolase Family 213. You can create this page.", DO NOT CLICK THE LINK. Instead, check your spelling. If you still can't find the page, immediately contact the page's Responsible Curator, i.e. the person who invited you to contribute.
  • Click the "Watch" tab at the top of the page (Important!).
  • Click on the "Edit" tab at the top of the page and get to work!

Make sure to read Help:Editing and Help:References carefully for information on how to make pages and insert literature references. Both links are always one click away through the Help! link in the left Navigation box. Help:Editing is always available at the bottom of the editing window when it's open.

* A little handy tip (redux)

You can always have more than one browser window/tab open at a time to look at examples in CAZypedia while you edit another page. You can even open two pages for editing (or "view source") at the same time, so you can copy & paste wiki-text from one to the other. This is a great way to get going quickly on the way to making nice-looking CAZypedia pages.