Help Activity refresh: Difference between revisions
| Line 238: | Line 238: | ||
== How to participate == |
== How to participate == |
||
If you plan to participate in the XO Users Manual refresh, either at the mini book sprint on the 21st or remotely before or after that, there are some things you should do ahead of time... |
<!--If you plan to participate in the XO Users Manual refresh, either at the mini book sprint on the 21st or remotely before or after that, there are some things you should do ahead of time... |
||
*Register an account on FLOSS Manuals' "Booki" site: |
*Register an account on FLOSS Manuals' "Booki" site: |
||
| Line 258: | Line 258: | ||
A click on the "Manuals" tab will show a list of all the manuals members of the group are working on. You can click on each one and see what is there. Some are very complete, others are only skeletons. Our manual is currently at the bottom of the list: "XO Users Manual (Rev 2011)." Currently, all of the chapters are "hidden" and waiting to be written, revised, and/or edited. If you click on "Edit" you will be able to see them at the bottom of the page. Please do not do any writing or editing until you have read and understand everything in the Booki Users Manual: http://en.flossmanuals.net/Booki-User-Guide/ |
A click on the "Manuals" tab will show a list of all the manuals members of the group are working on. You can click on each one and see what is there. Some are very complete, others are only skeletons. Our manual is currently at the bottom of the list: "XO Users Manual (Rev 2011)." Currently, all of the chapters are "hidden" and waiting to be written, revised, and/or edited. If you click on "Edit" you will be able to see them at the bottom of the page. Please do not do any writing or editing until you have read and understand everything in the Booki Users Manual: http://en.flossmanuals.net/Booki-User-Guide/ |
||
The members tab will give you a list of the people who have signed up for the group. If you would like to add a photo and a little blurb about yourself to the your listing, the place to do that is the "My Settings" section (find it listed on the second menu on the top left). |
The members tab will give you a list of the people who have signed up for the group. If you would like to add a photo and a little blurb about yourself to the your listing, the place to do that is the "My Settings" section (find it listed on the second menu on the top left).--> |
||
=== Procedures on porting/assembling the manual into Help Activity === |
=== Procedures on porting/assembling the manual into Help Activity === |
||
| Line 266: | Line 266: | ||
==== Start editing here ==== |
==== Start editing here ==== |
||
http://wiki.laptop.org/go/Help_Activity_refresh/TOC |
|||
http://booki.flossmanuals.net/xo-users-manual-rev-2011/_edit/ |
<!--http://booki.flossmanuals.net/xo-users-manual-rev-2011/_edit/ |
||
Note: this is a corrected link. Sign in first, then go to "WRITE." The CHAPTERS are at the bottom of the page as works-in-progress. The SECTIONS, above the CHAPTERS are currently empty. READ does not allow public access to the unfinished/unpublished chapters. You must sign in and go to WRITE to see what we are working on and to participate in writing and editing. Eventually, when the CHAPTERS are completed, they will be moved up into the SECTIONS. At that time they will be viewable by the general public. |
Note: this is a corrected link. Sign in first, then go to "WRITE." The CHAPTERS are at the bottom of the page as works-in-progress. The SECTIONS, above the CHAPTERS are currently empty. READ does not allow public access to the unfinished/unpublished chapters. You must sign in and go to WRITE to see what we are working on and to participate in writing and editing. Eventually, when the CHAPTERS are completed, they will be moved up into the SECTIONS. At that time they will be viewable by the general public. |
||
You can also find this link at: http://booki.flossmanuals.net/groups/one-laptop-per-childsugar-labs/ It is the last (newest) manual... at the bottom of the list. |
You can also find this link at: http://booki.flossmanuals.net/groups/one-laptop-per-childsugar-labs/ It is the last (newest) manual... at the bottom of the list.--> |
||
====Special for Windows users==== |
====Special for Windows users==== |
||
| Line 320: | Line 321: | ||
* bring your XOs loaded with the latest [http://wiki.laptop.org/go/11.3.0 11.3.0] development builds since that's the easiest way to get Sugar 0.94 |
* bring your XOs loaded with the latest [http://wiki.laptop.org/go/11.3.0 11.3.0] development builds since that's the easiest way to get Sugar 0.94 |
||
* investigate whether using the [http://wiki.laptop.org/go/Sugar/Quick_screenshot_hack advanced screenshot hack] is a viable alternative |
* investigate whether using the [http://wiki.laptop.org/go/Sugar/Quick_screenshot_hack advanced screenshot hack] is a viable alternative |
||
==Tasks== |
==Tasks== |
||
Revision as of 00:05, 7 April 2012
|
NOTE: The contents of this page are not set in stone, and are subject to change! This page is a draft in active flux ... |
|
Ideas for the refresh of OLPC/Sugar's Help Activity, associated web/paper manual and possibly new vid tutorials! Bookmark http://j.mp/xomanual to help!
April 2012 doc sprint schedule / goals
Initial planning occurred Friday October 21st, 2011 from 10AM to 4 PM outside the Kleider home in Bolinas, California, with almost 10 people present.
While draft & final cuts were desired for 2011, in the end 2012 became more realistic.
An actual in-person community doc sprint will take place the 5 days of Apr 6-10 at OLPC Foundation HQ in Has location city::East Cambridge, Massachusetts. Please join us to celebrate giving back, and meet OLPC engineers if you do, over a most unique Passover and Easter!
Our aim is to freshen up (1) http://laptop.org/manual (2) http://wiki.sugarlabs.org/go/Activities/Help and ideally (3) a paper book if not (4) produce short videos for Sugar Activities that kickstart learning fast!
Bonus Pregame: Apr 3-5 Video Tutorials "Incubator" Presprint for our favorite Sugar activities, thanks to Bill Stelzer, Mark Battley, Laura de Reynal, Christoph Derndorfer, Caryl Bigenho, Sameer Verma, Craig Perue and a growing list of talented mediamakers. Detail emerging below.
Experienced OLPC implementation groups from Kenya, Jamaica and Australia have confirmed their desire to attend; we hope others will RSVP too. Deployment knowledge is warmly welcomed! Mike Dawson, Tim Falconer, Tony Anderson, Chris Lowe etc etc etc -- do give us a ring!
Expected in person -- details emerging below: Sameer Verma, Mike Lee, Walter Bender, Claudia Urrea, Richard Smith, Christoph Derndorfer, Reuben Caron, SJ Klein, Mark Battley, Jennifer Martino, Paul Fox, George Hunt, Chris Ball, Nancie Severs, CScott Ananian, Craig Perue, Saadia Baloch, Bill Stelzer, Bernie Innocenti, Dogi Unterhauser, Laura de Reynal, Adam Holt, etc -- even Sugar Labs' new finance officer Robert Fadel, and Pablo Flores if we are lucky! Apologies attendance will likely be limited due to our facility's limited capacity.
Virtual Romance Ain't: Please talk to Caryl Bigenho and our public list if you are motivated to write a particular chapter, but cannot attend in person, thanks!! EG. We're thrilled OLPC Australia's Education Manager Tracy Richardson hopes to contribute remotely.
Our work should center on Release 11.3.x especially (Build 883 / Sugar 0.94) running on the XO-1, XO-1.5 and XO-1.75. Claudia Urrea suggests we avoid complex activities like Etoys, Scratch etc -- instead mixing up 2008's Activity list beyond the classic 4 {Record, Browse, Write, Turtle Art} to consider newly popular ones like FotoToon.
Beyond core book topics (eg. popular Sugar Activities and XO-1, XO-1.5, XO-1.75 hardware etc) most of us would be thrilled to see tight chapters on Gnome, Learning Realities/Lesson Plans/Stories, Deployment, School Server/XS, Community Leadership, SoaS, XO-3 dreams etc -- if a suitably talented volunteer author emerges, to take charge of any such chapter?
Our English screenshots will of course complicate translation, but Pablo Flores/Walter Bender have hope, using SVG (eg. during an Uruguayan translation jam @ eduJAM! May 7-12, 2012?) George Hunt has great ideas to automate screenshots, possibly using gtk-gnome regression tools.
We will have an absolute blast. Active contribution will be required, as we are already approaching capacity. All logistics/housing/travel must be self-organized and self-paid. Bernie's Google-funded McMansion only fits so many sleeping bags on the floor, sorry ;)
holt@laptop.org and other locals will provide Cambridge-area discount lodging tips where they can, if you're a genuine contributor.
Documentation design will be centered around the library@lists.laptop.org mailing list and live chat irc channels #olpc-help and #sugar.
Activity Central may provide a small amount of sponsorship to the effort, strictly at their discretion.
Tom Clancy fans ("Collaboration on a book is the ultimate unnatural act") please see how this has worked in the past:
http://booki.flossmanuals.net/a-webpage-is-a-book/what-is-a-book-sprint/
http://www.booksprints.net/book-sprint-methodology/
Huge thanks to Seth Woodworth, Caryl Bigenho, Christoph Derndorfer, Pablo Flores & others continuing to push us steadily forward!
Video tutorials: Apr 3-5
BONUS PREGAME: Video Tutorials "Incubator" Presprint for our favorite Sugar activities & XO tips/tricks, thanks to the very hard work of Bill Stelzer, Mark Battley, Laura de Reynal, Christoph Derndorfer, Caryl Bigenho, Sameer Verma, Craig Perue and a growing list of talented mediamakers.
Expected Start Time: 9AM Tuesday April 3rd @ OLPC Foundation HQ in East Cambridge. RSVP if you're interested in showcasing a particular Sugar Activity. Specific screencast/video ideas & experience most welcome. Do share your vision on the library@lists.laptop.org mailing list too!
Doc Sprint: Apr 5/6-10
|
WED Apr 4 - 7:00pm IRC Planning Meeting on #olpc-help @ irc.freenode.net (http://forum.laptop.org) THU Apr 5 - Pre-planning FRI Apr 6 - 10:00am start @ OLPC HQ. Claudia Urrea can help with TOC, Activity recommendations, etc |
SAT Apr 7 - Passover but working! SUN Apr 8 - Easter: Nancie Severs arrives MON Apr 9 - Paul Fox arrives TUE Apr 10 - All Day Final Crunch! 10:00-5:00 - Work @ OLPC HQ! |
People
Add your name! Include 2 words about the "Chapter" you're contributing!
|
|
Table of Contents
NEW Table of Contents: Help_Activity_refresh/TOC
ChristophD & CarylB are explaining live in person & over Skype Noon Fri April 6..
Pre-2012 Help Activity contents
You will notice some sections below with (???) after them. We are still looking for volunteers to work on those sections. If you would like to join with one of the other volunteers who is already working on one of the sections, please add your name and contact the person so you can coordinate your work!
- Introduction (Introduction, About OLPC, What is Sugar, How to Volunteer) (Christoph Derndorfer & Adam Holt, Sandra Thaxter)
- Getting Started (Getting Started, Opening the XO, Ports, Battery Charging, Starting the XO, Keyboard) (Tony Anderson Mark Battley)
- Interface (About the User Interface, Home View, Activity View, Neighborhood View, Group View, The Frame, The Journal) (Tony Anderson and Mark Battley, Sandra Thaxter)
- Activities (What is an Activity, Launching Activities, Switching Views, Collaborating, Exiting Activities, Installing Activities, Activity Sampler) (Tony Anderson and Mark Battley)
- Network (Give Me The Internet, Connecting, Ad-Hoc Networking, Wireless Devices, Networking Hardware, Troubleshooting) (Tony Anderson and Mark Battley, Sandra Thaxter))
- Record Activity (Introduction, Starting Record, Photos, Video, Audio, Starting Media, Things to Try, Wikimedia Commons) (Bill Stelzer, Samdra Tjaxter)
- Browse Activity (Introduction, What Is the Web, Starting Browse, Browse Web, Bookmarks, Changing the View, Sharing Links, Country Quiz, Search the Web, Using Wikipedia, Contribute to Wikipedia, Using Email) Cherry Withers
- Write Activity (Introduction, Starting Write, Collaborating, Peer Editing, The Basics, Group Story Telling, Letter to the Editor, Emailing a Document (Caryl Bigenho, Sandra Thaxter)
- Turtle Art (Introduction, Getting Started, Starter Commands, Pen Colors, Pen Commands, Try Turtle Art, Turtle Art Letters, Repeating Commands, Numbers and Commands, Shapes and Spectrum)
- Support (How to Reflash, Powering of Your Laptop, Replacing, Backing Up, Getting Support)( Sandra Thaxter??? )
- Appendices (Keyboard Shortcuts, Personalizing Sugar, Glossary, Getting Support, Credits) (Sandra Thaxter???)
Revised manual contents
This section lists the sections and chapters we are working on. It will be changed from time to time as we revise and add. If you add a section or chapter, be sure you have someone to work on it! Also, please add it and the name of the person (or persons) who will be working on it to the section below called "Suggestions for Additional Chapters."
- Introduction (To include: Unpacking, Battery, and Support)
- Get Started (To include: Get Started, Interface, Activities (using), and Network)
- Activities (To include introductions to assorted Activities including, but not limited to: Record, Browse, Write, Turtle Art, Etoys, Tam Tam, Labyrinth, Scratch, and others... see Activity sampler)
- Appendices (Keyboard Shortcuts, Personalizing Sugar, Glossary, Getting Support, Credits)
Copy of current User ManualA copy of the current User Manual as it appears in the Help Activity can be found at: http://laptop.org/manual ( currently resolves to http://laptop.org/8.2.0/manual/ ) A more up-to-date/Sugarized edition is Version 13, as included in Release 11.3.0 RC3 / Build 882, downloadable to your XO right here: http://activities.sugarlabs.org//en-US/sugar/addon/4051 If you are working in Windows or Mac OSX you will find instructions for downloading, viewing and editing this in the "Special For..... " notes below. Instructions for Linux users are coming. Chapters and resourcesList of manuals and chapters:
The above chapters were originally in one larger Manual that is currently the Help Activity. Other early manual versions:
|
Existing draft chaptersExisting manuals that are incomplete or not added to Help Activity:
Suggestions for new chapters
|
How to participate
Procedures on porting/assembling the manual into Help Activity
Information still needed for this section
Start editing here
http://wiki.laptop.org/go/Help_Activity_refresh/TOC
Special for Windows users
(Contributed byTony Forster in Melbourne Australia)
To edit the Help Activity in Windows
- download the help sugar bundle
use this link - http://activities.sugarlabs.org//en-US/sugar/downloads/latest/4051/addon-4051-latest.xo
- unpack the sugar bundle
- rename help-13.xo to help-13.zip
- open help-13.zip
- copy the directory Help.activity to somewhere else
- go to its help directory
The images can be edited with Paint The htm files can be viewed in a browser The htm files are best edited with something like Frontpage but you can use Notepad or Wordpad if you like working with html
Special for Mac OS X users
(Contributed by Caryl Bigenho with help from Tony Forster)
- Control-click on :
http://activities.sugarlabs.org//en-US/sugar/downloads/latest/4051/addon-4051-latest.xo
- Choose "Download Linked File As..." (click on it)
- In the "Save As:" box type " help-13.zip "
- Choose something for "Where" (desktop is OK)
- Click the "Save" button
Wait a few minutes for the download. If will give you a 12.6 MB zip file.
Click on it to unzip. It will give you a folder called "Help.activity" full of lots of resources from the activity.
The folder has another folder inside called, "help." Open it.
Find the Activity you are working on. The Chapters and resources for that Section in the Version 13 Help Activity will be there. The Activities are arranged in alphabetical order.
Some of these are html files. Click to highlight the file. You will be in the finder. Click on "File" -> "Open With" -> "Safari". The file will open in Safari and look exactly as it currently appears in the Help Activity on the XO (don't use Firefox for this).
If you have a capable text editor such as TextWrangler ( http://www.barebones.com/products/textwrangler/download.html ) you will be able to see and edit the file in html.
Screenshots
- Alt + 1 key combination (on XO keyboards) or PrnScn with attached keyboards
- post-processing with standard laptops and your tools of choice (Paint.Net (Windows) for me)
- bring your XOs loaded with the latest 11.3.0 development builds since that's the easiest way to get Sugar 0.94
- investigate whether using the advanced screenshot hack is a viable alternative
Tasks
Ideas and unassigned tasks
- keep localization in mind (see the corresponding thread from early October on Sugar-Devel, etc.
- retain the current chapter format in terms of length and general content. Use links to refer to more in depth resources.
- use the Activity descriptions in other places such as ASLO, git, etc.
Hands-on testing of chapters with XOs
Want to make sure chapters are correct and easy to understand
Style Guide
Some aspects of style should be enforced via CSS. Others require that writers, editors, artists and other be aware of how we have agreed things should be done, such as not translating "Sugar", consistent capitalization, consistent image formats, and the like.
See the OLPC Wiki Style Guide and Sugar Labs' Style Guide as starting point conventions.
Capitalization
- Activity / Activities
- OLPC and Sugar are not translated
- TBD: Pick a heading capitalization style! There are four existing styles: all lowercase http://laptop.org/10.1.3/gettingstarted/ , only capitalize first word (the wiki standard), Capitalized Chapter Words while sections only Capitalize first work (http://laptop.org/manual/), and Lots of Capitalized Words.
Text
- suggestions: 1200~1500 words
- Consider using vocabulary that's also present in the .pot files to speed up / facilitate translation
- Consider using the translation memory function in lokalize to make this information readily accessible to localizers and translators.
- Consider using lokalize offline when translating, and uploading finished draft chapters.
TBD
Images
- suggestions: 4~6 images
- screenshots: resized to a max. width of 800px
- icons: use of original icon size (55px * 55px)
- named something-icon.png or .svg
- TBD: standard for annotations, highlights in images, etc.
- when you upload, be sure in the description to give the software version: OS 11.3.0 / build 883 / Sugar 0.94 along with what you're capturing
- TBD: standards for image naming
- Activity Name-more description (-es on end if in Spanish?)
- categorization: See these existing categories: Category:Screenshots_by_type, Category:Screenshots_by_activity (with a subcategory for each activity), Category:Screenshots_of_Sugar.
- wiki.sugarlabs.org doesn't seem to have any standards or categories for its hundreds of images, see http://wiki.sugarlabs.org/go/Special:AllPages/File:
- Another useful link http://wiki.laptop.org/go/Special:ListFiles
- If there's an out-of-date screenshot with the same name, just upload the new version over it.
Chapter locations
- Hardware: on wiki.laptop.org
- suggest subpages of a content subsection of this, e.g. Help Activity refresh/content/Battery
- Core Sugar: on wiki.sugarlabs.org
- where?
- Activities: on wiki.sugarlabs.org (Activity related learning-focused content can be split between w.l.o and s.l.o with good links)
- Recommendation to work here: http://wiki.laptop.org/go/Help_Activity_refresh/Chapter/TamTam (EG. GrannieB!)
- w.s.o can use wiki links to [[olpc:Help Activity refresh/content/Battery]], w.l.o should be able to link to [[sugar:somewhere/content/Title, but there's a bug (<trac>9285</trac>).
- Follow Walter Bender's examples here where possible:
Structure
- Activity-related pages should include this tag
[[Category:Activities|TITLE]](The TITLE would be the particular Activity Name, which will be used to sort the Category:Activities page.) Would this be better??[[Category:Activity documentation|TITLE]].
TBD but possibly something similar to http://wiki.sugarlabs.org/go/Activities/Portfolio
- Possibly use an additional tag like Category:Help Activity content across pages and images, maybe include a version 11.3.0.
Suggested Activity Chapter Structure
- About <ACTIVITY>
- Where to get <ACTIVITY>
- Starting <ACTIVITY>
- Using <ACTIVITY>
- The Toolbars
- <ACTIVITY-SPECIFIC DESCRIPTIONS>
- Applying <ACTIVITY> (-> education context, basically the same as "A word to educators")
- Extending <ACTIVITY> (basically the same as "Suggestions for modification" / "Suggestions for enhancements")
- Where to report problems
- A word to developers
- Credits
or this suggestion, more child centric?
- About <ACTIVITY>
- Starting <ACTIVITY>
- Using <ACTIVITY>
- The Toolbars
- <ACTIVITY-SPECIFIC DESCRIPTIONS>
- Applying <ACTIVITY> (-> education context, basically the same as "A word to educators")
- Extending <ACTIVITY> (basically the same as "Suggestions for modification" / "Suggestions for enhancements")
- Credits
Subpages of Help Activity refresh
- Help Activity refresh/0.98
- Help Activity refresh/2012 doc sprint planning chat
- Help Activity refresh/Chapter
- Help Activity refresh/Chapter/
- Help Activity refresh/Chapter/About OLPC
- Help Activity refresh/Chapter/About Sugar
- Help Activity refresh/Chapter/About the User Interface
- Help Activity refresh/Chapter/About this Manual
- Help Activity refresh/Chapter/Activities/Activity Sampler
- Help Activity refresh/Chapter/Browse
- Help Activity refresh/Chapter/Calculate
- Help Activity refresh/Chapter/Chat
- Help Activity refresh/Chapter/Collaborating
- Help Activity refresh/Chapter/Disassembly Guide
- Help Activity refresh/Chapter/Discovery
- Help Activity refresh/Chapter/Etoys
- Help Activity refresh/Chapter/Exiting Activities
- Help Activity refresh/Chapter/FotoToon
- Help Activity refresh/Chapter/Getting Connected
- Help Activity refresh/Chapter/Getting Started
- Help Activity refresh/Chapter/Getting Support
- Help Activity refresh/Chapter/Give Me the Internet
- Help Activity refresh/Chapter/Glossary
- Help Activity refresh/Chapter/Gnome
- Help Activity refresh/Chapter/Group View
- Help Activity refresh/Chapter/Home View
- Help Activity refresh/Chapter/How to Volunteer
- Help Activity refresh/Chapter/Journal
- Help Activity refresh/Chapter/Keyboard
- Help Activity refresh/Chapter/Launching Activities
- Help Activity refresh/Chapter/Maintenance / Caring for your XO
- Help Activity refresh/Chapter/Measure
- Help Activity refresh/Chapter/Memorize
- Help Activity refresh/Chapter/My Settings
- Help Activity refresh/Chapter/Neighborhood View + Connecting to the Internet
- Help Activity refresh/Chapter/Note on Unbricking/Reflashing
- Help Activity refresh/Chapter/Opening the XO
- Help Activity refresh/Chapter/Opening the XOOpening the XO
- Help Activity refresh/Chapter/Pippy
- Help Activity refresh/Chapter/Ports
- Help Activity refresh/Chapter/Read
- Help Activity refresh/Chapter/Repairs / Troubleshooting / Support
- Help Activity refresh/Chapter/Starting the XO
- Help Activity refresh/Chapter/Switching Activities
- Help Activity refresh/Chapter/TamTam
- Help Activity refresh/Chapter/Terminal
- Help Activity refresh/Chapter/The Frame
- Help Activity refresh/Chapter/Troubleshooting Connectivity
- Help Activity refresh/Chapter/Turtle Art
- Help Activity refresh/Chapter/Upgrade all your Software
- Help Activity refresh/Chapter/What is an Activity
- Help Activity refresh/Chapter/Write
- Help Activity refresh/Chapter/XO-1, XO-1.5, XO-1.75 Specifications
- Help Activity refresh/Chapter/XS school server
- Help Activity refresh/Chapter/ports
- Help Activity refresh/TOC
- Help Activity refresh/content