Tagged value overview
action/form/view
action -- For a stereotype 'action', this tagged value can be used to
overwrite the default URL ('.../name_of_method') into
'.../tagged_value'.
action_label -- TODO.
category -- The category for the action. Defaults to 'object'.
condition -- A TALES expresson defining a condition which will be
evaluated to determine whether the action should be displayed.
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
form -- For a stereotype 'form', this tagged value can be used to
overwrite the default URL ('..../name_of_method') into
'..../tagged_value'.
id -- The id of the action. Use 'id',
label -- The label of the action - displayed to the user.
view -- For a stereotype 'view', this tagged value can be used to
overwrite the default URL ('..../name_of_method') into
'..../tagged_value'.
association
association_class -- You can use associations classes to store content
on the association itself. The class used is specified by this
setting. Don't forget to import the used class properly.
association_vocabulary -- Switch, defaults to False. Needs Product
'ATVocabularyManager'. Generates an empty vocabulary with the name
of the relation.
back_reference_field -- Use a custom field instead of ReferenceField.
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
inverse_relation_name -- Together with 'Relations' Product you have
inverse relations. the name default to
'name_of_your_relation_inverse', but you can overrrule it using this
tagged value.
label -- Sets the readable name.
reference_field -- Use a custom field instead of ReferenceField.
relation_field -- Use a custom field instead of RelationField. Works
only together with 'Relations' Product and relation_implementation
set to 'relations'.
relation_implementation -- Sets the type of implementation is used for
an association: 'basic' (used as default) for classic style
archetypes references or 'relations' for use of the 'Relations'
Product.
relationship -- Standard relationship for ReferenceField
attribute
accessor -- Set the name of the accessor (getter) method. If you are
overriding one of the DC metadata fields such as 'title' or
'description' be sure to set the correct accessor names such as
'Title' and 'Description' -- by default these accessors would be
generated as 'getTitle' or 'getDescription'.
allowed_types -- Sets the types allowed for a ReferenceField. Default
is []
array:widget -- specify which custom ArrayWidget should be used for a
field (only applies if the field has cardinality >1.
copy_from -- To copy an attribute from another schema, give it the type
'copy'. The tagged value 'copy_from' is then used to specify which
schema to copy it from (for instance, 'BaseSchema' when copying
Description from the base schema). For copying your own schemas, add
an 'imports' tagged value to import your class (say 'MyClass') and
then put 'MyClass.schema' in your 'copy_from' value.
default -- Set a value to use as the default value of the field.
default_method -- Set the name of a method on the object which will be
called to determine the default value of the field.
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
enforceVocabulary -- Set to true (1) to ensure that only items from the
vocabulary are permitted.
index -- Add an index to the attribute. The value of the tagged value
should be the same that archetypes expects, so something like
'FieldIndex' or 'FieldIndex:brains'. Not needed in 99.9% of the
cases, but a tuple can be used to create it in multiple catalogs:
'python:("portal_catalog/FieldIndex:schema",
"another_catalog/FieldIndex:schema, )'
label -- Sets the readable name.
multiValued -- Certain fields, such as reference fields, can optionally
accept more than one value if 'multiValued' is set to true (1).
mutator -- Similarly, set the name of the mutator (setter) method.
original_size -- Sets the maximum size for the original for an
ImageField widget.
read_permission -- Defines archetypes fields read-permission. Use it
together with workflow to control ability to view fields based on
roles/permissions.
required -- Set to true (1) to make the field required
schemata -- If you want to split your form with many, many attibutes in
multiple schemata ("sub-forms"), add a tagged value 'schemata' to
the attributes you want in a different schemata with the name of
that schemata (for instance "personal data"). The default schemata
is called "default", btw.
searchable -- Whether or not the field should be searchable when
performing a search in the portal.
sizes -- Sets the allowed sizes for an ImageField widget.
source_name -- With attribute type 'copy' sometimes schema-recycling is
fun, together with copy_from you can specify the source name of the
field in the schema given by copy_from.
validation_expression -- Use an ExpressionValidator and sets the by
value given expression.
validation_expression_errormsg -- Sets the error message to the
ExpressionValidator (use with validation_expression to define the
validation expression to which this error message applies).
validators -- TODO.
vocabulary -- Set to a python list, a DisplayList or a method name
(quoted) which provides the vocabulary for a selection widget.
vocabulary:name -- Togther with Products 'ATVocabularyManager' this
sets the name of the vocabulary.
vocabulary:term_type -- For use with 'ATVocabularyManager'. Defaults to
'SimplevocabularyTerm'. Lets you define the 'portal_type' of the
vocabularyterm used for the default term that is created in
'Install.py'.
vocabulary:type -- Enables support for Products 'ATVocabularyManager'
by setting value to 'ATVocabularyManager'.
widget -- Allows you to set the widget to be used for this attribute.
widget:description -- Set the widget's description.
widget:description_msgid -- Set the description i18n message id.
Defaults to a name generated from the field name.
widget:i18n_domain -- Set the i18n domain. Defaults to the product
name.
widget:label -- Set the widget's label.
widget:label_msgid -- Set the label i18n message id. Defaults to a name
generated from the field name.
widget:type -- Set the name of the widget to use. Each field has an
associated default widget, but if you need a different one (e.g. a
SelectionWidget for a string field), use this value to override.
write_permission -- Defines archetypes fields write-permission. Use it
together with workflow to control ability to write data to a field
based on roles/permissions.
class
additional_parents -- A comma-separated list of the names of classes
which should be used as additional parents to this class, in
addition to the Archetypes BaseContent, BaseFolder or
OrderedBaseFolder. Usually used in conjunction with 'imports' to
import the class before it is referenced.
allow_discussion -- Whether or not the content type should be
discussable in the portal by default.
allowable_content_types -- A comma-separated list of allowed text
formats for a textarea widget.
allowed_content_types -- A comma-separated list of allowed sub-types
for a (folderish) content type. Note that allowed content types are
automatically set when using aggregation and composition between
classes to specify containment.
archetype_name -- The name which will be shown in the "add new item"
drop-down and other user-interface elements. Defaults to the class
name, but whilst the class name must be valid and unique python
identifier, the archetype_name can be any string.
author -- You can set the author project-wide with the '--author'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a class level.
base_actions -- Sets the base actions in the class's factory type
information (FTI).
base_class -- Explicitly set the base class of a content type,
overriding the automatic selection of BaseContent, BaseFolder or
OrderedBaseFolder as well as any parent classes in the model. What
you specify here ends up as the first item (or items: comma-separate
them) in the classes it inherits from. So this is also a handy way
to place one class explicitly in front of the other. See also
additional_parents.
base_schema -- Explicitly set the base schema for a content type,
overriding the automatic selection of the parent's schema or
BaseSchema, BaseFolderSchema or OrderedBaseFolderSchema.
catalogmultiplex:black -- Remove an archetypes class (identified by
meta_type) from one or more catalogs to be cataloged in. Comma-
separated list of catalogs. Example-value: 'portal_catalog,
another_catalog'. Explaination: Instances of the class wont be
catalogged in portal_catalog anymore.
catalogmultiplex:white -- Add an archetypes class (identified by
meta_type) to one or more catalogs to be cataloged in. Comma-
separated list of catalogs. Example-value: 'myfancy_catalog,
another_catalog'. Explaination: Additionally to the default
'portal_catalog' the instances of this class will be catalogged in
the two given catalogs.
class_header -- An arbitrary string which is injected into the header
section of the class, before any methods are defined.
cmf_target_version -- Controls CMF Version specific behaviour, primary
to avoid 'Deprecation warnings.' Defaults to '1.4'.
contact_schema -- TODO. CMFMember related. (Use 'remember' instead.)
content_icon -- The name of an image file, which must be found in the
skins directory of the product. This will be used to represent the
content type in the user interface.
copyright -- You can set the copyright project-wide with the '--
copyright' commandline parameter (or in the config file). This TGV
allows you to use/ overwrite it on a class level.
creation_permission -- Sets the creation permission for the class.
Example: 'Add portal content'.
creation_roles -- You can set an own role who should be able to add a
type. Use a Tuple of Strings. Default and example for this value:
'("Manager", "Owner", "Member")'.
default_actions -- If set to true (1), generate explicitly the default
'view' and 'edit' actions. Usually, these are inherited from the
Archetypes base classes, but if you have a funny base class, this
may be necessary.
default_view -- The 'TemplateMixin' class in Archetypes allows your
class to present several alternative view templates for a content
type. The 'default_view' value sets the default one. Defaults to
'base_view'. Only relevant if you use 'TemplateMixin'.
detailed_creation_permissions -- Give the content-type (types in the
package, model) own creation permissions, named automagically
'ProductName: Add ClassName'.
disable_polymorphing -- Normally, archgenxml looks at the parents of
the current class for content types that are allowed as items in a
folderish class. So: parent's allowed content is also allowed in the
child. Likewise, subclasses of classes allowed as content are also
allowed on this class. Classic polymorphing. In case this isn't
desired, set the tagged value 'disable_polymorphing' to 1.
display_in_navigation -- Setting this boolean value adds the type to
'Displayed content types' in the portals navigation settings.
Default is True
doctest_name -- In a tests package, setting the stereotype
'<<doc_testcase>>' on a class turns it into a doctest. The doctest
itself is placed in the doc/ subdirectory. The 'doctest_name' tagged
value overwrites the default name for the file (which is the name of
the doctestcase class + '.txt'). ArchGenXML appends the '.txt'
extension automatically, so you don't need to specify it.
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
email -- You can set the email project-wide with the '--email'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a class level.
filter_content_types -- If set to true (1), explicitly turn on the
'filter_content_types' factory type information value. If this is
off, all globally addable content types will be addable inside a
(folderish) type; if it is on, only those values in the
'allowed_content_types' list will be enabled. Note that when
aggregation or composition is used to define containment,
'filtered_content_types' will be automatically turned on.
folder_base_class -- Useful when using the '<<folder>>' stereotype in
order to set the folderish base class.
folderish -- Explicitly specify that a class is folderish. It is
usually better to the the '<<folder>>' stereotype instead.
generate_reference_fields -- Per default (True) navigable reference (or
relation) ends are resulting in a ReferenceField (or RelationField).
Setting this value to False results in not generating
ReferenceFields automagically.
global_allow -- Overwrite the AGX-calculated 'global_allow' setting of
class. Setting it to '1' makes your content type addable everywhere
(in principle), setting it to '0' limits it to places where it's
explicitly allowed as content.
hide_actions -- A comma- or newline-separated list of action ids to
hide on the class. For example, set to 'metadata, sharing' to turn
off the metadata (properties) and sharing tabs.
hide_folder_tabs -- When you want to hide the folder tabs (mostly the
"contents" tab, just set this tagged value to 1.
immediate_view -- Set the 'immediate_view' factory type information
value. This should be the name of a page template, and defaults to
'base_view'. Note that Plone at this time does not make use of
'immediate_view', which in CMF core allows you to specify a
different template to be used when an object is first created from
when it is subsequently accessed.
import_from -- If you wish to include a class in your model (as a base
class or aggregated class, for example) which is actually defined in
another product, add the class to your model and set the import_from
tagged value to the class that should be imported in its place. You
probably don't want the class to be generated, so add a stereotype
'<<stub>>' as well.
imports -- A list of python import statements which will be placed at
the top of the generated file. Use this to make new field and widget
types available, for example. Note that in the generated code you
will be able to enter additional import statements in a preserved
code section near the top of the file. Prefer using the imports
tagged value when it imports something that is directly used by
another element in your model. You can have several import
statements, one per line, or by adding several tagged values with
the name 'imports'.
inherit_allowed_types -- By default, a child type will inherit the
allowable content types from its parents. Set this property to false
(0) to turn this off.
label -- Sets the readable name.
license -- You can set the license project-wide with the '--license'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a class level.
login_info_schema -- TODO. CMFMember related. (Use 'remember' instead.)
marshall -- Specify a marshaller to use for the class' schema.
marshaller -- Specify a marshaller to use for the class' schema.
migrate_dynamic_view_fti -- Migrates FTI of a type/class to
CMFDynamicViewFTI. This works only if the class derives from an
ATContentType, from ATCTMixIn or direct from
CMFDynamicViewFTI.browserdefault.BrowserDefaultMixin.
module -- Like 'module_name', it overwrites the name of the directory
it'd be normally placed in.
module_name -- Like 'module', it overwrites the name of the directory
it'd be normally placed in.
parentclass_first -- if this tgv is set to true generalization parents
are used before the standard base classes (e.g. BaseContent) this
option is sometimes necessary when inheriting from some special
parents (e.g. CMFMember or ReMember style classes).
parentclasses_first -- if this tgv is set to true generalization
parents are used before the standard base classes (e.g. BaseContent)
this option is sometimes necessary when inheriting from some special
parents (e.g. CMFMember or ReMember style classes).
plone_2_1_schema -- TODO. CMFMember related. (Use 'remember' instead.)
plone_schema -- TODO. CMFMember related. (Use 'remember' instead.)
policy -- On a class with stereotype '<<plone_testcase>>', this sets
the customization policy used by the test case to setup the site
(e.g. 'CMFMember Site'). XXX: CMFMember is obsolete as of Plone 2.5
portal_type -- Sets the CMF portal-type this class will be registered
with, defaults to the class-name.
quickinstall_dependencies -- In a tests package, setting the stereotype
'<<plone_testcase>>' on a class turns it into a base testcase. The
base testcase will install all listed products to the test portal
using CMFQuickInstallerTool. The list has the form: '"ProductA",
"ProductB"'.
quickinstall_self -- In a tests package, setting the stereotype
'<<plone_testcase>>' on a class turns it into a base testcase. The
base testcase will install the current Product (where the testcase
resides in) using CMFQuickInstallerTool.
read_permission -- Defines archetypes fields read-permission. Use it
together with workflow to control ability to view fields based on
roles/permissions.
searchable -- Per default a fields 'searchable' property is set to
False. Sometimes you want it for all fields True. This TGV let you
define the default for a class, package or model.
searchable_type -- Setting this boolean value adds the type to 'types
to be searched' in the portals search settings. Default is True
security_schema -- TODO. CMFMember related. (Use 'remember' instead.)
strict -- On a class with the '<<interface_doctest>>' stereotype: check
for inherited interfaces as well.
suppl_views -- The 'TemplateMixin' class in Archetypes allows your
class to present several alternative view templates for a content
type. The 'suppl_views' value sets the available views. Example:
'("my_view", "myother_view")'. Defaults to '()'. Only relevant if
you use 'TemplateMixin'.
typeDescription -- A description of the type, a sentence or two in
length. Used to describe the type to the user.
use_portal_factory -- Setting this boolean value enables the
registration of the type for use with portal_factory.
use_workflow -- Tie the class to the named workflow. A state diagram
(=workflow) attached to a class in the UML diagram is automatically
used as that class's workflow; this tagged value allows you to tie
the workflow to other classes.
version_info -- Add ArchGenXML version information to the generated
file (default is 1).
vocabulary:type -- Enables support for Products 'ATVocabularyManager'
by setting value to 'ATVocabularyManager'.
vocabulary:vocabulary_type -- For use with 'ATVocabularyManager'.
Defaults to 'Simplevocabulary'. Let you define the portal_type of
the vocabulary used as initial vocabulary at Product install time.
If VdexVocabulary is used, the install-script tries to install a
vocabulary from a vdex file names
'Products/PRODUCTNAME/data/VOCABULARYNAME.vdex'.
write_permission -- Defines archetypes fields write-permission. Use it
together with workflow to control ability to write data to a field
based on roles/permissions.
field
description -- Sets a description for this field. It's used for field
documentation while registering inside Archetypes.
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
label -- Sets the readable name.
validation_expression -- Use an ExpressionValidator and sets the by
value given expression.
validation_expression_errormsg -- Sets the error message to the
ExpressionValidator (use with validation_expression to define the
validation expression to which this error message applies).
method
autoinstall -- Set this to 'right' or 'left' on a method with a
stereotype '<<portlet>>', this adds the portlet to 'left_slots' or
'right_slots'. See the documentation for the stereotype.
code -- The actual python code of the method. Only use this for simple
one-liners. Code filled into the generated file will be preserved
when the model is re-generated.
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
label -- Sets the readable name.
permission -- For method with public visibility only, if a permission
is set, declare the method to be protected by this permission.
Methods with private or protected visiblity are always declared
private since they are not intended for through-the-web unsafe code
to access. Methods with package visibility use the class default
security and do not get security declarations at all.
model
association_class -- You can use associations classes to store content
on the association itself. The class used is specified by this
setting. Don't forget to import the used class properly.
association_vocabulary -- Switch, defaults to False. Needs Product
'ATVocabularyManager'. Generates an empty vocabulary with the name
of the relation.
author -- You can set the author project-wide with the '--author'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a model level.
catalogmultiplex:black -- Remove an archetypes class (identified by
meta_type) from one or more catalogs to be cataloged in. Comma-
separated list of catalogs. Example-value: 'portal_catalog,
another_catalog'. Explaination: Instances of the class wont be
catalogged in portal_catalog anymore.
catalogmultiplex:white -- Add an archetypes class (identified by
meta_type) to one or more catalogs to be cataloged in. Comma-
separated list of catalogs. Example-value: 'myfancy_catalog,
another_catalog'. Explaination: Additionally to the default
'portal_catalog' the instances of this class will be catalogged in
the two given catalogs.
cmf_target_version -- Controls CMF Version specific behaviour, primary
to avoid 'Deprecation warnings.' Defaults to '1.4'.
copyright -- You can set the copyright project-wide with the '--
copyright' commandline parameter (or in the config file). This TGV
allows you to use/ overwrite it on a model level.
creation_permission -- Sets the creation permission for the class.
Example: 'Add portal content'.
creation_roles -- You can set an own role who should be able to add a
type. Use a Tuple of Strings. Default and example for this value:
'("Manager", "Owner", "Member")'.
default_view -- The 'TemplateMixin' class in Archetypes allows your
class to present several alternative view templates for a content
type. The 'default_view' value sets the default one. Defaults to
'base_view'. Only relevant if you use 'TemplateMixin'.
detailed_creation_permissions -- Give the content-type (types in the
package, model) own creation permissions, named automagically
'ProductName: Add ClassName'.
display_in_navigation -- Setting this boolean value adds the type to
'Displayed content types' in the portals navigation settings.
Default is True
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
email -- You can set the email project-wide with the '--email'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a model level.
generate_reference_fields -- Per default (True) navigable reference (or
relation) ends are resulting in a ReferenceField (or RelationField).
Setting this value to False results in not generating
ReferenceFields automagically.
global_allow -- Overwrite the AGX-calculated 'global_allow' setting of
class. Setting it to '1' makes your content type addable everywhere
(in principle), setting it to '0' limits it to places where it's
explicitly allowed as content.
immediate_view -- Set the 'immediate_view' factory type information
value. This should be the name of a page template, and defaults to
'base_view'. Note that Plone at this time does not make use of
'immediate_view', which in CMF core allows you to specify a
different template to be used when an object is first created from
when it is subsequently accessed.
imports -- A list of python import statements which will be placed at
the top of the generated file. Use this to make new field and widget
types available, for example. Note that in the generated code you
will be able to enter additional import statements in a preserved
code section near the top of the file. Prefer using the imports
tagged value when it imports something that is directly used by
another element in your model. You can have several import
statements, one per line, or by adding several tagged values with
the name 'imports'.
label -- Sets the readable name.
license -- You can set the license project-wide with the '--license'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a model level.
migrate_dynamic_view_fti -- Migrates FTI of a type/class to
CMFDynamicViewFTI. This works only if the class derives from an
ATContentType, from ATCTMixIn or direct from
CMFDynamicViewFTI.browserdefault.BrowserDefaultMixin.
module -- Like 'module_name', it overwrites the name of the directory
it'd be normally placed in.
module_name -- Like 'module', it overwrites the name of the directory
it'd be normally placed in.
read_permission -- Defines archetypes fields read-permission. Use it
together with workflow to control ability to view fields based on
roles/permissions.
relation_implementation -- Sets the type of implementation is used for
an association: 'basic' (used as default) for classic style
archetypes references or 'relations' for use of the 'Relations'
Product.
searchable -- Per default a fields 'searchable' property is set to
False. Sometimes you want it for all fields True. This TGV let you
define the default for a class, package or model.
searchable_type -- Setting this boolean value adds the type to 'types
to be searched' in the portals search settings. Default is True
suppl_views -- The 'TemplateMixin' class in Archetypes allows your
class to present several alternative view templates for a content
type. The 'suppl_views' value sets the available views. Example:
'("my_view", "myother_view")'. Defaults to '()'. Only relevant if
you use 'TemplateMixin'.
use_portal_factory -- Setting this boolean value enables the
registration of the type for use with portal_factory.
use_workflow -- Tie the class to the named workflow. A state diagram
(=workflow) attached to a class in the UML diagram is automatically
used as that class's workflow; this tagged value allows you to tie
the workflow to other classes.
version_info -- Add ArchGenXML version information to the generated
file (default is 1).
vocabulary:type -- Enables support for Products 'ATVocabularyManager'
by setting value to 'ATVocabularyManager'.
vocabulary:vocabulary_type -- For use with 'ATVocabularyManager'.
Defaults to 'Simplevocabulary'. Let you define the portal_type of
the vocabulary used as initial vocabulary at Product install time.
If VdexVocabulary is used, the install-script tries to install a
vocabulary from a vdex file names
'Products/PRODUCTNAME/data/VOCABULARYNAME.vdex'.
write_permission -- Defines archetypes fields write-permission. Use it
together with workflow to control ability to write data to a field
based on roles/permissions.
package
association_class -- You can use associations classes to store content
on the association itself. The class used is specified by this
setting. Don't forget to import the used class properly.
association_vocabulary -- Switch, defaults to False. Needs Product
'ATVocabularyManager'. Generates an empty vocabulary with the name
of the relation.
author -- You can set the author project-wide with the '--author'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a package level.
catalogmultiplex:black -- Remove an archetypes class (identified by
meta_type) from one or more catalogs to be cataloged in. Comma-
separated list of catalogs. Example-value: 'portal_catalog,
another_catalog'. Explaination: Instances of the class wont be
catalogged in portal_catalog anymore.
catalogmultiplex:white -- Add an archetypes class (identified by
meta_type) to one or more catalogs to be cataloged in. Comma-
separated list of catalogs. Example-value: 'myfancy_catalog,
another_catalog'. Explaination: Additionally to the default
'portal_catalog' the instances of this class will be catalogged in
the two given catalogs.
cmf_target_version -- Controls CMF Version specific behaviour, primary
to avoid 'Deprecation warnings.' Defaults to '1.4'.
copyright -- You can set the copyright project-wide with the '--
copyright' commandline parameter (or in the config file). This TGV
allows you to use/ overwrite it on a package level.
creation_permission -- Sets the creation permission for the class.
Example: 'Add portal content'.
creation_roles -- You can set an own role who should be able to add a
type. Use a Tuple of Strings. Default and example for this value:
'("Manager", "Owner", "Member")'.
default_view -- The 'TemplateMixin' class in Archetypes allows your
class to present several alternative view templates for a content
type. The 'default_view' value sets the default one. Defaults to
'base_view'. Only relevant if you use 'TemplateMixin'.
detailed_creation_permissions -- Give the content-type (types in the
package, model) own creation permissions, named automagically
'ProductName: Add ClassName'.
display_in_navigation -- Setting this boolean value adds the type to
'Displayed content types' in the portals navigation settings.
Default is True
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
email -- You can set the email project-wide with the '--email'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a package level.
generate_reference_fields -- Per default (True) navigable reference (or
relation) ends are resulting in a ReferenceField (or RelationField).
Setting this value to False results in not generating
ReferenceFields automagically.
global_allow -- Overwrite the AGX-calculated 'global_allow' setting of
class. Setting it to '1' makes your content type addable everywhere
(in principle), setting it to '0' limits it to places where it's
explicitly allowed as content.
immediate_view -- Set the 'immediate_view' factory type information
value. This should be the name of a page template, and defaults to
'base_view'. Note that Plone at this time does not make use of
'immediate_view', which in CMF core allows you to specify a
different template to be used when an object is first created from
when it is subsequently accessed.
imports -- A list of python import statements which will be placed at
the top of the generated file. Use this to make new field and widget
types available, for example. Note that in the generated code you
will be able to enter additional import statements in a preserved
code section near the top of the file. Prefer using the imports
tagged value when it imports something that is directly used by
another element in your model. You can have several import
statements, one per line, or by adding several tagged values with
the name 'imports'.
label -- Sets the readable name.
license -- You can set the license project-wide with the '--license'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a package level.
migrate_dynamic_view_fti -- Migrates FTI of a type/class to
CMFDynamicViewFTI. This works only if the class derives from an
ATContentType, from ATCTMixIn or direct from
CMFDynamicViewFTI.browserdefault.BrowserDefaultMixin.
module -- Like 'module_name', it overwrites the name of the directory
it'd be normally placed in.
module_name -- Like 'module', it overwrites the name of the directory
it'd be normally placed in.
read_permission -- Defines archetypes fields read-permission. Use it
together with workflow to control ability to view fields based on
roles/permissions.
relation_implementation -- Sets the type of implementation is used for
an association: 'basic' (used as default) for classic style
archetypes references or 'relations' for use of the 'Relations'
Product.
searchable -- Per default a fields 'searchable' property is set to
False. Sometimes you want it for all fields True. This TGV let you
define the default for a class, package or model.
searchable_type -- Setting this boolean value adds the type to 'types
to be searched' in the portals search settings. Default is True
suppl_views -- The 'TemplateMixin' class in Archetypes allows your
class to present several alternative view templates for a content
type. The 'suppl_views' value sets the available views. Example:
'("my_view", "myother_view")'. Defaults to '()'. Only relevant if
you use 'TemplateMixin'.
use_portal_factory -- Setting this boolean value enables the
registration of the type for use with portal_factory.
use_workflow -- Tie the class to the named workflow. A state diagram
(=workflow) attached to a class in the UML diagram is automatically
used as that class's workflow; this tagged value allows you to tie
the workflow to other classes.
version_info -- Add ArchGenXML version information to the generated
file (default is 1).
vocabulary:type -- Enables support for Products 'ATVocabularyManager'
by setting value to 'ATVocabularyManager'.
vocabulary:vocabulary_type -- For use with 'ATVocabularyManager'.
Defaults to 'Simplevocabulary'. Let you define the portal_type of
the vocabulary used as initial vocabulary at Product install time.
If VdexVocabulary is used, the install-script tries to install a
vocabulary from a vdex file names
'Products/PRODUCTNAME/data/VOCABULARYNAME.vdex'.
write_permission -- Defines archetypes fields write-permission. Use it
together with workflow to control ability to write data to a field
based on roles/permissions.
portlet
author -- You can set the author project-wide with the '--author'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a portlet level.
autoinstall -- Set to 'left' or 'right' to automatically install the
portlet (a class with the stereotype '<<portlet>>') with the product
in the left or right slots, respectively. If it already exists in
the slot it won't get overwritten.
copyright -- You can set the copyright project-wide with the '--
copyright' commandline parameter (or in the config file). This TGV
allows you to use/ overwrite it on a portlet level.
creation_permission -- Sets the creation permission for the class.
Example: 'Add portal content'.
creation_roles -- You can set an own role who should be able to add a
type. Use a Tuple of Strings. Default and example for this value:
'("Manager", "Owner", "Member")'.
default_view -- The 'TemplateMixin' class in Archetypes allows your
class to present several alternative view templates for a content
type. The 'default_view' value sets the default one. Defaults to
'base_view'. Only relevant if you use 'TemplateMixin'.
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
email -- You can set the email project-wide with the '--email'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a portlet level.
immediate_view -- Set the 'immediate_view' factory type information
value. This should be the name of a page template, and defaults to
'base_view'. Note that Plone at this time does not make use of
'immediate_view', which in CMF core allows you to specify a
different template to be used when an object is first created from
when it is subsequently accessed.
imports -- A list of python import statements which will be placed at
the top of the generated file. Use this to make new field and widget
types available, for example. Note that in the generated code you
will be able to enter additional import statements in a preserved
code section near the top of the file. Prefer using the imports
tagged value when it imports something that is directly used by
another element in your model. You can have several import
statements, one per line, or by adding several tagged values with
the name 'imports'.
label -- Sets the readable name.
license -- You can set the license project-wide with the '--license'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a portlet level.
module -- Like 'module_name', it overwrites the name of the directory
it'd be normally placed in.
module_name -- Like 'module', it overwrites the name of the directory
it'd be normally placed in.
suppl_views -- The 'TemplateMixin' class in Archetypes allows your
class to present several alternative view templates for a content
type. The 'suppl_views' value sets the available views. Example:
'("my_view", "myother_view")'. Defaults to '()'. Only relevant if
you use 'TemplateMixin'.
view -- Set the name of the portlet. Defaults to the method name. This
will be used as the name of the auto-created page template for the
portlet.
state
description -- Sets the state description.
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
initial_state -- Sets this state to be the initial state. This allows
you to use a normal state in your UML diagram instead of the special
round starting-state symbol.
label -- Sets the readable name.
worklist -- Attach objects in this state to the named worklist. An
example of a worklist is the to-review list.
worklist:guard_permissions -- Sets the permissions needed to be allowed
to view the worklist. Default value is 'Review portal content'.
worklist:guard_roles -- Sets the roles needed to be allowed to view the
worklist. No default value
state transition
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
label -- Sets the readable name.
trigger_type -- Sets the trigger type, following what is defined by
DCWorkflow: 0 : Automatic 1 : User Action (default) 2 : Workflow
Method
url -- Action URL, need 'PloneWorkflowTransitions' to see it in Plone.
tool
author -- You can set the author project-wide with the '--author'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a tool level.
autoinstall -- Set to true (1) to automatically install the tool when
your product is installed.
configlet -- Set to true (1) to set up a configlet in the Plone control
panel for your tool.
configlet:condition -- A TALES expresson defining a condition which
will be evaluated to determine whether the configlet should be
displayed.
configlet:description -- A description of the configlet.
configlet:icon -- The name of an image file, which must be in your
product's skin directory, used as the configlet icon.
configlet:permission -- A permission which is required for the
configlet to be displayed.
configlet:section -- The section of the control panel where the
configlet should be displayed. One of 'Plone', 'Products' (default)
or 'Member'. **warning**: older documentation versions mentioned
'Members' here.
configlet:title -- The name of the configlet.
configlet:view -- The id of the view template to use when first opening
the configlet. By default, the 'view' action of the object is used
(which is usually base_view)
copyright -- You can set the copyright project-wide with the '--
copyright' commandline parameter (or in the config file). This TGV
allows you to use/ overwrite it on a tool level.
creation_permission -- Sets the creation permission for the class.
Example: 'Add portal content'.
creation_roles -- You can set an own role who should be able to add a
type. Use a Tuple of Strings. Default and example for this value:
'("Manager", "Owner", "Member")'.
default_view -- The 'TemplateMixin' class in Archetypes allows your
class to present several alternative view templates for a content
type. The 'default_view' value sets the default one. Defaults to
'base_view'. Only relevant if you use 'TemplateMixin'.
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
email -- You can set the email project-wide with the '--email'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a tool level.
immediate_view -- Set the 'immediate_view' factory type information
value. This should be the name of a page template, and defaults to
'base_view'. Note that Plone at this time does not make use of
'immediate_view', which in CMF core allows you to specify a
different template to be used when an object is first created from
when it is subsequently accessed.
imports -- A list of python import statements which will be placed at
the top of the generated file. Use this to make new field and widget
types available, for example. Note that in the generated code you
will be able to enter additional import statements in a preserved
code section near the top of the file. Prefer using the imports
tagged value when it imports something that is directly used by
another element in your model. You can have several import
statements, one per line, or by adding several tagged values with
the name 'imports'.
label -- Sets the readable name.
license -- You can set the license project-wide with the '--license'
commandline parameter (or in the config file). This TGV allows you
to use/ overwrite it on a tool level.
module -- Like 'module_name', it overwrites the name of the directory
it'd be normally placed in.
module_name -- Like 'module', it overwrites the name of the directory
it'd be normally placed in.
suppl_views -- The 'TemplateMixin' class in Archetypes allows your
class to present several alternative view templates for a content
type. The 'suppl_views' value sets the available views. Example:
'("my_view", "myother_view")'. Defaults to '()'. Only relevant if
you use 'TemplateMixin'.
tool_instance_name -- The id to use for the tool. Defaults to
'portal_<name>', where <name> is the class name in lowercase.
toolicon -- The name of an image file, which must be found in the skins
directory of the product. This will be used to represent your tool
in the Zope Management Interface.
widget
description -- Sets a description for this widget. It's used for widget
documentation while registering inside Archetypes.
documentation -- You can add documention via this tag; it's better to
use your UML tool's documentation field.
label -- Sets the readable name.
macro -- Sets the macro used by the widget. This will be used as the
name of the auto-created page template for the widget.
show_hm -- Setting this boolean value to False will show only the date
entry.
title -- Sets the widget title. It's used for widget documentation
while registering inside Archetypes.
used_for -- Sets the possible fields which can use this widget. It's
used for widget documentation while registering inside Archetypes.
The list has the form: '"Products.Archetypes.Field.Field1Name",
"Products.Archetypes.Field.FieldName2"'.
Visit our