معرفی شرکت ها
ftw.inflator-1.9.0
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Plone site setup wizard with content creation and bundle system for predefined configurations.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | ftw.inflator-1.9.0 |
| نام | ftw.inflator |
| نسخه کتابخانه | 1.9.0 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | 4teamwork AG |
| ایمیل نویسنده | mailto:info@4teamwork.ch |
| آدرس صفحه اصلی | https://github.com/4teamwork/ftw.inflator |
| آدرس اینترنتی | https://pypi.org/project/ftw.inflator/ |
| مجوز | GPL2 |
ftw.inflator
============
This packages helps predefining a Plone site setup including content
creation (using generic setup), defining multiple bundles and a wizard
for installing a new site with a bundle.
.. contents:: Table of Contents
Features
--------
- A simplified site setup wizard. The wizard can be customized and branded.
- A bundle system for defining variants in the setup configuration.
- A generic setup site creation import step which can be used in the bundles
for creating initial content. It can be used without using the setup wizard
and bundle system.
Installation
------------
- Add ``ftw.inflator`` to your buildout configuration:
.. code:: ini
[instance]
eggs +=
ftw.inflator
Dexterity support
~~~~~~~~~~~~~~~~~
For beeing able to create dexterity objects (Content Creation), install the `dexterity` extras:
.. code:: ini
[instance]
eggs +=
ftw.inflator [dexterity]
Compatibility
-------------
- Plone 4.3
- Plone 5.1
Setup wizard
------------
On the `manage_main` view of the Zope app there is an additional button
for installing your product.
It leads to the site setup wizard where an ID and a bundle can be selected.
The setup wizard allows to select one of a set of predefined bundles.
See the bundle section for details on how to define bundles.
.. image:: https://raw.github.com/4teamwork/ftw.inflator/master/docs/inflate.png
Wizard customizations
~~~~~~~~~~~~~~~~~~~~~
The product name and logo can easily be customized through ZCML:
.. code:: xml
<configure
xmlns="http://namespaces.zope.org/zope"
xmlns:inflator="http://namespaces.zope.org/inflator"
i18n_domain="my.package">
<include package="ftw.inflator" file="meta.zcml" />
<inflator:customize
product="Product Name"
image="resources/product-logo.png"
/>
</configure>
Bundle system
-------------
A bundle defines a list of profiles which are automatically applied when
creating a new Plone site with this bundle.
It has a base-profile (defaults to the Plone default base profile without
default content).
Defining bundles
~~~~~~~~~~~~~~~~
The bundles are defined in ZCML:
.. code:: xml
<configure
xmlns="http://namespaces.zope.org/zope"
xmlns:inflator="http://namespaces.zope.org/inflator"
i18n_domain="my.package">
<include package="ftw.inflator" file="meta.zcml" />
<inflator:bundle
title="ftw.inflator example bundle one"
profiles="plonetheme.sunburst:default
my.policy:default
my.policy:init-content"
/>
</configure>
ZCML-Attributes
~~~~~~~~~~~~~~~
title
The (translatable) title of the bundle, shown in the setup wizard.
profiles
One or multiple Generic Setup profiles (without ``profile-``-prefix).
description (optional)
The description of the bundle, shown in the setup wizard.
base (optional)
The Generic Setup base profile for creating the plone site.
This defaults to ``Products.CMFPlone:plone``, the default plone base
profile without content creation.
Using ``Products.CMFPlone:plone-content`` will generate the default
example content.
standard (optional)
By using the standard flag (``standard="True"``) you can define product bundles.
When registering custom bundles later without flagging them as standard, they
will appear above the standard bundles in the setup wizard and top is selected.
Full ZCML example:
.. code:: xml
<configure
xmlns="http://namespaces.zope.org/zope"
xmlns:inflator="http://namespaces.zope.org/inflator"
i18n_domain="ftw.inflator">
<include package="ftw.inflator" file="meta.zcml" />
<inflator:bundle
title="MyProduct with sunburst"
description="Installs MyProduct with the sunburst theme and plone default content"
profiles="plonetheme.sunburst:default
my.product:default"
base="Products.CMFPlone:plone-content"
standard="True"
/>
</configure>
Setting the language
~~~~~~~~~~~~~~~~~~~~
When installing a Plone site with the default add-site view, the language
is set in the ``Products.CMFPlone:plone-content``, which also creates example content.
This makes it hard to setup the language without creating the example content.
To solve this issue ``ftw.inflator`` provides a ``ftw.inflator:setup-language`` generic
setup profile, meant to be used while setting up a bundle.
You can add it to the list of bundle profiles. This sets the language of the Plone site
to the one selected in the setup wizard.
Using it as a dependency (in ``metadata.xml``) is not recommended, since it is not meant
to be used on a existing plone site.
Example usage in bundle definition:
.. code:: xml
<configure
xmlns="http://namespaces.zope.org/zope"
xmlns:inflator="http://namespaces.zope.org/inflator"
i18n_domain="my.package">
<include package="ftw.inflator" file="meta.zcml" />
<inflator:bundle
title="ftw.inflator example bundle one"
profiles="ftw.inflator:setup-language
my.policy:default"
/>
</configure>
Content creation
----------------
The content creation allows to define a ``content_creation`` folder in any
generic setup profile folder, containing JSON-files with definitions of the
content to create. The content is created when the generic setup profile is
applied.
Content creation features
~~~~~~~~~~~~~~~~~~~~~~~~~
- JSON based definition
- support for tree structure
- internationalization of strings
- construct instances of any archetypes FTIs
- add file- and image-fields
- create topic criterions
- execute workflow transition on creation
- create placeful workflow policies
- set properties
- set constraint types
- set per-object provided interfaces
- reindexing the catalog
- define and block local roles
Structure
~~~~~~~~~
Add a ``content_creation`` folder to your generic setup profile. All content
creation configurations are within this folder.
You can add as many ``*.json``-files as you want - they will be read
and executed in order of the sorted filename
(use integer prefixes for sorting them easily).
Folder creation example
~~~~~~~~~~~~~~~~~~~~~~~
For creating content create a JSON file (
e.g. ``profiles/default/content_creation/01-foo-folder.json``) and insert a
JSON syntax list of hashes (dicts).
Each hash creates a new object.
Example creating a folder with title "Foo" at ``/Plone/foo``:
.. code:: javascript
[
{
"_path": "foo",
"_type": "Folder",
"title": "Foo"
}
]
Tree structure example
~~~~~~~~~~~~~~~~~~~~~~
For nested structures it sometimes useful to define the JSON as tree.
Using the tree structure it is not necessary to repeat the path of the parent:
.. code:: javascript
[
{
"_path": "foo",
"_type": "Folder",
"title": "Foo",
"_children": [
{
"_id": "bar",
"_type": "Folder",
"title": "Bar"
},
{
"_path": "bar/qux",
"_type": "Folder",
"title": "Bar"
}
]
}
]
Be sure that the root node has a `_path` and all nodes in a `_children` list
have either an `_id` or a `_path`. The `_path` of a child node is considered to be relative to the parent node. The paths will then be automatically concatenated.
Internationalization
~~~~~~~~~~~~~~~~~~~~
Using the `key:translate(domain)` syntax in keys, the respective string value is
translated to the current default language of the Plone site.
When creating content while installing a bundle with inflator, be sure to install
the generic setup profile ``ftw.inflator:setup-language`` before creating the
content.
This will make sure the language is properly configured.
Example:
.. code:: javascript
[
{
"_path": "foo",
"_type": "Folder",
"title:translate(my.domain)": "Foo",
"_children": [
{
"_id:translate(my.domain)": "bar",
"_type": "Folder",
"title": "Bar"
}
]
}
]
Multilingual support
~~~~~~~~~~~~~~~~~~~~
When `plone.app.multilingual <https://pypi.python.org/pypi/plone.app.multilingual>`_ is installed
translated content can be generated for each language.
The translation is based on the `key:translate(domain)` syntax (see above) and can be translated
in regular .po-files.
Example:
.. code:: javascript
[
{"_multilingual": [
"en",
"de"],
"_contents": [
{
"_id": "foo",
"_type": "Folder",
"title:translate(my.domain)": "Foo"
}
]}
]
Make sure that each language in the "_multilingual" list is configured as supported
language in the `portal_languages.xml`:
.. code:: xml
<?xml version="1.0"?>
<object>
<default_language value="en"/>
<supported_langs>
<element value="en"/>
<element value="de"/>
</supported_langs>
</object>
The default setup of `plone.app.multilingual` is used for setting up the language folders.
`plone.app.multilingual` is using a special portal type for the language root folders and for the language independent folders. Sometimes it is useful to have a custom portal type as root and language independent folders. You can choose custom types through the `_folder_type` and `_folder_type_language_independent` properties:
.. code:: javascript
[
{"_multilingual": [
"en",
"de"],
"_folder_type": "my.custom.type",
"_folder_type_language_independent": "my.custom.type",
"_contents": []
}
]
Creating / setting properties
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Properties can easily be created.
If there already is a property (because the object exists already), it is
updated.
Example:
.. code:: javascript
[
{
"_path": "foo",
"_type": "Folder",
"title": "Foo",
"_properties": {
"layout": ["string", "folder_listing_view"]
}
}
]
Configuring constrain types
~~~~~~~~~~~~~~~~~~~~~~~~~~~
For configuring the addable types on a folder, use the ``_constrain_types``
keyword:
.. code:: javascript
[
{
"_path": "foo",
"_type": "Folder",
"title": "Foo",
"_constrain_types": {
"locally": ["Folder", "Document"],
"immediately": ["Folder"]
}
}
]
Provide additional interfaces
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
By passing a list of dottednames as ``_interfaces`` those interfaces will
automatically be provided (``alsoProvides``) by the created object:
.. code:: javascript
[
{
"_path": "foo",
"_type": "Folder",
"title": "Foo",
"_interfaces": [
"ftw.inflator.tests.interfaces.IFoo",
"remove:foo.bar.interfaces.IBar"
]
}
]
By prefixing the dotted name with ``remove:``, directly provided interfaces
can be removed (``noLongerProvides``).
Files and images
~~~~~~~~~~~~~~~~
File- and image-fields can easily be filled by using the ``:file`` postfix,
providing a relative path to the file to "upload":
.. code:: javascript
[
{
"_path": "files/example-file",
"_type": "File",
"title": "example file",
"file:file": "files/examplefile.txt"
}
]
The filename can be changed (although this does not work with multiple files
on the same Dexterity item):
.. code:: javascript
[
{
"_path": "files/example-file",
"_type": "File",
"title": "example file",
"file:file": "files/lkdfahjkewrhiu.txt",
"file:filename": "important.txt"
}
]
Workflow transitions
~~~~~~~~~~~~~~~~~~~~
With the ``_transitions`` keyword it is possible to execute a workflow
transition upon content creation:
.. code:: javascript
[
{
"_path": "foo",
"_type": "Folder",
"title": "Foo",
"_transitions": "publish"
}
]
Placeful workflow policies
~~~~~~~~~~~~~~~~~~~~~~~~~~
When placeful workflow policies are installed it is possible to activate them
on a folder using the ``_placefulworkflow`` keyword:
.. code:: javascript
[
{
"_path": "intranet",
"_type": "Folder",
"title": "Intranet",
"_placefulworkflow": ["intranet", "intranet"]
}
]
You need to install the Generic Setup profile
``Products.CMFPlacefulWorkflow:CMFPlacefulWorkflow`` for using placeful workflow policies.
Annotations
~~~~~~~~~~~
With the ``_annotations`` it is possible to set simple annotations on the
object.
Values of type ``dict`` are converted to ``PersistentMapping``, those of
type ``list`` are converted to ``PersistentList`` recursively.
Example:
.. code:: javascript
[
{
"_path": "intranet",
"_type": "Folder",
"title": "Intranet",
"_annotations": {"foo": {"bar": [1, 2, 3]}}
}
]
Portlets
~~~~~~~~
Portlets can easily be defined by using the ``_portlets`` key, expecting a dict (portlet_manager : configuration).
It is possible to define the context portlets assignments (``assignments``) and set the inheritance settings (``blacklist_status``).
.. code:: javascript
[
{
"_path": "foo",
"_type": "MyType",
"title": "Foo",
"_portlets": {
"plone.leftcolumn": {
"blacklist_status": {
"context": "block",
"user": "show",
"group": "acquire"
},
"assignments": [
{"id": "new_navigation",
"portlet_type": "portlets.Navigation",
"name": "New Navigation",
"bottomLevel": 0,
"includeTop": false,
"topLevel": 1}
]
}
}
}
]
UUID Lookup
~~~~~~~~~~~
Sometimes you need to have the UUID of another object.
Since the UUID is generated randomly when creating the object you cannot
predict it in a .json-file.
The UUID lookup helps you here:
.. code:: javascript
[
{
"_path": "foo",
"_type": "MyType",
"title": "Foo",
"relations": "resolveUUID::bar"
}
]
Using the ``resolveUUID::path`` syntax the value is replaced with UUID of the
object which has the ``path``.
You can prefix the value with a `/` for making it relative to the site root,
otherwise it is relative to the item it is defined in ("Foo" in the above
example).
Path Lookup
~~~~~~~~~~~
Sometimes you need to resolve an already created object by its path.
The resolve-path section helps you here:
.. code:: javascript
[
{
"_path": "foo",
"_type": "MyType",
"title": "Foo",
"relations": "resolvePath::bar"
}
]
Using the ``resolvePath::path`` syntax the value is replaced with the resolved object.
You can prefix the value with a `/` for making it relative to the site root,
otherwise it is relative to the item it is defined in ("Foo" in the above
example).
Local roles example
~~~~~~~~~~~~~~~~~~~
You can configure local roles and block local as following:
.. code:: javascript
[
{
"_path": "foo",
"_type": "MyType",
"title": "Foo",
"_ac_local_roles": {
"admin": [
"Owner"
]
},
"_block-local-roles": true
}
]
For details, see: https://collectivejsonmigrator.readthedocs.io/en/latest/ac_local_roles.html
Import single items
~~~~~~~~~~~~~~~~~~~
The inflator's transmogrifier config can be used in code for importing
single items by using the ``single_item_content_creation`` configuration:
.. code:: python
item = {'_path': 'foo',
'_type': 'Folder',
'title': 'Foo'}
mogrifier = Transmogrifier(portal)
mogrifier(u'ftw.inflator.creation.single_item_content_creation',
jsonsource=dict(item=item))
Links
-----
- Github: https://github.com/4teamwork/ftw.inflator
- Issues: https://github.com/4teamwork/ftw.inflator/issues
- Pypi: http://pypi.python.org/pypi/ftw.inflator
- Continuous integration: https://jenkins.4teamwork.ch/search?q=ftw.inflator
Copyright
---------
This package is copyright by `4teamwork <http://www.4teamwork.ch/>`_.
``ftw.inflator`` is licensed under GNU General Public License, version 2.
Changelog
=========
1.12.1 (2019-11-26)
-------------------
- Remove old generic setup dependency for Products.PloneLanguageTool. [jone]
- Fix tests for ftw.testing >= 2.0. [buchi]
1.12.0 (2019-11-08)
-------------------
- Replace discontinued collective.blueprint.jsonmigrator with collective.jsonmigrator. [djowett-ftw]
1.11.0 (2019-06-13)
-------------------
- Implement possibility to override the default plone.app.multilingual root and
language independent folder types. [elioschmutz]
- Fix Plone 4 support with plone.app.multilingual 2.x which should be the default for new Plone 4 projects. [elioschmutz]
1.10.0 (2019-03-19)
-------------------
- Plone 5.1 compatibility [mathias.leimgruber, jone, busykoala, njohner]
- Drop Plone 4.2 support [busykoala]
1.9.0 (2018-05-14)
------------------
- Add portlets updater section, to allow the creation of portlets. [phgross]
1.8.1 (2016-08-12)
------------------
- Fix multilingual import error in Plone 5. [Guido A.J. Stevens]
1.8.0 (2016-05-20)
------------------
- Show install button even when there's already a site installed. [raphael-s]
- Drop Plone 4.1 support. [jone]
- Let ":filename" key postfix change the filename. [jone]
1.7.0 (2016-03-15)
------------------
- Content creation: log the progress. [jone]
1.6.0 (2016-03-04)
------------------
- Fix multilingual import error.
[elioschmutz]
- Add transmogrifier config for creating single items.
[jone]
1.5 (2015-04-22)
----------------
- Use ftw.profilehook instead of custom import steps (setuphandlers).
[jone]
- Add section to resolve objects by their path.
[deiferni]
1.4 (2014-06-05)
----------------
- Add local-role definitions and blocking local roles.
[phgross, deif]
1.3.2 (2014-03-10)
------------------
- Add relative path support to initial content child nodes.
[deif]
1.3.1 (2014-01-27)
------------------
- Add support for dexterity file creation.
[deif]
1.3.0 (2014-01-21)
------------------
- Implement support for setting properties on multilingual root folders.
[deif]
1.2.1 (2014-01-16)
------------------
- Fix unresolved generic setup import step dependencies.
"languagetool" is only available when plone.app.multilingual is installed.
[jone]
1.2 (2013-12-11)
----------------
- Implement plone.app.multilingual support for content creation.
[jone]
1.1.2 (2013-05-30)
------------------
- Make sure that the Products.CMFPlone ZMI patches are applied
prior to our patches.
[jone]
1.1.1 (2013-05-24)
------------------
- Support UTF-8 encoded strings as value for :translate().
[treinhard]
1.1 (2013-02-27)
----------------
- Implement UUID lookup.
[jone]
- Add Dexterity support to content creation. Use the `ftw.inflator[dexterity]` extras.
[jone]
- Run content creation after type creation.
[jone]
- Move site creation into bundle class, so that a site with a
bundle can be created without using the view.
This is useful for tests or automated setups.
[jone]
- Support internationalization with `key:translate(domain)`
key syntax.
[jone]
- Add support for nested tree structures.
[jone]
1.0.1 (2013-02-13)
------------------
- Fix bad page template expression.
[jone]
1.0 (2013-02-13)
----------------
- Initial implementation.
[jone]
نحوه نصب
نصب پکیج whl ftw.inflator-1.9.0:
pip install ftw.inflator-1.9.0.whl
نصب پکیج tar.gz ftw.inflator-1.9.0:
pip install ftw.inflator-1.9.0.tar.gz