GitXplorerGitXplorer
r

grunt-scorm-manifest

public
12 stars
14 forks
1 issues

Commits

List of commits on branch master.
Unverified
7b6644cd1b3c3398818f245b158b7f0b8007a022

Merge pull request #4 from gruntjs-updater/peerDep

rraygesualdo committed 8 years ago
Unverified
4a8b658dc3c49741ac56fd8483dec76dfeb8ab30

Update README.md

rraygesualdo committed 8 years ago
Unverified
35e22cb01f14d7abd7b88deb68b8b36ccd83dead

Update peerDependencies to support Grunt 1.0

committed 9 years ago
Unverified
6670854990454991611a442eb6a7b8227d83b0b7

Releasing v0.2.0

committed 11 years ago
Unverified
bff86255fe8c5415cf2c0d46fed33efb77737c69

Documentation update

committed 11 years ago
Unverified
93c9adaeb9d4159aa35a1b9cc0219b9f5c269e90

Cleaned up project files and code in task file

committed 11 years ago

README

The README file for this repository.

grunt-scorm-manifest

No Maintenance Intended

A grung plugin that generates a valid SCORM IMS manifest file.

Getting Started

This plugin requires Grunt ~0.4.2

If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:

npm install grunt-scorm-manifest --save-dev

Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:

grunt.loadNpmTasks('grunt-scorm-manifest');

The "scorm_manifest" task

Run this task with the grunt scorm_manifest command.

Task targets, files and options may be specified according to the grunt Configuring tasks guide.

Node Libraries Used: xmlbuilder-js (for xml generation).

Config

In your project's Gruntfile, add a section named scorm_manifest to the data object passed into grunt.initConfig().

grunt.initConfig({
  scorm_manifest: {
    your_target: {
			options: {
			  // Options go here
			},
			files: {
			  // File declaration goes here
			}
		}
  }
});

Options

options.version

Type: String Default value: '2004' Possible values: 2004||1.2

This is used to define which version of SCORM will be applied to the manifest.

options.courseId

Type: String Default value: 'CourseID'

This is used to define the top-level course ID.

options.SCOtitle

Type: String Default value: 'SCO Title'

This is used (by <organization />) to define the SCO title.

options.moduleTitle

Type: String Default value: 'Module'

This is used (by <item />) to define the SCO module title.

options.launchPage

Type: String Default value: 'index.html'

This is used to define the launchpage of the SCO.

options.path

Type: String Default value: './'

This is used to define the path to which imsmanifest.xml will be written.

Usage Example

This example creates a SCORM 2004 3rd Edition IMS manifest. The manifest will be written to the project directory and will include files in the project directory and all subdirectories.

// simple single SCO package
scorm_manifest: {
	your_target: {
		options: {
			version: '2004',
			courseId: 'GRUNT101',
			SCOtitle: 'Intro to Grunt',
			moduleTitle: 'AU101',
			launchPage: 'the_launchpage.html',
			path: './'
		},
		files: [{
			expand: true,	 	// required
			cwd: './', 			// start looking for files to list in the same dir as Gruntfile 
			src: ['**/*.*'], 	// file selector (this example includes subdirectories)
			filter: 'isFile'	// required
		}]
	}
}

Release History

  • 2013-12-18 v0.2.0 Initial plugin release.