-
Notifications
You must be signed in to change notification settings - Fork 250
Framework in five minutes
DRAFT
So what is the Adapt Framework?
You can read the full detail on the community site (start with the Vision).
The Framework is a JavaScript client-side application that delivers Responsive e-learning.
E-Learning content is defined in JSON files which are included into a package along with various components or plugins. The Adapt Framework takes these JSON files, applies them to the included components and builds Responsive HTML5 pages using them.
The Framework has a component based architecture. There is a small core with most functionality delivered by Adapt Plugins. Most plugins will be Components which produce output as part of a course.
Version 1.0 of the Framework launches with a set of core components
As a developer you shouldn't normally need to modify code in the core framework. Instead, most of your time will be spent developing Themes, Components and additional plugins.
There's some detailed information about content structure on the Community Site.
The Adapt Framework deals with "Courses". Each package contains a single Course and that course is made up of Pages. Pages have a hierarchical structure of Articles which contain Blocks which contain Components
There are rules about how these elements are tied together, and you can read about that on the content format page. The Components in this context are the components defined above.
- Framework in Five Minutes
- Setting up Your Development Environment
- Manual Installation of the Adapt Framework
- Adapt Command Line Interface
- Common Issues
- Reporting Bugs
- Requesting Features
- Creating Your First Course
- Styling Your Course
- Configuring Your Project with config.json
- Content starts with course.json
- Course Localisation
- Compiling, testing and deploying your Adapt course
- Core Plugins in the Adapt Learning Framework
- Converting a Course from Framework Version 1 to Version 2
- Contributing to the Adapt Project
- Git Flow
- Adapt API
- Adapt Command Line Interface
- Core Events
- Core Model Attributes
- Core Modules
- Web Security Audit
- Peer Code Review
- Plugins
- Developing Plugins
- Developer's Guide: Components
- Developer's Guide: Theme
- Making a theme editable
- Developer's Guide: Menu
- Registering a Plugin
- Semantic Version Numbers
- Core Model Attributes
- Adapt Command Line Interface
- Accessibility v3
- Adapt Framework Right to Left (RTL) Support