Help Activity refresh/0.98

From OLPC
< Help Activity refresh
Revision as of 08:07, 19 April 2013 by Godiard (talk | contribs) (TODO)
Jump to: navigation, search

Objective

Based on the work done last year, a new Help activity was created.

Now we need update the content for newer develpment done, this page is a list of important pending issues.

The repository with the content is here https://git.sugarlabs.org/help-activity-content/

Anybody interested in help can send a mail to sugar-devel mailing list http://lists.sugarlabs.org/listinfo/sugar-devel or to gonzalo at laptop dot org

While the content is stored in rst format, you can send updates in text format, or the images to be updated.

TODO

  • Update Record screenshots and text.
  • Update Write screenshots and text.
  • Update Memorize screenshots and text.
  • TODO in the rst files:
source/frame.rst:TODO: 3 ways? there are 2 here
source/give_me_the_internet.rst:TODO: Picture_49.png  need a new screen shot for the new mesh network
source/hardware_evolution.rst:TODO: Add xo-4 info
source/keyboard.rst:TODO: <We should have a picture of 1.5 rather than 1.0>
source/starting_the_xo.rst:TODO: < we need a screen shot of the go to sleep image >
source/starting_the_xo.rst:TODO: < we need a screen shot of the stop sign image >
source/write.rst:TODO: write screenshot is wrong

About rst format

The rst format is easy to create and we are using a part of it only:

Titles:


====================
This is a main title
====================
This is a secondary title
-------------------------
This is a 3rdh level title
::::::::::::::::::::::::::

Links

Links like http://activities.sugarlabs.org are automatically created.

To create links where the text displayed in the page is different to the link you should do:

'Activities repository <http://activities.sugarlabs.org>'_

Lists

Lists are simple

* First item
* Second item
* Last item

or numbered:

1. One item
2. Another item
3. The last one


Images

A image can be included doing:

.. image :: image_file_name

More complete help:

http://docutils.sourceforge.net/docs/user/rst/quickref.html

http://docutils.sourceforge.net/docs/ref/rst/directives.html

http://sphinx-doc.org/concepts.html

Why rst format

Is a valid question. There are a lot of formats, and everybody have pros and cons. rst format is really easy, and there are tools to create html, pdf and epub files.