Web   ·   Wiki   ·   Activities   ·   Blog   ·   Lists   ·   Chat   ·   Meeting   ·   Bugs   ·   Git   ·   Translate   ·   Archive   ·   People   ·   Donate
summaryrefslogtreecommitdiffstats
path: root/source/help.rst
blob: f144d07ddd4305801195b9208105ea1573ffe150 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
====
Help
====

Help displays documentation for Sugar and the XO laptop.

.. image :: ../images/Help.png

The image above is of the top of the screen, when the Activity Help is running. There is a simple range of tabs and buttons on the top row of the toolbar. Starting from the left, they are:

* Activity tab or toolbar button.

* View toolbar button.

* Home button, brings you back to the index, or contents page.

* Forward and back buttons.

* Stop, or close the Activity, on the far right of the toolbar.

Tour of Help
------------
We see, working clockwise from top left:

.. image :: ../images/HelpComp.png


1. Activity tab, here you can enter a name for the page or project, access the Journal, to provide a description. The :doc:`/collaborating`, or sharing, icon is grayed out and not available. In Help you do not really need to provide a name for the page you are researching, but it allows you to get back to it  easily from the :doc:`/journal`.

2. View toolbar button. The buttons are zoom in, zoom out, and enlarge page to *Full screen*.

3. *Next* button, top right of every page, takes you to the next page of Help.

4. Follow links in the index to jump to that page. Here the Activity FotoToon is being selected.

5. Forward and Back buttons help you navigate.

6. Use this small red icon, only showing when you hover the cursor over it, at the end of a paragraph heading, to place the paragraph well on your screen.

7. Here we see a link to the OLPC getting started page. Within Help you can follow links, which take you onto the internet, when you are online.

8. The Home button brings you back to the index, or contents page.

9. Stop, or close the Activity.

Speak Help
----------
.. image :: ../images/HelpSpeech1.png

You can have Speak read out loud, the text in Help. You can select a whole page of Help, and have it read out loud to you while you explore that Activity.

Try it now, Select the text in this frame.

To select text, follow these instructions. Move the mouse to the top left of the text, there is a green arrow near the correct point. Click the left, or main, mouse button. Move the cursor to the bottom right of the text to select, there is a red arrow near the correct point.

Bring in the :doc:`/frame` with the "Frame key" or F6. Press on the "Speech lips" icon in the bottom of the frame, then press on *Say selected text*. Notice also that there is a pause feature, once *speech* has started.

.. image :: ../images/HelpSpeech2.png

.. _View source:

View source
-----------

You can view the *source* of the page you are reading. Bring in the :doc:`/frame` with the "Frame key" or F6. Right click on the Help icon, and select, *View source*. When you read the *source*, you see the simple text, which Help converts into HTML pages. It is quite easy to make further pages.

.. image :: ../images/HelpFrame.png

This version of Help can be edited by the user. If you are interested in making documentation using Help please see this page: :doc:`/how_to_help`.

|more| The underlying software used to display Help, and for the user to edit within Help, is Sphinx. To explore the possibilities of documentation made using this software, please follow the link to *Sphinx* in the footnote below.

.. |more| image:: ../images/more.png