| 1 | === WPide === |
|---|
| 2 | Contributors: WPsites, Thomas Wieczorek |
|---|
| 3 | Tags: code, theme editor, plugin editor, code editor |
|---|
| 4 | Requires at least: 3.0 |
|---|
| 5 | Tested up to: 3.3.2 |
|---|
| 6 | Stable tag: 2.0.10 |
|---|
| 7 | |
|---|
| 8 | WordPress code editor with auto completion of both WordPress and PHP functions with reference, syntax highlighting, line numbers, tabbed editing, automatic backup. |
|---|
| 9 | |
|---|
| 10 | == Description == |
|---|
| 11 | |
|---|
| 12 | WPide is a WordPress code editor with the long term goal of becoming the ultimate environment to code/develop WordPress themes and plugins. You can edit any files in your wp-content, not just plugins and themes. Code completion will help you remember your WordPress/PHP commands providing function reference along the way. Edit multiple concurrent files with the tabbed editor. |
|---|
| 13 | |
|---|
| 14 | Please come forward (either on or the WordPress support forum) with any bugs, annoyances or any improvements you can suggest. I'd like this plugin to be the best it can be and that's only going to happen if users chip in with their feedback. Code contributions welcome, over on . |
|---|
| 15 | |
|---|
| 16 | This plugin would not be possible without the Ajax.org Cloud9 Editor (http://ace.ajax.org/) which is the embedded code editor that powers much of the functionality. |
|---|
| 17 | |
|---|
| 18 | This plugin performs best in the Chrome web browser. |
|---|
| 19 | |
|---|
| 20 | = Current Features: = |
|---|
| 21 | |
|---|
| 22 | * Syntax highlighting |
|---|
| 23 | * Line numbers |
|---|
| 24 | * Code autocomplete for WordPress and PHP functions along with function description, arguments and return value where applicable |
|---|
| 25 | * Automatic backup of every file you edit. (one daily backup and one hourly backup of each file stored in plugins/WPide/backups/filepath) |
|---|
| 26 | * File tree allowing you to access and edit any file in your wp-content folder (plugins, themes, uploads etc) |
|---|
| 27 | * Create new files and directories |
|---|
| 28 | * Highlight matching parentheses |
|---|
| 29 | * Code folding |
|---|
| 30 | * Auto indentation |
|---|
| 31 | * Tabbed interface for editing multiple files (editing both plugin and theme files at the same time) |
|---|
| 32 | * Using the WordPress filesystem API, although currently direct access is forced (edit WPide.php in the constructor to change this behaviour) ftp/ssh connections aren't setup yet, since WP will not remember a password need to work out how that will work. Maybe use modal to request password when you save but be able to click save all and save a batch with that password. Passwords defined in wp-config.php are persistent and would fix this problem but people don't generally add those details. Open to ideas here. |
|---|
| 33 | * Image editing/drawing (requires Flash - will move over to HTML5 when there is a decent alternative) |
|---|
| 34 | |
|---|
| 35 | = Feature ideas and improvements: = |
|---|
| 36 | |
|---|
| 37 | * Improve the code autocomplete command information, providing more information on the commands, adding links through to the WordPress codex and PHP.net website for further info. |
|---|
| 38 | * Add find and replace functionality |
|---|
| 39 | * Create an admin panel to choose between syntax highlighting themes and turn on/off other Ajax.org Cloud9 functionality |
|---|
| 40 | * Better automated file backup process |
|---|
| 41 | * Templates/shortcuts for frequently used code snippets, maybe even with an interface to accept variables that could be injected into code snippet templates. |
|---|
| 42 | * Integration with version control systems such as Git |
|---|
| 43 | |
|---|
| 44 | |
|---|
| 45 | As with most plugins this one is open source. For issue tracking, further information and anyone wishing to get involved and help contribute to this project can do so over on https://.com/WPsites/WPide |
|---|
| 46 | |
|---|
| 47 | == Contributors == |
|---|
| 48 | |
|---|
| 49 | Simon Dunton - http://www.wpsites.co.uk |
|---|
| 50 | Thomas Wieczorek - http://www.wieczo.net |
|---|
| 51 | |
|---|
| 52 | |
|---|
| 53 | == Installation == |
|---|
| 54 | |
|---|
| 55 | 1. Upload the WPide folder to the `/wp-content/plugins/` directory |
|---|
| 56 | 1. Activate the plugin through the 'Plugins' menu in WordPress |
|---|
| 57 | 1. Access WPide by clicking the WPide menu item in your main administration menu |
|---|
| 58 | |
|---|
| 59 | == Frequently Asked Questions == |
|---|
| 60 | |
|---|
| 61 | = Can I override the default file permissions when creating files/directories on the local filesystem = |
|---|
| 62 | |
|---|
| 63 | Yes you can using the below WordPress settings in wp-config.php which will effect files created with WPide and files added during the WordPress upgrade process. |
|---|
| 64 | |
|---|
| 65 | define('FS_CHMOD_DIR', (0755 & ~ umask())); |
|---|
| 66 | define('FS_CHMOD_FILE', (0644 & ~ umask())); |
|---|
| 67 | |
|---|
| 68 | = Whenever I try to edit an image the application says that it could not load the image = |
|---|
| 69 | Either the image contains no image data (its a new empty file) or the image is not accessible to the image editor. Your images need to be accessible to the web. i.e. if you're developing a site on your local machine behind a router/firewall your local web server could not be accessible to the web. |
|---|
| 70 | |
|---|
| 71 | == Screenshots == |
|---|
| 72 | |
|---|
| 73 | 1. Editor view, showing line numbers and syntax highlighting. |
|---|
| 74 | 2. Image editor in action |
|---|
| 75 | 3. Showing auto complete, function reference and file tree. |
|---|
| 76 | |
|---|
| 77 | == Changelog == |
|---|
| 78 | |
|---|
| 79 | = 2.0.10 = |
|---|
| 80 | * Fixed a problem with file loading (ajax) indicator not showing. |
|---|
| 81 | |
|---|
| 82 | = 2.0.9 = |
|---|
| 83 | * Upload snapshot of current ajaxorg editor (master/build/src) at 00:30 on the 22 May 2012. Which fixes some issues with selecting big blocks of text, code folding seems better with gutter interface hidden when not in use |
|---|
| 84 | |
|---|
| 85 | = 2.0.8 = |
|---|
| 86 | * Fix browser compatibility issues |
|---|
| 87 | |
|---|
| 88 | = 2.0.7 = |
|---|
| 89 | * Fixing issue with closing tabs not focusing onto next tab once closed. |
|---|
| 90 | * Fixed issue with detecting ajax url correctly which was causing all WPide ajax requests to fail if WordPress was installed in a subdirectory. |
|---|
| 91 | * Stopped autocomplete from trying to work when a js/css file is being edited. |
|---|
| 92 | |
|---|
| 93 | = 2.0.6 = |
|---|
| 94 | * Cleaned up the WPide class and modified the way the class is passed to WordPress actions/filters. |
|---|
| 95 | |
|---|
| 96 | = 2.0.5 = |
|---|
| 97 | * On startup the editor page now shows extra debuggin information for the filesystem API initialisation. |
|---|
| 98 | |
|---|
| 99 | = 2.0.4 = |
|---|
| 100 | * On startup the initial editor page now shows some startup info regarding file permissions to help with debugging. |
|---|
| 101 | |
|---|
| 102 | = 2.0.3 = |
|---|
| 103 | * If WPide cannot access your files due to permissions then when it starts up it will give you an alert to say this. |
|---|
| 104 | |
|---|
| 105 | = 2.0.2 = |
|---|
| 106 | * Image editing is now available using the SumoPaint image editor and drawing application http://www.sumopaint.com/ |
|---|
| 107 | |
|---|
| 108 | = 2.0.1 = |
|---|
| 109 | * You can now create new files/folders |
|---|
| 110 | |
|---|
| 111 | = 2.0 = |
|---|
| 112 | * Recreated this plugin as a dedicated WPide section/app rather than extending the built in plugin/theme editor (just incase WP remove it) |
|---|
| 113 | * Now using the WP filesystem API (although currently restricted to local access) |
|---|
| 114 | * More security checks on file opening and editing |
|---|
| 115 | * Added new file tree for exploring the file system and opening files (any file in wp-content) |
|---|
| 116 | * Massive overhaul to code autocomplete functionality with the addition of function information right in the app |
|---|
| 117 | * Update the ajaxorg Ace Editor to the current branch |
|---|
| 118 | * Tabbed editing |
|---|
| 119 | |
|---|
| 120 | = 1.0.6 = |
|---|
| 121 | * Added link to meta section of plugin list for easy install of V2 Dev version if you have dismissed the alert. |
|---|
| 122 | |
|---|
| 123 | = 1.0.5 = |
|---|
| 124 | * Added the facility to download and run the cutting edge development version of WPide from the repository |
|---|
| 125 | |
|---|
| 126 | = 1.0.4 = |
|---|
| 127 | * Implemented JavaScript and CSS mode for better syntax highlighing and checking (Thanks to Thomas Wieczorek) |
|---|
| 128 | * Organise and format source code |
|---|
| 129 | |
|---|
| 130 | = 1.0.2 = |
|---|
| 131 | * Tidy and comment code |
|---|
| 132 | * Added message when backup file is generated |
|---|
| 133 | * Adjust code complete dropdown position |
|---|
| 134 | * Improved editor responsiveness when using delete or enter keys |
|---|
| 135 | |
|---|
| 136 | = 1.0.1 = |
|---|
| 137 | * Fixed "Folder name case" issue. |
|---|
| 138 | |
|---|
| 139 | = 1.0 = |
|---|
| 140 | * Initial release. |
|---|
| 141 | |
|---|
| 142 | == DEV NOTES == |
|---|
| 143 | |
|---|
| 144 | Maybe some interesting things here we could implement to help with following the WordPress standard and more advanced code syntax checking |
|---|
| 145 | |
|---|
| 146 | http://magp.ie/2011/01/10/tidy-and-format-your-php-and-meet-wordpress-standards-on-coda-and-textwrangler/ |
|---|
| 147 | |
|---|
| 148 | Checkout the following WordPress plugin "WP Live CSS Editor" to work out how to do LIVE css editing. Combining a LESS compiler with live CSS editing/compile would be a dream. |
|---|
| 149 | |
|---|