Annotation of loncom/html/adm/help/tex/Docs_Short_URLs.tex, revision 1.1

1.1     ! raeburn     1: \label{Docs_Short_URLs}
        !             2: \index{deep link}
        !             3: Although LON-CAPA is a fully functional LMS/CMS, which provides all the tools needed to run a
        !             4: fully online course, or a hybrid course, other use cases may simply require access to
        !             5: individual LON-CAPA resource(s) without a need for course management functionality.
        !             6: 
        !             7: For such use cases, the standard LON-CAPA course container will continue to be employed by a 
        !             8: Course Coordinator to organize resources, set parameters, and control content availability,
        !             9: but students themselves may access the resource(s) from some other context, by simply following
        !            10: a direct link to a particular LON-CAPA resource or folder.
        !            11: 
        !            12: To support the use of deep-linking to an individual resource or folder, URLs of the form:
        !            13: /tiny/$<$domain$>$/$<$unique code$>$ can be generated within a domain.  The $<$unique$>$ code
        !            14: is a six character code which internally maps to either the LON-CAPA's unique identifier 
        !            15: (or ``symb'') for an instance of a resource in a course, or the path to a folder within a course.
        !            16: 
        !            17: As Course Coordinator display the Course Editor menu, and click the ``Content Utilities'' tab, and
        !            18: then click the ``Display/Set Shortened URLs for Deep-linking'' link in the ``Adminstration'' panel.
        !            19: From there check the checkbox(es) for resource(s) for which deep-link access is needed, and push
        !            20: the ``Create Tiny URL(s)' button.
        !            21: 
        !            22: If your LON-CAPA domain has multiple machines, then one machine may have been designated by the
        !            23: Domain Coordinator as a LON-CAPA load-balancer, and/or may operate as the LON-CAPA portal for the domain.
        !            24: In that case the href attribute to set in a link in a web page outside LON-CAPA should point at:
        !            25: https://$<$yourportalserver$>$/tiny/$<$domain$>$/$<$unique code$>$.  Otherwise, the href attribute
        !            26: should point at https://$<$yourloncapaserver$>$/tiny/$<$domain$>$/$<$unique code$>$.
        !            27: 
        !            28: If a deep-link is followed from a web browser without an active LON-CAPA session, the user 
        !            29: will be prompted to log-in to LON-CAPA.  Once authenticated, the user's role in the course 
        !            30: to which the deep-link belongs will be selected automatically, and the resource which the 
        !            31: deep-link references will be displayed.  If the deep-link is for a folder instead of a 
        !            32: resource, then a listing of available items in that folder will be displayed as clickable 
        !            33: links. If a user has an active Coordinator role in a course, then that role will be 
        !            34: selected automatically.  Otherwise, if a user nas more than one (non-Coordinator) active 
        !            35: roles in the specific course referenced by the deep-link, then a listing of the available
        !            36: active roles will be shown, with the option to select one. Once selected, the resource
        !            37: will be displayed.

FreeBSD-CVSweb <freebsd-cvsweb@FreeBSD.org>