Contents
Introduction
Installation / Setup
Frequently Asked Questions
Known Bugs & Issues
Introduction
What is htmlArea?
htmlArea is a free WYSIWYG (what you see is what you get) editor replacement for <textarea> fields. By adding a few simple lines of JavaScript to your web page, you can replace a regular textarea with a rich text editor that lets your users do the following:
- Format text to be bold, italicized, or underlined
- Change the face, size, style and colour
- Left, centre, or right-justify paragraphs
- Make bulleted or numbered lists
- Indent or un-indent paragraphs
- Insert a horizontal line
- Insert hyperlinks and images
- View the raw HTML source of what they're editing
- and much more...
Some of the interesting features of htmlArea that sets it apart from other web based WYSIWYG editors are as follows:
- It's lightweight, fast loading and can transform a regular textarea into a rich-text editor with a single line of JavaScript.
- It's 100% backwards compatible with older or non-supported browsers (they get the original textarea field).
- It's free and can be incorporated into any free or commercial program.
- It works with any programming language (ASP, PHP, Perl, Java, etc.).
- It's written in simple JavaScript and can be easily viewed, modified or extended.
- It remembers entered content when a user navigates away and then hits "back" in their browser.
- Since it replaces existing textareas, it doesn't require a lot of code to add it to your pages (just one line).
- Did we mention it was free? :)
Is It Really Free? What's the Catch?
Yes! It's really free. You can use it, modify it, distribute it with your software, or do just about anything you like with it.
What Are the Browser Requirements?
htmlArea requires Internet Explorer 5.5 or better on Windows to run. This is because it makes use of some advanced features of IE5.5 that aren't available in other browsers yet. It is backwards compatible with other browsers, though. They will get a regular textarea field instead of a WYSIWYG editor.
Can I See an Example of What It Looks Like?
Sure, make sure you're using IE5.5 or better on windows and see below.
Here is a regular <textarea> field.
And here is a <textarea> transformed with htmlArea (with a single line of JavaScript code).
Where Can I Find Out More Info, Download the Latest Version, and Talk to Other htmlArea Users?
You can find out more about htmlArea and download the latest version on the htmlArea homepage and you can talk to other htmlArea users and post any comments or suggestions you have in the htmlArea forum.
Installation / Setup
How Do I Add htmlArea to My Web Page?
It's easy, first you need to upload the htmlArea files to your website. Just follow these steps:
- Download the latest version from the htmlArea homepage.
- Unzip the files onto your local computer (making sure to maintain the directory structure contained in the zip).
- Create a new folder on your website called /htmlarea/ (make sure it's NOT inside the cgi-bin).
- Transfer all the htmlArea files from your local computer into the /htmlarea/ folder on your website.
- Open the example page /htmlarea/example.html with your browser to make sure everything works.
Once htmlArea is on your website, all you need to do is add some JavaScript to any pages that you want to add WYSIWYG editors to. Here's how to do that.
- Open the page you want to add a WYSIWYG editor to. Add the following to the top of the page in the
<head></head> of the HTML document.
<script language="Javascript1.2"><!--
_editor_url = "";
var win_ie_ver = parseFloat(navigator.appVersion.split("MSIE")[1]);
if (navigator.userAgent.indexOf('Mac') >= 0) { win_ie_ver = 0; }
if (navigator.userAgent.indexOf('Windows CE') >= 0) { win_ie_ver = 0; }
if (navigator.userAgent.indexOf('Opera') >= 0) { win_ie_ver = 0; }
if (win_ie_ver >= 5.5) {
document.write('<scr' + 'ipt src="' +_editor_url+ 'editor.js"');
document.write(' language="Javascript1.2"></scr' + 'ipt>');
} else { document.write('<scr'+'ipt>function editor_generate()
{ return false; }</scr'+'ipt>'); }
If you've installed htmlArea anywhere other than /htmlarea/, then be sure to change _editor_url to point to your htmlarea directory (ending with a forward slash "/"). - For each
<textarea> that you want to change, add the following code to the page.
<script language="JavaScript1.2" defer>
editor_generate('fieldname');
</script>
Be sure to change "fieldname" to be the name (not id) of the textarea you want to change. - And you're done, open your page in your browser and see if it worked. If you run into any problems, keep trying and feel free to visit the htmlArea forum.
I Want to Change the Editor Settings, How Do I Do That?
While it's true that all you need is one line of JavaScript to create an htmlArea WYSIWYG editor, you can also specify more config settings in the code to control how the editor works and looks. Here's an example of some of the available settings:
<script language="JavaScript1.2" defer>
var config = new Object();
config.width = "90%";
config.height = "200px";
config.bodyStyle = 'background-color: white; font-family: "Verdana";' +
'font-size: x-small;';
config.debug = 0;
editor_generate('fieldname',config);
</script>
See below for even more configuration options that can be added. All of these settings will use default values in editor.js if you don't specify them yourself.
Width | Specifies the width of the editor (in pixels or as a percentage). |
Height | Specifies the height of the editor (in pixels or as a percentage). |
bodyStyle | specifies CSS style of the editor window including color, default font face, and size. Note, the default font information isn't saved, it just controls how text is displayed if no other font formatting has been applied. |
debug | If set to 1, displays a debug field with the actual contents of the editor (in raw HTML) which is updated as your type. |
How Can I Change What Controls Are Displayed on the Toolbar?
You can add a config.toolbar config setting to control exactly what's shown on the toolbar. Here's an example.
config.toolbar = [
['fontname'],
['fontsize'],
['fontstyle'],
['linebreak'],
['bold','italic','underline','separator'],
['strikethrough','subscript','superscript','separator'],
['justifyleft','justifycenter','justifyright','separator'],
['OrderedList','UnOrderedList','Outdent','Indent','separator'],
['forecolor','backcolor','separator'],
['HorizontalRule','Createlink','InsertImage','htmlmode','separator'],
['about','help']
];
The square brackets control how the buttons are "grouped" together. You can either erase or comment out (by adding // to the beginning of the line) buttons or button groups you don't want displayed. Most of the buttons do pretty much just what you'd expect, but here are a few odd ones for reference.
linebreak | Adds a linebreak to the toolbar, all buttons after this are on the next line |
separator | Adds a vertical separator between buttons, helps to visually group buttons together |
customN | These are custom buttons that can be defined by JavaScript programmers who want to extend htmlArea. |
How Can I Change What Fonts Are in the Font List?
There is a config.fontnames setting that lets you control this. See below.
config.fontnames = {
"Arial": "arial, helvetica, sans-serif",
"Courier New": "courier new, courier, mono",
"Georgia": "Georgia, Times New Roman, Times, Serif",
"Tahoma": "Tahoma, Arial, Helvetica, sans-serif",
"Times New Roman": "times new roman, times, serif",
"Verdana": "Verdana, Arial, Helvetica, sans-serif",
"impact": "impact",
"WingDings": "WingDings"
};
The name on the left is what is displayed to the user. The list of fonts on the right is what is actually put into the font tag in the code.
How Can I Change What Sizes Are in the Font Size?
There is a config.fontsizes setting that lets you control this. See below.
config.fontsizes = {
"1 (8 pt)": "1",
"2 (10 pt)": "2",
"3 (12 pt)": "3",
"4 (14 pt)": "4",
"5 (18 pt)": "5",
"6 (24 pt)": "6",
"7 (36 pt)": "7"
};
The value on the right is what the user sees, the value on the left is the actual font size used.
How Can I Change What Styles Are in the Font Style (CSS) List?
As you can probably guess, there's a config.fontstyles setting for this. Now remember, the styles defined here control how the text looks in the editor. These styles ALSO have to be defined on any page where you display content created with the editor. htmlArea will save the class name with the content but nothing else. It's up to you to define the class style in your pages.
config.fontstyles = [{
name: "headline",
className: "headline",
classStyle: "font-family: arial; font-size: 28px;"
},{
name: "red text",
className: "saletext2",
classStyle: ""
}];
The "name" is what's displayed to users, "className" is the name of the CSS class to use, and classStyle defines the attributes of the style in the editor. If you leave classStyle blank, you have to be sure to also specify an external stylesheet with all the style information (and matching classNames!). See the next question on how to do that.
How Can I Specify an External Stylesheet for My Styles?
You can specify a stylesheet to avoid entering the class style data for each class name. You still have to specify which classNames you want to have available though, see the previous question for information on that.
config.stylesheet = "/style.css";
Frequently Asked Questions
What Are the Project Goals for htmlArea?
When we originally started the htmlArea project, we had some pretty specific goals in mind for how it would work and what issues were important to us. Those goals still lead the direction of development today and are listed below in order of priority.
- Compatibility
htmlArea has to always be backwards compatible with older and unsupported browsers. This ensures that even if a user with an older and unsupported browser can't use htmlArea, they'll always be able to, at a minimum, enter text in a plain textarea like they would have done before. htmlArea should also be compatible with as many programming languages as possible by being completely DHTML and JavaScript based.
- Ease of Use
htmlArea needs to be easy for developers to integrate into their applications and customize, easy for programmers to extend and modify, and easy for end users to "use". That's why you only have to add a single line of JavaScript for each textarea you want to convert, and why all the code is stored in a single, easy to follow JavaScript file. That's why htmlArea can be used with almost any programming language (ASP, PHP, Perl, Java, etc.), and that the toolbar is streamlined, customizable by developers, and follows the conventions of common word processing programs.
- Lightweight
htmlArea needs to be fast loading, allow the user to perform word processing functions at a reasonable speed, and not put a lot of strain on a user's browser. To these ends, we've managed to keep the main editor program in a single file of only 40k and we've written the editor in such a way that it has a minimal impact on the resources of the browser it is running in. In addition, where we make use of popup windows to perform additional functions we try to put as much code as possible in the popup window so it doesn't increase the size of the base editor.
This Editor Is Pretty Neat, So How Does It Actually Work?
htmlArea is based on the MSHTML Editing Platform in Internet Explorer 5.5+ on windows. Basically, Internet Explorer includes some functionality to make sections of a webpage editable by defining a "contentEditable" attribute or "designMode" property. It also provides some built in commands for performing common web editing operations (bold, italic, center, insert image, etc).
htmlArea builds on the features provided by Internet Explorer and adds its own user definable toolbar, an easy method to include a WYSIWYG editor in a web page (replacing textareas), an easy way to save user changes, as well as a number of custom web editing commands of its own.
How htmlArea actually works is it replaces a textarea with an (user definable) toolbar, an iframe that has the "contentEditable" attribute set to true, and a hidden field with the same name as your original textarea that gets updated automatically when you modify content in the editor.
The user can enter or modify text as well as use keyboard shortcuts and toolbar buttons to perform operations on the content. A lot of the editor commands are built into IE and called via the execCommand method, but htmlArea also includes other custom commands and functions written in JavaScript and stored in the editor.js file or the popup windows (in the /popups/ folder).
You Don't Happen to Have One of These for (Netscape, Mozilla, Opera, Mac Ie, etc.) Do You?
No. None of these other browsers (including IE for Mac) support "contentEditable" or a way to make existing content in the page editable. It might be possible to emulate this in JavaScript, but it would be a lot of work. Other problems include displaying or emulating the flashing | bar cursor you see when editing. The cross-platform Mozilla browser has some bug entries related to adding contentEditable functionality, and perhaps in the future, it may be possible to create something for that browser.
Although it's a long shot, you might want to send a friendly letter to Microsoft to encourage them to make the "contentEditable" functionality work on IE for the Macintosh. Once they implement it, we can offer it.
Why Doesn't htmlArea Output XHTML Instead of Regular HTML? Can You Make It Do That?
The HTML output by htmlArea is generated by the built in functionality of Internet Explorer. For that reason, there is no easy way to have it output XHTML. If we were going to do it, the way to do so would be to parse the HTML after it's output by IE and convert it to XHTML. That's something we hope to do at some point.
I'd Like to Be Able to Upload Images From My Hard Drive, Can You Add That Feature?
No. We want htmlArea to be compatible with as many programming languages as possible. Because it's written in client side JavaScript, it should work with any programming language. If we start adding language specific features, htmlArea won't be as useful to as many people. That said, there's a lot of free "file upload" scripts available, and htmlArea does include a function called editor_insertHTML() for inserting text or HTML tags. If you want to write your own program for doing this, it shouldn't be that hard. Alternatively, you might check in the forum to see if someone already has.
I'd Like to <insert idea here>, Can You Add That Feature?
Maybe, maybe not. If it's a good feature and it fits in with the goals of our project we'll likely consider it. The best thing to do is post your suggestions to the forum. At the very least, we'll try to give you some suggestions and point you in the right direction. At best, you might find somebody else has already implemented the feature you were hoping for.
Can I Change the Toolbar/Button Colors?
Yes, just search for "buttonface" and "buttonhighlight" in editor.js and change those to whatever colors you like. If you haven't heard of those colors before, it's because they're special windows colors that match whatever color scheme the user has selected for their desktop. For example, if someone has changed their desktop color scheme to "lilac", the WYSIWYG editor toolbar and buttons will match that theme. Try it, it's really neat.
I Love htmlArea, Is There Anything I Can Do to Help the Project?
The number one thing you can do to help is also the easiest thing to do; give us a link on your website. The more people who can find out about htmlArea the better it will be.
The next best thing you can do is participate in our forum and post a message or two to help other htmlArea users (or learn something new yourself).
Lastly, any code improvements you want to share would certainly be welcome as well.
Why Do the ToolbAr Buttons Take So Long to Load When I Have Multiple htmlArea Editors on the Same Page?
This is a bug/feature of Internet Explorer. htmlArea dynamically updates the content of your page to replace a textarea with the WYSIWYG editor. In Internet Explorer, when you update the content of a page after it has loaded and insert an image it will load the image from the server EVEN if has the image in it's cache. This means if you have 10 htmlareas on the same page the "bold" toolbar button will be loaded 10 times.
One workaround for this is to move all your editor_generate() scripts to the bottom of the page, combine them into one script tag, and remove the "defer" attribute from that script tag. This will cause them all to run just as the page is finishing loading and the cached images WILL be used. Meaning, the browser will only need to load each image once.
Known Bugs and Issues
Undo/Redo Doesn't Work
We update a hidden field every time you make a change in the editor so the hidden field will be submitted when you submit the form. The way undo/redo works in Internet Explorer it seems to reset the undo buffer every time you use JavaScript to set the value of a form element or otherwise make changes to the page. Because of this, the built in undo/redo functionality of the browser doesn't work. We hope to implement our own undo/redo functionality at a future point.
Relative Paths Are Converted to Absolute Paths
Internet Explorer has a tendency to convert relative paths into absolute paths. We've seen some implementations of WYSIWYG editors that maintain relative paths "better" than others but certain operations (such as dragging and dropping, etc.) still convert relative paths to absolute paths. We hope to find a workaround for this in a future version.
HTML Header Info (e.g.: <head>, <body>, etc.) Doesn't Get Preserved
This is due to Internet Explorer and the way the editor works. The editor already has a HTML header of its own so inserting another one confuses the browser and the content gets thrown away. The best solution is to have another plain text textarea field for HTML header information.
Some Tags (e.g.: noframes, noscript, etc.) Doesn't Get Preserved
This is a result of how Internet Explorer works. It seems to discard certain tags that it doesn't need to display. Because htmlArea reads the content back from the browser it cannot preserve content the browser has "thrown away".
htmlArea Doesn't Work With Multiple Textareas That Have the Same Name
If you have two or more textareas with the same name on the same page and you try to convert one or more of them into a WYSIWYG editor htmlArea won't work. This is because htmlArea looks up the textareas by name in the entire page, not just inside a specific form. There's currently no workaround for this. We hope to resolve it in a future release.
Why Do I Get "Non Secure Items" Warnings When Using Htmlarea on a Secure (SSL) Https:// Page?
This is a bug/feature of Internet Explorer. Even if you get unsecure warnings your form contents should still be submitted securely.
htmlArea uses an <iframe> to contain the editor and because the contents of the iframe isn't being loaded off a secure site, Internet Explorer thinks the iframe is unsecure. The problem is, the iframe doesn't load anything off any site, it's blank, it doesn't even have a src attribute. We just create an empty iframe and then use JavaScript to update it. We hope to have this fixed in a future release.
Note: There's a clever workaround for this problem posted in the forum here. The only issue with it is that can cause the back button to not work as intended (it goes back in the iframe first).
Change Log
Version 2.03 (Released: December 17, 2002)
- New license - Switched to "BSD style" software license. The "About this editor" button is no longer required.
- Readme updates - minor updates, spelling, and grammar fixes.
Version 2.02a (Released: December 5, 2002)
- Fixed error in readme.html example code under "How do I add htmlArea to my web page?".
Version 2.02 (Released: December 5, 2002)
Bug Fixes (Thanks to everybody in the forum for contributing and reporting bugs!)
- Fix nested script tag error (thanks to Phil Revill)
New Features
- Added '
replaceNextlines' config option to replace nextlines with spaces on output - Added '
plaintextInput' config option to replace nextlines with <br> tags on input
Version 2.01 (Released: December 3, 2002)
Bug Fixes (Thanks to everybody in the forum for contributing and reporting bugs!)
- Fixed "function not found" error for non IE5.5+ browsers (thanks to slowhand)
- Popup editor - fixed JavaScript error caused during launch of popup (thanks to slowhand and Chlorel)
- Popup editor - fixed toolbar '
linebreak' error (thanks to fbridge9 and RekiM)
Documentation Updates
- Add two new questions to readme.html:
- Why do the toolbar buttons take so long to load when I have multiple htmlArea editors on the same page?
- Why do I get "non secure items" warnings when using htmlarea on a secure (SSL) https:// page?
Version 2.00 (official release) (Released: November 25, 2002)
New JavaScript Functions
editor_getHTML(objname) - return HTML content of editoreditor_setHTML(objname) - set HTML content of editoreditor_appendHTML(objname) - add HTML content to editor
New Features
- Popup "fullscreen" editor now has minimize and maximize buttons (switched from
ModalDialog to popup window)
Bug Fixes (Thanks to everybody in the forum for contributing and reporting bugs!)
- "Create Table" popup now creates tables with the correct number of cols and rows (thanks to Corey)
- Clicking on images no longer causes error when you have "CSS style pulldown" enabled (thanks to Virrdo)
- Fixed bug that prevented external stylesheets from working properly (thanks to slowhand)
- Fixed JavaScript errors in Mozilla 1.0 (thanks to slowhand)
- Moved browser detection code to editor page to prevent JavaScript errors from older browsers and prevent the editor from being loaded unless it's needed.
- Submitting empty htmlarea now submits nothing "" instead of "
<p> </p>" - Popup "fullscreen" editor no longer generates error on "
<>" html mode change
Version 2.00 (beta2) (Released: October 16, 2002)
New Docs
- Created new readme.html with install instructions, FAQ, and lots of information
New Features
- Added support for stylesheets
- Get enlarge/shrink window working
- Get context menu working (still disabled by default, needs more code for functionality)
- Allow user to change ANY option in internal config from calling page
- Added
_editor_filterOutput function that's called on form submit - Added insert table button
Bug Fixes / Optimizations
- Organized associated files into directories
- Fixed bug that caused htmlarea to sometimes not display last entered content when user pressed back in their browser.
- Moved about window into a separate file to reduce size of editor
Version 2.00 (beta1) (Released: August 19, 2002)
Visual changes
- Added mouseover/mouseoff events and style for toolbar UI buttons
- Update toolbar to take up less space and be smaller
- Display point sizes beside HTML font sizes (eg: 7 (36px)
- Change "about this editor" icon to an "i"
- Created a help popup (content still needs to be written).
- Cdded version number to about page.
Code Changes
- Added "
defer" to script tag to prevent editor from being created until page loads - Simplified header that needs to be added to pages that contain editor
- Generated script include tag using
_editor_url so users don't have to enter URL twice - Moved CSS for editor toolbar buttons into editor.js
- Switched to using object to pass configuration arguments to editor_generate
- General code improvements, optimizations and re-organization
- Added hooks for keypress events for future use
New Features
- Added pulldown for CSS style classnames
- Added many many more config options including:
- Ability to select which toolbar elements you want displayed
- Ability to specify the order of toolbar elements
- Ability to specify fonts, sizes, and CSS styles for pulldowns
- Ability to set default font and style used in editor window
- Debug flag that lets you see the source of the WYSIWYG field at all times
- Add more sample code and comments showing how to add custom buttons
Bug Fixes
- Fixed error caused when height/width were manually specified (reported by jpeto, thanks!)
- "About this editor" window now works when in textedit mode
Version 1.05 (Released: August 28, 2002)
- Added support for textareas with underscores ("
_") in their names.
Version 1.04 (Released: August 27, 2002)
- Even more speed improvements (WYSIWYG editor is now much faster on older computers).
- General code improvements and optimizations.
Version 1.03 (Released: August 26, 2002)
Version 1.02 (Released: August 21, 2002)
- Added
editor_insertHTML() function. Developers can now easily add buttons that insert HTML or surround selected text with HTML - Removed unneeded debug code and comments to reduce editor.js file size (and load time)
Version 1.01 (Released: August 20, 2002)
- Optimized code to improve speed (WYSIWYG editor is now much faster)
- Added addition event handlers to update UI on mouse events
Version 1.00 (Released: August 19, 2002)
License
This article has no explicit license attached to it, but may contain usage terms in the article text or the download files themselves. If in doubt, please contact the author via the discussion board below.
A list of licenses authors might use can be found here.
