[Building Sakai] Fwd: gradebook2 help

[Geng, Kelly]

Yes GB2 doesn't come with built-in help content, but provides a
configurable external link to any custom document.  We found this ticket :
https://jira.sakaiproject.org/browse/GRBK-918 and got the sense that there
was some waiting for the help refactory, so went ahead to implement our own.





On Sat, Jul 27, 2013 at 6:46 PM, Steve Swinsburg
<steve.swinsburg at gmail.com>wrote:

> The strange thing is that there already is a help module, but as you
> mentioned, its not in the main pom so its not built and deployed. So adding
> the <module>help</module> will correct that.
>
> But why does source need to be added? Is the help module in gb2 just a
> placeholder and doesnt actually have any help content? All other tools
> provide the basic help for their own tool and people can customise it and
> translate it, its not expected that everyone is to do their own thing from
> scratch.
>
> cheers,
> Steve
>
>
>
> On Sun, Jul 28, 2013 at 2:02 AM, Geng, Kelly <gengx at miamioh.edu> wrote:
>
>> Sanghyun <https://plus.google.com/u/0/116260149370084228636?prsrc=4>,
>>
>> We did something like that. By default, the GB2 pom doesn't include the
>> help module. You want to add a <module>help</module> into the
>> $gb2_src/pom.xml to deploy the help jar to shared/lib, as Steve pointed
>> out. Once it's deployed, you will see a placeholder for GB2. Then all you
>> need to do is to add your help files into
>> $gb2_src/help/src/sakai_gradebook_gwt_rpc, and organize/configure them in
>> $gb2_src/help/src/sakai_gradebook_gwt_rpc/help.xml, and then of course
>> redeploy the help jar. Upon restarting tomcat, the help module should be
>> able to pick up your content. The last step would be to point the gb2 help
>> link in sakai.properties to the contextual help page so that the Help link
>> inside of GB2 will take users to the same place.
>>
>> Let me know if you have further questions.
>>
>> Kelly
>>
>>
>>
>> On Sat, Jul 27, 2013 at 12:21 AM, Steve Swinsburg <
>> steve.swinsburg at gmail.com> wrote:
>>
>>> Does the gradebook2 help jar get deployed to shared?
>>>
>>>
>>> On Sat, Jul 27, 2013 at 9:04 AM, Sanghyun Jeon <euksa99 at gmail.com>wrote:
>>>
>>>> Does anybody have a solution for this question?
>>>>
>>>> S
>>>>
>>>> ---------- Forwarded message ----------
>>>> From: Sanghyun Jeon <euksa99 at gmail.com>
>>>>  Date: Fri, Jul 19, 2013 at 10:25 AM
>>>> Subject: Fwd: gradebook2 help
>>>> To: sakai-dev <sakai-dev at collab.sakaiproject.org>
>>>>
>>>>
>>>> unfortunately, I have not heard back from anybody.
>>>> I hope somebody can shed some light on this, so that I can move on.
>>>>
>>>>
>>>> S
>>>>
>>>> ---------- Forwarded message ----------
>>>> From: Sanghyun Jeon <euksa99 at gmail.com>
>>>> Date: Thu, Jul 18, 2013 at 11:50 AM
>>>> Subject: gradebook2 help
>>>> To: sakai-dev <sakai-dev at collab.sakaiproject.org>
>>>>
>>>>
>>>> We are testing Sakai 2.8 and  recognize that Sakai help link (blue
>>>> question mark on the right top corner)  does not contain Gradebook2 link.
>>>> Would you mind telling me how I can add gradebook2 link into this help link?
>>>>
>>>> my sakai.properties has below in order to enable "Help" tab in
>>>> gradebook2 table
>>>> gb2.help.url=
>>>> https://smartsite.ucdavis.edu/ucd-gateway/Gradebook2Documents.html
>>>>
>>>> However, this does not affect blue question mark help link.
>>>>
>>>> Thank you in advance.
>>>>
>>>> S
>>>>
>>>>
>>>>
>>>> _______________________________________________
>>>> sakai-dev mailing list
>>>> sakai-dev at collab.sakaiproject.org
>>>> http://collab.sakaiproject.org/mailman/listinfo/sakai-dev
>>>>
>>>> TO UNSUBSCRIBE: send email to
>>>> sakai-dev-unsubscribe at collab.sakaiproject.org with a subject of
>>>> "unsubscribe"
>>>>
>>>
>>>
>>> _______________________________________________
>>> sakai-dev mailing list
>>> sakai-dev at collab.sakaiproject.org
>>> http://collab.sakaiproject.org/mailman/listinfo/sakai-dev
>>>
>>> TO UNSUBSCRIBE: send email to
>>> sakai-dev-unsubscribe at collab.sakaiproject.org with a subject of
>>> "unsubscribe"
>>>
>>
>>
>>
>> --
>> Kelly
>>
>
>


-- 
Kelly
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://collab.sakaiproject.org/pipermail/sakai-dev/attachments/20130727/9bd1ea2a/attachment.html