This document aims to get you started with common issues / questions with MODX Revolution by either answering it, or pointing you to the right resources. It is by no means exclusive, and a good search on the forums and this documentation may find more resources for what you're looking for. In all cases - if you can't find what you need, do ask in the forums or on IRC: irc.freenode.org channel: #MODX.
The questions numbering represents nothing but that - a number to indicate what question you're looking at to help scanning through.
If you do not have access to editing this document, please post anything you would want to see added or updated in this topic on the forums.
- Please use the right headings (heading 2 for categories, heading 3 for questions) to make sure the table of contents et al are properly generated and make sense.
- Big subjects can be created as a subpage to this page, and if other pages already exist on these docs please link to it in the first section.
- Please make sure the numbering is correct when you add a question to allow easier scanning of the page.
- Make sure you link generously to further reading on the subject.
Table of Contents
FAQs and/or Troubleshooting on specific subjects elsewhere:
- Troubleshooting Installation
- Troubleshooting Upgrades
- Troubleshooting Package Management
- Troubleshooting Security
Subpages dealing with specific subjects:
On this page, you will find the following categories and questions:
- Table of Contents
- 1. MODX 101
- 2. The Manager
- 2.1. Help! Where did the sidebar go?
- 2.2 How can I modify what resource fields are visible when creating or editing a Resource? Is there something like ManagerManager for Revolution?
- 2.3 What does modDocument/ modWeblink/ modSymLink/ modStaticResource mean?
- 2.4 What is the difference between a Resource and a Document?
- 2.5 I'm locked out! I can't access the manager! Forgot my password and recovery doesn't work!
- 3. Frontend Display Issues
1. MODX 101
1.1. What is MODX Evolution, and what is MODX Revolution? What's the difference?
MODX Evolution is the legacy code and are the 1.x versions. It has powered hundreds of thousands of websites in the past five years and is what has shaped MODX.
MODX Revolution is a complete rewrite of MODX Evolution which shares the same ideas but is based on xPDO, a database abstraction layer, and finally saw daylight in 2010.
There are three kinds of MODX products at this point:
- 0.9.6.x – the original code base that started with it's first production/stable release as version 0.9.0 at the end of October 2005. No longer supported, and you REALLY should update to the latest Evolution version. Exploits founds in 0.9.6.x have long been fixed!
- Evolution 1.x – a cleaned up and refined distribution of 0.9.6.x with conventions and terminology more in line with our totally rewritten Revolution release.
- Revolution 2.x – a fully object oriented and completely new branch that's been in development for more than 3 years that addresses limitations found in the original code base such as having a truly recursive parser and eliminating the 5,000 document ceiling.
- "The Evolution of a Revolution" http://modx.com/about/blog/the-evolution-of-a-revolution/
- "What are the basic differences between Evolution and Revolution?" http://modx.com/revolution/product/faq/#q1
- There's a number of big topics on the forums as well discussing evo and revo which may be interesting if you're looking for more in-depth discussing of the differences. As Revolution has been over three years in development, do check out the date something was posted to be sure they are still relevant.
1.2. What different tags can I use? What is [[*pagetitle]], [[Wayfinder]] etc?
2. The Manager
2.1. Help! Where did the sidebar go?
You probably hid it at some point. There's a subtle arrow on the left side of the screen (see this image) that you can click to bring it back. In some cases you will need to refresh the page for the contents of the sidebar to load properly.
2.2 How can I modify what resource fields are visible when creating or editing a Resource? Is there something like ManagerManager for Revolution?
You can use Form Customization (found under the Security menu) to change the fields. It doesn't offer all of the (Evolution) ManagerManager plugin but comes pretty far.
2.3 What does modDocument/ modWeblink/ modSymLink/ modStaticResource mean?
They are the class names of Documents, Weblinks, Symlinks and Static Resources. They are "subtypes" of Resources (class name modResource) and each have their own specific goal. They all show up in the Resource Tree and can appear anywhere in the hierarchy.
- Documents (commonly refered to as Resources, see 2.4 below) are regular pages and have content.
- A Weblink redirect a user to a different Resource or an external URL.
- A Symlink acts as a copy of a Document
- Static Resources act like Documents, however their content comes from a file on the filesystem.
2.4 What is the difference between a Resource and a Document?
Technically, a Resource (modResource) is an abstract object of which a Document (modDocument) is an implementation.
Practically both terms are used to indicate the same thing: a Document which holds certain content. Coming from the technical implementation, a Weblink, Symlink or Static Resource are also be included when referring to "Resources" as they are also implementations of the modResource class.
2.5 I'm locked out! I can't access the manager! Forgot my password and recovery doesn't work!
3. Frontend Display Issues
3.1 Blank frontend pages resolved by Clearing Cache
In Revolution 2.2.5 the way xPDO/MODX write cache files has been re-factored. If you are having issues with blank frontend pages that are resolved after clearing the site cache, you could try setting use_flock. This should help with RackSpace Cloud hosting, GoDaddy hosting, and some other providers.
In your MODX config file add the setting use_flock in your $config_options array, and set it to false.
3.2 General Snippet Problems
If you find a snippet and/or plugin isn't working properly despite the correct code, double check that it has been installed.
Suggest an edit to this page on GitHub (Requires GitHub account. Opens a new window/tab).