Code Templates ImageCode Template View Help

A code template is a set of files containing marked up component code. The code templates are used as the skeletons structure and code for the generated components.

In the Standard (i.e. free version) of Component Architect the code templates are predefined and cannot be changed or new ones created. In the Pro version of Component Architect the supplied code templates may be copied and altered to meet the requirements of the developer.

You can use the following links to jump to a section of this help page:

Screenshot

Code Template - Screenshot

Toolbar Buttons

Code Template - Toolbar

Close

Close the view form and return to the list.

Help

Link to display the Help system.
Top

Headline Details

Code Template - Headline Details

Name

Text
Top

Basic Details

Code Template - Basic Details

Description

The description for the template.
Editor

Category

The category that this item is assigned to.
Category List

Version

The version number of this code template.

text

Source Path

The root folder for this code template.

text

Pre-defined

Flag indicating whether this code template is pre-defined or not. As pre-defined code templates are provided with the Component Architect extension they are read-only. They can be cloned (which will also create a copy of the code tempalte files with the cascade batch copy method

list

Generate Pre-defined Fields

Flag indicating whether this Code Template will ignore the fields marked as pre-defined or will use them in generating a component. Some templates are marked-up to handle the Include Joomla! Features flags without reference to a defined Field, others may use the pre-defined Fields to implement the Joomla! Feature.

checkbox

Multiple Category Objects

Flag indicating whether this Code Template will generate categories that can be set for multiple Component Objects or just a single Component Object.

checkbox

Platform

The platform for this code template. Currently only Joomla

list

Platform Version

The version of the platform for this code template.

list

Coding Language

The coding language(s) used by this code template

checkboxes

Ordering

The ordering of template.
Ordering List

ID

The ID of the displayedcode template.
Text - read only
Top

Code Template Markup Defaults

Fieldset containing the default values used in the Code Template for marking up the code.

Code Template - Code Template Markup Defaults

Template Component Name

The name used in the template to represent the component name used in code. For example if this field is set to 'architect comp' the component folder would be 'com_architectcomp' on generating a component, say called Events, the 'architectcomp' name would be replaced throughout the component with 'events' so 'com_architectcomp' would become 'com_events'.

For best results this should be two words e.g. 'architect comp'. This allows the code generator to output the maximum number of variations of capitals and words possible.

Only alphanumeric and space are allowed.

text

Template Object Name

The name used in the template to represent an object (i.e. table) name used in code. For example if this field is set to 'comp object' there should be model files called 'compobject' and 'compobjectplural' on generating a component, with a component object of say Event, the 'compobject' name would be replaced throughout the component with 'event' and 'compobjectplural' with 'events'.

For best results this should be two words e.g. 'architect comp'. This allows the code generator to output the maximum number of variations of capitals and words possible.

Only alphanumeric and space are allowed.

text

Template Markup Prefix

The characters to be used to prefix a markup command in a code template. The default value is '[%%'. The Template Markup Suffix will mark the end of the markup command.

The value should be something which will not be used elsewhere in the code template as part of the normal code otherwise unexpected results will occur on component generation.

text

Template Markup Suffix

The characters to be used to suffix a markup command in a code template. The default value is '%%]'. The Template Markup Prefix will mark the start of the markup command.

The value should be something which will not be used elsewhere in the code template as part of the normal code otherwise unexpected results will occur on component generation.

text
Top

Publishing Options

Code Template - Publishing

Created By

The user that is to be shown as creating the template. If none selected on create then the current logged in user will be used.
Calendar

Created By Alias

An alias for the user that is to be shown as creating the template.
Text

Created Date

Code template created date.
Calendar

Modified Date

Code template last modified date.
Text - protected

Modified By

The user that last modifed the Code template record.
Text - protected
Top