Help issues are known and we need solve it,<div>but I don't agree with the proposed solution.</div><div><br></div><div>The style can be changed with css, that is not a problem.</div><div><br></div><div>The biggest problem we have today, is found people to write the help.</div>
<div>If we impose to a potential writer the work of learn docbook,</div><div>will be worst. And writing a docbook editor is not a trivial task.</div><div><br></div><div>About having help content inside the activities,</div>
<div>probably is a good idea. We need think about:</div><div>* how enable the translation of that content (and how much disk space</div><div>will use if we have all the translations inside the activity)</div><div>* where put the content related to sugar (not activities)</div>
<div><br></div><div>Gonzalo  </div><div><br><div class="gmail_quote">On Mon, Oct 15, 2012 at 10:03 PM, S. Daniel Francis <span dir="ltr"><<a href="mailto:francis@sugarlabs.org" target="_blank">francis@sugarlabs.org</a>></span> wrote:<br>
<blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi,<br>
<br>
Looking at the Help activity, I see the following issues:<br>
- It looks very orange. A more integrated style is needed.<br>
- Activities should be documented independently of the help activity.<br>
<br>
(Not very related with my purpose but important for deploy a solution)<br>
- The documentation needs to be updated and Gonzalo told me about<br>
there were efforts to update it. ¿Where are them?<br>
<br>
Now I purpose some solutions:<br>
- Using docbook.<br>
Docbook is used by the GNOME documentation team and can be styled<br>
easily with CSS.<br>
- Save the documentation in each activity.<br>
With that way, Help could scan each activity for documentation, that<br>
documentation could depend of the installed version of each activity.<br>
And documentation for non-core activities could be seen from the Help<br>
activity.<br>
<br>
Knowing that the Help isn't up to date, I only migrated the first<br>
chapter for give you a preview of my purpose.<br>
<br>
A screenshot:<br>
<a href="http://wiki.sugarlabs.org/go/File:Help-docbook-purpose.png" target="_blank">http://wiki.sugarlabs.org/go/File:Help-docbook-purpose.png</a><br>
<br>
On the git repository:<br>
<a href="http://git.sugarlabs.org/~danielf/help/help-docbook" target="_blank">http://git.sugarlabs.org/~danielf/help/help-docbook</a><br>
<br>
For generate the HTML files I used the following command: (Already<br>
generated in the repository)<br>
$ yelp-build html -o ./help/ sources.xml<br>
<br>
Warm regards,<br>
Daniel Francis.<br>
</blockquote></div><br></div>