kotti_settings 0.3

设置

要激活kotti站点中的kotti_settings加载项，您需要 在粘贴中的kotti.configurators设置中添加一个条目 部署配置。如果没有kotti.configurators选项， 加一个。您的[app:main]（或[app:kotti]中的行，具体取决于 然后，您可以设置fanstatic）部分如下：

kotti.configurators = kotti_settings.kotti_configure

加载项将添加一个新的配置页以保存模块的设置或 跨越不同的模块。它向 菜单点“站点设置”。每个设置集合都显示在一个选项卡中。它 旨在为模块使用一个选项卡，但也可以使用 如果需要更扩展的结构，可以使用多个选项卡。

您可以选择两种模式来设置设置。使用“dict模式” 您有一个非常简单和直接的设置选项。如果你 需要更高级的表单，您可以设置自己的架构。

设置选项卡是用字典设置的。在这里，您定义一个名称和 标签的标题，需要什么。可选参数是成功消息， 设置或架构、架构工厂和使用CSRF令牌。

在字典中定义设置：

TestSettings = {
'name': 'test_settings',
'title': "Testsettings",
'description': "Some description for my settings",
'success_message': u"Successfully saved test settings.",
'settings': [
    {'type': 'String',
     'name': 'testsetting_1',
     'title': 'Test 1',
     'description': 'a test setting',
     'default': '', },
    {'type': 'Integer',
     'name': 'testsetting_2',
     'title': 'Test 2',
     'description': 'again a test setting',
     'default': 23, }]}

使用模式定义设置：

class StringSchemaNode(colander.SchemaNode):
    name = 'a_string'
    title = 'hello'
    default = 'hello world'

class RangedIntSchemaNode(colander.SchemaNode):
    name = 'range_int'
    validator = colander.Range(0, 10)
    default = 5
    title = 'Ranged Int'

class TestSchema(colander.MappingSchema):
    string = StringSchemaNode(colander.String())
    ranged_int = RangedIntSchemaNode(colander.Int())

TestSettings = {
    'name': 'test_settings',
    'title': "Testsettings",
    'description': "Some description for my settings",
    'success_message': u"Successfully saved test settings.",
    'schema_factory': TestSchema
}

若要在kotti_settings内注册配置，请添加 加载项中填充器中的设置。查看kotti文档 获取有关populators的更多信息并查看example。

在populator中添加设置配置，例如在名为populate.py的文件中：

def populate():
    from kotti_settings.util import add_settings
    add_settings(TestSettings)

并将其添加到您的配置中：

def kotti_configure(settings):
    settings['kotti.populators'] += ' my_addon.populate.populate'

或者直接指向您的ini文件：

kotti.populators = my_addon.populate.populate

要将设置恢复到代码中，请使用以下命令：

from kotti_settings.util import get_setting

first_test_setting = get_setting('test_setting_1')

from pyramid.events import subscriber
from kotti_settings.events import SettingsAfterSave

@subscriber(SettingsAfterSave)
def do_something_when_settings_saved(event):
    # Check if the settings for this module was saved.
    if not event.module == __package__:
        return
    my_fancy_thing()

from kotti.views.slots import assign_slot
from kotti_settings.config import SlotSchemaNode
from kotti_settings.config import ShowInContextSchemaNode
from kotti_settings.util import add_settings
from kotti_settings.util import get_setting
from kotti_myaddon import _

class MyWidgetSchema(colander.MappingSchema):
    slot = SlotSchemaNode(colander.String())
    show_in_context = ShowInContextSchemaNode(colander.String())

MyAddonSettings = {
    'name': 'myaddon_settings',
    'title': _(u'My Addon Settings'),
    'description': _(u"Settings for my addon"),
    'success_message': _(u"Successfully saved my addon settings."),
    'schema_factory': MyAddonSchema,
}

def populate():
    add_settings(MyAddonSettings)

更改日志