WYMeditor Documentation Contents

• WYMeditor Documentation
  • Description
  • Resources
  • Full Table of Contents
  • Chapters and Sections
    • About WYMeditor
      • Description
      • Resources
      • Why WYMeditor?
      • Try It
      • Browser Compatibility
      • Requirements
        • Global Pollution
      • Copyright
    • Getting Started With WYMeditor
      • Setting up WYMeditor
        • Quick Start Instructions
          • Include jQuery
          • Download a Pre-built Release of WYMeditor
          • Or install via Bower
          • Source the WYMeditor Javascript
          • Create a textarea for the Editor
          • Use wymeditor() to Create an Editor
          • All Together Now
          • Troubleshooting
            • Security Errors
            • 404s Loading Files
        • Example
      • WYMeditor Integrations
        • Content Management Systems
          • Django CMS
          • Refinery CMS
          • Drupal
          • Frog CMS
          • MediaWiki
          • Midgard CMS Framework
        • Web Frameworks
          • Jelix
        • Open Source Projects
          • Adminer
        • Commercial Projects
          • Kickstarter
          • PolicyStat
    • Using WYMeditor
      • WYMeditor Skins
        • Loading a Skin
          • Third-party Skins and Skins in Development
          • Optimizations
        • Included Skins
          • Seamless
            • Known Issues
              • Window doesn’t shrink for IE8+
              • Usability problems with very-wide tables/images
              • Frame centering problems in IE
              • View HTML box not affixed
              • Toolbar UI Tweaks Needed
              • Window doesn’t grow for inserted images
        • Third-Party Skins
          • wymeditor-refine
      • Using WYMeditor Plugins
      • Common WYMeditor Options
      • Getting Help
      • Anatomy of an Editor Initialization
    • Upgrade Guides
      • Upgrading to v1
        • High Impact Backwards Incompatible Changes
          • Semantic Versioning
          • Internet Explorer 7 Not Supported
          • Internet Explorer 8 Requires Shims
          • No jQuery-migrate
          • New Document Getters and Setters
          • Test Your Dialogs
          • Plugins Should Register Modifications
          • Object Re-sizing is Gone
          • Using the Legacy Skin and Editor Styles
            • Deprecation
          • No More Skin Auto-loading
            • Options Removed
          • No More CSS Configuration Options
            • Options Removed
            • Methods Removed
          • No More Language Automatic Loading
            • Options Removed
        • Low Impact Backwards Incompatible Changes
    • Customizing WYMeditor
      • Basics of Customization
        • 1. Using WYMeditor Initialization Options
        • 2. Using a WYMeditor “Skin”
        • 3. Using WYMeditor Plugins
        • 4. Using a Custom Iframe
      • Using WYMeditor Options
        • Example: Start with Existing HTML and Alert on Load
          • Full HTML
      • WYMeditor Options
        • Common Options
          • html
            • Example
          • lang
            • Example: Choosing the Polish Translation
          • toolsItems
            • Example
            • Default value
          • containersItems
            • Example
          • classesItems
            • Example
          • preInit
            • Parameters
          • preBind
            • Parameters
          • postInit
            • Parameters
            • Example
        • Uncommon Options
          • basePath
            • Example
          • wymPath
          • iframeBasePath
          • updateSelector and updateEvent
          • preInitDialog
            • Parameters
          • postInitDialog
            • Parameters
        • UI Customization Options
          • List of HTML Template Options
        • UI Selectors Options
          • List of Selectors
          • Example Selector Customization
            • Contributed Examples and Cookbooks
              • Running the Examples Locally
              • Examples Table of Contents
                • Integrate WYMeditor in Django Administration
                  • Using the filebrowser Application
                • Image Gallery Implementation Example
                  • 1. Including Plugin Code
                  • 2. Adding Injection Target to Dialog Body
                  • 3. AJAX Call from Javascript
                  • 4. Database Structure
                  • 5. PHP / CodeIgniter Functions
                  • 6. Put it all Together
                  • 7. Using it
                • Integrate WYMeditor into sNews CMS
                  • Install sNews
                  • Install WYMeditor
                  • Integrate WYMeditor
                • Integrate WYMeditor into Rails
                  • Extra Info
    • WYMeditor Plugins
      • Included Plugins with Download
        • Embed
        • Fullscreen
        • Hovertools
        • List
        • RDFA
        • Resizable
        • Table
        • Tidy
        • Structured Headings
          • Features
          • Applying Structured Headings Styling outside of the Editor
      • Third Party Plugins
        • Modal Dialog (by samuelcole)
        • Alignment (by Patabugen)
        • Site Links (by Patabugen)
        • Image Float (by Patabugen)
        • Image Upload (by Patabugen)
        • Catch Paste
      • Plugins
        • Using a Plugin
        • Writing Plugins
          • Example Plugin
          • Adding a Button to the Tool Bar
        • Available Plugins
    • Writing WYMeditor Plugins
      • API
        • Core
          • html(html)
          • rawHtml(html)
          • update()
          • getCurrentState()
          • WYMeditor.instances
          • WYMeditor.version
          • iframeInitialized
          • vanish()
          • jQuery.getWymeditorByTextarea()
          • element
          • EVENTS
          • documentStructureManager.setDefaultRootContainer(tagName)
        • Selection Setting and Getting
          • hasSelection()
          • deselect()
          • nodeAfterSel()
          • doesElementContainSelection(element)
          • selectedContainer()
          • getRootContainer()
          • getSelectedImage()
          • canSetCaretBefore(node)
          • setCaretBefore(node)
          • canSetCaretIn(node)
          • setCaretIn(element)
          • restoreSelectionAfterManipulation(manipulationFunc)
          • selection()
        • Content Manipulation
          • body()
          • $body()
          • exec(cmd)
          • link(attrs)
          • insertImage(attrs)
          • paste(data)
          • insert(data)
          • setRootContainer(sType)
          • registerModification()
          • switchTo(node, sType, stripAttrs)
          • toggleClass(sClass, jqexpr)
          • isBlockNode(node)
          • isForbiddenRootContainer(tagName)
          • isInlineNode(node)
          • keyCanCreateBlockElement(keyCode)
          • prepareDocForEditing()
          • findUp(node, filter)
          • unwrapIfMeaninglessSpan(node)
        • Undo/Redo
          • undoRedo.undo()
          • undoRedo.redo()
          • undoRedo.reset()
        • List manipulation
          • isListNode(node)
          • indent()
          • outdent()
          • insertList(listType)
          • changeListType(list, listType)
          • convertToList(blockElement, listType)
        • User Interface
          • status(sMessage)
          • toggleHtml()
          • keyboard.combokeys
          • focusOnDocument()
          • get$Buttons()
        • Dialogs
          • dialog(dialogObject)
        • Helpers
          • WYMeditor.console
          • wym.uniqueStamp()
          • jQuery.fn.nextContentsUntil() and jQuery.fn.prevContentsUntil()
          • jQuery.fn.nextAllContents() and jQuery.fn.prevAllContents()
          • jQuery.fn.parentsOrSelf()
          • jQuery.fn.isPhantomNode() and WYMeditor.isPhantomNode()
          • WYMeditor.isPhantomString()
          • WYMeditor.arrayContains(array, thing)
          • WYMeditor.replaceAllInStr(str, old, new)
          • WYMeditor.editor.get$CommonParent(one, two)
        • Constants
          • Elements
          • Key codes
          • Node types
        • Internationalization
          • replaceStrings(sVal)
          • encloseString(sVal)
        • Utilities
          • box
          • jQuery.wymeditors(i)
          • jQuery.copyPropsFromObjectToObject(origin, target, props)
          • isInlineNode(node)
          • WYMeditor.isInternetExplorer*()
      • Custom Events
        • Available Events
          • postBlockMaybeCreated
          • postIframeInitialization
      • Plugin-Writing Mini Guide
        • 1. Create an example in examples/
          • Serving Examples
          • Serving Examples from dist/
        • 2. Create your plugin folder
        • 3. Build your awesome thing
        • 4. Document your awesome plugin
      • Plugin Do’s and Don’ts
        • Don’t enable your plugin on file load
        • Mark your dialog-opening buttons
        • Handle focus
    • WYMeditor Development
      • Contributing
        • We <3 Contributions
        • Example Contribution Process
          • Staying up to Date
        • Configuring Your Development Environment
          • Example Installation
            • 1. Install NVM
            • 2. Install node and npm using nvm
            • 3. Install WYMeditor’s dependencies
            • 4. Install Grunt
            • 4. Ensure everything works
          • Troubleshooting
            • PhantomJS Isn’t Working
          • Front-end dependencies with Bower
          • Enabling Automatic Livereload for Development
      • Contributing Documentation
        • Building and Opening the Documentation
        • Documentation Source Files
        • Version Agnostic Documentation
      • Building WYMeditor
      • Testing WYMeditor
        • Unit tests vs. Selenium tests
        • QUnit test suite
          • Running in real browsers
          • Running in a headless browser
          • Running with various versions of jQuery
            • In real browsers
            • In a headless browser
          • Travis CI
        • Selenium tests
          • Running Selenium tests
      • Coding Standard
        • jshint
          • Making Files Pass
            • Fix Your Code
            • Define global and exported
              • global
              • exported
              • Make single-section jshint Exceptions
              • Make file-wide jshint Exceptions
          • Current vs Ideal
        • Crockford Javascript Code Conventions
          • Changes to Crockford Conventions
        • Formatting and Style
          • Naming Conventions
            • Variables and Functions
            • Constructors
          • Namespacing
          • Multi-Line Strings
            • HTML Strings
          • Inheritance and “Classes”
          • Other Rules and Best Practices
            • Leave the Natives Alone
            • Use Literals
            • Use the which Property of jQuery Event Objects
            • Comments should read as “why?” sentences
              • “What” comment example
              • Improved
            • Further Reading
      • WYMeditor Architecture
        • Code Structure
          • core.js
          • parser.js
          • editor/
          • iframe/
          • skins/
          • lang/
          • plugins/
      • Expected Cross-browser behavior of the Cursor in Reaction to Keystrokes
        • General Guidelines
        • Guide
          • Paragraph at Start
      • Planning For Future Enhancements
        • Roadmap for WYMeditor 2.0 (Draft)
          • General Goals
          • The Roadmap
            • Step 1: The HTML, DOM and CSS Parsers
            • Step 2: the Selection API
            • Step 3: The Editor Core
            • Step 4: The UI
        • Proposed Build Stack
          • 100% Javascript
          • Components
            • General build tool
            • Asset Management
            • Documentation
              • Inline Documentation
              • Full Documentation
            • Testing
        • Plugin System Architecture
          • Goals
          • Enabling a Plugin
          • API
        • Selection API
        • Plan for Insertion Functions
          • insertInline
          • insertBlockAfter
          • insertBlock
            • Examples
        • Dev Process Improvements
          • Build Process
            • 1. Minify/Concat all the things
            • 2. Support Custom Builds
          • Documentation
            • Better Structure
            • Automate Taking Demo Screenshots for the Docs
          • Code Cleanup
            • JSHint the remaining first-party files
            • Don’t use eval()
            • Vendor Rangy
          • Testing
            • Eliminate the Selenium tests
              • Candidates
            • Run the Unit Tests in Every Browser on Every Build
            • Load all examples/tests on travis
      • Making WYMeditor Releases
        • Prerequesites for a release
          • No Regression Bugs
          • Passing Tests
          • Documentation is up–to–date
          • Change–log is up–to–date
          • Read–me is up–to–date
          • Website is up–to–date
        • Making the release
          • Prepare
          • Update version strings
          • Build the web–site
          • Build WYMeditor
          • Commit the changes
          • Ship it!
        • Prepare for the next release
      • WYMeditor Website
        • Website files
        • Environment for development of the website
        • Previewing the website locally
        • Building the website
        • Publishing the website
      • Troubleshooting
        • Error Running $ grunt server
          • Just Fix It
          • More Details
    • Resources
      • Using WYMeditor
        • Introduction
        • Guidelines
        • Word References