Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Creating a Course
Before you start to create content, it may be useful to have a read of our Framework in five minutes page over in the adapt_framework wiki, as it gives a nice introduction to the structure of Adapt's output content (be aware that some of the content in that page is geared towards framework developers, so won't be relevant to you as an authoring tool user).
If you haven't already, you might want to take a quick look at the Adapt showcase to get a feel of how Adapt content is structured (the Adapt 2.0 Demo will be particularly useful, as it only contains the open-source plugins).
- Adding a course
- Editing course content
- Editing course settings
- Applying a theme
- Applying a menu
- Configuring extensions
- Viewing your course
- Further reading
Adding a course
When you first load up the authoring tool, you'll see the dashboard; a display showing every course that's been created. You can organise the view of courses using the onscreen filters and search controls.
Shared courses: the default view ("My courses") will only show the courses which you have created yourself. To view any shared courses, you must click the link in the sidebar. To make a course you've authored yourself viewable in this section, you must enable the relevant option in the course's "Configuration setting" page.
To begin, click the "Add new course" button on the dashboard, give the course a title and description, choose who it should be visible to, and give it any appropriate tags (these details can be edited after the course has been created).
Once the course has been created, it should show up on the dashboard. Double click the course, or click the gear icon and then choose "Edit". This will take you into the course editor.
Editing course content
Once in the course editor, there are two things to notice: the sidebar at the left of the screen gives you access to many top-level configuration pages ("Configuration settings" and a "Menu picker" for example) -- these are explained later, and the panel in the middle -- this is the main content area.
This information applies to the courses on the dashboard, pages and sub-menus in the menu editor, and all content objects in the page editor:
- Objects are draggable, to allow you to easily reposition them at will
- Objects have an 'actions' menu, which allows you to edit, copy, copy ID and delete
- Objects can also be deleted using the trash icon to the right
You'll find that most of the editor 'form' screens follow the same layout: left sidebar with save button and filters, and the main form area in the middle.
The sidebar filters allow you to hide groups of options in the current page, which is very handy for the longer pages! By default, all options are shown.
Make sure you use the save button frequently to ensure you don't lose any changes!
- Display-title/title: The display title is that which is shown in the page, while the title is only shown in the Page-level progress extension's drawer.
- Body: Text usually shown below the title.
- Instruction: Instruction text for the current object (shown with the body text).
- Classes: adds CSS classes to the object -- handy if you want to add custom CSS to a single object.
- Is this optional?: Whether the object should be tracked towards completion.
- Is this available?: Whether the object should be displayed.
The first page you'll come to upon opening a course for editing is the menu editor. The menu editor shows you the top-level structure of your course. The only content items that will appear here are pages and sub-menus.
If you add a sub-menu and single-click on it, you'll notice that an extra column is added to the right. Each column represents a single 'menu' screen, with the top-level items arranged to the far left, with child items to the immediate right, and so on. There can be any number of sub-menus, and sub-menus can also be contained in other sub-menus, allowing you to create complex content hierarchies.
Page/sub-menu settings: Once you've created a page or sub-menu, you can access its settings by clicking "Edit" in its cog menu.
Double-clicking on any of your pages will take you to the page editor screen, which gives you a visual 'wireframe' view of the page's structure.
Adding content objects
If you're editing a new page, you'll find yourself with a single empty article with an empty block. If you try to preview now, you'll be given an error, as the tool won't let you publish a course with empty blocks.
Add a new component to your empty block using the "Add component" button. A sidebar will appear which allows you to select the type of component, as well as it's position within the block (i.e. left/right/full-width). Blocks can take either one full-width component, or two half-width components (one to the left and one to the right).
Once added, edit your new component by double clicking on it or by selecting "Edit" from the the cog menu. Feel free to add more articles and blocks using the relevant controls.
Once the course contains at least one page with one component, you can preview it using the sidebar button.
Moving/deleting content objects
You can change the layout (i.e. left/right/full-width) of any component in your page using the layout arrows next to the component's settings cog. Certain actions may be unavailable if you have another component in the current block (e.g. you won't be able to change a component to full-width if there are two components in the block).
If you want to move a content object to a different position in the page, you can simply drag and drop. Make sure you grab the top of the content object (i.e. where it's title is) -- the cursor will change to let you know you're in the right place.
If you want to get rid of any content object, you can use either its trash icon, or by the "Delete" option in its settings/cog menu. Be aware that any child objects will also be deleted, so make sure you move out everything you want to keep before you do this!
Editing course settings
Each course has several different types of settings.
Project settings: contains the same settings used when creating the course, and groups content-based options, such as global button labels.
Configuration settings: contains course-wide configuration options such as the default language, the 'weighting' of each question in the greater score progress and accessibility settings.
Head over to this page for more detailed information about these two pages.
Applying a theme
To apply a theme to your course, you just need to go to the "Theme picker" page, choose your theme by clicking on it, and clicking save.
Applying a menu
Setting the menu for your course is identical to applying a theme.
By default, no extensions will be enabled for your course. To add extensions, you must go to the "Manage extensions" page in the main editor sidebar.
Here you will be presented a list of the extensions you have installed, along with a brief description of what they do, and an "Add" button, which is used to add them to your course. When you add an extension to your course, it will be moved to the section at the top of the page entitled "Enabled extensions". You will notice you now have the option to "Remove" it.
Viewing your course
When you're ready to view your course, there are a few different functions available (found at the top of the editor's sidebar).
Loads a fully functioning preview of your course in a new window.
As the course runs on a simple web server, there is no cross-session tracking (although you will get single session progress tracking). To fully test tracking, you need to either download a published version of your course, or use the
scorm_test_harness.html file (see Advanced use).
If you have the Spoor extension enabled, you can use a file called
scorm_test_harness.html which uses browser cookies to allow you to test LMS specified behaviour outside of an LMS environment.
To do this, you must add
scorm_test_harness.html to the end of the preview URL in your browser's address bar and load the new page.
This function builds your course, and packages it as a zip file to download to your computer.
If you've enabled the Spoor extension, the downloaded package will be SCORM 1.2 conformant, ready for uploading to the Learning Management System of your choice.
If you are not using Spoor/SCORM, the contents of the zip file will need to be uploaded to (and run from) a web server.
Export source code
You can also export a complete copy of all source code for your course. See this page for more information.