A Component/Extension is the main definition record for the component (or extension) to be generated and provides the publishing details such as author, website, copyright etc. for the generation of the code. The default settings for the features and functionality to be generated for each Object/Table can also be specified.
Enter a name for the component. This is the visible name of the component/extension. This will also be the label used for the component/extension in views.
Only alphanumeric, space and \ / & + - _ ( ) are allowed - this prevents problems in generated code.
Enter an author's name or company name to be included in the header of each file generated.
Enter the first version number to be used for the Component/Extension. This will be set in all the manifest xml files for the Component/Extension.
Enter a web site address to be included in the header of each file generated.
Enter an email address to be included in the header of each file generated.
The variable name used in code for a Component/Extension. This field is auto_generated from the Component/Extension name and can be changed. No spaces or punctuation marks (except underscore _) are allowed, the value must be unique and start with a letter.
Enter a copyright statement to be included in the header of each file generated.
Chose the default Object/Table for this Component/Extension (e.g. if an event component then an object called 'Event' is likely to be the default object). This determines the default views for both Admin and the main Site plus the default Object/Table is the one linked to Joomla! categories, if Include Categories is selected for the Component/Extension.
A 16 x 16 pixel icon used for the Component/Extension in menu items. This must be a png file.
A 48 x 48 pixel icon used for the Component/Extension in titles. This must be a png file.
A 16 x 16 pixel icon used for the Component/Extension Categories in menu items. This must be a png file.
A 48 x 48 pixel icon used for the Component/Extension Categories in titles. This must be a png file.
Select the options to control which parts of Joomla! (admin, site, plugins and modules) are to be generated for this Component/Extension.
The value at the Component/Extension level will override that at the Object/Table level.
So if not set for the Component/Extension that part will not be generated irrespective of what is set for the Object/Table.
Select whether to generate the administrator part of Joomla!. If not selected then no administrator part for any Object/Table will be generated irrespective of the Generate Admin setting at the Object/Table level.
This may have only limited value at the moment as the component/extension structure requires an administrator area for it to function properly.
Select whether to generate the site front end of Joomla!. If not selected then no site front end for any component object will be generated irrespective of the Generate Site setting at the component object level.
Select whether to generate the views in the front end of Joomla!. If not selected then no views in the front end for any Object/Table will be generated irrespective of the Generate Site Views setting at the Object/Table level.
For this to be selected the Generate Site must also be selected.
There may be a requirement to have access to models in the front end but not to separate views e.g. for field values tables
Select whether to generate the front end Article Layout in Object/Table view. If not selected then no Article Layouts for any Object/Table will be generated irrespective of the Generate Site - Article Layout setting at the Object/Table level.
For this to be selected the Generate Site and Generate Site Views options must also be selected.
The article layout is based on the core Joomla! content article layouts.
Select whether to generate the front end Blog Layout in Objects/Tables view. If not selected then no Blog Layouts for any Object/Table will be generated irrespective of the Generate Site - Blog Layout setting at the Object/Table level.
For this to be selected the Generate Site and Generate Site Views options must also be selected.
The blog layout is based on the core Joomla! content blog layouts.
Select whether to include Joomla!'s standard implementation of categories in the generated Component/Extension. If not selected then no categories functionality for any Object/Table will be generated irrespective of the Generate Categories setting at the Object/Table level.
For Standard Code Templates, if Generate Categories is selected, then it will only ever be the Component/Extension's default Object/Table that will be linked to categories. The Enhanced code template may have multiple Object/Tables that have categories.
Select whether to generate the front end Categories View. If not selected then no Categories View for any Object/Table will be generated irrespective of the Generate Categories - Site Categories View setting at the Object/Table level.
For this to be selected the Generate Categories, Generate Site and Generate Site Views options must also be selected.
Select whether to generate the front end Category View. If not selected then no Category View for any Object/Table will be generated irrespective of the Generate Categories - Site Category View setting at the Object/Table level.
For this to be selected the Generate Categories, Generate Site and Generate Site Views options must also be selected.
Select whether to generate the front end plugins of Joomla!. If not selected then no front end plugins for any Object/Table will be generated irrespective of the Generate Plugins setting at the Object/Table level.
Select whether to generate the front end Search (legacy Joomla! Search) plugin of Joomla!. If not selected then no front end Search plugins for any Object/Table will be generated irrespective of the Generate Plugins - Search setting at the Object/Table level.
For this to be selected the Generate Plugins option must also be selected.
Select whether to generate the front end Finder (Smart Search) plugin of Joomla!. If not selected then no front end Finder plugins for any Object/Table will be generated irrespective of the Generate Plugins - Finder setting at the Object/Table level.
For this to be selected the Generate Plugins option must also be selected.
Select whether to generate the front end Item Navigation plugin of Joomla!. If not selected then no front end Item Navigation plugins for any Object/Table will be generated irrespective of the Generate Plugins - Item Navigation setting at the Object/Table level.
For this to be selected the Generate Plugins option must also be selected.
Select whether to generate the front end Vote plugin of Joomla!. If not selected then no front end Vote plugins for any Object/Table will be generated irrespective of the Generate Plugins - Vote setting at the Object/Table level.
For this to be selected the Generate Plugins option must also be selected.
Select whether to generate the front end Page Break plugin of Joomla! and the associated code to insert page breaks. If not selected then no front end Page Break plugins nor associated code for any Object/Table will be generated irrespective of the Generate Plugins - Page Break setting at the Object/Table level.
For this to be selected the Generate Plugins option must also be selected.
Select whether to generate the front end Email Cloaking plugin of Joomla! and the associated code to mask email address. If not selected then no front end Email CLoaking plugins nor associated code for any Object/Table will be generated irrespective of the Generate Plugins - Email Cloaking setting at the Object/Table level.
For this to be selected the Generate Plugins option must also be selected.
Select whether to generate the front end Load Module plugin of Joomla! and the associated code to insert modules. If not selected then no front end Load Module plugins nor associated code for any Object/Table will be generated irrespective of the Generate Plugins -Load Module setting at the Object/Table level.
For this to be selected the Generate Plugins option must also be selected.
Select whether to generate the front end Events (customisable plugin with place holder for each event raised) plugin of Joomla!. If not selected then no front end Events plugins for any Object/Table will be generated irrespective of the Generate Plugins - Events setting at the Object/Table level.
For this to be selected the Generate Plugins option must also be selected. The Events plugin is only available in the Enhanced code templates.
Select whether to generate the front end modules of Joomla!. If not selected then no front end modules for any Object/Table will be generated irrespective of the Generate Modules setting at the Object/Table level.
Select the options that are standard features in Joomla! that you wish to include in your Component/Extension.
The settings will include not just the field in a table and form but also the standard code for how it is used within the core Joomla! components.
The values set at the Component/Extension level can be over ruled by a setting for a Object/Table.
Select whether to include Joomla!'s legacy access control and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include Joomla!'s 'alias' field and associated code for Objects/Tables in the generated Component/Extension. This can only be set if 'Include Name' is also set.
Select whether to include Joomla!'s ACL and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include Joomla!'s ACL and associated code for record level access control for Objects/Tables in the generated Component/Extension. This can only be set if 'Include Asset ACL' is also set.
Select whether to include Joomla!'s Batch functionality for Objects/Tables in the generated Component/Extension.
This will only be used in code templates for Joomla! 2.5 and later.
Select whether to include Joomla!'s 'checked_out' fields and associated check in/check out code for Objects/Tables in the generated Component/Extension.
Select whether to include a copy function for Components/Extensions. This will affect the copy functionality for Batch copy, Save and Copy, Cascade Copy and a Copy button.
This will only be used in code templates for Joomla! 2.5 and later.
Select whether to include Joomla!'s 'created' and 'created by' fields and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include a 'description' field and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include a standard Joomla! 'featured' field and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include a standard Joomla! 'hits' field and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include a standard set of Joomla! image fields and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include an 'intro' field and associated code for Objects/Tables in the generated Component/Extension. This can only be set if 'Include Description' is also set.
Select whether to include a language fields and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include a set of meta data fields and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include micro data mark-up of front end display output for Objects/Tables in the generated Component/Extension.
Joomla! 3.3 onwards only.
Select whether to include standard Joomla! 'modified' and modified by' fields and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include a name field and associated code for Objects/Tables in the generated Component/Extension.
Note: in Joomla! core components and most other components there is a mix of use of either 'title' or 'name' as being the short descriptor field for a record. I have gone with using 'name' for this but plan in later enhancements to Component Architect and code templates to allow a choice for this.
Select whether to include an ordering field and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include global component level params and associated code for Objects/Tables in the generated Component/Extension.
Any combination of 'Global', 'Menu Item' and 'Record Level' params can be selected and the code will then be generated to check for the values set in the lowest level params before checking higher levels i,e, check record level first, then menu item and then global.
Select whether to include global menu item level params and associated code for Objects/Tables in the generated Component/Extension.
Any combination of 'Global', 'Menu Item' and 'Record Level' params can be selected and the code will then be generated to check for the values set in the lowest level params before checking higher levels i,e, check record level first, then menu item and then global.
Select whether to include data record level params and associated code for Objects/Tables in the generated Component/Extension.
Any combination of 'Global', 'Menu Item' and 'Record Level' params can be selected and the code will then be generated to check for the values set in the lowest level params before checking higher levels i,e, check record level first, then menu item and then global.
Select whether to include standard Joomla! 'publish up' and 'published down' date fields and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include standard Joomla! 'state' field and associated code for Objects/Tables in the generated Component/Extension.
This is used to set the status of the record e.g. Unpublished, Published, Trashed or Archived. The end user sees this as 'status' or 'published' but internally this uses the database field called 'state'.
Future releases of Component Architect may change this internal field to be 'status' as the use of the field name 'state' causes confusion with the PopulateState function and 'state' part of an object of class JModel or JModelAdmin.
Select whether to include tags functionality for Objects/Tables in the generated Component/Extension. Note in Joomla! tags are not held in the Object/Table but in a separate table which links content to tags.
Select whether to include a standard set of 3 url links and associated code for Objects/Tables in the generated Component/Extension.
Select whether to include versions functionality for Objects/Tables in the generated Component/Extension. Note in Joomla! version history are not held in the Object/Table but in a separate table which links content to version history. A latest version field is defined in the Object/Table.