233
edits
Changes
Jump to navigation
Jump to search
mLine 1:
Line 1: − + − + + + + + − Our mission is to provide the Sugar community with high quality documentation, including user manuals, programming references, and tutorials.+ − == BookSprint ==+ − 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. − Attendee listing (fluid and changing) is at http://flossmanuals.net/donate.+ − ''Arrival/Departure plans''+ − Brian Jordan (activities/sugar/Pygame hacker, OLPC intern exploring 3rd World deployment) − Arr AUS 12:25PM TUE Aug 26 − Dep AUS 5:05PM THU Aug 28 − − Adam Holt (100-person support gang founder & coordinator) − Arr AUS 11:10AM SAT Aug 23 − Dep AUS 6:35AM SAT Aug 30 − − Walter Bender (former president of software and content at OLPC, writer of Getting Started at laptop.org/start, Sugar Labs affiliate) − Arr AUS morning Sun Aug 24 − Dep AUS morning Fri Aug 29 − − Adam Hyde (founder of FLOSS Manuals) − Arr AUS 10:30AM Sat, Aug 23 − Dep AUS Sun, Aug 30 − − David Farning (Sugar Labs affiliate and community builder) − Arr AUS 7:21pm Sat, Aug 23, 2008 − Dep AUS 6:00am Sat, Aug 30, 2008 − − The venue has changed from Outernet to Motive - their address is: − 12515 Research Blvd − Austin, TX 78759 − www.motive.com − − There's a hotel within walking distance, Extended Stay America, at − 12424 Research Blvd, Austin, TX, (512) 219-6500 where attendees are staying. There is breakfast served at the hotel. − − I'd like to arrange pickup at the airport for all participants - to avoid cab fares and so forth. So let me get some work going for that, and I'll update this page with more information. − − ''XO Hardware for the Sprint"" − I've got a spreadsheet set up with the names of all the XOs we can use − at the BookSprint. I have 8 now and Mikus will do the updates (I − already requested dev keys on all of them.) Here's the published − version: http://spreadsheets.google.com/pub?key=pjAQh2AGJq8cooRMaUwKlWg. − I can add everyone as collaborators next week once we get all the data − filled in, so when updates are done to a machine, the writer can just − update the spreadsheet. − − === Remote participation === − We're going to do our best to allow remote participants to take part in the event. We will be holding a daily phonecall in the afternoon for all participants. [[User:Seth|Seth]] will be available at OLPC's office as a direct contact for unanswered questions, or if one of the (Cambridge) development team needs to be reached. − − Remote contributors: − * [[User:Seth|Seth]] − * Greg Dek − * Christoph − − == User Manuals == − We will be working with [http://flossmanuals.net/about FLOSS manuals] to create our end user documentation. Their excellent getting started guide is at [http://flossmanuals.net/OLPC_simple OLPC simple]. Repurposing the best from these [http://wiki.laptop.org/go/Documentation_Projects 20 pre-existing documents] will be key. Works in progress are listed in the DocumentationTeam/KnowledgeBase . − − 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 + + + + + + + Line 144:
Line 36: − + Line 155:
Line 47: − + Line 162:
Line 54: − + Line 172:
Line 64: + + + + − + + + + + + − + + +
Remove link to dead URL, no longer relevant.
{{Translations
{{Translations
| [[DocumentationTeam|english]] | [[DocumentationTeam/lang-es|español]] }}
| [[Documentation Team|english]] | [[Documentation Team/lang-es|español]] }}
<noinclude>{{ GoogleTrans-en | es =show | bg =show | zh-CN =show | zh-TW =show | hr =show | cs =show | da =show | nl =show | fi =show | fr =show | de =show | el =show | hi =show | it =show | ja =show | ko =show | no =show | pl =show | pt =show | ro =show | ru =show | sv =show }}{{TeamHeader|DocumentationTeam|home=Documentation}}</noinclude>
<noinclude>{{TeamHeader|Documentation Team|home=Documentation}}</noinclude>
== Mission ==
{{:Documentation Team/Mission}}
== Sugar FLOSS manual ==
FLOSS Manuals held a BookSprint during the last week of August 2008 in Austin, TX; together, we wrote separate but combinable (remixable) manuals for Sugar, individual Sugar Activities and the hardware it may run on, such as the XO.
The manuals for a number of Sugar Activities are now published (including manuals for [http://en.flossmanuals.net/write_activity '''Write'''], [http://en.flossmanuals.net/terminal '''Terminal'''], [http://en.flossmanuals.net/chat '''Chat'''], [http://en.flossmanuals.net/browse '''Browse'''], [http://en.flossmanuals.net/record '''Record'''], and [http://en.flossmanuals.net/turtleart '''Turtle Art''']).
People "remixed" these manuals to form the [[Activities/Help|Help activity]] for the XO laptop; a version of this is on the web at http://laptop.org/manual/
Please help us improve these manuals by going to http://en.flossmanuals.net/write where the editable versions reside. Note that we are including tutorials and notes to parents and teachers as part of the documentation effort. Helping expanding these sections would be greatly appreciated.
Those who participated include: Adam Hyde, Anne Gentle, David Farning, Mikus Grinbergs, Brian Jordan, Adam Holt, Janet Swisher, Morgan Collett, Yama Ploskonka, David Cramer, Emily Kaplan, Faisal Anwar, Christoph Derndorfer, Sandy Culver, Aaron Konstam, and the Sugar community.
===Translation===
We are translating the Sugar FLOSS manual into
Spanish ([http://translate.flossmanuals.net/bin/view/Sugar_es es]),
French ([http://translate.flossmanuals.net/bin/view/Sugar_fr fr]),
Dutch ([http://translate.flossmanuals.net/bin/view/Sugar_nl nl]),
German ([http://translate.flossmanuals.net/bin/view/Sugar_de de]),
and Portuguese ([http://translate.flossmanuals.net/bin/view/Sugar_pt pt]). Please help us.
'''See also'''
'''See also'''
=== [http://api.sugarlabs.org API] ===
=== [http://api.sugarlabs.org API] ===
The [[DocumentationTeam/API_Documentation | API guide ]] explains how to get started documenting api.
The [[Documentation Team/API_Documentation | API guide ]] explains how to get started documenting api.
References
References
::* 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! [http://dev.laptop.org/git?p=activities/colors;a=blob;f=colors.py;h=c262f55e46519248418a07e3c4eed1ab4207fa09;hb=5822328cab1162b32452dfb915b33d98307b55d1#l579] [[User:Wade|Wade]] 18:49, 18 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! [http://dev.laptop.org/git?p=activities/colors;a=blob;f=colors.py;h=c262f55e46519248418a07e3c4eed1ab4207fa09;hb=5822328cab1162b32452dfb915b33d98307b55d1#l579] [[User:Wade|Wade]] 18:49, 18 May 2008 (UTC)
* Low level API (non-python activities). We should just move bert document on this wiki.
* 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
:this is the page http://wiki.laptop.org/go/Low-level_Activity_API (see [[Development Team/Low-level Activity API]]) but it must be complemented with
:* http://wiki.laptop.org/go/Sugar_Factory
:* http://wiki.laptop.org/go/Sugar_Factory
:* http://www.catmoran.com/olpc/#sugxterm
:* http://www.catmoran.com/olpc/#sugxterm
* Probably good to have a pygame tutorial, it's probably the best thing we have at the moment to do free form graphics stuff.
* 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?
* Etoys based activity tutorial - we now have an Etoys Activity manual set up on FLOSS Manuals. Feel free to contribute here: [http://en.flossmanuals.net/bin/view/Etoys/WebHome|Etoys]
* Ideally, each Activity will have a tutorial within a manual on FLOSS Manuals. Here's a rough outline for each Activity Manual:
* Ideally, each Activity will have a tutorial within a manual on FLOSS Manuals. Here's a rough outline for each Activity Manual:
Reference
Reference
== Auto-generated documentation ==
Some of Sugar Labs projects have auto generated (from source code) documentation. Follow the [http://doc.sugarlabs.org/ doc.sugarlabs.org] link to browse currently present documentation.
== Glossary ==
== Glossary ==
[[DocumentationTeam/Glossary | Glossary]]
[[Documentation Team/Glossary | Glossary]]
== Subpages ==
{{Special:PrefixIndex/{{PAGENAMEE}}/}}
[[Category:DocumentationTeam]]
[[Category:Documentation Team]]
[[Category:General public]]
[[Category:Team]]