Skip to content

Latest commit

 

History

History
117 lines (87 loc) · 3.1 KB

README.md

File metadata and controls

117 lines (87 loc) · 3.1 KB
Raw

ALPS Online Editor

ALPS Online Editor is a web-based editor for creating and editing Application-Level Profile Semantics (ALPS) documents. It supports both XML and JSON formats with real-time validation, auto-completion, and live preview features.

Usage

Online Version

Visit app-state-diagram.com to use the editor directly in your browser.

Offline Usage

Prerequisites

  • PHP 8.0 or higher
  • Composer

Installation

  1. Clone the repository
git clone https://github.com/alps-asd/alps-editor
cd alps-editor
  1. Install dependencies
composer install
  1. Start the local server
composer serve
  1. Open http://localhost:8081/ in your browser

Features

Smart Auto-Completion

  • Press Ctrl + Space to show context-aware snippets
  • When starting from scratch:
    1. Clear the editor content
    2. Press Ctrl + Space
    3. Choose either "ALPS XML Skeleton" or "ALPS JSON Skeleton"
    4. Fill in the placeholders using Tab

Real-Time Validation

  • Automatic validation against ALPS schema
  • Immediate visual feedback on errors
  • Detailed error messages with line numbers
  • Live preview of the rendered ALPS document

File Management

  • Support for both XML and JSON ALPS formats
  • Drag and drop ALPS files directly into the editor
  • Accepts JSON, XML, and HTML files containing ALPS profiles
  • Quick save with Ctrl + S (or Cmd + S on Mac)

Smart Suggestions

  • Context-aware descriptor completions
  • Automatic href suggestions from existing descriptors
  • Built-in semantic terms from Schema.org

Getting Started

  1. Creating a New Document

    • Clear the editor content
    • Press Ctrl + Space
    • Select either "ALPS XML Skeleton" or "ALPS JSON Skeleton"
    • Start filling in your API description

  2. Adding Descriptors

    • Type at desired location
    • Press Ctrl + Space for suggestions
    • Available snippet types:
      • Ontology (with/without href)
      • Taxonomy
      • Choreography (with/without parameters)

  3. Opening Existing Files

    • Drag and drop your ALPS file into the editor
    • Supports:
      • .json (ALPS JSON format)
      • .xml (ALPS XML format)
      • .html (Will extract ALPS profile if present)

  4. Saving Your Work

    • Press Ctrl + S (or Cmd + S on Mac)
    • File will be downloaded in current format

Keyboard Shortcuts

  • Ctrl + Space: Show auto-completion suggestions
  • Ctrl + S / Cmd + S: Save document
  • Tab: Navigate through snippet placeholders
  • Shift + Tab: Navigate backwards through placeholders

Validation

The editor performs two types of validation:

  1. Syntax validation (JSON/XML)
  2. ALPS semantic validation against the official ALPS schema

Error indicators:

  • ❌ Red squiggly underline: Syntax error
  • ✅ Green checkmark: Valid ALPS document

References