Documentation

 

Serious Disclaimer

IMPORTANT: The disclaimer is at the beginning of this documentation for a very important reason. The Theme Editor gives you and your authorized users the ability to edit any of the files in your theme directory, thus potentially damaging your site layout and possibly rendering it inaccessible. ALWAYS BACKUP your site's files and database before doing any editing. I will not and cannot be held responsible for anything that happens to your site by using the Theme Editor. I will not entertain support requests of that nature. What you do with the Theme Editor is your responsibility. If you cannot handle that responsibility, please refrain from using this addon.



About Permissions

strongly suggest that you remove permissions for the Theme Editor page to anyone but the Super Administrator. You can set these permissions via your Sitemap by checking the box for "Show System Pages", clicking on the Theme Editor page and selecting Permissions.



On Preparing Themes

Themes must be "prepared" before editing to ensure that original author updates do not overwrite your edits and that you will always be able to restore the original theme files.

The Process:

  1. During install of the Theme Editor package, a database table is added that copies the PageThemes table and allows the addon to flag if the theme is ready to edit.
  2. The theme's folder and all of it's files are copied into the /themes folder of your site's root directory. This overwrites original author theme files but does not change them, allowing you to restore to the original easily in the case that something goes wrong.
  3. The theme is flagged in the database as prepared. You're now able to edit the theme files.



Editing Themes

When you begin editing a theme, you'll see a screen with the editor and a list of theme files on the left.

Click on a filename on the left to begin editing that file. The file will load into the editor.

The current line and character number are displayed in the top right.

NOTE: Standard text editor keyboard commands will work.

The toolbar above the editor is displayed as follows:



  1. Save: This will save the current file being edited.

  2. Syntax Highlighting: Toggles syntax highlighting. The type of file is automatically detected and syntax is highlighted by default.

  3. Word Wrap: Toggles line wrapping within the editor.

  4. Undo: Will undo recent changes within the editor.

  5. Redo: Will redo recent changes within the editor.

 



Restoring Themes

This feature is used to restore a theme to it's original state.

The Process:

  1. The theme's folder in the /themes folder of your site's root directory is deleted. This removes your modified theme files and restores the theme to the original author's version.
  2. The theme is flagged in the database as ready to prepare.
  3. Note: This is an irreversible process. Once done, you can prepare the theme again and make new updates, but any updates you made to the theme before restoring will be gone.



Uninstalling

When you uninstall the Theme Editor, the changes you made to themes are not removed. To remove changes, you need to "Restore" the original them from the Theme Editor main page. Ultimately, you can also delete the them folder from /themes.



Troubleshooting

None of my theme changes are taking effect?

  1. Make sure that theme is active for your site.
  2. Clear your browser cache.
  3. Clear your site cache.



Support

Support for this addon can be found on concrete5.org or by emailing lucas@lucasanderson.comdirectly. As always, I try to respond to support requests within 2 business days. Support is offered to the original addon purchaser only. As mentioned in the disclaimer above, I do not entertain support for any theme problems on your site that happen due to using the Theme Editor. I will, however, make sure the Theme Editor works as advertised.



License

This software is licensed under the terms described in the concrete5.org marketplace. Please find the add-on there for the latest license copy. In English, it reads: You own your copy for use on one (1) site and the development environment for it. Use it on another site, you should buy it again. Don't sue us. 

License infringement is a serious issue for myself and many developers in the community. I enact strict monitoring of the use of my add-ons to make sure only legal copies are being used.



Credits

Lucas Anderson is the author of the Theme Editor.