Difference between revisions of "UGR Report Template"

From ESE497 Wiki
Jump to navigationJump to search
 
(40 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
<sidebar>UGR Report Template Nav</sidebar>
 
<sidebar>UGR Report Template Nav</sidebar>
−
Instructions for creating your web based wiki report
+
To create you web based report, you need to know a few tricks in WikiSpeak. Just click on View Edit at the top of this page and copy and paste from here to your new pages.
−
To create you web based report, you need to know a few tricks in WikiSpeak. Just edit this page and copy and paste from here to your new pages.
+
* '''To create a new page''', edit the page where the link should be and use the wiki syntax: [[New Page | New Page]]. When you click on New Page it will automatically create the page for you if it doesn't exist. Edit this page to see the syntax.
−
* To create a new page, edit the page where the link should be and use the wiki syntax: [[New Page | New Page]]. When you click on New Page it will automatically create the page for you if it doesn't exist. Edit this page to see the syntax.
+
* '''For main headings''' on the same page, use the == around the heading name. This will create sub-pages automatically.
−
* For main headings on the same page, use the == around the heading name. This will create sub-pages automatically.
+
* '''For Bullets''', use * or ** for multiple levels
−
* For Bullets, use * or ** for multiple levels
+
* [http://www.mediawiki.org/wiki/Help:Formatting MediaWiki help page for more '''formatting''']
−
* [http://ese.wustl.edu/ese497 Link to URL Example]
+
* [http://ese.wustl.edu Link to '''URL Example''']
−
* To link to an uploaded file (PDF for example)
+
* [http://www.mediawiki.org/wiki/Help:Tables '''Make a table''']
−
** Click on the "Upload File" link in the "toolbox" on the left side of the page
+
* '''Link to an uploaded file''' (PDF for example)
−
** [[media:LabVIEW_Robotics_Tutorial.pdf|Link to PDF Example]
+
** Click on the "Upload File" link in the "toolbox" on the left side of the page and browse to file. Uploaded file name might be reformatted on the wiki so copy the file name and paste that into your wiki page. Also, the filename is case sensitive!
−
* Insert an image [[File:IMG_2458.JPG|400px|thumb|right|Zach and his Robot]]  
+
** [[media:LabVIEW_Robotics_Tutorial.pdf|Link to PDF Example]]
 +
[[File:IMG_2458.JPG|400px|Zach and his Robot]]  
 +
* '''Insert an image'''
 
** Click on the "Upload File" link in the "toolbox" on the left side of the page
 
** Click on the "Upload File" link in the "toolbox" on the left side of the page
 
** Browse to the image.
 
** Browse to the image.
 
** There are several syntax examples on the Upload page to use depending on how you want the image to render
 
** There are several syntax examples on the Upload page to use depending on how you want the image to render
−
** Remember that the filename is case sensitive!
+
<mediaplayer width=720 height=504>FILE:Andrew UGRPoseterSession_043010 09.avi.MP4</mediaplayer>
−
* Insert a video [[File:MVI_2467.AVI‎|400px|thumb|right|Chase and his Robot]]  
+
* '''Insert a video'''
−
**To install and enable the Custom Sidebar extension click [[http://www.mediawiki.org/wiki/Extension:Player here]]
+
** Convert your video to .mp4. You can use [http://www.softpedia.com/get/Multimedia/Video/Encoders-Converter-DIVX-Related/SUPER.shtml Super] to do this.
 +
** Upload .mp4 to the wiki
 +
** This is already done, but to install and enable the MediawikiPlayer extension click [[http://www.mediawiki.org/wiki/Extension:MediawikiPlayer here]]
 
== Create a custom navigation box ==
 
== Create a custom navigation box ==
−
* To install and enable the Custom Sidebar extension click [[http://www.mediawiki.org/wiki/Extension:CustomSidebar here]]
 
 
* Create a new wiki page - use your main report page name with Nav as the suffix.
 
* Create a new wiki page - use your main report page name with Nav as the suffix.
−
* Copy and Paste from the Sidebar for this page [[UGR Report Template Nav|UGR Report Template Navigation]]
+
* Copy and Paste from this page to create your Sidebar [[UGR Report Template Nav|UGR Report Template Navigation]]
 +
* It's useful initially to keep the link to the Sidebar in your sidebar so you can navigate to it easily.
 
* Edit this document and look at the top line to see and example of how to invoke the custom navigation box. Add the sidebar line to all of the pages of your report.
 
* Edit this document and look at the top line to see and example of how to invoke the custom navigation box. Add the sidebar line to all of the pages of your report.
 +
* This is already done, but to install and enable the Custom Sidebar extension click [[http://www.mediawiki.org/wiki/Extension:CustomSidebar here]]
  
 
== Writing Equations ==
 
== Writing Equations ==
−
The equation editor uses TEX syntax where you can do:
+
* The equation editor uses TEX syntax to create your equations in line:
  
 
<math>a_{i,j} + a^2 = \sqrt{z^2}</math>
 
<math>a_{i,j} + a^2 = \sqrt{z^2}</math>
 +
 +
* [http://meta.wikimedia.org/wiki/Help:Formula MediaWiki help for TeX syntax]

Latest revision as of 19:26, 21 June 2010

<sidebar>UGR Report Template Nav</sidebar> To create you web based report, you need to know a few tricks in WikiSpeak. Just click on View Edit at the top of this page and copy and paste from here to your new pages.

  • To create a new page, edit the page where the link should be and use the wiki syntax: New Page. When you click on New Page it will automatically create the page for you if it doesn't exist. Edit this page to see the syntax.
  • For main headings on the same page, use the == around the heading name. This will create sub-pages automatically.
  • For Bullets, use * or ** for multiple levels
  • MediaWiki help page for more formatting
  • Link to URL Example
  • Make a table
  • Link to an uploaded file (PDF for example)
    • Click on the "Upload File" link in the "toolbox" on the left side of the page and browse to file. Uploaded file name might be reformatted on the wiki so copy the file name and paste that into your wiki page. Also, the filename is case sensitive!
    • Link to PDF Example

Zach and his Robot

  • Insert an image
    • Click on the "Upload File" link in the "toolbox" on the left side of the page
    • Browse to the image.
    • There are several syntax examples on the Upload page to use depending on how you want the image to render

<mediaplayer width=720 height=504>FILE:Andrew UGRPoseterSession_043010 09.avi.MP4</mediaplayer>

  • Insert a video
    • Convert your video to .mp4. You can use Super to do this.
    • Upload .mp4 to the wiki
    • This is already done, but to install and enable the MediawikiPlayer extension click [here]

Create a custom navigation box

  • Create a new wiki page - use your main report page name with Nav as the suffix.
  • Copy and Paste from this page to create your Sidebar UGR Report Template Navigation
  • It's useful initially to keep the link to the Sidebar in your sidebar so you can navigate to it easily.
  • Edit this document and look at the top line to see and example of how to invoke the custom navigation box. Add the sidebar line to all of the pages of your report.
  • This is already done, but to install and enable the Custom Sidebar extension click [here]

Writing Equations

  • The equation editor uses TEX syntax to create your equations in line:

<math>a_{i,j} + a^2 = \sqrt{z^2}</math>

Retrieved from "http://classes.engineering.wustl.edu/ese497/index.php?title=UGR_Report_Template&oldid=727"