ICEcoder v 5.7 Manualintroduction
demo, features, download & more
adding extra languages
introductionICEcoder is a browser based code editor which provides a modern approach to building websites by allowing you to code directly within the web browser. This, in turn, means you only need one program (your browser), plus can test on actual web servers and after development, maintain the website easily, all of which make for speedy and smart development. Because it is web based you also can do this from any internet enabled computer with a modern browser and because it's built with common web languages, customise it to your liking.
features, download & moreCan be found along with the latest news at icecoder.net
requirementsYou will need:
- Apache or similar (eg Nginx) web server environment
- PHP 5 minimum, PHP 5.3+ recommended
It can either run on web server or on a local machine. Windows and Mac users can use programs such as WAMP, MAMP or XAMPP or a Apache & PHP installation to provide the environment they need. It should run just fine in Chrome, Firefox (latest versions) and Internet Explorer (v9+), locally or on a live server.
- Download via the icecoder.net website
- Unzip the contents into a new directory on your server environment
- Set write permissions (757 or 775 depending on your system) on the 'backups', 'lib', 'plugins', 'test' and 'tmp' folders
- View your ICEcoder direcory in a web browser, it will prompt you to set a password
- Begin coding!
usageICEcoder has a huge amount to it, even tho it seems simple on the surface. The best thing to do is experiment to get to grips with advanced features.
New users can take note of these things to get started:
- Click files in the file manager to select
- Double-click files to open
- Right click on them to show a context menu
- CTRL + clicking will select multiple
- CTRL/Cmd + S to save
- Go to Help > Shortcuts for more usage info
pluginsThere are lots of useful plugins, accessed by moving your mouse to the left edge of the file manager, or by clicking the plugins icon in the file manager. Installing plugins does require unzipping the file, so zipArchive must be enabled on your server.
There may also be times when you'd like to create your own custom plugin. Thankfully, you already know how to write plugins as they're written with web languages! Follow the handy guide below to write your first plugin in around 5 mins.
- Create a new 'myplug' dir in ICEcoder's /plugins dir
- In that dir, create an icon image of around 28px square, called 'icon.png'
- Also in that dir, add a new text file, called 'myplug.html'
- Open myplug.html and add:
- Open your settings file in /lib/config-* (eg config-localhost.php or config-mydomain.php)
- Add a new array item in the "plugins" array:
- array("My Plug - Hello World!","plugins/myplug/icon.png","","plugins/myplug/myplug.html","fileControl:Going to line 20","");
- Click the update button and your plugin should now show in the plugins panel
- Click your plugin to go to line 20 of the current document!
The parameters for the plugin are:
name, icon path, style extras, URL, target, set interval (in mins)
Target can of course be any suitable target such as _blank, _new etc or fileControl which is ICEcoders hidden iFrame, suitable for running tasks without opening a new window.
If you add a value for set interval, eg "5", it will trigger your URL every 5 minutes as well as when you click it.
ICEcoder has a rich API which allows you to interact with it in many ways so you can create useful plugins. See further down the manual at api.
adding extra languagesICEcoder supports a lot of common languages but you may find you want it to support something extra.
Adding languages is relatively simple and will take about 15 mins if you follow these steps:
- Open ICEcoder's editor.php file and near the top you will see 3 commented lines indicating all the files that need to be included. Select all of these on CodeMirrors compression helper page plus the extra language(s) you want to include and press the button to create a new compressed file. Replace the lib/codemirror-compressed.js file in the CodeMirror dir with this new file.
- Open images/file-folder-icons.png, make the file 16px wider, leaving your 16px square gap to the right and add your 16x16pixel icon there.
- Add a new line in lib/file-type-icons.css for your new language and include the new pixel position for it (16px on from the last one).
- Search processes/on-editor-load.php for the word 'coffee' and and add your new language in a similar way (file extensions and word to use, plus considering the comment type).
ICEcoder should now support the extra language(s)!
troubleshootingWhile ICEcoder works fine on almost all PHP environments (v5.0 and up), I've found about 1% of the time people run into issues, particularly regarding initial setup, opening or saving files. This usually turns out to be some server oddity that's stopping it working as expected, so here's what to look for.
Internal Server Error
On some servers you can put ICEcoder in place, set permissions, open in a browser and it shows an internal server error. This seems to be more down to your host permissions you've just set, not allowing anything to run. If you've tried 775, 757 and even 777 and still get problems, set back to 755 and it'll maybe work. If you still have issues, looking at your servers error logs may provide the answer.
My password won't work/I can't get in?
The first thing is to ensure you're using the right password. Sounds obvious, but maybe you set something different on setup. Also note that the password is case sensitive. Assuming you are using the right password, it may be something to do with lib/headers.php, lib/settings.php or your servers use of $_SESSION. Again, looking into your error logs or the web tools console may provide clues.
I can't open a file/just shows loading spinner?