Meta:BSoD/2006/Template

Summer of Documentation template

Introduction

Welcome to the basic Summer of Documentation template. We are trying to keep it as simple as possible so that the documentation can be adapted to multiple formats and/or different templates at a later date.

First off please read the Editing help pages! Of course you can always ask your mentor to help you.

Some basics... The top menu is created automatically. It gets all the headers and subheaders from the document. Divide your documentation up into major sections for which you use headers and subsections using subheaders. Like I've done here with Summer of Documentation template and Introduction

Test Sidenote

This is a sidenote using the new inlined sidenote template. You can make use of this for seperating logically distinct ideas from the main information flow. You should even be able to put images in here if you want to. AltA

Also you will notice the UM navigator bit of code at the top. We still have to decide on what that will be exactly but to start you can put that there, and don't forget to put in the correct blender version for which the documentation was written.

Image description

If you use images please use .jpg format since everyone should be able to open them. Also do not make them too large. We don't want people to have to scroll horizontally if it can be avoided. If you do need to use a very large image, then put a smaller image in your page and link it to the large image so that it opens elsewhere.

Try to put the images next to text like I've done here. Also alternate the position. So one image on the left, then the next one on the right. Start with the first image on the page on the right. Also add a "clr" tag in front of each new section/subsection so that the floating image in the previous part does not influense it.

When you upload images don't forget to add a description so that people know exactly what it's being uploaded for.

Below here I added a horizontal row of images, but only use that if you really have to since it is easy to make a row too wide.

If you want to create multiple pages simply add a link to the page you want to create to your document and after saving you will see it is red. That means that it is a page that does not exist yet. Click the link to go to the page and edit/create it.

All the way at the bottom of the page always add your signature with timestamp, that way people know who is responsible. In front of it put "Summer of documentation 2006"

Below that you can see there is a tag with links to the previous and next page. Always enter those since that is the only way people will find them.

First major section

Section one

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Image description.

Image description.

Image description.

Section two

Image description.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

List example

• item one - Description.
• item two - Description.
• item three - Description.
• item four - Description.

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Summer of documentation 2006--Macouno 13:34, 13 June 2006 (CEST)