CAZypedia needs your help!
We have many unassigned pages in need of Authors and Responsible Curators. See a page that's out-of-date and just needs a touch-up? - You are also welcome to become a CAZypedian. Here's how.
Scientists at all career stages, including students, are welcome to contribute.
Learn more about CAZypedia's misson here and in this article.
Totally new to the CAZy classification? Read this first.

Difference between revisions of "Help:Getting Started Guide"

From CAZypedia
Jump to navigation Jump to search
 
(83 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''. For security, direct creation of user accounts on ''CAZypedia'' has been disabled.'''
** 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].)''
 
  
* In [http://www.mozilla.com/firefox/ FireFox], right-click on this link and select "Open Link in New Tab": [[Special:Userlogin]]
+
You are mostly likely reading this page becuase an account has already been set-up for you.  Otherwise, if you would like to become a ''CAZypedia'' [[Author]] or [[Responsible Curator]], please contact the [[Board of Curators|Primary Curator]], [[User:Harry Brumer|Harry Brumer]], by email at brumer[@]msl.ubc.ca.  Please make sure you are familiar with ''CAZypedia's'' [[CAZypedia:About|mission and editorial policies]].
**Opening pages on multiple tabs allows you to quickly jump back-and-forth to read these instructions while as you do other stuff.
 
  
== Create a new user account ==
+
== Getting ready ==
* Click on the new tab "Log in / create account" in your browser.
+
* We generally prefer to use the [http://www.mozilla.com/firefox/ Mozilla FireFox] browser, which works consistently well with MediaWiki, the software that runs ''CAZypedia''.
 +
** '''Note:''' ''Javascript should be enabled to ensure that CAZypedia's advanced editor, [[Help:Editing#Making_life_a_bit_easier:_The_wikEd_editor_in_CAZypedia|wikEd]], functions properly.
 +
** You may be able to use other modern browsers, e.g. [http://www.apple.com/safari/ Apple Safari], [http://www.google.com/chrome Google Chrome], [https://microsoft.com/edge Microsoft Edge], [https://www.opera.com/ Opera], etc.
 +
*** [https://microsoft.com/ie Microsoft Internet Explorer] (now retired) will work for basic editing, but '''will not''' run ''CAZypedia's'' advanced editor, [[Help:Editing#Making_life_a_bit_easier:_The_wikEd_editor_in_CAZypedia|wikEd]], resulting in a poor experience.
  
* Click on "Create an account."
+
* 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 you do other stuff.'''
* '''Use your real first and last name as your username.'''  Also, make sure to re-enter your real name in that field.
 
** '''''Failure to follow these guidelines will result in your account being blocked.'''''
 
** If you make an error and/or the account you created has been blocked, please contact the [[Board of Curators|Primary Curator]].
 
 
 
* Enter your current E-mail address.
 
 
 
* Pick a reasonably 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).
 
 
 
* Click the "Create account" button.
 
  
== Make a biography page for yourself ==
+
== Set your account preferences ==
* If you are not automatically 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 preferences" at the top right of the page.
* Click on "My talk" at the top of the page. A box will open for you start editing the page.
+
* Check that your "Real Name" and "E-mail Address" are correct (under the "User profile" tab).
** ''Unsure of what to do?''
+
* Check all of the boxes in the "E-mail" options box.
*** Take a moment to read this page on how to use the editor [[Help:Editing]] (right click and "Open Link in New Tab").
+
* Click "Save".
*** See [[Category:Contributors|bio pages 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.
+
* '''AlsoIf 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.'''
  
 +
== 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.
 +
* 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.
 
* 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 requested that you 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.
 +
* ''A handy tip: You can have more than one browser window/tab open at a time to look at examples in ''CAZypedia'' while you edit your page.  You can also open the other page for editing (or "view source"), so you can copy & paste wiki-text from that example page to yours.  This is a great way to get going quickly and make nice-looking ''CAZypedia'' pages.''
  
* ''Not happy?''  Just click the "Edit" tab at the top of the page and change it!  ''(Again and again and again...)''
+
== Start contributing to your page! ==
 
+
*  Have a look at some other [[:Category:Curator approved|Curator Approved]] pages by following this link (''yes...right click, open in new tab...''): [[:Category:Curator approved]]
 
+
* Make sure to read [[Help:Editing]], [[Help:References]], and [[Help:Images]] carefully for information on how to make pages, and insert literature references and figuresThese links are always one click away through the ''For contributors'' section in the left menu.  [[Help:Editing]] is always available at the bottom of the editing window when it's open.
<blockquote>
+
* You can navigate to your page either directly using the search in the top right corner of the page, or via the links in the ''Content'' section in the left menu.
'''''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>
 
 
 
== 4. 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]]
 
 
 
=== For [[Responsible Curator|Responsible Curators]] ===
 
When you are ready to create the entry you are responsible for 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.
 
 
 
* 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.
 
 
 
* ''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!
 
 
 
<blockquote>
 
'''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>
 
 
 
=== 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, 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 CAZypedia says "There is no page titled "Glycoside Hydrolase Family 213". You can create this page.", DO NOT CLICK THE LINK. Instead, immediately contact the page's [[Responsible Curator]], i.e. the person who invited to to contribute.
 
 
 
 
* Click on the "Edit" tab at the top of the page and get to work!
 
* Click on the "Edit" tab at the top of the page and get to work!
  
<blockquote>
+
=== A handy tip (redux) ===
'''Make sure to read [[Help:Editing]] and [[Help:References]] carefully for information on how to make pages and insert literature referencesBoth 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.''
+
'' You can always have more than one browser window/tab open at a time to look at examples in ''CAZypedia'' while you edit a pageYou can even open the example page for editing (or "view source") at the same time, so you can copy & paste wiki-text from one to the otherThis is a great way to create page content quickly, borrowing from already established ''CAZypedia'' pages.''
</blockquote>
 

Latest revision as of 09:25, 22 May 2024

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. For security, direct creation of user accounts on CAZypedia has been disabled.

You are mostly likely reading this page becuase an account has already been set-up for you. Otherwise, if you would like to become a CAZypedia Author or Responsible Curator, please contact the Primary Curator, Harry Brumer, by email at brumer[@]msl.ubc.ca. Please make sure you are familiar with CAZypedia's mission and editorial policies.

Getting ready

  • We generally prefer to use the Mozilla FireFox browser, which works consistently well with MediaWiki, the software that runs CAZypedia.
  • 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.

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 biographies from other contributors for examples (right click and "Open Link in New Tab"). 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.
  • 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 requested that you 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 handy tip: You can have more than one browser window/tab open at a time to look at examples in CAZypedia while you edit your page. You can also open the other page for editing (or "view source"), so you can copy & paste wiki-text from that example page to yours. This is a great way to get going quickly and make nice-looking CAZypedia pages.

Start contributing to your page!

  • Have a look at some other Curator Approved pages by following this link (yes...right click, open in new tab...): Category:Curator approved
  • Make sure to read Help:Editing, Help:References, and Help:Images carefully for information on how to make pages, and insert literature references and figures. These links are always one click away through the For contributors section in the left menu. Help:Editing is always available at the bottom of the editing window when it's open.
  • You can navigate to your page either directly using the search in the top right corner of the page, or via the links in the Content section in the left menu.
  • Click on the "Edit" tab at the top of the page and get to work!

A 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 a page. You can even open the example page 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 create page content quickly, borrowing from already established CAZypedia pages.