Changes

This page aims to inform anyone interested in contributing to Sugar documentation, Help 18 and beyond.

This page aims to inform anyone interested in contributing to Sugar documentation, Help 18 and beyond.

Please add you name ...

Please add you name ...

==Wish list for new documentation==

 

 

 

=== Wish list for new documentation ===

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

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

Keyboard shortcuts

Keyboard shortcuts - not yet well covered.

Please add any item you see missing.

Please add any item you see missing.

This version of Help allows us to have an open mind about how Help documentation evolves, depending on the content provided by contributors.

This version of Help allows us to have an open mind about how Help documentation evolves, depending on the content provided by contributors.

=== New to Sugar pages===

=== New to Sugar pages===

== Collaboration ==

== Collaboration ==

It would be good to find a model for collaboration. It might be possible within the Sugarlabs system to upload a help_page.rst for multiple editors.

It would be good to find a model for collaboration. It might be possible within the Sugarlabs system to upload a {{Code|help_page.rst}} for multiple editors.

Any suggestions welcome for a repository for "Documentation - work in progress".

Any suggestions welcome for a repository for "Documentation - work in progress".

== How to get freshest Help sources ==

== How to get freshest Help sources ==

b. or in the event you wish to make changes to the index, over and above, adding a new line to the bottom a table of contents as described in the tutorials,

b. or in the event you wish to make changes to the index, over and above, adding a new line to the bottom a table of contents as described in the tutorials,

   

   

you may delete all the output files, that is, ``~/mainline/html/`` and ``~/mainline/doctrees/``. They will be regenerated by ``make html``.

you may delete all the output files, that is, {{Code|~/mainline/html/}} and {{Code|~/mainline/doctrees/}}. They will be regenerated by {{Code|make html}}.

=== Reconfigure Help to show View source ===

=== Reconfigure Help to show View source ===

In Sugar as we already have a View source button in the frame.

In Sugar as we already have a View source button in the Frame.

If you are working with the Help software in a browser, you can add a *View source* button, which will appear in the navigation panel. You need to alter three lines in ''~/mainline/source/conf.py''. Each of the entries listed below comprise a comment line, starting with a "#" followed by the code line. Find each pair of lines in ''conf.py'' and change the value in the code line like this.

If you are working with the Help software in a browser, you can add a ''View source'' button, which will appear in the navigation panel. You need to alter three lines in {{Code|~/mainline/source/conf.py}}. Each of the entries listed below comprise a comment line, starting with a "#" followed by the code line. Find each pair of lines in {{Code|conf.py}} and change the value in the code line like this.

  # Custom sidebar templates, maps document names to template names. ## Edit: Sugar default is without 'sourcelink.html'

  # Custom sidebar templates, maps document names to template names. ## Edit: Sugar default is without 'sourcelink.html'

  html_copy_source = True

  html_copy_source = True

A disadvantage of doing this is that extra folders are created, that might be confusing at first, and the duplication of files can make it difficult to correct certain mistakes. The command ``make html`` also takes longer to run. It is recommend not to make these changes before you are confident navigating the source and HTML folders.

A disadvantage of doing this is that extra folders are created, which might be confusing at first, and the duplication of files can make it difficult to correct certain mistakes. The command ``make html`` also takes longer to run. It is recommend not to make these changes before you are confident navigating the source and HTML folders.

 

...