[WG: Accessibility] Fwd: [WG: Docs] Updating arkn.html for Accessibility

Wed May 8 11:36:10 PDT 2013

FYI . 

I'll keep you posted as other progress is made.

Cheers,
Neal

Begin forwarded message:

> From: "Venstra, Elizabeth" <erytting at indiana.edu>
> Subject: RE: [WG: Accessibility] [WG: Docs] Updating arkn.html for Accessibility
> Date: May 8, 2013 11:16:41 AM EDT
> To: Neal Caidin <nealcaidin at sakaifoundation.org>, Beth Kirschner <bkirschn at umich.edu>
> 
> Swell!
>  
> For what it’s worth—I’m working on revisions to arkn for our upgrade this weekend right now, and it will have a Sakai version (just in case) that looks like this:
>  
> Accessibility information
> 
> For accessibility information for persons using adaptive technology, visit Sakai 2.9 Accessibility Documentation.
> 
>  
>  
> -----Original Message-----
> From: Neal Caidin [mailto:nealcaidin at sakaifoundation.org] 
> Sent: Wednesday, May 08, 2013 10:44 AM
> To: Beth Kirschner
> Cc: Venstra, Elizabeth
> Subject: Re: [WG: Accessibility] [WG: Docs] Updating arkn.html for Accessibility
>  
> I *think* I know how to try this locally on my PC. Professional development activity :-)
>  
> I know where to get help now!
>  
> If/when I get this working, I can run it by the Accessibility working group so they can see how it looks.  A little different than we had envisioned, but might be okay.
>  
> Thanks,
> Neal
>  
> On May 8, 2013, at 10:34 AM, Beth Kirschner <bkirschn at umich.edu> wrote:
>  
> > No worries - your suggestion was a good one and completely possible.
> >
> > - Beth
> >
> > On May 8, 2013, at 10:33 AM, "Venstra, Elizabeth" <erytting at indiana.edu> wrote:
> >
> >> And let me say that my suggestion was based on an understanding of
> >> the Sakai help tool that's extremely hazy at best--I'm sure Beth
> >> knows much more about it.  Just so that's clear.  :)
> >>
> >> -----Original Message-----
> >> From: Beth Kirschner [mailto:bkirschn at umich.edu]
> >> Sent: Wednesday, May 08, 2013 10:31 AM
> >> To: Neal Caidin
> >> Cc: Venstra, Elizabeth; documentation at collab.sakaiproject.org
> >> Subject: Re: [WG: Accessibility] [WG: Docs] Updating arkn.html for
> >> Accessibility
> >>
> >> I don't think you should create a new xxx document - I believe what Elizabeth was suggesting was that you change the location field to a complete URL (e.g.https://confluence.sakaiproject.org/display/2ACC/Accessibility+Working+Group). But you'll need to update all three help*.xml files to make sure that it's available to all localized versions. The "name" value must be unique across all of the help docs, butI prefer meaningful names over "xxx" (so what you have below is good).
> >>
> >> - Beth
> >>
> >> P.S. I've dropped the accessibility list from this thread because I'm not a member. Feel free to forward it along if desired.
> >>
> >> On May 8, 2013, at 10:00 AM, Neal Caidin <nealcaidin at sakaifoundation.org> wrote:
> >>
> >>> Currently in help.xml there is this chunk of data:
> >>>
> >>> <property name="docId"><value>arkn</value></property>
> >>>    <property name="name"><value>Accessibility Information</value></property>
> >>>    <property name="location"><value>/sakai_accessibility/arkn.html</value></property>
> >>>    <property
> >>> name="defaultForTool"><value>sakai.accessibility</value></property>
> >>>
> >>>
> >>> 1) I could make up a docId with "xxx" in the name to insure it is
> >>> not connected to Indiana KB, replacing arkn
> >>> 2) Make up an html file in that directory, call it whatever I want
> >>> and change the location to point to it
> >>> 3) Add the new html file to trunk (associate with a Jira) and update
> >>> the help.xml in trunk (also associated with the Jira)
> >>>
> >>> If that is all there is to it, I can do that.
> >>>
> >>> Thanks,
> >>> Neal
> >>>
> >>>
> >>> On May 8, 2013, at 9:34 AM, Beth Kirschner <bkirschn at umich.edu> wrote:
> >>>
> >>>> Hi Neal,
> >>>>
> >>>> The arkn.html file is configured in the help.xml file within the same directory. There are several (e.g. help_pt_BR.xml) for alternate localized copies of the help docs.
> >>>>
> >>>> - Beth
> >>>>
> >>>> On May 8, 2013, at 8:42 AM, Neal Caidin <nealcaidin at sakaifoundation.org> wrote:
> >>>>
> >>>>> Hi Elizabeth,
> >>>>>
> >>>>> I wouldn't be removing the ilnk to arkn.html, I would be updating the html itself. But maybe I am missing something. I know how to create a different html file with a different name and check it into Sakai, but I don't know how to tell the Online Help to find that document. Perhaps it is just the directory structure? I don't know. Maybe Matt Jones or someone could help me figure it out.
> >>>>>
> >>>>> For me, the easiest thing is to update in both places, arkn.html for me and the Knowledge Base for you. Since we may never run the updater scripts again, that pull Indiana's KB information into Sakai then there is no link. But just in case it does get run one or more times before being permanently retired, at least it would overwrite with the same information. I hope that makes sense.
> >>>>>
> >>>>> Thanks,
> >>>>> Neal
> >>>>>
> >>>>>
> >>>>> On May 6, 2013, at 3:29 PM, "Venstra, Elizabeth" <erytting at indiana.edu> wrote:
> >>>>>
> >>>>>> Whatever works for you, works for me.  If it's possible on your end, and simpler, to simply remove the link tohttps://source.sakaiproject.org/svn/help/trunk/help/src/sakai_accessibility/arkn.htmland replace it with a direct link to the Confluence page, that might be even better, because then it wouldn't look like a KB doc without actually being a KB doc, if you see what I mean.  But if that's tricky, by all means, let's do your plan.  I'll go ahead and draft that revision this week (whether or not I end up making it live this weekend) and send you the text I come up with.
> >>>>>>
> >>>>>> best,
> >>>>>> Elizabeth
> >>>>>>
> >>>>>> From: Neal Caidin [mailto:nealcaidin at sakaifoundation.org]
> >>>>>> Sent: Monday, May 06, 2013 3:18 PM
> >>>>>> To: Venstra, Elizabeth
> >>>>>> Cc: documentation at collab.sakaiproject.org;
> >>>>>> accessibility at collab.sakaiproject.org; Humbert, Joseph A
> >>>>>> Subject: Re: [WG: Docs] Updating arkn.html for Accessibility
> >>>>>>
> >>>>>> Hi Elizabeth,
> >>>>>>
> >>>>>> I'm not recollecting when the Confluence page should be ready. Probably Joe H. can comment.
> >>>>>>
> >>>>>> Here's the problem - I'm not sure if the scripts used to update Sakai CLE with the Knowledge base information will ever be run again. They might be, but I'm not sure. This is definitely not ideal.
> >>>>>>
> >>>>>> My suggestion is that we update them in both places with the same text? I'll update manually in Sakai CLE and you update the IU Knoweldge base? I don't expect this page to change for a long time, at least until a better online help system is figured out. So I think this will not be too bad to manage.
> >>>>>>
> >>>>>> What do you think?
> >>>>>>
> >>>>>> Thanks!
> >>>>>> Neal
> >>>>>>
> >>>>>>
> >>>>>>
> >>>>>> On May 6, 2013, at 1:37 PM, "Venstra, Elizabeth" <erytting at indiana.edu> wrote:
> >>>>>>
> >>>>>>
> >>>>>> Yes, that should be the correct page.  At any rate, the four-letter docid, arkn, is the correct one that maps to the document in our repository (https://www.indiana.edu/~sakaikb/display.cgi?docid=arkn ).  I was planning on changing the document in our repository as of this coming weekend, May 11, which is when we're deploying 2.9 here at Indiana-removing the detailed content, and simply telling readers to go to the Confluence page, with a link.  But Neal-just so I understand correctly-are you saying that you plan to remove the link to our repository for this document, and point straight to the Confluence page, without going through our document arkn?  Or do you want it to continue to use our document, which will then point to the Confluence page?  I'm fine with either approach-both should get end users to the same information-but if I know that you're going to go straight to the Confluence page, then I suppose I could just remove this document from our "sakaiht" (a.k.a. Sakai help tool) domain . . . I won't until I know for sure it's not needed there, though.
> >>>>>>
> >>>>>> Question about timing-Joe had indicated to me that the Confluence page should be ready by May 3, but it looks like it still says "Draft".  Are we still on track for it being ready for public consumption before this weekend?
> >>>>>>
> >>>>>> best,
> >>>>>>
> >>>>>> Elizabeth Venstra
> >>>>>> Knowledge Management team
> >>>>>> University Information Technology Services Indiana University
> >>>>>> erytting at indiana.edu
> >>>>>> 812-855-0459
> >>>>>>
> >>>>>>
> >>>>>>
> >>>>>> From:
> >>>>>> documentation-bounces at collab.sakaiproject.org[mailto:documentatio
> >>>>>> n- bounces at collab.sakaiproject.org] On Behalf Of Neal Caidin
> >>>>>> Sent: Monday, May 06, 2013 11:31 AM
> >>>>>> To: documentation at collab.sakaiproject.org
> >>>>>> Cc: accessibility at collab.sakaiproject.org
> >>>>>> Subject: [WG: Docs] Updating arkn.html for Accessibility
> >>>>>>
> >>>>>> Hi Documentation group,
> >>>>>>
> >>>>>> We are updating the Accessibility page in Sakai CLE so that it points to a Confluence page that can be updated more rapidly, as needed.
> >>>>>>
> >>>>>>
> >>>>>> Is this the right page, just double checking?
> >>>>>>
> >>>>>> https://source.sakaiproject.org/svn/help/trunk/help/src/sakai_acc
> >>>>>> es
> >>>>>> sibility/arkn.html
> >>>>>>
> >>>>>> All the existing text is going to be replaced with:
> >>>>>> <h1>Accessibility information</h1> <a
> >>>>>> href="https://confluence.sakaiproject.org/display/2ACC/Sakai+2.9+
> >>>>>> Ac
> >>>>>> cessibility+Documentation+English">Please click here for Sakai
> >>>>>> accessibility information</a>
> >>>>>>
> >>>>>> Thanks,
> >>>>>> Neal
> >>>>>
> >>>>> _______________________________________________
> >>>>> accessibility mailing list
> >>>>> accessibility at collab.sakaiproject.org
> >>>>> http://collab.sakaiproject.org/mailman/listinfo/accessibility
> >>>>>
> >>>>> TO UNSUBSCRIBE: send email to accessibility-unsubscribe at collab.sakaiproject.org with a subject of "unsubscribe"
> >>>>
> >>>
> >>
> >

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://collab.sakaiproject.org/pipermail/accessibility/attachments/20130508/22fc68c0/attachment-0001.html 