This is an auto-generated topic for
GetMyComponent 1.0.1-beta1 by bobray.
Brief Description:
GetMyComponent installs all files for the MyComponent package for MODx Revolution (which can't be installed directly as a package because it is itself a build script).
MyComponent is an extensive example build script for MODx revolution
transport packages. It is designed so that you can modify it, and
use it to create your own transport packages.
Much of the code in the MyComponent files was written by Shaun McCormick or inspired by his code.
MyComponenet contains examples of how to add all of the following MODx objects to a Revolution transport package:
- snippets
- chunks
- resources
- plugins
- plugin events
- template variables
- templates
- resources
- system settings
- properties
- other packages
- lexcicon topics and strings
- readme file
- changelog file
- license file
It also demonstrates how to accomplish the following tasks:
- Organize a component's directories
- Interact with the user during the install
- Create and set properties
- Create and set system settings
- Connect TVs to their templates
- Connect plugin events to their plugins
- Use a script and/or file resolver
- Use a validator to abort the install
- Use lexicon strings for property descriptions
- Copy core and assets files during the install
- Include a GPL license in executable files
- Include PhpDoc comments to document your component
- Create a readme.md file for GitHub
MyComponent is designed so that you can use it to package your own components by setting variables in the build.transport.php fie, renaming files, and performing a series of search-and-replace operations.
