1 MODX: The Official Guide Building dynamic websites with the MODX content management platform. Bob Ray. 2 Bob Ray MODX: The Official Guide No. This guide provides an introduction to how to Get Started, introduces the basic handled, sometimes via a link from MODX, by CiviCRM. Over a year in the works, by Bob Ray is a page reference for all things MODX . This is the first publication by our own in-house MODX Press.
|Language:||English, Spanish, Japanese|
|Genre:||Politics & Laws|
|ePub File Size:||25.38 MB|
|PDF File Size:||9.32 MB|
|Distribution:||Free* [*Register to download]|
MODX: The Official Guide is a comprehensive reference for all things MODX. Complete 1st Chapter; Full-Table of Contents; Full Index; PDF of Print Edition. MODX: The Official Guide i. Introduction .. PDF format. Each editor PDF files , for example, that the user can view or download by following a link to the static. MODX the Official Guide - Ebook download as PDF File .pdf), Text File .txt) or read book online. MODX the Official Guide.
Hundreds of updates, corrections, additions, and improvements Pasteable code! Multi-color highlighting for easy identification of field names, system events, resource names, snippet properties, system settings, and code comments. Search capability Improved weight profile — the digital edition weighs a fraction of what the paper book does. The available formats depend on where you download it. If you get it from site, you will only get one version of the Kindle format, depending on the device site thinks you have.
Edit one or more fields of the Snippet. If you attempt to add a Snippet which does not exist i. If you have added a Snippet but do not see the results of the Snippet on the Resource: Ensure that the Snippet exists. Using Files a. Click the binoculars icon to view the file. The file will open in a textbox in the lower half of the screen.
You are able to make changes to the file, but you will be unable to save these changes and make them permanent. Click the green checkmark icon to edit the file.
You are able to make changes to the file. A file explorer window will appear which shows the files of your local computer.
Locate and click the file which you wish to upload. Note: You may repeat steps to upload multiple files at one time. Click the red minussign icon to delete the file.
Note: Deleting a file or folder cannot be undone. Make certain that the file you are deleting is not used by other parts of the site. Deleting necessary system files can damage your site. The new directory will immediately appear as a new folder at the level which you chose. Using Meta Tags and Keywords a. This name will help you remember what the tag does or represents. Edit the Name, Tag, and Values as desired. Managing Keywords i. Keywords are simple phrases and have no additional properties.
When editing keywords, it is possible to rename or delete multiple keywords at the same time. Hold down the CTRL key while clicking to select multiple tags. Other Functions 1. This is not the recommended way to add content to your MODx site, but it is very useful when converting a site that contains a large number of existing HTML pages.
Click on the desired Parent Resource in the lefthand Site Tree. The Import function is capable of processing almost documents per second; thus 30 seconds is more than sufficient for most websites.
The Resources are not directly editable from the Schedule screen. User Administration a. Accessing User Administration The User Administration screens are accessible via the small toolbar in the upper right corner of every screen. A link to access your Content Manager messages. A link to generic MODx help resources. Type your new password.
Passwords must be between 6 and 15 characters long. Password changes are immediate.
You will need to use your new password the next time you access the Content Manager. You will not receive email confirmation of the change. The Inbox The Inbox contains a list of all messages sent to you or a User Group of which you are a member. Unread messages are marked with a star and green text. Messages which have already been read have black text and no star. From this screen you can use the topmost row of buttons to reply to the sender of the message, forward the message to another user, or delete the message.
Note: Clicking on the Delete button immediately removes the message. You may send a message either to a specific user such as johndoe , a user group everyone who is an Administrator , or everyone registered in the system.
Most help resources are available directly from the MODx website. Adminstrative content will be displayed along with editorial content. You will be immediately logged out and returned to the Content Management login page. Other User Administration Functions All other aspects of user administration e. Applying and Removing Styles a. Applying a Style Click and hold your left mouse button while dragging it over the desired text or image.
Note: It is not possible to add more than one style to a particular image or text. This will remove any styles currently in place. Adding and Deleting Styles Adding and deleting styles is simple but requires a knowledge of CSS and full administrative access to the server.
They have developed a firstclass Open Source CMS, and this book would not have been possible without their support and patience. Shaun served as the book s technical editor and deserves special credit for ensuring its accuracy. Haven Stephens, the book s editor, played a critical role in eliminating countless errors and making sure that the explanations in the book were as clear as possible.
I would also like to thank the many users of the MODX Forums, both those whose answers have taught me almost everything I know about MODX and those whose questions led to the creation of this book. My apologies to the many others whose names I ve omitted either from lack of space or memory lapse. I d also like to thank my cat, Cosmo, who spent many hours each day for over two years curled up next to me as I worked on the book at my computer. His comments on the book were invaluable.
Disclaimer of Warranty Legal Mumbo Jumbo All of the information, instructions, and recommendations in this book are provided on a strictly as is basis without any warranty, expressed or implied.
In particular, any and all warranties of fitness for use or merchantability are disclaimed. Neither MODX nor Bob Ray personally shall be held responsible for any direct, indirect, incidental, or consequential damages that may result from the use of material in this book or anything any reader does as a result of reading any part of the book or any associated web site. It is up to the reader to determine the suitability of any directions or information presented in the book.
Furthermore, it is the responsibility of the reader to determine if any information, instructions, or recommendations given in the book are appropriate based upon his or her particular situation. The author and publisher cannot be held accountable for decisions made based upon material in the book. If you are not familiar with the term CMS, think of a word processor for web sites, but on steroids.
A CMS will usually provide you with a graphical view of your web site, a database that stores the site s content, and one or more editors for creating web pages and populating them with links, lists, headings, and formatted text. Every CMS tries to provide a convenient and powerful user interface for creating and maintaining web sites, but to some extent, convenience and power are in opposition to one another.
If you want a standard blog with a ready-made look and feel, WordPress provides a surprisingly friendly and intuitive user interface for creating and maintaining one.
MODX, on the other hand, leans more toward the power side of the equation. The learning curve is a little steeper, but MODX allows you much more freedom in the design of your web site, more powerful tools you can use to make the web site unique, and the ability to customize the CMS itself. We will cover customizing the MODX user interface in later chapters. One guiding principle of MODX is to put as few restrictions on the web developer as possible. One illustration of this flexibility is that you can take virtually any existing web site and make a MODX web site out of it that looks exactly the same to a front-end visitor.
Trying that with many other CMS platforms will leave you cursing and tearing your hair out. In the following sections, we ll look at who the book is for, how it is organized, and how the typography of the book can help you understand what you re looking at.
Audience This book is for anyone who wants to use MODX for web site design, development, and maintenance. In order to get the most out of this book, you should have a basic familiarity with X HTML, CSS, and how the two interact in the rendering of web pages. You will also see some PHP code in the book. If you don t, never fear. Often, they created a web site with no PHP, and then learned PHP, a little bit at a time, as they began to make their web site more and more interesting and easier to maintain.
This book is perfectly suitable for MODX beginners but contains plenty of in-depth information for power users as well. If you are brand new to MODX, some parts of the book may go over your head the first time you read them. Over time, however, you will grow more familiar with how MODX works, and they will gradually begin to make sense to you. At first, I tried to put material for beginners at the beginning of the book and save the more advanced information for later.
Because of the way MODX works, however, it just wasn t possible. As a result, you ll see things that may confuse you on the first pass. You should be able to ignore them and create a perfectly good web site using the things you do understand.
Later, as things make more sense to you, you ll be able to refine your site to take advantage of MODX s more advanced features. The book is also meant to serve as a reference manual for both beginners and experts. If you are new to MODX, you won t be familiar with these at first. After reading Chapter 1, however, you should have a fair idea of what they are and how they work together. Later in the book, we ll look at each MODX object in depth.
Because the objects constantly interact with each other, you ll be learning about them all bit-by-bit as we go along. Conventions A number of typographical conventions are used throughout the book to make it easier to understand what you re looking at.
There are two main typefaces for content in the book: The regular font used for this sentence and the code font. The code font looks like this when it appears in a regular font paragraph: This is the inline code font. When it appears in a separate paragraph, it looks like this: This is the code snippet font. It is also used for file and directory names and for path names and for text to be entered in a field in the MODX Manager. Key terms will generally be in the regular font in italics when they first appear.
Terms referring to MODX objects snippets, template variables, chunks, plugins, categories, placeholders, etc. Names of resources or elements that you will be creating and editing yourself, will be in italics in the code font when they first appear, then in the regular font in roman type, usually in CamelCase: Create a chunk called FooterChunk. The FooterChunk will contain code for the page footer. Field names and tab names used in the MODX Manager will be in initial caps when referring to the specific area of the Manager, but in lowercase when discussing them as general objects.
They will be enclosed in quotation marks when they are included in directions to click or select them, but used without the quotation marks in general discussion: Click on the Elements tab. Chunks are listed on the Elements tab. Chunks are classified as elements. The names of specific resources and elements will generally be in CamelCase in the text. They will usually be in the code font and italics when they first appear especially in directions to create them : Create a resource called News.
Let s create our ShowList snippet. Later references to them will be in the regular font in CamelCase: The FooterChunk contains all the elements shown in the footer of the page. They will be enclosed in quotation marks in instructions to click or select them in the Manager: Click on the ShowList snippet on the Elements tab. Variable names including snippet properties will generally start with a lowercase letter and have the first letter of each following word capitalized.
As mentioned earlier, MODX settings and system event names will be in the code font in bold. The actual field names used internally by MODX and by users in tags and snippets will be in the code font and bold e. This is important because new users sometimes type in the example exactly as it is written and are surprised when it doesn t work.
I ve tried to be as faithful to these conventions as possible, but this is a long book with many complicated references. I hope the reader will forgive the inevitable errors in typography. I tried to break them in a way that doesn t harm the user s understanding of what the code does, but it wasn t always possible. The extra lines of code created will always be indented.
The only time the lines must be combined is for Input Option Values of template variables. In all other cases that I m aware of, the code can be entered as written and no harm will be done the PHP and HTML parsers are very forgiving about formatting but you should feel free to combine the split lines to fit your coding style. Generally, the only negative effect of the split lines will be on the formatting of some raw HTML code you ll see if you select View Source in your browser.
We ll also take a look at the architecture and key features of MODX. Is MODX for you? MODX is designed to be useful to everyone from beginning web designers to advanced Content Management System developers, but it is somewhat difficult for the former.
If you are looking for a system that will do everything you want out-of-the-box and let you produce a finished web site without getting your hands dirty, MODX is probably not for you. For a standard blog, for example, WordPress might be a better choice. You install it, select a theme or use the default one , and begin entering your posts. Where MODX shines is in cases where you want a unique web site with active pages that you design yourself.
Its flexibility and power are unequalled in the CMS world. If you can describe what you want your web site to do, the odds are good that you can do it in MODX. The site had the usual pages: a page describing the organization s officers, a volunteer page, a page for the local elected officials with links to their web sites, a page containing the organization s bylaws, a page where users could download issues of the organization s newsletter, etc.
The site also had a front page with excerpts from news posts, each with a link to the full post. Next, I added a series of photo galleries for various events and put a random photo from one of the galleries under the menu on the front page that served as a link to the photo s gallery. Then came a fundraising thermometer that showed the current level of contributions. I set up one user as the photo editor who could easily create new galleries and upload photos in the front end.
I set up a news editor who could write new articles that would automatically show up in the news section and be excerpted on the front page. I set up a newsletter editor who could upload new newsletters in. Each editor had access to only his or her own section of the site.
I learned MODX, created the site, and wrote simple instructions for each user in a surprisingly short time less than a week. The site has been rock-solid ever since with almost no intervention on my part. On one of my next MODX sites, the client wanted a page with seasonal photos and a discount coupon that changed automatically four times a year, with the seasons. Doing this on most other CMS platforms would have taken much, much longer and would have been extremely frustrating.
It s best if you have created a few web sites before diving into MODX. The odds are that you will pick it up as you develop your MODX skills and can then go back and read over any sections that confused you at first. Jason became the principle architect of the MODX core code.
MODX has an extremely creative and responsive user community, and countless MODX users have contributed to the development process over the last few years.
The designation was misleading by that time, MODX was a very robust and mature product. Under the hood, the two are quite different. We ll look at some of the similarities and differences in the following sections.
For now, we ll say that the main components of MODX discussed in this book chunks, snippets, templates, template variables, plugins, resources, settings, and tags exist in both versions and play the same role in each.
That said, most of the content in the book will apply equally well to either version, and there is a section at the end of each chapter describing how the content of that chapter applies in MODX Evolution. It provides a fairly seamless upgrade for all legacy MODX sites. The version numbers of earlier versions of MODX e.
The version numbers imply that they were beta versions. In fact, they were and still are very mature and used in thousands of production web sites. Evolution also has a smaller footprint and takes somewhat less memory to install and use. Revolution, however, is more robust and more secure.
Revolution is a significant technical advance compared to Evolution and represents the future of MODX. The Manager is somewhat easier to navigate and has a number of extremely convenient features like drag-and-drop editing and the ability to create new elements and resources and clear the cache in pop-up windows without leaving your current work.
Revolution also introduces convenient grids for editing language strings, system settings, and snippet properties. By far the most revolutionary feature in Revolution from the average user s perspective is the Package Management system. In Evolution, you have to download a. There is a completely new database API based on xpdo, which provides an efficient and easy-to-use way to read, create, and update all MODX objects.
It also allows you to easily pull data from multiple MODX tables with one query in a single, elegant line of code. Which Version Should I Use? If you are upgrading an existing site that you don t work on very often, MODX Evolution may be a better choice for you.
Evolution is also a better choice if you need to install and run your web site with limited memory. As I write this, Revolution needs at least 32M of memory to install although there are plans to remedy this , so if your web host restricts you to 8M or 16M of memory and you are not allowed to change that, Evolution is the better choice.
Most web hosts have higher limits, and many allow you to modify the amount of available memory. If you will be working through the examples in the book, however, MODX Revolution is really your only choice. All of the tags and much of the code presented in the book s examples will only work as written in MODX Revolution.