Style Guide: Difference between revisions
Jump to navigation
Jump to search
Created page with "This pages links to the templates for a robot page and a part page. Starting from the main page. <br> The important reason for having a style guide is to be consistent. This styl..." |
|||
| (3 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
This | This page contains the templates to be used starting with the addition of a new robot onto the Main Page together with some additional style guides. This style guide can't cover every possible thing you may need to write a wiki page about, so just remember to be consistent in your own documentation. | ||
| Line 12: | Line 11: | ||
* Parts: [[Robot Name Part 1|Part 1]], [[Robot Name Part 2|Part 2]], [[Robot Name Part 3|Part 3]], etc. | * Parts: [[Robot Name Part 1|Part 1]], [[Robot Name Part 2|Part 2]], [[Robot Name Part 3|Part 3]], etc. | ||
|} | |} | ||
= Styles = | |||
=== Subchapter === | |||
Use heading-level 3 for subchapters. | |||
<pre> | |||
=== Subchapter Name === | |||
</pre> | |||
=== Naming === | |||
Names of a new page or a figure should always start with the robot name. | |||
=== Figures === | |||
Keep the wiki easy to read. | |||
* Don't make pictures unnecessarilly big. | |||
* Always center figures to keep it clean. | |||
* Provide figures of number and a short description. | |||
<pre> | |||
[[Image:Robot Name Figure Name.jpg|500px|thumb|center|Figure 1: Figure description]] | |||
</pre> | |||
[[Image:Robot Name Figure Name.jpg|500px|thumb|center|Figure 1: Figure description]] | |||
* Use a table when adding multiple pictures next to each other. | |||
<pre> | |||
{| style="background: transparent; margin: auto;" | |||
| [[Image:Robot Name Figure Name.jpg|400px|thumb|center|Figure 2: Left]] | |||
| [[Image:Robot Name Figure Name.jpg|400px|thumb|center|Figure 3: Right]] | |||
|} | |||
</pre> | |||
{| style="background: transparent; margin: auto;" | |||
| [[Image:Robot Name Figure Name.jpg|400px|thumb|center|Figure 2: Left]] | |||
| [[Image:Robot Name Figure Name.jpg|400px|thumb|center|Figure 3: Right]] | |||
|} | |||
=== Movies === | |||
To include a movie from par example Youtube use: | |||
<pre> | |||
<div class="center" style="width:auto; margin-left:auto; margin-right:auto;">{{#ev:youtube|jF--uLxtYlo}}</div> | |||
</pre> | |||
<div class="center" style="width:auto; margin-left:auto; margin-right:auto;">{{#ev:youtube|jF--uLxtYlo}}</div> | |||
Latest revision as of 10:33, 1 December 2011
This page contains the templates to be used starting with the addition of a new robot onto the Main Page together with some additional style guides. This style guide can't cover every possible thing you may need to write a wiki page about, so just remember to be consistent in your own documentation.
Robot Name
Short description of the robot. |
Styles
Subchapter
Use heading-level 3 for subchapters.
=== Subchapter Name ===
Naming
Names of a new page or a figure should always start with the robot name.
Figures
Keep the wiki easy to read.
- Don't make pictures unnecessarilly big.
- Always center figures to keep it clean.
- Provide figures of number and a short description.
[[Image:Robot Name Figure Name.jpg|500px|thumb|center|Figure 1: Figure description]]
- Use a table when adding multiple pictures next to each other.
{| style="background: transparent; margin: auto;"
| [[Image:Robot Name Figure Name.jpg|400px|thumb|center|Figure 2: Left]]
| [[Image:Robot Name Figure Name.jpg|400px|thumb|center|Figure 3: Right]]
|}
Movies
To include a movie from par example Youtube use:
<div class="center" style="width:auto; margin-left:auto; margin-right:auto;">{{#ev:youtube|jF--uLxtYlo}}</div>