687
edits
Changes
Jump to navigation
Jump to search
Line 1:
Line 1: − {{Under construction|--[[User:Inkyfingers|Inkyfingers]] ([[User talk:Inkyfingers|talk]]) − Target completion mid December 2013.}} − Line 30:
Line 27: − + + + + + + + − + Line 41:
Line 44: + + + + + + + + + + Line 57:
Line 70: − + − − == Sugar features page == − − A page was produced quickly before Help 17 was published. This is ripe for improvement. − − The current content is View source and Say selected text. − − Please add undocumented features. − − == How does this effort support Mallard? == − − Please see also [[Documentation_Team/Notes/1.0]] Line 118:
Line 119: − + − + − + Line 135:
Line 136: − + − − == To add, existing Help index for reference == − ...
Activities/Help/Contribute (view source)
Revision as of 06:37, 12 December 2013
, 06:37, 12 December 2013Adjust layout and remove "under construction" flag
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==
== XO Help Contents ==
=== Mallard ===
How does this effort support Mallard? Please see also [[Documentation_Team/Notes/1.0]]
=== 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.
What ideas can be added to improve XO Help?
=== Sugar features page ===
An experimental page was produced quickly before Help 17 was published.
The current content is View source and Say selected text. This section is hoped to expand.
Please add undocumented features.
=== 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.