Skip to content

Commit

Permalink
Namespace changes and changes documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
Oliver Pulges committed May 13, 2016
1 parent 7f1c64e commit 00570c4
Show file tree
Hide file tree
Showing 58 changed files with 585 additions and 833 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.textile
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
*wysihtml 0.6.0 (May 13 , 2016) (BREAKING CHANGES)
* Object namespace is now wysihtyml (was previously wysihtml5)
* Restructures code into separate modules, so users can build their own bundle of needed features (wysihtml-toolbar.js all bundle no longer present)
* Fixes problems when bundling code by removing conflicting internal bundled UMD wrappers
* Reduced size by removing some IE8 only targeting code.

*wysihtml5x 0.5.5* (January 6, 2016)
* Fixes some editing issues with IE proprietary control selection

Expand Down
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
The MIT License (MIT)

Copyright (C) 2012-2014 XING AG, Voog and contributors
Copyright (C) 2012-2016 XING AG, Voog and contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

Expand Down
19 changes: 14 additions & 5 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
# wysihtml

wysihtml is an extended and less strict approach on [xing/wysihtml5](https://github.com/xing/wysihtml5) open source rich text editor based on HTML5 technology.
The code is completely library agnostic: No jQuery, Prototype or similar is required.
wysihtml is an extended and less strict approach on [xing/wysihtml5](https://github.com/xing/wysihtml5) open source rich text editor.
The code is library agnostic and has all dependencies bundled: No jQuery, Prototype or similar is required.
The currently bundled dependencies are rangy.js (including textrange and selectionsaverestore modules) and base.js.

This project is supported by [Voog](https://voog.com).

# Version 0.6.0 breaking changes

Version 0.6.0 notes for migration.

* Object namespace is now wysihtyml (was previously wysihtml5).
* The default toolbar is separated to independant module (wysihtml.toolbar.js) and must be added separately if used.
* Full command set for backwards compatibility is not bundled and separated to wysihtml.all-commands.js module. Most commands there directly map to formatBlock or formatInline commands and are thus optional and can be replaced with these internal commands.
* Table editing features are now as a separate module

## Demos
* Project page with simple demo: https://wysihtml.com
* Minimal demo: https://voog.github.com/wysihtml/examples/simple.html
Expand All @@ -24,7 +34,6 @@ This project is supported by [Voog](https://voog.com).
* Source code view for users with HTML skills.
* Uses sandboxed iframes in order to prevent identity theft through XSS.
* Editor inherits styles and attributes (`placeholder`, `autofocus`, etc.) from original textarea (you only have to style one element).
* Speech-input for Chrome.

**Extended features not present in xing/wysihtml5:**

Expand All @@ -41,7 +50,7 @@ This project is supported by [Voog](https://voog.com).

## Browser Support

The rich text editing interface is supported in IE9+, FF 29+, Safari 5+, Safari on iOS 5+, Opera 12+ and Chrome.
The rich text editing interface is supported in IE9+, FF 29+, Safari 6+, Safari on iOS 6+, Opera 12+ and Chrome.
**Graceful Degradation:** Users with other browsers will see the textarea and are still able to write plain HTML by themselves.

## Development
Expand All @@ -51,7 +60,7 @@ wysihtml can be initialized and built using node package manager:
npm install
npm run build

This adds dependencies (first line) and builds both minified and development versions (second line), including one with toolbar support.
This adds dependencies (first line) and builds both minified and development versions (second line).

## Contributors

Expand Down
2 changes: 1 addition & 1 deletion dist/minified/wysihtml.all-commands.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions dist/minified/wysihtml.min.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dist/minified/wysihtml.min.map

Large diffs are not rendered by default.

Loading

0 comments on commit 00570c4

Please sign in to comment.