[Building Sakai] Use Sakai Help Tool to access customized external help source?

Walters, Cynthia (cmw6s) cmw6s at eservices.virginia.edu
Mon Dec 19 13:55:25 PST 2011


Hello:
A general question about configuring external help files for use with the Help Tool... confirming whether I understand the purpose of the external configuration.

Is it correct that the external help file configuration should allow our customized help to show up in the Help Tool's window, table of contents, same as the out-of-the-box configuration?  This is what we would like to see, but I have not gotten it to work yet.

Is this what Michigan does?  I've been looking at this page...
    https://confluence.sakaiproject.org/display/HELP/Help+Configuration+Examples

I've patterned a help.xml file after this example (only specifying announcements and assignments so far), but I receive the following parsing error when I attempt to access the Help Tool -- and looking for guidance about the error message (re: 'publicId and systemId'?):


2011-12-19 16:17:08,046  INFO TP-Processor43 org.sakaiproject.component.app.help.HelpManagerImpl - ***UVa:    before call to builder.parse()
[Fatal Error] :1:50: White spaces are required between publicId and systemId.
2011-12-19 16:17:08,050 ERROR TP-Processor43 org.sakaiproject.component.app.help.HelpManagerImpl - White spaces are required between publicId and systemId.
org.xml.sax.SAXParseException: White spaces are required between publicId and systemId.
    at org.apache.xerces.parsers.DOMParser.parse(Unknown Source)
    at org.apache.xerces.jaxp.DocumentBuilderImpl.parse(Unknown Source)
    at org.sakaiproject.component.app.help.HelpManagerImpl.registerExternalHelpContent(HelpManagerImpl.java:1093)
    at org.sakaiproject.component.app.help.HelpManagerImpl.registerHelpContent(HelpManagerImpl.java:1004)
    at org.sakaiproject.component.app.help.HelpManagerImpl.initialize(HelpManagerImpl.java:921)
    at org.sakaiproject.component.app.help.HelpManagerImpl.getWelcomePage(HelpManagerImpl.java:673)
    [...]

Here is my help.xml file:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>

<!-- Help External Configuration -->
<help-reg>
  <!-- Announcements -->
    <category name="Announcements">
        <resource name="Announcements" location="http://collab-dev.itc.virginia.edu/docs/help/sakai_announcements/argc.html" defaultForTool="sakai.announcements"></resource>
        <resource name="Announcements Overview" location="http://collab-dev.itc.virginia.edu/docs/help/sakai_announcements/aqyk.html"></resource>
        <resource name="Create/Edit/Delete Announcement" location="http://collab-dev.itc.virginia.edu/docs/help/sakai_announcements/arcr.html"></resource>
        <resource name="Post Announcement" location="http://collab-dev.itc.virginia.edu/docs/help/sakai_announcements/arbw.html"></resource>
        <resource name="Read Announcement" location="http://collab-dev.itc.virginia.edu/docs/help/sakai_announcements/arbd.html"></resource>
        <resource name="Set Announcement Permissions" location="http://collab-dev.itc.virginia.edu/docs/help/sakai_announcements/aram.html"></resource>
        <resource name="Merge Announcement" location="http://collab-dev.itc.virginia.edu/docs/help/sakai_announcements/aqzq.html"></resource>
    </category>
  <!-- Assignments -->
    <category name="Assignments">
        <resource name="Assignments" location="http://collab-dev.itc.virginia.edu/docs/help/sakai_assignment_grades/argj.html" defaultForTool="sakai.assignment"></resource>
        <resource name="Assignments Overview" location="http://collab-dev.itc.virginia.edu/docs/help/sakai_assignment_grades/ardn.html"></resource>
        <resource name="Create/Add Edit or Delete Assignments" location="http://collab-dev.itc.virginia.edu/docs/help/sakai_assignment_grades/arbs.html"></resource>
    </category>
</help-reg>



Thanks for any help,
Cynthia Gast Walters
UVa



-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://collab.sakaiproject.org/pipermail/sakai-dev/attachments/20111219/5d5d8379/attachment.html 


More information about the sakai-dev mailing list