wiki:Documentation

Version 12 (modified by gogo, 6 months ago) (diff)

--

Documentation

  1. Documentation
    1. User Documentation
      1. Newbie Guide
      2. Configuration Options
      3. Plugins
      4. Toolbars
    2. Developer Documentation
      1. Style Guide?
      2. Event Hooks?
      3. Class Reference

User Documentation

Newbie Guide

This is "the way" to make a Xinha. Read and follow it. NewbieGuide?

Configuration Options

List of Xinha Core Options?

Plugins

List of Xinha Plugins

Toolbars

Specifying Custom Toolbars?

Developer Documentation

Style Guide?

If you want to work on Xinha code, please adhere to the Style Guide?

Event Hooks?

There are a bunch of event hooks that can be used from within plugins or the config that can be used to perform some action at specific events that happen in the editor.
Event Hooks?

Class Reference

Automatically generated documentation. Including reference for the configuration options and all public methods:
​http://xinha.raimundmeyer.de/JSdoc/Xinha/

If you you want to dive even deeper in the world of Xinha, there's also a variant including the private methods here:
​http://xinha.raimundmeyer.de/JSdoc/XinhaWithPrivates/