mirror of
https://github.com/kjanat/articulate-parser.git
synced 2026-01-16 11:42:09 +01:00
164 lines
4.2 KiB
Markdown
164 lines
4.2 KiB
Markdown
# Articulate Rise Parser
|
|
|
|
A Go-based parser that converts Articulate Rise e-learning content to various formats including Markdown and Word documents.
|
|
|
|
## Features
|
|
|
|
- Parse Articulate Rise JSON data from URLs or local files
|
|
- Export to Markdown (.md) format
|
|
- Export to Word Document (.docx) format
|
|
- Support for various content types:
|
|
- Text content with headings and paragraphs
|
|
- Lists and bullet points
|
|
- Multimedia content (videos and images)
|
|
- Knowledge checks and quizzes
|
|
- Interactive content (flashcards)
|
|
- Course structure and metadata
|
|
|
|
## Installation
|
|
|
|
1. Ensure you have Go 1.21 or later installed
|
|
2. Clone or download the parser code
|
|
3. Initialize the Go module:
|
|
|
|
```bash
|
|
go mod init articulate-parser
|
|
go mod tidy
|
|
```
|
|
|
|
## Dependencies
|
|
|
|
The parser uses the following external library:
|
|
|
|
- `github.com/unidoc/unioffice` - For creating Word documents
|
|
|
|
## Usage
|
|
|
|
### Command Line Interface
|
|
|
|
```bash
|
|
go run main.go <input_uri_or_file> <output_format> [output_path]
|
|
```
|
|
|
|
#### Parameters
|
|
|
|
- `input_uri_or_file`: Either an Articulate Rise share URL or path to a local JSON file
|
|
- `output_format`: `md` for Markdown or `docx` for Word Document
|
|
- `output_path`: Optional. If not provided, files are saved to `./output/` directory
|
|
|
|
#### Examples
|
|
|
|
1. **Parse from URL and export to Markdown:**
|
|
|
|
```bash
|
|
go run main.go "https://rise.articulate.com/share/rcIndCUPTdBfKAShckA5XSz3YSHpi5al#/" md
|
|
```
|
|
|
|
2. **Parse from local file and export to Word:**
|
|
|
|
```bash
|
|
go run main.go "articulate-sample.json" docx "my-course.docx"
|
|
```
|
|
|
|
3. **Parse from local file and export to Markdown:**
|
|
|
|
```bash
|
|
go run main.go "C:\Users\kjana\Projects\articulate-parser\articulate-sample.json" md
|
|
```
|
|
|
|
### Building the Executable
|
|
|
|
To build a standalone executable:
|
|
|
|
```bash
|
|
go build -o articulate-parser main.go
|
|
```
|
|
|
|
Then run:
|
|
|
|
```bash
|
|
./articulate-parser input.json md output.md
|
|
```
|
|
|
|
## Output Formats
|
|
|
|
### Markdown (.md)
|
|
|
|
- Hierarchical structure with proper heading levels
|
|
- Clean text content with HTML tags removed
|
|
- Lists and bullet points preserved
|
|
- Quiz questions with correct answers marked
|
|
- Media references included
|
|
- Course metadata at the top
|
|
|
|
### Word Document (.docx)
|
|
|
|
- Professional document formatting
|
|
- Bold headings and proper typography
|
|
- Bulleted lists
|
|
- Quiz questions with answers
|
|
- Media content references
|
|
- Maintains course structure
|
|
|
|
## Supported Content Types
|
|
|
|
The parser handles the following Articulate Rise content types:
|
|
|
|
- **Text blocks**: Headings and paragraphs
|
|
- **Lists**: Bullet points and numbered lists
|
|
- **Multimedia**: Videos and images (references only)
|
|
- **Knowledge Checks**: Multiple choice, multiple response, fill-in-the-blank, matching
|
|
- **Interactive Content**: Flashcards and interactive scenarios
|
|
- **Dividers**: Section breaks
|
|
- **Sections**: Course organization
|
|
|
|
## Data Structure
|
|
|
|
The parser works with the standard Articulate Rise JSON format which includes:
|
|
|
|
- Course metadata (title, description, settings)
|
|
- Lesson structure
|
|
- Content items with various types
|
|
- Media references
|
|
- Quiz/assessment data
|
|
- Styling and layout information
|
|
|
|
## URL Pattern Recognition
|
|
|
|
The parser automatically extracts share IDs from Articulate Rise URLs:
|
|
|
|
- Input: `https://rise.articulate.com/share/rcIndCUPTdBfKAShckA5XSz3YSHpi5al#/`
|
|
- API URL: `https://rise.articulate.com/api/rise-runtime/boot/share/rcIndCUPTdBfKAShckA5XSz3YSHpi5al`
|
|
|
|
## Error Handling
|
|
|
|
The parser includes error handling for:
|
|
|
|
- Invalid URLs or share IDs
|
|
- Network connection issues
|
|
- Malformed JSON data
|
|
- File I/O errors
|
|
- Unsupported content types
|
|
|
|
## Limitations
|
|
|
|
- Media files (videos, images) are referenced but not downloaded
|
|
- Complex interactive elements may be simplified in export
|
|
- Styling and visual formatting is not preserved
|
|
- Assessment logic and interactivity is lost in static exports
|
|
|
|
## Future Enhancements
|
|
|
|
Potential improvements could include:
|
|
|
|
- PDF export support
|
|
- Media file downloading
|
|
- HTML export with preserved styling
|
|
- SCORM package support
|
|
- Batch processing capabilities
|
|
- Custom template support
|
|
|
|
## License
|
|
|
|
This is a utility tool for educational content conversion. Please ensure you have appropriate rights to the Articulate Rise content you're parsing.
|