Difference between revisions of "Template for UB MAE 277 Class"

From GICL Wiki
Jump to: navigation, search
(References)
(Guide to Writing Wiki Code)
Line 49: Line 49:
  
 
<b>Here's a few tips on writing with Wiki:</b>
 
<b>Here's a few tips on writing with Wiki:</b>
 +
 +
This is a bracket "[" "]"
 +
 +
 +
This is a brace "{" "}"
 
   
 
   
 +
 
To create a new page/link within Wiki:
 
To create a new page/link within Wiki:
 
*Double brackets, page name, double brackets
 
*Double brackets, page name, double brackets
*Typing in a new page name will automatically create a page, which when clicked, you can then edit
+
*Typing in a new page name will automatically create a page, which when clicked, you can then edit.
 +
*Whatever name you first type in is the name of the page. You can't change page names, only create new pages. Think before you create a new page.
 +
*Don't worry about slashes or anything, all pages are located in the same directory. If I wanted to create a page called "MAE 277 Template" the code would be ''[[''MAE 277 Template'']]'' Note: Brackets are italicized to prevent creating a new page.
 +
 
  
 
Your table of contents is created automatically.
 
Your table of contents is created automatically.
 
*1,2,3,4 are level 2 sections
 
*1,2,3,4 are level 2 sections
 
*1.1, 1.2, 1.3 are level 3 headers
 
*1.1, 1.2, 1.3 are level 3 headers
 +
  
 
To create headers:
 
To create headers:
*Section titles are wrapped with two equal signs (two on each side)
+
*Section titles are wrapped with two equal signs ''==''My favorite header''==''
*Bold headers within a section are wrapped with three equal signs
+
*Bold headers within a section are wrapped with three equal signs ''===''My not-so-favorite header''===''
 +
 
  
 
Asterisks indicate bullets. Be sure to put each asterisk on a new line.  
 
Asterisks indicate bullets. Be sure to put each asterisk on a new line.  
 
*Here's one
 
*Here's one
 
*Here's two *Here's three, but its not on the next line
 
*Here's two *Here's three, but its not on the next line
 +
  
 
Bold text:
 
Bold text:
 
*Start line with "b" in "<>". Be sure to end the line with "/b" in "<>" if you don't want the whole paragraph to be bold.
 
*Start line with "b" in "<>". Be sure to end the line with "/b" in "<>" if you don't want the whole paragraph to be bold.
 
*Surround text to be bolded with three " ' " marks on either side. Or highlight the text and click the "B" button on the toolbar.
 
*Surround text to be bolded with three " ' " marks on either side. Or highlight the text and click the "B" button on the toolbar.
 +
  
 
Italics:
 
Italics:
 
*"i" in "<>". Don't forget to end with "/i" in "<>"
 
*"i" in "<>". Don't forget to end with "/i" in "<>"
 
*Highlight the text and click the "I" button in the toolbar (It will put four " ' " on either side).
 
*Highlight the text and click the "I" button in the toolbar (It will put four " ' " on either side).
 +
  
  
 
[[Media:Media File Link|This is a broken link media file caption]]
 
[[Media:Media File Link|This is a broken link media file caption]]
 +
  
 
Media tags are indicated by "Media:", images by "Image:" Broken links in red. Case is not important. Use the toolbar to get examples if you're not sure.
 
Media tags are indicated by "Media:", images by "Image:" Broken links in red. Case is not important. Use the toolbar to get examples if you're not sure.
 +
  
 
Spacing is werid in wiki.  
 
Spacing is werid in wiki.  
Line 86: Line 102:
  
 
Triple return (two blank lines), puts an extra blank line between lines of text.
 
Triple return (two blank lines), puts an extra blank line between lines of text.
 +
  
 
"br" in "<>" will break lines. They can also be used to separate section headers.
 
"br" in "<>" will break lines. They can also be used to separate section headers.

Revision as of 17:45, 18 September 2006

Contents

Executive Summary

This section is much like an abstract and summarizes the entire report

Introduction

This section should include an introduction of the product and a brief description of group members (i.e. who was responsible for which sections or tasks)

Before Disassembly Section

General notes about the product (it's condition, how it works, how many parts, types of materials, etc)

Disassembly Procedure

  • Document each step to disassemble the product
  • How difficult was each disassembly step?
  • What types of tools were required to perform this step?
  • Include a picture of each disassembly step

After Disassembly

Part Table, including:

  • Part number
  • Part name
  • Number of parts of this type
  • Part material
  • Part manufacturing process
  • Image of the part
  • CAD file for selected parts

Assembly

  • Document each step to reassemble the product
  • How difficult was each assembly step?
  • What types of tools were required to perform this step?

After Assembly

  • Does it still work?
  • Conclusion remarks

References

APA Style You must use this format (It's easier than MLA, so don't worry).

Guide to Writing Wiki Code

The beauty about Wiki is that if you don't know the code, you can steal it from someone's page that does. Feel free to click the "edit" links or tabs to view the code for sections or the pages respectively. Be weary about wrecking havoc on another's page. Each page can be rollbacked to a previous verison and your username is linked to all changes. Although you might think it's cool to go through and insert "MIKE RULES" throughout the page, I'm sure Dr. Lewis would not be pleased.

Here's a few tips on writing with Wiki:

This is a bracket "[" "]"


This is a brace "{" "}"


To create a new page/link within Wiki:

  • Double brackets, page name, double brackets
  • Typing in a new page name will automatically create a page, which when clicked, you can then edit.
  • Whatever name you first type in is the name of the page. You can't change page names, only create new pages. Think before you create a new page.
  • Don't worry about slashes or anything, all pages are located in the same directory. If I wanted to create a page called "MAE 277 Template" the code would be ''MAE 277 Template'' Note: Brackets are italicized to prevent creating a new page.


Your table of contents is created automatically.

  • 1,2,3,4 are level 2 sections
  • 1.1, 1.2, 1.3 are level 3 headers


To create headers:

  • Section titles are wrapped with two equal signs ==My favorite header==
  • Bold headers within a section are wrapped with three equal signs ===My not-so-favorite header===


Asterisks indicate bullets. Be sure to put each asterisk on a new line.

  • Here's one
  • Here's two *Here's three, but its not on the next line


Bold text:

  • Start line with "b" in "<>". Be sure to end the line with "/b" in "<>" if you don't want the whole paragraph to be bold.
  • Surround text to be bolded with three " ' " marks on either side. Or highlight the text and click the "B" button on the toolbar.


Italics:

  • "i" in "<>". Don't forget to end with "/i" in "<>"
  • Highlight the text and click the "I" button in the toolbar (It will put four " ' " on either side).


This is a broken link media file caption


Media tags are indicated by "Media:", images by "Image:" Broken links in red. Case is not important. Use the toolbar to get examples if you're not sure.


Spacing is werid in wiki. Single return does nothing.

Double return (blank line), breaks the line.


Triple return (two blank lines), puts an extra blank line between lines of text.


"br" in "<>" will break lines. They can also be used to separate section headers.



Finally, use the "Show Preview" button on the bottom of the page to see how it looks before saving. It will allow you to catch and edit your errors without having to edit the page again. Just don't forget to save it when you're really done.

This is an example table

This is the table title
This is Column Header 1 This is Column Header 2 This is Column Header 3
This starts Row 1 Width values (pixels) in header are used to designate the width of the column for the entire table. Text will wrap but it helps to control the layout. Height of the row is determined by the row's largest content A return and single vertical lines separate columns in rows. A double vertical line is necessary if you don't break up the text for cells.
This starts Row 2 "br" in brackets
break lines. Wiki sometimes ignores blank lines.
Some html tags can be used, but not many. Notice the align equals center tag at the beginning of the row. It centers the text in the first two columns, but doesn't work for the third column. I don't know why. Adding the tag again to the beginning of the cell in question will center the text.
This starts Row 3 Image tags are in this format:


Double brackets "[["
Image name
| = Vertical Line

The following order is not important, as long as each is separated by a vertical line:

  • Horizontal position (left, center, right)
  • Thumb (to create clickable thumbnail that links to fullsize image), don't include to make a fullsize
  • Size denoted in pixels (if desired)
  • You can add a caption if there is a thumbnail


Then close with double brackets "]]"

Broken links show up in red.



Here's where you can view any uploaded files

This is thumbnail
Camera disassembly 4.jpg


This is a resized image, not a thumbnail, but notice you can still click on it to get the full size.

This starts Row 4 Notice the repeating code for every row? It's important. A vertical line and a dash indicate the start of a new row. An exclamation point indicates the first column. You can put the entire row onto a single line, but it's easier to read if you break it up. Again, wiki usually ignores new paragraphs. Make sure to end the table correctly (vertical line and closed brace). Not doing so might still display the table, but nothing that comes afterwards.