[Building Sakai] Use Sakai Help Tool to access customized external help source?
Margaret Wagner
mwagner at umich.edu
Mon Dec 19 15:16:42 PST 2011
Hi Cynthia,
Yes, at University of Michigan the pages that show up in our CTools
(Sakai) online help tool were all created here at UM. We store these
pages on one of our enterprise-wide storage system and the help tool
accesses them from there. I don't think I can help you decipher or
debug your error but here is a sample of how our .xml file is set up.
(I've deleted most of the lines, but this shows examples of
everything.) Here -- www.umich.edu/~umctdocs -- is where our pages
are stored.
I hope this helps.
-- Margaret Wagner
-----
<!-- Help External Configuration -->
<help-reg>
<category name="CTools Overview">
<resource name="Description"
location="http://www.umich.edu/~umctdocs/Description.html"/>
<resource name="New in CTools"
location="http://www.umich.edu/~umctdocs/NewFeatures.html"/>
<resource name="What are Course and Project Sites?"
location="http://www.umich.edu/~umctdocs/WhatAreSites.html"/>
</category>
<category name="What Can Instructors do with CTools?">
<resource name="What can instructors do?"
location="http://www.umich.edu/~umctdocs/WhatCanDo.html"/>
</category>
<category name="Getting Started">
<resource name="What Would You Like to Do?"
location="http://www.umich.edu/~umctdocs/WhatWantDo.html"/>
<resource name="Opening CTools and Logging In"
location="http://www.umich.edu/~umctdocs/OpeningLogging.html"/>
<resource name="Joining a Site"
location="http://www.umich.edu/~umctdocs/JoiningSites.html"
defaultForTool="sakai.membership"/>
<resource name="CTools Accessibility"
location="http://www.umich.edu/~umctdocs/Accessibility.html"/>
</category>
<category name="Creating a Site">
<resource name="Simple Outline of the Process"
location="http://www.umich.edu/~umctdocs/SettingUpSimpleOutline.html"/>
<resource name="Setting up and Publishing a site"
location="http://www.umich.edu/~umctdocs/SettingUpPublishingSite.html"
defaultForTool="sakai.sitesetup"/>
</category>
<category name="Using the Tools">
<resource name="Announcements"
location="http://www.umich.edu/~umctdocs/Announcements.html"
defaultForTool="sakai.announcements"/>
<resource name="Assignments - Creating"
location="http://www.umich.edu/~umctdocs/AssignmentsCreating.html"
defaultForTool="sakai.assignment"/>
<resource name="Assignments - Submitting"
location="http://www.umich.edu/~umctdocs/AssignmentsSubmitting.html"/>
</category>
<category name="Getting Help">
<resource name="Contact Us"
location="http://www.umich.edu/~umctdocs/ctoolsfeedback.html"/>
<resource name="Contacting CTools Consultants"
location="http://www.umich.edu/~umctdocs/Consultants.html"/>
<resource name="CTools Workshops"
location="http://www.umich.edu/~umctdocs/Training.html"/>
<resource name="Comments about this Online Help Guide?"
location="http://www.umich.edu/~umctdocs/DocComments.html"/>
</category>
<category name="Known Issues">
<resource name="Known Issues"
location="http://www.umich.edu/~umctdocs/KnownIssues.html"/>
</category>
<category name="Common Questions">
<resource name="Frequently-asked questions about using CTools"
location="http://www.umich.edu/~umctdocs/FAQMini.html"/>
</category>
<category name="Common Computer Tasks Using CTools">
<resource name="Performing Common Computer Tasks"
location="http://www.umich.edu/~umctdocs/CommonTasks.html"/>
</category>
<category name="Glossary">
<resource name="Glossary of Terms"
location="http://www.umich.edu/~umctdocs/Glossary.html"/>
</category>
<category name="Accessibility">
<resource name="Accessibility Information for CTools"
location="http://www.umich.edu/~umctdocs/Accessibility.html"/>
</category>
<category name="CTools Tutorial Videos">
<resource name="Adding a Friend Account to a Site"
location="http://www.umich.edu/~umctdocs/FriendAccountTutorial.html"/>
<resource name="Adding an Icon to a Project Site"
location="http://www.umich.edu/~umctdocs/AddingIconTutorial.html"/>
</category>
</help-reg>
================================
Quoting "Walters, Cynthia (cmw6s)" <cmw6s at eservices.virginia.edu>:
> 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
>
>
>
>
More information about the sakai-dev
mailing list