Skip to content

Commit

Permalink
SAK-50091 Help sakai help doc updates targeted for 23 (sakaiproject#1…
Browse files Browse the repository at this point in the history
  • Loading branch information
ottenhoff authored May 15, 2024
1 parent 597cc3f commit 6064d2b
Show file tree
Hide file tree
Showing 21 changed files with 1,355 additions and 104 deletions.
2 changes: 1 addition & 1 deletion help/help-tool/src/webapp/WEB-INF/tools/sakai.help.xml
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,6 @@
<registration>
<tool id="sakai.help" title="Help Documentation" description="The Sakai Help Tool">
<category name="sakai.help"/>
<configuration name="help.collections" value="sakai_toc,sakai_screensteps_academicTermManagerAdministratorGuide,sakai_screensteps_adminSitePermsAdministratorGuide,sakai_screensteps_aliasesAdministratorGuide,sakai_screensteps_announcementsorMessageoftheDayAdministratorGuide,sakai_screensteps_becomeUserAdministratorGuide,sakai_screensteps_delegatedAccessAdministratorGuide,sakai_screensteps_emailTemplatesAdministratorGuide,sakai_screensteps_eventsAdministratorGuide,sakai_screensteps_externalToolsAdministratorGuide,sakai_screensteps_jobSchedulerAdministratorGuide,sakai_screensteps_memoryAdministratorGuide,sakai_screensteps_messageBundleManagerAdministratorGuide,sakai_screensteps_onlineAdministratorGuide,sakai_screensteps_pASystemAdministratorGuide,sakai_screensteps_permissionsandRolesAdministratorGuide,sakai_screensteps_realmsAdministratorGuide,sakai_screensteps_resourcesAdministratorGuide,sakai_screensteps_searchAdministratorGuide,sakai_screensteps_siteArchiveAdministratorGuide,sakai_screensteps_sitesAdministratorGuide,sakai_screensteps_sitestatsAdminAdministratorGuide,sakai_screensteps_usersAdministratorGuide,sakai_screensteps_userMembershipAdministratorGuide,sakai_screensteps_worksiteSetupAdministratorGuide,sakai_screensteps_quotaIncreasesAdministratorGuide,sakai_screensteps_aboutHelpUserGuide,sakai_screensteps_accessibilityUserGuide,sakai_screensteps_announcementsUserGuide,sakai_screensteps_assignmentsUserGuide,sakai_screensteps_notificationsUserGuide,sakai_screensteps_calendarUserGuide,sakai_screensteps_chatUserGuide,sakai_screensteps_commonsUserGuide,sakai_screensteps_contactUsUserGuide,sakai_screensteps_conversationsUserGuide,sakai_screensteps_courseandProjectSitesUserGuide,sakai_screensteps_dashboardUserGuide,sakai_screensteps_discussionsUserGuide,sakai_screensteps_dropBoxUserGuide,sakai_screensteps_emailUserGuide,sakai_screensteps_emailArchiveUserGuide,sakai_screensteps_externalToolLTIUserGuide,sakai_screensteps_globalNavigationUserGuide,sakai_screensteps_gradebookUserGuide,sakai_screensteps_homeUserGuide,sakai_screensteps_lessonsUserGuide,sakai_screensteps_messagesUserGuide,sakai_screensteps_newsUserGuide,sakai_screensteps_overviewUserGuide,sakai_screensteps_permissionsandRolesUserGuide,sakai_screensteps_podcastsUserGuide,sakai_screensteps_pollsUserGuide,sakai_screensteps_postEmUserGuide,sakai_screensteps_profileUserGuide,sakai_screensteps_resourcesUserGuide,sakai_screensteps_richTextEditorUserGuide,sakai_screensteps_rosterUserGuide,sakai_screensteps_rubricsUserGuide,sakai_screensteps_searchUserGuide,sakai_screensteps_sectionInfoUserGuide,sakai_screensteps_signUpUserGuide,sakai_screensteps_siteInfoUserGuide,sakai_screensteps_statisticsUserGuide,sakai_screensteps_syllabusUserGuide,sakai_screensteps_testsandQuizzesUserGuide,sakai_screensteps_webContentUserGuide,sakai_screensteps_wikiUserGuide,sakai_screensteps_gatewayUserGuide" type="final"/>
<configuration name="help.collections" value="sakai_toc,sakai_screensteps_academicTermManagerAdministratorGuide,sakai_screensteps_adminSitePermsAdministratorGuide,sakai_screensteps_aliasesAdministratorGuide,sakai_screensteps_announcementsorMessageoftheDayAdministratorGuide,sakai_screensteps_becomeUserAdministratorGuide,sakai_screensteps_delegatedAccessAdministratorGuide,sakai_screensteps_emailTemplatesAdministratorGuide,sakai_screensteps_eventsAdministratorGuide,sakai_screensteps_externalToolsAdministratorGuide,sakai_screensteps_jobSchedulerAdministratorGuide,sakai_screensteps_memoryAdministratorGuide,sakai_screensteps_messageBundleManagerAdministratorGuide,sakai_screensteps_onlineAdministratorGuide,sakai_screensteps_pASystemAdministratorGuide,sakai_screensteps_permissionsandRolesAdministratorGuide,sakai_screensteps_plusAdminAdministratorGuide,sakai_screensteps_realmsAdministratorGuide,sakai_screensteps_resourcesAdministratorGuide,sakai_screensteps_searchAdministratorGuide,sakai_screensteps_siteArchiveAdministratorGuide,sakai_screensteps_sitesAdministratorGuide,sakai_screensteps_sitestatsAdminAdministratorGuide,sakai_screensteps_usersAdministratorGuide,sakai_screensteps_userMembershipAdministratorGuide,sakai_screensteps_worksiteSetupAdministratorGuide,sakai_screensteps_quotaIncreasesAdministratorGuide,sakai_screensteps_aboutHelpUserGuide,sakai_screensteps_accessibilityUserGuide,sakai_screensteps_announcementsUserGuide,sakai_screensteps_assignmentsUserGuide,sakai_screensteps_calendarUserGuide,sakai_screensteps_chatUserGuide,sakai_screensteps_commonsUserGuide,sakai_screensteps_contactUsUserGuide,sakai_screensteps_conversationsUserGuide,sakai_screensteps_courseandProjectSitesUserGuide,sakai_screensteps_dashboardUserGuide,sakai_screensteps_discussionsUserGuide,sakai_screensteps_dropBoxUserGuide,sakai_screensteps_emailUserGuide,sakai_screensteps_emailArchiveUserGuide,sakai_screensteps_externalToolLTIUserGuide,sakai_screensteps_globalNavigationUserGuide,sakai_screensteps_gradebookUserGuide,sakai_screensteps_homeUserGuide,sakai_screensteps_lessonsUserGuide,sakai_screensteps_messagesUserGuide,sakai_screensteps_newsUserGuide,sakai_screensteps_notificationsUserGuide,sakai_screensteps_overviewUserGuide,sakai_screensteps_permissionsandRolesUserGuide,sakai_screensteps_podcastsUserGuide,sakai_screensteps_pollsUserGuide,sakai_screensteps_postEmUserGuide,sakai_screensteps_profileUserGuide,sakai_screensteps_resourcesUserGuide,sakai_screensteps_richTextEditorUserGuide,sakai_screensteps_rosterUserGuide,sakai_screensteps_rubricsUserGuide,sakai_screensteps_searchUserGuide,sakai_screensteps_sectionInfoUserGuide,sakai_screensteps_signUpUserGuide,sakai_screensteps_siteInfoUserGuide,sakai_screensteps_statisticsUserGuide,sakai_screensteps_syllabusUserGuide,sakai_screensteps_testsandQuizzesUserGuide,sakai_screensteps_webContentUserGuide,sakai_screensteps_wikiUserGuide,sakai_screensteps_gatewayUserGuide" type="final"/>
</tool>
</registration>
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ <h3 class="step-title screensteps-heading">Sites</h3>
<div class="step screensteps-section screensteps-depth-2" id="your-profile-picture-and-name-use-this-menu-to-log-out">
<h3 class="step-title screensteps-heading">Your Account Menu (Use This Menu to Log Out)</h3>
<div class="image screensteps-image">
<img src="https://media.screensteps.com/image_assets/assets/007/114/959/original/0c7b665c-5958-422a-9cec-ef99a9fab3c4.png" alt="user account menu" height="678" width="455">
<img src="https://media.screensteps.com/image_assets/assets/007/858/092/original/95e0a201-33fc-4285-a3c4-9650fdf7554b.png" alt="user account menu" height="885" width="527">
</div>

<div class="step-instructions screensteps-textblock">
Expand Down Expand Up @@ -269,14 +269,19 @@ <h3 class="step-title screensteps-heading">Expand/Collapse Tool Navigation (for
<div class="step screensteps-section screensteps-depth-2" id="content-area">
<h3 class="step-title screensteps-heading">Content Area</h3>
<div class="image screensteps-image">
<a href="https://media.screensteps.com/image_assets/assets/005/024/099/original/4b04bb11-8275-4041-9524-122c33a15ff4.png" class="screensteps-image-zoom">
<img src="https://media.screensteps.com/image_assets/assets/005/024/099/medium/4b04bb11-8275-4041-9524-122c33a15ff4.png" alt="" height="121" width="855">
<a href="https://media.screensteps.com/image_assets/assets/007/858/094/original/df98d6ea-85a1-4f61-b7b8-bfd6545a3a95.png" class="screensteps-image-zoom">
<img src="https://media.screensteps.com/image_assets/assets/007/858/094/medium/df98d6ea-85a1-4f61-b7b8-bfd6545a3a95.png" alt="" height="206" width="855">
</a>
</div>

<div class="step-instructions screensteps-textblock">
<div id="text-content_85341BA9-63B6-4954-9405-6C3408B12BC7" class="text-block-content">
<p>The content comes after the Tool Menu.  </p>
<p>At the top of the screen, you will find:</p>
<ol>
<li>The <strong>title of the site you are in and the tool</strong> you are currently viewing. This is also a <strong>Refresh Tool</strong> link that returns you to the main page of the tool when clicked. Pictured above is an example of an <strong>Announcements </strong>(<strong>Refresh Tool</strong>) link.</li>
<li>There is also a <strong>Help</strong> button in the top navigation, which opens a new tab or window (depending on your internet browser preferences) with help documentation for the current tool.</li>
</ol>
<p>3. The content comes after the Tool Menu.  </p>
<ul>
<li>
<strong>Location:</strong> On Desktop View, the content displays to the right of the Tool Menu. On Mobile View, the content appears underneath the <strong>Tools</strong> link.</li>
Expand All @@ -287,11 +292,6 @@ <h3 class="step-title screensteps-heading">Content Area</h3>
<li>
<strong>Access key:</strong> [<strong>C</strong>]</li>
</ul>
<p>At the top of the content area for most tools, you will find:</p>
<ol>
<li>The <strong>title of the tool</strong> you are currently viewing. This is also a <strong>Refresh Tool</strong> link that returns you to the main page of the tool when clicked. Pictured above is an example of an <strong>Announcements </strong>(<strong>Refresh Tool</strong>) link.</li>
<li>The title will be followed by a <strong>Help</strong> button, which opens a new tab or window (depending on your internet browser preferences) with help documentation for the current tool.</li>
</ol>
</div>
</div>

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,129 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>How do I set Announcements tool options?</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="" name="description">
<link href="../css/help.css" media="all" rel="stylesheet" type="text/css" charset="utf-8">
<link href="/library/webjars/fontawesome/4.7.0/css/font-awesome.min.css" media="screen" rel="stylesheet">
<link href="/library/skin/morpheus-default/tool.css" media="screen" rel="stylesheet" type="text/css" charset="utf-8">
<script src="/library/webjars/jquery/1.12.4/jquery.min.js" type="text/javascript" charset="utf-8"></script>
<script src="/library/js/headscripts.js" type="text/javascript" charset="utf-8"></script>
<script type="text/javascript" charset="utf-8">
includeWebjarLibrary('featherlight');
$(document).ready(function(){
$("a.screensteps-image-zoom").featherlight({
type: { image:true },
closeOnClick: 'anywhere'
});
});
</script>
</head>
<body>
<div><div>
<div><h1 class="article-title">How do I set Announcements tool options?</h1></div>
<div>



<div class="step-instructions screensteps-textblock screensteps-wrapper--introduction screensteps-wrapper">
<div id="text-content_A8342B78-FAD2-4925-BE51-98002003F7BF" class="text-block-content">
<p>By default, students may only read announcements that have been posted by instructors and other instructor-type roles. Instructors may set the announcement display options for users within a course site.</p>
</div>
</div>

<div class="step screensteps-section screensteps-depth-1">
<h2 class="step-title screensteps-heading">Go to the Announcements tool.  </h2>
<div class="image screensteps-image">
<img src="https://media.screensteps.com/image_assets/assets/005/984/125/original/ad4ab7cd-36af-4258-97b3-1f57d19b56da.png" alt="" height="124" width="177">
</div>

<div class="step-instructions screensteps-textblock">
<div id="text-content_81F462A5-D4F2-4A85-86A3-EAE4591764C1" class="text-block-content">
<p>Select the <strong>Announcements</strong> tool from the Tool Menu of your site.</p>
</div>
</div>

</div>

<div class="step screensteps-section screensteps-depth-1">
<h2 class="step-title screensteps-heading">Click Options.</h2>
<div class="image screensteps-image">
<img src="https://media.screensteps.com/image_assets/assets/008/326/718/original/157d7737-b90f-4c27-a436-0f98cddc2640.png" alt="" height="48" width="361">
</div>

</div>

<div class="step screensteps-section screensteps-depth-1" id="change-the-display-options">
<h2 class="step-title screensteps-heading">Change the Display Options.</h2>
<div class="image screensteps-image">
<img src="https://media.screensteps.com/image_assets/assets/008/326/720/original/8e04022c-c73b-420e-b434-02768ba7f6cb.png" alt="" height="419" width="533">
</div>

<div class="step-instructions screensteps-textblock">
<div id="text-content_df3c6bdc-a831-4661-819c-9b5b0bc40324" class="text-block-content">
<p>You may select to display site announcements in one of the following ways:</p>
<ol>
<li>Sortable table view</li>
<li>Sortable table view with announcement body</li>
<li>List view with announcement body</li>
<li>If you select to show the announcement body, you may also specify the number of body characters to display.</li>
</ol>
</div>
</div>

</div>

<div class="step screensteps-section screensteps-depth-1" id="create-an-rss-alias">
<h2 class="step-title screensteps-heading">Create an RSS Alias</h2>
<div class="image screensteps-image">
<a href="https://media.screensteps.com/image_assets/assets/008/326/722/original/3b7da026-1559-47ba-b047-fb4488c6e0b9.png" class="screensteps-image-zoom">
<img src="https://media.screensteps.com/image_assets/assets/008/326/722/medium/3b7da026-1559-47ba-b047-fb4488c6e0b9.png" alt="" height="240" width="855">
</a>
</div>

<div class="step-instructions screensteps-textblock">
<div id="text-content_1749545b-26da-4244-a5d7-ab26a8f8f952" class="text-block-content">
<p>By default, each site is automatically given an RSS URL that can be used to subscribe to public announcements. If you would like to customize this URL to one that is easier to remember, you may type the desired alias into the RSS Alias text entry field.</p>
</div>
</div>

<div class="image screensteps-image">
<img src="https://media.screensteps.com/image_assets/assets/008/326/724/original/27b8f45a-96f3-467d-9b7a-36ffe0aa3b22.png" alt="" height="242" width="752">
</div>

<div class="step-instructions screensteps-textblock">
<div id="text-content_fc2af27c-7d8b-4556-a927-7ee5da24ed67" class="text-block-content">
<p>After you Update to save that change, your alias will replace the auto-generated portion at the end of the URL.</p>
</div>
</div>

</div>

<div class="step screensteps-section screensteps-depth-1" id="specify-the-announcement-display-limits">
<h2 class="step-title screensteps-heading">Specify the announcement display limits.</h2>
<div class="image screensteps-image">
<img src="https://media.screensteps.com/image_assets/assets/008/326/726/original/89dec8ac-c73d-48b1-ba48-e757497584f1.png" alt="" height="277" width="346">
</div>

<div class="step-instructions screensteps-textblock">
<div id="text-content_2e1b78dc-15c3-4497-9c5b-14ea107d3db5" class="text-block-content">
<p>If you would like to specify the default number of days in the past or number of announcements to be display, enter those values in the fields provided.</p>
</div>
</div>

</div>

<div class="step screensteps-section screensteps-depth-1" id="select-the-update-button-to-save-your-changes">
<h2 class="step-title screensteps-heading">Select the Update button to save your changes.</h2>
<div class="image screensteps-image">
<img src="https://media.screensteps.com/image_assets/assets/008/326/728/original/5dc6cf17-6089-4dcc-a3c1-2bd0c43b19a5.png" alt="" height="88" width="243">
</div>

</div>


</div>
</div></div>
</body>
</html>
Loading

0 comments on commit 6064d2b

Please sign in to comment.