Documentation Team

english | español

HowTo [ID# 7790]

Documentation   ·   Join   ·   Contacts   ·   Resources   ·   FAQ   ·   Roadmap   ·   To Do   ·   Meetings

Our mission is to provide the Sugar community with high quality documentation, including user manuals, programming references, and tutorials.

User Manuals

We will be working with FLOSS manuals to create our end user documentation. Their excellent getting started guide is at OLPC simple. Works in progress are listed in the DocumentationTeam/KnowledgeBase .

FLOSS Manuals is planning a BookSprint for the last week of August in Austin, TX, to put together separate but combinable (remixable) manuals for Sugar and the hardware it may run on, such as the XO. Here are rough working outlines:

Sugar Manual

Connecting to the network

Installing and configuring

Personalizing Sugar

Updating the version

Installing New Activities

Interface

Neighborhood View

Group View

Home View

Activity View

Joining Activities

Switching Activities

Exiting Activities

Troubleshooting Sugar

XO Manual

Getting started with the XO

About computers

Opening the XO

Starting the XO

Keyboard Shortcuts

Conserving Disk Space

Maintenance

Backing Up

Caring for Your XO

Charging the Battery

Replacing the Battery

Screen

Safety

Repairing Your XO

Avoiding Loss of Your XO

Hardware Specifications

Getting Support

See also

• OLPC Publications in the OLPC Wiki.
• OLPC Austria's Activity Handbook

Topic Ideas

• Setup a development environment. With and without jhbuild.
• "Write your activity" tutorial. It should include:
  • graphic controls,
  • datastore,
  • collaboration.

Programming References

API

The API guide explains how to get started documenting api.

References

• http://wiki.laptop.org/go/API_reference?
• Probably we should document the datastore dbus API. I'm not sure what's the best way to generate documentation for it. It's so small that a wiki page might be the simpler solution for now.
• Existing collaboration documentation is at Collabration.

• Morgs, my impression after a 3 minutes look over the available documentation is that there is little written with activity authors in mind, and that it's dispersed in several pages and mixed with implementation docs. Is that impression correct? I would like to have a couple of things: 1 complete documentation of the API which interest activity authors (with good links to dbus documentation since it's used so heavily) 2 A complete tutorial as part of the "manual". One of the Tubes pages looks like a pretty good start in this respect. Does it make sense to you? Can we make it happen? -- Marcopg

• Yes we can! --Morgs 13:50, 16 May 2008 (UTC)
• Hey, I came up with an alternate "reference" implementation for collaboration when I wrote Colors!, I think it's a lot easier to understand and could be the basis for a good tutorial. The only weird thing is, I wanted my activity class to receive DBus signals directly, so I subclassed ExportedGObject but initialized late - hacky, I know. It would be nice if this were not needed! [1] Wade 18:49, 18 May 2008 (UTC)

• Low level API (non-python activities). We should just move bert document on this wiki.

this is the page http://wiki.laptop.org/go/Low-level_Activity_API but it must be complemented with

• http://wiki.laptop.org/go/Sugar_Factory
• http://www.catmoran.com/olpc/#sugxterm

Tutorials

• Probably good to have a pygame tutorial, it's probably the best thing we have at the moment to do free form graphics stuff.
• Etoys based activity tutorial?
• Ideally, each Activity will have a tutorial within a manual on FLOSS Manuals. Here's a rough outline for each Activity Manual:

Introduction

Getting Started

Tutorials

Reference

Glossary

Glossary