Skip to content

Commit

Permalink
SAK-26062 mega-commit of new help images and english content
Browse files Browse the repository at this point in the history
git-svn-id: https://source.sakaiproject.org/svn/help/trunk@308146 66ffb92e-73f9-0310-93c1-f5514f145a0a
  • Loading branch information
ottenhoff committed Apr 11, 2014
1 parent 9646342 commit 7ef1d5c
Show file tree
Hide file tree
Showing 398 changed files with 31,592 additions and 112 deletions.
37 changes: 35 additions & 2 deletions help/README
Original file line number Diff line number Diff line change
@@ -1,4 +1,37 @@
Help Configuration Sakai 2.0.1
==Help Configuration==

Sakai 10 Help Rewrite: https://jira.sakaiproject.org/browse/SAK-26062
Sakai 10 Help Process: https://confluence.sakaiproject.org/display/ESUP/Help+Files+and+Documentation+Process+Redesign

How were help files generated for Sakai 10?
--------------------------------------------
1) Articles were authoried in an online system called Screensteps
2) HTML + Images were exported from Screensteps as a ZIP
3) Files were converted using a PHP file written by Longsight (https://github.com/LongsightGroup/sakai-help-conversion)

# Unzip the Screensteps export
mkdir /tmp/help
cd /tmp/help
unzip export.zip

# Git the code
cd ~/
git clone https://github.com/LongsightGroup/sakai-help-conversion.git
cd sakai-help-conversion
php -q sakai-help-parse.php

# Optimize the PNG images from the export
find /tmp/help/images/ -iname '*.png' -exec optipng -o7 {} \;
find /tmp/help/images/ -name '*.png' -print0 | xargs -0 -P8 pngquant --ext .png --force 64

# Remove empty image directories
find /tmp/help/images/ -empty -type d -delete

# Copy the images into the sourcecode
rsync --delete -vzra /tmp/help/images/ /path/to/source/reference/library/images/help/en/


----------------------------------------------------------------------------------------------------------------------------

Overview:

Expand Down Expand Up @@ -152,4 +185,4 @@ Configuration: Help - Window Title
The Help tool's window title will be retrieved from the property ui.service in sakai.properties:
ui.service=CTools



60 changes: 41 additions & 19 deletions help/help-tool/src/webapp/html/help.html
Original file line number Diff line number Diff line change
@@ -1,24 +1,46 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html><head>
<title>Welcome to Help</title>
<link type="text/css" href="/library/skin/tool_base.css" rel="stylesheet" />
<link type="text/css" href="/library/skin/default/tool.css" rel="stylesheet" />
<!DOCTYPE html>
<html lang="en">
<head>
<title>About Sakai Help</title>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<meta content="sakai.help" name="description">
<meta content="" name="search">
<link href="/library/skin/tool_base.css" media="screen" rel="stylesheet" type="text/css" charset="utf-8">
<link href="/library/skin/neo-default/tool.css" media="screen" rel="stylesheet" type="text/css" charset="utf-8">
<link href="/library/skin/neo-default/help.css" media="screen" rel="stylesheet" type="text/css" charset="utf-8">
<link href="/library/js/jquery/featherlight/0.4.0/featherlight.min.css" media="screen" rel="stylesheet" type="text/css" charset="utf-8">
<script src="/library/js/jquery/jquery-1.9.1.min.js" type="text/javascript" charset="utf-8"></script><script src="/library/js/jquery/featherlight/0.4.0/featherlight.min.js" type="text/javascript" charset="utf-8"></script><script type="text/javascript" charset="utf-8">
$(document).ready(function(){
$("a[rel^='featherlight']").featherlight({
type: { image:true },
closeOnClick: 'anywhere'
});
});
</script>
</head>
<body>
<div class="helpBody">
<h2>Welcome to Help</h2>
<p>You can navigate to any Help article by clicking on the title of a collection name in the contents pane on the left to expand the collection, and then clicking on the article title.</p>
<h3>Searching Help</h3>
You can search Help content by entering a search term or phrase in the search pane on the left, and clicking on the <strong><code>Search</code></strong> button. Search results are ranked by relevance.
<h3>Tool Help</h3>
While using a tool, you can go directly to the Help for that tool by clicking on the Help icon in the tool title bar.
<h3>Things to consider</h3>
<ul>
<li>Help articles may describe features or settings that are not available to you, depending on your role within a worksite. See <a href="../TOCDisplay/content.hlp?docId=arax">Permissions and Roles: Overview</a> for more information.</li>
</ul>
<h3>Further resources</h3>
If the information you're looking for is not available here, try looking in the online <a href="http://confluence.sakaiproject.org/confluence/display/CONF" target="_blank">Sakai Community Wiki</a>.
<div id="wrapper">
<div id="article-content">
<div id="article-header">
<h1 class="article-title">About Sakai Help</h1>
</div>

<div id="article-description">
<p>Please note that the help documentation provided for Sakai is written for "out-of-the-box" (OOTB) Sakai. As such, it is designed to support the core tools available for this version.</p>
<p>The screen images incorporated into the documentation are all taken using the generic, OOTB Sakai theme or "skin".</p>
<p>Depending on local customizations, your individual instance of Sakai may have some differences in available tools, tool names, user roles, skins, or default permissions.</p>
<p>Also note that while all users have the ability to search and view all available help, your user account must have the necessary permissions in order to perform administrative or site management tasks. Help articles may describe features or settings that are not available to you, depending on your role within a site. See What are permissions and roles? for more information.</p>
</div> <div id="steps-container"> <div id="step-2393" class="step-container"> <h2 class="step-title">Navigating Help</h2> <div class="step-instructions"><p>You can navigate to any Help article by clicking on the title of a collection name in the contents pane on the left to expand the collection, and then clicking on the article title.</p></div> </div>
<div class="clear"></div> <div id="step-2394" class="step-container"> <h2 class="step-title">Searching Help</h2> <div class="step-instructions"><p>You can search Help content by entering a search term or phrase in the search pane on the left, and clicking on the Search button. Search results are ranked by relevance.</p></div> </div>
<div class="clear"></div> <div id="step-2395" class="step-container"> <h2 class="step-title">Tool Help</h2> <div class="step-image-container">
<img src="/library/image/help/en/About-Sakai-Help/Tool-Help.png" width="20" height="24" class="step-image" alt="Tool Help">
</div>
<div class="step-instructions"><p>While using a tool, you can go directly to the Help for that tool by clicking on the Help icon in the tool title bar.</p></div> </div>
<div class="clear"></div> <div id="step-2396" class="step-container"> <h2 class="step-title">Additional Help Resources</h2> <div class="step-instructions"><p>If the information you're looking for is not available here, try looking in the online <a href="https://confluence.sakaiproject.org" target="_blank">Sakai Community Wiki</a>.</p></div> </div>
<div class="clear"></div> </div>
</div>


</div>
</body>
</html>
25 changes: 0 additions & 25 deletions help/help-tool/src/webapp/html/help_fr_CA.html

This file was deleted.

29 changes: 0 additions & 29 deletions help/help-tool/src/webapp/html/help_mn.html

This file was deleted.

24 changes: 0 additions & 24 deletions help/help-tool/src/webapp/html/help_zh_TW.html

This file was deleted.

17 changes: 4 additions & 13 deletions help/help-tool/src/webapp/tools/sakai.help.xml
Original file line number Diff line number Diff line change
@@ -1,16 +1,7 @@
<?xml version="1.0"?>

<registration>

<tool id="sakai.help" title="Help Documentation" description="The Sakai Help Tool">

<category name="sakai.help" />

<!-- generic help collections -->
<configuration name="help.collections"
value="sakai_iframe_myworkspace,sakai_menubar,sakai_course_sites,sakai_permissions,sakai_accessibility,sakai_editor"
type="final" />

</tool>

<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_aboutHelpInstructorGuide,sakai_screensteps_accessibilityInstructorGuide,sakai_screensteps_myWorkspaceInstructorGuide,sakai_screensteps_courseandProjectSitesInstructorGuide,sakai_screensteps_permissionsandRolesInstructorGuide,sakai_screensteps_announcementsInstructorGuide,sakai_screensteps_assignmentsInstructorGuide,sakai_screensteps_chatInstructorGuide,sakai_screensteps_dropBoxInstructorGuide,sakai_screensteps_emailInstructorGuide,sakai_screensteps_emailArchiveInstructorGuide,sakai_screensteps_externalToolLTIInstructorGuide,sakai_screensteps_forumsInstructorGuide,sakai_screensteps_gradebookInstructorGuide,sakai_screensteps_lessonsInstructorGuide,sakai_screensteps_messagesInstructorGuide,sakai_screensteps_newsInstructorGuide,sakai_screensteps_podcastsInstructorGuide,sakai_screensteps_pollsInstructorGuide,sakai_screensteps_postEmInstructorGuide,sakai_screensteps_profileInstructorGuide,sakai_screensteps_resourcesInstructorGuide,sakai_screensteps_richTextEditorInstructorGuide,sakai_screensteps_rosterInstructorGuide,sakai_screensteps_scheduleInstructorGuide,sakai_screensteps_searchInstructorGuide,sakai_screensteps_sectionInfoInstructorGuide,sakai_screensteps_signUpInstructorGuide,sakai_screensteps_siteInfoInstructorGuide,sakai_screensteps_statisticsInstructorGuide,sakai_screensteps_syllabusInstructorGuide,sakai_screensteps_testsQuizzesInstructorGuide,sakai_screensteps_webContentInstructorGuide,sakai_screensteps_wikiInstructorGuide,sakai_screensteps_aboutHelpStudentGuide,sakai_screensteps_accessibilityStudentGuide,sakai_screensteps_myWorkspaceStudentGuide,sakai_screensteps_courseandProjectSitesStudentGuide,sakai_screensteps_announcementsStudentGuide,sakai_screensteps_assignmentsStudentGuide,sakai_screensteps_chatStudentGuide,sakai_screensteps_dropBoxStudentGuide,sakai_screensteps_emailStudentGuide,sakai_screensteps_emailArchiveStudentGuide,sakai_screensteps_forumsStudentGuide,sakai_screensteps_gradebookStudentGuide,sakai_screensteps_lessonsStudentGuide,sakai_screensteps_messagesStudentGuide,sakai_screensteps_newsStudentGuide,sakai_screensteps_podcastsStudentGuide,sakai_screensteps_pollsStudentGuide,sakai_screensteps_postEmStudentGuide,sakai_screensteps_profileStudentGuide,sakai_screensteps_resourcesStudentGuide,sakai_screensteps_richTextEditorStudentGuide,sakai_screensteps_rosterStudentGuide,sakai_screensteps_scheduleStudentGuide,sakai_screensteps_searchStudentGuide,sakai_screensteps_signUpStudentGuide,sakai_screensteps_syllabusStudentGuide,sakai_screensteps_testsQuizzesStudentGuide,sakai_screensteps_wikiStudentGuide,sakai_screensteps_evaluationsOSPOSPGuide,sakai_screensteps_formsOSPOSPGuide,sakai_screensteps_glossaryOSPOSPGuide,sakai_screensteps_matricesOSPOSPGuide,sakai_screensteps_portfolioTemplatesOSPOSPGuide,sakai_screensteps_portfoliosOSPOSPGuide,sakai_screensteps_stylesOSPOSPGuide,sakai_screensteps_settingSakaiPropertiesforOSPOSPGuide" type="final"/>
</tool>
</registration>
Loading

0 comments on commit 7ef1d5c

Please sign in to comment.