Hi Nathalie,
I just reinstalled the platform on my PC at home to make sure
nothing goes wrong and can confirm that everything is working
the way I intended it. Are you certain your "old" help item
table was replaced during (re)installation?
If and when the installation went OK and if and when you've
enabled the setting that allows Chamilo to automatically
register missing help items with the storage engine, the result
should be something like this:
The settings control the following behaviour:
- Display the help button even if there is no help page attached
to it yet? Could be useful for documentation contributors.
- When an application component does not have any help item
attached to it yet, can Chamilo add that help item to it's
storage?
- When the help item is missing, can Chamilo add the item for
all languages where it's missing?
So basically, just like with the translations, browsing through the
platform will result in a more complete list of help items / topics.
If and when we think that list is more or less complete, it could be
converted into a default XML-file whihc is parsed on installation
and might already contain default documentation links for each
package. That's up to the developers, documentation writers, etc.
In theory, right now, we can have multiple help items per page, but
is this interesting or even helpful? I doubt it. At the same time
having only one help item fixes some potential issues when doing
hierarchic calls of several submanagers. To trigger the correct
behaviour in terms of help items (among others) it's very important
to use the DelegateComponent marker interface wherever it's
relevant. Components that are marked by it, with *not* trigger the
automatic help item lookup / creation.
To answer another question: it should ne longer be necessary to add
a help item to the breadcrumb trail, this is done automatically
whenever a component is started. I hope to add a small bit of
functionality that still allows you to overwrite the "automatic"
help context if and when deemed necessary. 95% of the work required
for the help application should be finished.
If you have any more questions, just shoot :)
Best regards,
Hans
On 11/04/2011 9:24, Nathalie Blocry wrote:
Hi Hans,
could you give some more details on how it works and if and how it
needs to be implemented in the optional applications.
Have you finished refactoring this application or is it still work
in progress?
Right now a see a list of not so meaningfull contexts and
identifier (a, H, h, d ...)
some applications/components have one help-items, others have two
and some have none.
do you still have to add the help-item to the breadcrumb-trail?
Kind regards,
Nathalie
Op 04/08/2011 11:51 AM, Hans De Bisschop schreef:
Hi
all,
As discussed previously there were still some "holes" in the
help-application, most notably the fact that help pages had to
be defined explicity and that a link was missing with the
handbook application. To avoid having to explicity add help
pages to all components, this has now been automated, partly
thanks to improvements in architecture implemented these last
few months. There is no longer a need to define the help page
which the component should refer too. Some improvements might
still be added to allow you to overwrite the help page though,
although this shouldn't be necessary given that it's the actual
help target which is the most important.
Please note that a reinstall is required to avoid errors (that
or update your database manually: the column "name" was deleted
in the help_help_item table and "context" and "identifier" were
added)
Best regards,
_______________________________________________
Dev mailing list
Dev@lists.chamilo.org
http://lists.chamilo.org/listinfo/dev
_______________________________________________
Dev mailing list
Dev@lists.chamilo.org
http://lists.chamilo.org/listinfo/dev
|
