Help Activity refresh/0.98

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.

Download

First version of Help activity with this content is 16.

You can download it from

http://activities.sugarlabs.org/es-ES/sugar/addons/versions/4051#version-16

Testing now

The source of Activity Help has been modified so that the version of Help in the link below includes a self-installing, fully user editable form of Help.

When you:

git clone gitorious@git.sugarlabs.org:help/mainline.git

you will get the help activity _with_ the sources included.

You can install it in your development environment doing:

cd mainline
./setup.py dev

(if you have the activity already installed, uninstall it first)

Now you can modify any .rst file in source directory or the images in the images directory, and to create the html files, you only need do:

make html

• In Sugar

You don’t need to restart the activity to see the changes, can do click with the secondary button, and select reload.

• In any other Linux environment

The output of make html is in /mainline/html, and is opened by opening index.html in a browser, it is easy to see the changes as you work.

TODO

This section updated Novmber 2013. Contributors might note their work-in-progress on Talk:Help Activity refresh/0.98 to help avoid avoid duplication.

• Update Record screenshots and text.
• Update Write screenshots and text.
• Update Memorize screenshots and text.
• Update Paint screenshots and text.
• 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
• Calculate screenshot is wrong!
• In "Journal" page, we need replace the image and text showing how copy to a device doing drag and drop,

(because do not work anymore) and add the information about copy using the Copy to menu in the palette.

• Compare with the old content, and check if something is missing http://dev.laptop.org/~gonzalo/old_help/XO_Introduction.html

NOTE:

Screenshots should not be more than 800px width

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:

You will find `ASLO <http://activities.sugarlabs.org>`_ here.

.. _Activities repository: http://activities.sugarlabs.org

This occupies 3 lines, a line of white space is required above between the link, and the "reference".

To link to another page in Help:

this page contains more about terms and words used in sugar: 
:doc:`/glossary`

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 :: ../images/image_file_name

Icons and small images

|iconNhd| This is the sharing option.

.. |iconNhd| image:: ../images/Neighborhood_key_sml.png

More complete help:

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

http://docutils.sourceforge.net/docs/ref/rst/directives.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.

About Sphinx

Sphinx is used to create the index and generate html.

Is possible generate html, epub files [1], and pdf files too (but Ihave a problem in my system to do it, right now)

There are options to use different themes [2] and have support to i18n [3].

If you download the content repository (https://git.sugarlabs.org/help-activity-content/)

can create html output doing:

make html

and a epub file doing:

make epub

More information

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

[1] http://dev.laptop.org/~gonzalo/Sugar.epub

[2] http://sphinx-doc.org/theming.html#builtin-themes

[3] http://sphinx-doc.org/intl.html