Activities/Help/Contribute: Difference between revisions
No edit summary |
No edit summary |
||
| (6 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
This page aims to inform anyone interested in contributing to Sugar documentation | This page aims to inform anyone interested in contributing to Sugar documentation. | ||
This page acts as a "Landing page" for those who have read "How to edit Help and contribute" in XO Help, and to encourage others to test it. | |||
This page acts as a "Landing page" for those who have read "How to edit Help and contribute" in XO Help | |||
Any updates to the technical contents of that page will be announced here. Please see [[#Known issues]]. | Any updates to the technical contents of that page will be announced here. Please see [[#Known issues]]. | ||
| Line 23: | Line 21: | ||
Users actively involved, who are prepared to review the work of contributors: | Users actively involved, who are prepared to review the work of contributors: | ||
[[User: | * [[User:Quozl]] | ||
Please add | Please add your name ... | ||
== TODO == | == TODO == | ||
| Line 46: | Line 44: | ||
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 - not yet well covered. | Keyboard [[Hotkeys|shortcuts]] - not yet well covered. | ||
Please add any item you see missing. | Please add any item you see missing. | ||
| Line 90: | Line 88: | ||
To see work in progress since the previous XO Help, this command: | To see work in progress since the previous XO Help, this command: | ||
git clone | git clone https://github.com/godiard/help-activity.git | ||
you will get the Help Activity _with_ the sources included. | you will get the Help Activity _with_ the sources included. | ||
You can install it in your development environment doing: | You can install it in your development environment doing: | ||
cd | cd help-activity | ||
./setup.py dev | ./setup.py dev | ||
(if you have the activity already installed, uninstall it first) | (if you have the activity already installed, uninstall it first) | ||
| Line 109: | Line 107: | ||
* In any other Linux environment | * In any other Linux environment | ||
The output | The output directory {{Code|html/}}, and is opened by opening | ||
index.html in a browser, it is easy to see the changes as you work. | {{Code|html/index.html}} in a browser, so it is easy to see the changes as you work. | ||
== Further reading == | == Further reading == | ||
| Line 132: | Line 130: | ||
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, {{Code|~/ | you may delete all the output files, that is, {{Code|~/help-activity/html/}} and {{Code|~/help-activity/doctrees/}}. They will be regenerated by {{Code|make html}}. | ||
=== Reconfigure Help to show View source === | === Reconfigure Help to show View source === | ||
| Line 138: | Line 136: | ||
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 {{Code|~/ | 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|~/help-activity/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' | ||