Difference between revisions of "Documentation Team/Notes/1.0"
Jump to navigation
Jump to search
Inkyfingers (talk | contribs) (Add XO Help 17) |
|||
(32 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
Most part of the Sugar documentation and resources are out-of-date. The idea is to provide Sugar 1.0 with up-to-date documentation. | Most part of the Sugar documentation and resources are out-of-date. The idea is to provide Sugar 1.0 with up-to-date documentation. | ||
− | =Schedule= | + | ==Schedule== |
− | |||
− | |||
{| cellpadding="10" cellspacing="0" border="1" | {| cellpadding="10" cellspacing="0" border="1" | ||
Line 10: | Line 8: | ||
!Date | !Date | ||
|- | |- | ||
− | |Join all documentation resources | + | |'''Join all documentation resources''' |
+ | |style="background:#00ff00; color:black" | '''Current''' | ||
+ | | From February 1<sup>st</sup> 2013 to March 12<sup>th</sup> 2013 | ||
+ | |- | ||
+ | |'''Sugar feature cycle begins'''<br>Time to purpose the ways to write and provide documentation. | ||
|style="background:#00ff00; color:black" | '''Current''' | |style="background:#00ff00; color:black" | '''Current''' | ||
− | | From | + | | March |
+ | |- | ||
+ | |'''Writing'''<br>Time to have user guides for Sugar and its core activities. | ||
+ | |Pending | ||
+ | | From March 12<sup>th</sup> 2013 | ||
|- | |- | ||
− | |||
− | |||
− | |||
|- | |- | ||
− | |Sugar 1.0 Release | + | |style="background:#cccccc; color:black" | Add your point here... |
− | | | + | |style="background:#cccccc; color:black" | Unknown |
+ | |style="background:#cccccc; color:black" | Unknown | ||
+ | |- | ||
+ | |'''Sugar feature cycle closes'''<br>Deadline to purpose new ideas. | ||
+ | |Coming | ||
+ | | July 29<sup>th</sup> 2013 (??) | ||
+ | |- | ||
+ | |'''Sugar 1.0 Release Candidate'''<br>Time to update documentation Screenshots. | ||
+ | |Coming | ||
+ | | Waiting for Sugar 1.0 Release Schedule | ||
+ | |- | ||
+ | |'''Sugar 1.0.x bugfixed Release'''<br>All work is released. | ||
+ | |Coming | ||
| Waiting for Sugar 1.0 Release Schedule | | Waiting for Sugar 1.0 Release Schedule | ||
|} | |} | ||
+ | |||
+ | ==Resources== | ||
+ | |||
+ | There is multiple documentation, some out-of-date, and some being updated. These are the resources to join and create an only documentaton. | ||
+ | |||
+ | {| cellpadding="10" cellspacing="0" border="1" | ||
+ | !Title | ||
+ | !Status | ||
+ | |- | ||
+ | |[http://en.flossmanuals.net/sugar/ Sugar FLOSS Manual] | ||
+ | |Out of date since 2011 | ||
+ | |- | ||
+ | |[http://laptop.org/manual XO Manual] (Sugar chapters) | ||
+ | |Sugar content deprecated | ||
+ | |- | ||
+ | |[http://wiki.laptop.org/go/Help_Activity_refresh/TOC OLPC-SF Summit 2011 Work] | ||
+ | |Not finished. Needs a very short update. | ||
+ | |- | ||
+ | |[http://wiki.laptop.org/go/OLPC_SanFranciscoBayArea/OLPCSF_Community_Summit_2011/Help_Activity_Refresh#Existing_draft_chapters Activity specific chapters] | ||
+ | |Incomplete. Will need a short update near the 1.0 release. | ||
+ | |- | ||
+ | |[[Tutorials|Sugar Tutorials]] | ||
+ | |Up-to-date. dd write to USB SAMPLE.iso of tutorial.pdf's (insert USB and open with write in sugar) http://wiki.sugarlabs.org/go/Tutorials/Tutorials.iso 5.3M or Save tutorials as .html files http://people.sugarlabs.org/Tgillard/Tutorial_HTML.iso | ||
+ | |- | ||
+ | |[[Activities/TurtleArt/Tutorials|TurtleArt-Tutorials]] | ||
+ | |Turtle Art comes with many sample project. Below are more examples created by community members | ||
+ | |- | ||
+ | |[[Activities#Sugar_Activities|Specific Activity Pages]] | ||
+ | |list of activity home pages: | ||
+ | |- | ||
+ | |[[The_Undiscoverable|The undiscoverable features of Sugar]] | ||
+ | |Guide to the non-obvious; hard to find details | ||
+ | |- | ||
+ | |XO Help 17 | ||
+ | |XO Help 17 will include the facility to make pages within Help. See [[Activities/Help/Contribute]] | ||
+ | |- | ||
+ | |Add your link here | ||
+ | |... | ||
+ | |- | ||
+ | |} | ||
+ | |||
+ | ==Components to document== | ||
+ | |||
+ | ===Sugar environment=== | ||
+ | * Home View (List and favourites) | ||
+ | * Frame | ||
+ | * Control Panel | ||
+ | * Mesh - Neighborhood and group view. | ||
+ | **These are covered in [[Tutorials/Introduction_to_the_Sugar_Interface|Introduction to the Sugar Interface]] and other [[Sugar_Creation_Kit#Tutorials|Tutorials]] | ||
+ | * Journal | ||
+ | |||
+ | === Basics - Sugar in Use === | ||
+ | |||
+ | * Opening, closing, saving data in Journal, collaboration, etc. | ||
+ | |||
+ | ===Activities=== | ||
+ | |||
+ | Feel free to add a core activity. | ||
+ | |||
+ | * Core activity guides | ||
+ | ** Browse | ||
+ | *** [http://laptop.org/8.2.0/manual/Browse_Introduction.html XO Manual] (Very old) | ||
+ | *** [http://wiki.sugarlabs.org/go/Activities/Browse Sugar FLOSS Manual] (Last update: Sugar 0.86) | ||
+ | *** [http://wiki.laptop.org/go/Help_Activity_refresh/Chapter/Browse SF Summit Work] (Sugar 0.94, needs screen-shots with Sugar 1 style) | ||
+ | *** Unable to run olpc.dailymotion.com and www.dailymotion.com videos in soas v8 Browse (See Discussion) | ||
+ | ** Calculate | ||
+ | ** Chart | ||
+ | ** Chat [[Tutorials/Chatting_with_the_Chat_Activity|Chat Tutorial]] | ||
+ | ** Dimensions | ||
+ | ** Etoys (Already documented by Squeakland, low priority) | ||
+ | ** Fototoon | ||
+ | ** Irc [[Tutorials/Chatting_with_the_IRC_Activity|IRC Tutorial]] | ||
+ | ** Jukebox | ||
+ | ** Labyrinth | ||
+ | ** Measure | ||
+ | ** Memorize | ||
+ | ** Paint | ||
+ | ** Physics | ||
+ | ** Pippy | ||
+ | ** Portfolio | ||
+ | ** Record | ||
+ | ** Read | ||
+ | ** Scratch (Already documented, low priority) | ||
+ | ** Terminal | ||
+ | ** Tam Tam | ||
+ | ** Turtle Blocks | ||
+ | ** Wikipedia | ||
+ | ** Write | ||
+ | |||
+ | == Multimedia content == | ||
+ | |||
+ | * video/animation purposes | ||
+ | ** Ogg Demos Videos for use in sugar-Desktop and the XO: | ||
+ | ::http://wiki.sugarlabs.org/go/Sugar_Creation_Kit#Gnome3_has_already_a_screen_recording_functionality | ||
+ | |||
+ | * Mute video/animation purposes | ||
+ | ** Add your purpose here | ||
+ | |||
+ | * Videos with audio purposes<br>Research about i18n. | ||
+ | ** Add your purpose here. | ||
+ | |||
+ | == Writing format == | ||
+ | |||
+ | The purpose is about using [http://projectmallard.org/ Mallard] to have i18n support. | ||
+ | |||
+ | == Activity documentation template == | ||
+ | |||
+ | This template is used in wiki pages and modified to be a user guide provided optionally with each activity. | ||
+ | |||
+ | === About Portfolio === | ||
+ | === Using Portfolio === | ||
+ | * The Toolbars | ||
+ | * Saving to PDF | ||
+ | === Learning with Portfolio === | ||
+ | * Samples of student work | ||
+ | === Extending Portfolio === |
Latest revision as of 07:53, 11 December 2013
Most part of the Sugar documentation and resources are out-of-date. The idea is to provide Sugar 1.0 with up-to-date documentation.
Schedule
Action | Status | Date |
---|---|---|
Join all documentation resources | Current | From February 1st 2013 to March 12th 2013 |
Sugar feature cycle begins Time to purpose the ways to write and provide documentation. |
Current | March |
Writing Time to have user guides for Sugar and its core activities. |
Pending | From March 12th 2013 |
Add your point here... | Unknown | Unknown |
Sugar feature cycle closes Deadline to purpose new ideas. |
Coming | July 29th 2013 (??) |
Sugar 1.0 Release Candidate Time to update documentation Screenshots. |
Coming | Waiting for Sugar 1.0 Release Schedule |
Sugar 1.0.x bugfixed Release All work is released. |
Coming | Waiting for Sugar 1.0 Release Schedule |
Resources
There is multiple documentation, some out-of-date, and some being updated. These are the resources to join and create an only documentaton.
Title | Status |
---|---|
Sugar FLOSS Manual | Out of date since 2011 |
XO Manual (Sugar chapters) | Sugar content deprecated |
OLPC-SF Summit 2011 Work | Not finished. Needs a very short update. |
Activity specific chapters | Incomplete. Will need a short update near the 1.0 release. |
Sugar Tutorials | Up-to-date. dd write to USB SAMPLE.iso of tutorial.pdf's (insert USB and open with write in sugar) http://wiki.sugarlabs.org/go/Tutorials/Tutorials.iso 5.3M or Save tutorials as .html files http://people.sugarlabs.org/Tgillard/Tutorial_HTML.iso |
TurtleArt-Tutorials | Turtle Art comes with many sample project. Below are more examples created by community members |
Specific Activity Pages | list of activity home pages: |
The undiscoverable features of Sugar | Guide to the non-obvious; hard to find details |
XO Help 17 | XO Help 17 will include the facility to make pages within Help. See Activities/Help/Contribute |
Add your link here | ... |
Components to document
Sugar environment
- Home View (List and favourites)
- Frame
- Control Panel
- Mesh - Neighborhood and group view.
- These are covered in Introduction to the Sugar Interface and other Tutorials
- Journal
Basics - Sugar in Use
- Opening, closing, saving data in Journal, collaboration, etc.
Activities
Feel free to add a core activity.
- Core activity guides
- Browse
- XO Manual (Very old)
- Sugar FLOSS Manual (Last update: Sugar 0.86)
- SF Summit Work (Sugar 0.94, needs screen-shots with Sugar 1 style)
- Unable to run olpc.dailymotion.com and www.dailymotion.com videos in soas v8 Browse (See Discussion)
- Calculate
- Chart
- Chat Chat Tutorial
- Dimensions
- Etoys (Already documented by Squeakland, low priority)
- Fototoon
- Irc IRC Tutorial
- Jukebox
- Labyrinth
- Measure
- Memorize
- Paint
- Physics
- Pippy
- Portfolio
- Record
- Read
- Scratch (Already documented, low priority)
- Terminal
- Tam Tam
- Turtle Blocks
- Wikipedia
- Write
- Browse
Multimedia content
- video/animation purposes
- Ogg Demos Videos for use in sugar-Desktop and the XO:
- Mute video/animation purposes
- Add your purpose here
- Videos with audio purposes
Research about i18n.- Add your purpose here.
Writing format
The purpose is about using Mallard to have i18n support.
Activity documentation template
This template is used in wiki pages and modified to be a user guide provided optionally with each activity.
About Portfolio
Using Portfolio
- The Toolbars
- Saving to PDF
Learning with Portfolio
- Samples of student work