Documentation Suggestions &amp; Corrections - MODX Community Forums <![CDATA[Suggested changes to "Moving sites to new servers"]]>

In step one:

Don’t forget to rename the .htaccess file in the /manager folder to turn off the RewriteEngine for that folder.

Rename the ht.access file in the /manager folder to .htaccess. This will turn off the RewriteEngine for that folder.

In step 6:

Dump the local DB contents (use the Backup Manger, or any MySQL client such as phpMyAdmin) and then execute the SQL dump in the target DB on the remote LAMP server (most hosting environments use phpmyadmin for this).

Dump (export) the local DB contents (use the Backup Manager, or any MySQL client such as phpMyAdmin). In phpMyAdmin, select SQL for the file type. Save to a file on your local machine and note the location. Then go to the remote LAMP server and import the SQL dump you saved into the modx DB (most hosting environments use phpmyadmin for this -- select the database and "import" the SQL file).

In step seven:

Access the remote manager’s . . .

Point your browser at After logging in, go to . . .

Suggested new step between 7 and 8:If you can’t access the manager, you may have the wrong database settings in manager/includes/ Try correcting them on the local machine and uploading the file again. If you still can’t access the manager, try going to and doing a "custom install." There you can try different database settings and test them until you get a connection. As long as you haven’t hacked any of the MODx code on the local machine, you can finish the install. Alternately, you can put the correct settings (now that you know them) in manager/includes/ and upload it.


]]> Tue, 28 Aug 2012 06:05:02 +0000
<![CDATA[Revo-Doc: Resource Fields & Output Parameters]]>
in the resource fields documentation it is stated that

Resource fields can be accessed from anywhere by using the Template Variable syntax, ie:

whereas in the output filters documentation the examples use a + :

which according to the tag documentation is to be used for placeholders, not template variables.

Are all these * and + interchangeable?

(my context: [[*editedon:date=`%A, %e %B %Y`]], which btw didn’t seem to work except with the fuzzydate-filter, but [[*editedon:strtotime:date=`%A, %e %B %Y`]] does work.)]]> Tue, 07 Jun 2011 11:28:10 +0000
<![CDATA[Documentation (desperately?) needing improvement, examples etc.]]>
Hopefully, there are people (including myself) that can make time to increase the quality of the documentation when we know what to change, as the people who know what to do, rarely look into certain documentation...

Please post back when certain documentation mentioned here has been improved.

- eForm @ : quite detailed regarding validation, but there is no guidance on what to do with the codes on there (-> put in a chunk named this or that)

Random links / notes from my docAdditions.txt on my desktop:

Beginner docs
- Building a dynamic menu
- Using a different (background) image per page
- User registration and login
- Step-to-step setting up a dynamic website from a static site.
- Making a real basic contact form

- List of as much add-ons as possible with their general purpose, revolution/evolution, on the addon space.

Demo packages
- Static site turned dynamic
-- Including Wayfinder menu, getResources document listing, (Quip commenting)

Tips & Tricks:
- Save with ctrl+alt+s,51160.0.html,58001.msg339666.html#msg339666
- Faster ExtJS loading in manager (for in CMPs):,59793.msg340121.html#msg340121]]> Mon, 06 Jun 2011 10:14:33 +0000
<![CDATA[modx 1.0.5 Reflect dataSource not accepting Template variable date]]>
by the way only "createdon" working as default date but not "pub_date" or "editedon". but i want to set as as a template variable "optDate"
here is my Reflect snippet

 [!Reflect? &getDocuments=`1`  &filter=`hidemenu,0` config=`wordpress` &targetID=`67` &dittoSnippetParameters=`parents:6`&id=`wp` &dateSource=`optDate` &dateFormat=`%e %B` &monthSortDir=`DESC`!]

If any one could give some idea would be great. Thanks in advanced. smiley


Prabir]]> Tue, 24 May 2011 07:18:27 +0000
<![CDATA[Revolution Security Use Cases]]>
If you all could reply to this thread with examples of Use Cases (iow, a problem you want to solve with Security in MODX), and we’ll try and get them documented. Think of this as a wishlist for more tutorials on this page:


Currently in existence:

  • Creating a Second Super Admin User
  • Giving a User Manager Access
  • Making Member-Only Pages
]]> Thu, 19 May 2011 10:36:12 +0000
<![CDATA[Security / ACL's - A better understanding]]>
I am attempting to understand MODx ACLs from the ground up. I have started this thread to try and create a map for users (such as myself) to get things up and running and attempt to possibly point out some inconsistencies in documentation. I would like to point out again this is not meant as any offence at all to any person, and/or documentation, official or otherwise - I love all you guys smiley

This is post one, point one...

I like many others have been reading through bobsguide to permissions, link in Referenced URLs.

Access Control Lists
Note: Before messing with Permissions, check the setting of the allow_root System Setting in System | System Settings. It determines whether users can create Documents in the site root and it overrides any other security settings. You can spend a lot of time trying to figure out why your users can’t create documents if allow_root is set to "No."


Does not exist...


Seems to have taken its place, however... according to the documentation (link in Ref’d URLs) it has been deprecated and now is covered by

I shall edit this post when I have uncovered what exactly "new_document_in_root" is, how to access it etc (via, Administrator Policy)...
Security->Access Controls->AdministratorTemplate

I’m doing this in baby steps, please bear with me. wink

Reference URLs;,64266.0.html]]> Mon, 09 May 2011 08:15:30 +0000
<![CDATA[Do we really need another space on the RTFM for 2.1?]]>
Wouldn’t it be better for a release like this to just go through the Revolution docs and highlight things depreciated in Revolution 2.1 and keeping that one space updated to the latest specs until the basics drastically change?

I’ve never been a fan of the way Confluence is set up, but it’s manageable until you start creating spaces for everything in there.. Ideally (well, imo anyway) there should be one for Evo (096 should just be depreciated imo), one for MODX Revolution and one for Evolution addons and one for Revolution addons.

Imo xPDO (although developed by the core team/Jason) should have its own wiki on the website, and the MODX Revolution space should have a section dedicated to the basic xPDO methods that can be used with a link to the xPDO docs where it is out of scope to discuss.

- the DEV space has only a few pages and one of them still speaks about SVN which could do with an update. Or rather just delete that space, and add those to Revolution or Evolution depending on the page.
- The examples space is for MODX Revolution examples... so add it to the MODX Revolution space to keep it all in one place. I wouldn’t know how to find it unless I’d know it was there.
- The extension space only has a doc about Template Package which has been depreciated in favour of PackMan which is documented on the Addons space.. any reason to distinguish between extensions and addons? They both extend the core in one way or another. I’d vote to remove the extension space.

The Old Revo docs space gives a 302 response to which then seems to want to redirect somewhere. The old Revo docs still frequently show up on Google cause it’s not simply sending out a 301 to revolution20. If it was my call I’d put a .htaccess in place to simply redirect everything targeted at /display/revolution/* to the newer docs and delete the entire space.

That’d bring down the number of spaces to only a few and make it much more manageable and easy to use..]]> Fri, 01 Apr 2011 11:30:42 +0000
<![CDATA[Can't Log In to Documentation for Revolution]]>
Thanks much.]]> Wed, 26 Jan 2011 06:31:52 +0000
<![CDATA[Wiki spam]]> old wiki is becoming quite a problem. Does anyone have the power to remove all of these spam pages and accounts and instate a better CAPTCHA?]]> Mon, 17 Jan 2011 01:49:41 +0000 <![CDATA[Published Pages]]>
Thanks in advance, Bronson]]> Thu, 18 Nov 2010 06:24:03 +0000
<![CDATA[doc suggestion]]>
:)]]> Wed, 03 Nov 2010 10:49:32 +0000
<![CDATA[List of default (or system0 TVś]]>
Just started with Revolution (previously learned about Evolution) and are looking for a list of all default available TV´s like "pagetitle" "site_url" etc. etc.

Possibly such a list (including meaningful short description) can be added to the documentation?

Just now the documentation describes the purpose of TV’s, how to create them etc. etc. but I miss an obvious subject: which ones do you have already available as soon as you start?

Kind regards,

Hans Troost]]> Tue, 02 Nov 2010 06:15:09 +0000
<![CDATA[Error in Loading Pages in the Front-End via AJAX and jQuery Tabs Revolution Doc]]>
the code for the myRowTpl template is :

<li id="[[+id]"><a href="[[~[[+id]]]]" title="[[+longtitle]]">[[+pagetitle]]</a></li>

and should be corrected to :

<li id="[[+id]]"><a href="[[~[[+id]]]]" title="[[+longtitle]]">[[+pagetitle]]</a></li>

I hope this will help.

Philippe]]> Tue, 02 Nov 2010 06:10:56 +0000
<![CDATA[Developpers guidelines]]>
Some usefull

  • $modx->makeUrl(’id’) to generate the url of a document.
  • $modx->regClientStartupScript to avoid multiple load of same script
  • [(base_url)] in front of path to have correct path
  • modx->config[’rb_base_dir’] for local assets path.
  • Develop with respect of standards xhtml, css, ... (so hard with full compatibility sad) but closing all tags is easy!
  • ...
]]> Thu, 16 Sep 2010 08:34:14 +0000
<![CDATA[Images not displaying in]]>

Document Groups

Next, consider how the documents in your site will be grouped.

Corporate - pages referring to the company in general, such as the About Us pages and the Home page.
Product - pages dealing with individual products.
Support - pages that contain FAQ lists or company contact information.
Unable to render embedded object: File (access2.jpg) not found.

User Groups

Then you begin to organize the User groups your content editor users will belong to.

Marketing - will handle Corporate pages; anything that will effect the public's perception of the company and its products.
Products - will work with the pages relevant to the company's products.
Support - will take care of the support pages.
Proofreaders - will have access to all documents (but is limited in what he can do with them by the permissions granted by his Role).
Unable to render embedded object: File (access1.jpg) not found.

Here is how the user groups and documents groups will interact.

Unable to render embedded object: File (usermap.png) not found.

Tried in Safari and Firefox. Doesn’t apply to all images - but many...

On this page, for example
I have two broken image links at the top and the rest I can see.

Any suggestions?
]]> Tue, 31 Aug 2010 09:29:35 +0000
<![CDATA[Unable to render embedded object]]>
"Unable to render embedded object: File (filebinding.png) not found"]]> Thu, 26 Aug 2010 08:52:18 +0000
<![CDATA[Error(?) in Documentation: Upgrading MODx Revolution]]>
in the Chapter upgrading (Revolution-Doc) there is written:
For traditional distribution users, simply upload the files over the existing ones, and then run setup. For the advanced distribution, do the same, but you’ll only need to do so for the core/ and setup/ directories.

Make sure that you don’t overwrite core/config/, and that it’s writable.

I upgraded from rc2 to 2.0.0-pl and got a problem with the full installer, not the advanced one (thread: blank page in frontend after upgrading). As i experienced the problem is this: When you have installed extras (like Wayfinder or Breadcrumbs) and you replace the folder "core", the contents of core/packages are overwritten and even cannot be uninstalled from the manager. The fix: You have to copy the contents of your "old" (backupped smiley ) package-folder into the core/packages-folder, than uninstall the extras with the manager -> package management and install them new.

Perhaps I did not understand the term "simply upload the files over the existing ones" correctly. For me this means "replace the folders"; perhaps it actually means "merge folders"? If this is the case, one should mention it explicitely in the documentation. Perhaps it would make sense to mention all the folders which could contain stuff that should not be overwritten.]]> Wed, 04 Aug 2010 04:38:08 +0000
<![CDATA[Quip Validation Fix]]>

The issue is with the labels not lining up. The corrected code is as follows:

<span class="quip-success" id="quip-success-[[+idprefix]]">[[+successMsg]]</span>

<form id="quip-add-comment-[[+idprefix]]" action="[[+url]]#quip-comment-preview-box-[[+idprefix]]" method="post">

<div class="quip-comment quip-add-comment">
<input type="hidden" name="nospam" value="" />
<input type="hidden" name="thread" value="[[+thread]]" />
<input type="hidden" name="parent" value="[[+parent]]" />
    <span class="quip-error">[[+error]]</span>
     <div class="quip-fld">
        <label for="quip-comment-name-[[+idprefix]]">[[ &namespace=`quip` &topic=`default`]]:</label>
        <input type="text" name="name" id="quip-comment-name-[[+idprefix]]" value="[[+name]]" />
        <br />
    <div class="quip-fld">
        <label for="quip-comment-email-[[+idprefix]]">[[]]: </label>
        <input type="text" name="email" id="quip-comment-email-[[+idprefix]]" value="[[+email]]" />
        <br />
    <div class="quip-fld">
        <label for="quip-comment-website-[[+idprefix]]">[[]]: </label>
        <input type="text" name="website" id="quip-comment-website-[[+idprefix]]" value="[[+website]]" />
        <br />

    <div class="quip-fld">
        <label for="quip-comment-notify-[[+idprefix]]">[[%quip.notify_me]]: </label>
        <input type="checkbox" value="1" name="notify" id="quip-comment-notify-[[+idprefix]]" [[+notify:if=`[[+notify]]`:eq=`1`:then=`checked="checked"`]] />
        <br />

    <div class="quip-fld recaptcha">
    <p><span class="quip-allowed-tags">[[%quip.allowed_tags? &tags=`[[++quip.allowed_tags:htmlent]]`]]</span>[[%quip.comment_add_new]] </p>
    <textarea name="comment" id="quip-comment-box-[[+idprefix]]" rows="5" cols="40">[[+comment]]</textarea>
    <button type="submit" name="quip-preview" value="1">[[%quip.preview]]</button>
    <br class="clear" />

The short version is adding this to the end of the current labels: "-[[+idprefix]]" (without quotes)

I guess I should fill out the CLI to contribute directly?]]> Tue, 03 Aug 2010 03:38:50 +0000
<![CDATA[Problems with widget]]>
$strInputName = "$sendString";

$name = htmlentities($strInputName);

$modx->setPlaceholder('firstName', $name);

return $modx->getChunk('This');

Where $sendString comes from -> [!mySnippetName? &sendString=`[*myTVwithHTMLwidget*]`!]]]> Wed, 07 Jul 2010 02:12:50 +0000
<![CDATA[minor correction Revlution documentation]]> please correct the link on
Although it gets redirected automatically.]]> Sun, 28 Mar 2010 04:17:15 +0000