How to make a tutorial on the help wiki

From VectorBase Development

Jump to: navigation, search
  1. Write your tutorial (either as a powerpoint or PDF)
    • Decide on a title for your tutorial, try to keep it similar to the other ones on the site List of tutorials
  2. Upload to Slideshare
    • www.slideshare.net, login as user VectorBase and follow the online instructions
      • Clik on the upload button, in the top left menu
      • Follow the instructions - you might need to use the "Having trouble using bulk upload?" link
      • Upload your document, giving him a clear title and if possible a short description and tags (keywords)
      • The upload can take a while .... up to several mn.
    • Check that the flash processing looks good (important for PPT as sometime images get mangled)
    • Make a note of the URL for embedding in web pages (the wiki in our case)
      • The info. is in the white square, on the right "Embed ..." (click customize to get a version without related slides)
  3. Decide on the page title for the Help Wiki
    • Follow the wiki template below to mark up your tutorial
    • Look at the one that is already done if you struggle
  4. All done, check the page to see that it looks okay and mail the group to let people know that a new tutorial is online
    • We would like to include these in newsletters and maybe news items (if things are quiet!)


Section 1 - Site organisation, add a Category tag so that this page is indexed with the other tutorials 

[Category:Tutorial]]

Section 2 - Embedding the Slideshare Flash This is an example and you will need to alter the URLs for your tutorial based on cut-and-paste from the embedded URL as provided by SlideShare. We have made a couple of modifications to change the default size (width & height parameters) and to remove the a lot of the extraneous information including allowScriptAccess, tags and some links. Basically, you need to keep what's between the <object style...> and </object> tags. If you are unsure about this then contact Dan. 

<table cellpadding=5 width=100%>
<tr><td>
<html>
<object style="margin:0px" width="580" height="510">
<param name="movie" value="http://static.slideshare.net/swf/ssplayerd.swf?doc=caphelp-1222462327198344-8&stripped_title=vectorbase" />
<param name="allowFullScreen" value="true"/>
<embed src="http://static.slideshare.net/swf/ssplayerd.swf?doc=caphelp-1222462327198344-8&stripped_title=vectorbase" type="application/x-shockwave-flash"  allowfullscreen="true" width="580" height="510">
</embed>
</object>
</html>
</td>

Section 3 - Adding a title panel 

<td valign=top >
{| width=100% cellpadding=5 cellspacing=5
|-
| style="background:#008800; color:#FFFFFF;" align=center | <big>'''Community Annotation System Tutorial'''</big>
|-
|}

Section 4 - Adding a download link to the PDF, you will need to upload the PDF to the Help Wiki 

{{PDF|VectorBase_Community_annotation_submission.pdf|Community Annotation submission instructions}}
<br/>

Section 5 - Adding explanatory text about the tutorial 

A bit of text to describe you tutorial.</td>
</tr>

Section 6 - Tidy up page, close the table and force a newline 

</table>
<br clear="all" />
Retrieved from "http://neuron.cse.nd.edu/vectorbase/index.php/How_to_make_a_tutorial_on_the_help_wiki"
Personal tools