[Sugar-devel] Purpose for Help Activity

[Gonzalo Odiard]

Help issues are known and we need solve it,
but I don't agree with the proposed solution.

The style can be changed with css, that is not a problem.

The biggest problem we have today, is found people to write the help.
If we impose to a potential writer the work of learn docbook,
will be worst. And writing a docbook editor is not a trivial task.

About having help content inside the activities,
probably is a good idea. We need think about:
* how enable the translation of that content (and how much disk space
will use if we have all the translations inside the activity)
* where put the content related to sugar (not activities)

Gonzalo

On Mon, Oct 15, 2012 at 10:03 PM, S. Daniel Francis
<francis at sugarlabs.org>wrote:

> Hi,
>
> Looking at the Help activity, I see the following issues:
> - It looks very orange. A more integrated style is needed.
> - Activities should be documented independently of the help activity.
>
> (Not very related with my purpose but important for deploy a solution)
> - The documentation needs to be updated and Gonzalo told me about
> there were efforts to update it. ¿Where are them?
>
> Now I purpose some solutions:
> - Using docbook.
> Docbook is used by the GNOME documentation team and can be styled
> easily with CSS.
> - Save the documentation in each activity.
> With that way, Help could scan each activity for documentation, that
> documentation could depend of the installed version of each activity.
> And documentation for non-core activities could be seen from the Help
> activity.
>
> Knowing that the Help isn't up to date, I only migrated the first
> chapter for give you a preview of my purpose.
>
> A screenshot:
> http://wiki.sugarlabs.org/go/File:Help-docbook-purpose.png
>
> On the git repository:
> http://git.sugarlabs.org/~danielf/help/help-docbook
>
> For generate the HTML files I used the following command: (Already
> generated in the repository)
> $ yelp-build html -o ./help/ sources.xml
>
> Warm regards,
> Daniel Francis.
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.sugarlabs.org/archive/sugar-devel/attachments/20121016/fea69c41/attachment.html>