Summary Page Boilerplate Text

This page delivers Summary page boilerplate text that you can copy into your project.

The boilerplate is just a framework - it needs the context of your project and some interesting artwork to bring it to life. To help you understand how to turn the framework into a compelling story for your project, we provide general guidance and links to projects that use some or all elements of the boilerplate structure. Following the boilerplate, we also list some additional tips and tricks.

What makes a good Summary page?

Most good summary pages in the wiki have had a few things in common:

• Informative description of the goals of the project
• Screenshots or video highlighting the project
• Compatibility and test information
• Links to key information about using or building the project
• The are simple enough that users will choose to read them

The boilerplate below is based on ideas taken from the following projects. We suggest you browse these for inspiration.

• Momaths
• Nokia Data Gathering
• Qt Game Enabler
• Diner
• RentBook

Boilerplate

Copy the text below, and paste it into your new Summary page. Text that displays in italics is instructional, and should be deleted prior to saving.

''Insert a one-sentence heading that describes what the project is all about. This is like a mission or vision statement. 
For example "Momaths connects learners in a new way using personal mobile phones to study mathematics" and 
"Fast and accurate way to collect data"''
= My project's goal or vision =

''Insert an overview of what you project does and who it is for. This extends your project description and includes images that explain
your project, or screenshots of your running software, or if that isn't possible perhaps just a banner of showing your happy users!''
* ''Images can be added by uploading/attaching them to the page and then using the [//home/wiki/WikiMacros#Image-macro Image macro].
[[Image(picture-attached-to-current-page.gif,center)]]
* ''Movies from online services like !YouTube can be added using the [//home/wiki/WikiMacros##Movie-macro Movie macro].
[[Movie(http://www.youtube.com/watch?v=U7yje3D1UM4, width=260, height=180, align=center)]]

== Compatibility ==
''List the SDKs your project requires and any other build dependencies.''

''List the devices and platforms on which your project can run.''

== Next steps ==
''Describe what you want to achieve in the upcoming months and how developers and users can help you. This can be as simple as 
"we need people to fix work on the XXX engine, see our Roadmap and Defects here." ''

''Depending on the number of open tickets, you might use the [//home/wiki/TracQuery#UsingtheTicketQueryMacro Ticket Query Macro] 
to list the open tickets in-place.''

== Documentation ==
''Provide links to key documentation. At its simplest this will be a link to your project WikiStart page. 
If you have a lot of information you might want to provide an index like the one shown below.''

Click on the links below to find out more:
===  [//ProjectKey Home] | [wiki:About About] | [wiki:Partners Partners] | [wiki:Documents Documents] | [wiki:support Support] | [wiki:contact Contact] |  [wiki:BuildingTheProject Building] ===

Tips and tricks

Use images to link to different themes or users

Images can be used to redirect different types of users, or users at different stages in development, to the most relevant information. For example, the Nokia Data Gathering project uses a simple wiki table to provide information on how to use, develop or implement the solution, as shown below:

Similarly Momaths Momaths divides its users into learners and educators. In fact, they have used Wiki processors to layout a table without borders for the whole of their summary page.

And of course, you can choose to stick with a simple textual layout, either a list or a horizontal layout (as used in the boilerplate)