pyams_content.component.paragraph.interfaces package ⊞

interface pyams_content.component.paragraph.interfaces.IBaseParagraph

Extends: pyams_content.features.renderer.interfaces.IRenderedContent, zope.annotation.interfaces.IAttributeAnnotatable

Base paragraph interface

__parent__

Implementation:zope.schema.Field Read Only:False Required:True Default Value:None

icon_class

Icon class in paragraphs list

icon_hint

Icon hint in paragraphs list

visible

Visible?

Is this paragraph visible in front-office?

Implementation:zope.schema.Bool Read Only:False Required:True Default Value:True Allowed Type:bool

anchor

Anchor?

Is this paragraph a navigation anchor?

Implementation:zope.schema.Bool Read Only:False Required:True Default Value:False Allowed Type:bool

title

§ Title

Implementation:pyams_i18n.schema.I18nTextLineField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

interface pyams_content.component.paragraph.interfaces.IParagraphContainer

Extends: zope.container.interfaces.IOrderedContainer

Paragraphs container

__setitem__(key, value)

Add the given object to the container under the given name.

Raises a TypeError if the key is not a unicode or ascii string.

Raises a ValueError if the key is empty, or if the key contains a character which is not allowed in an object name.

Raises a KeyError if the key violates a uniqueness constraint.

The container might choose to add a different object than the one passed to this method.

If the object doesn’t implement IContained, then one of two things must be done:

1. If the object implements ILocation, then the IContained interface must be declared for the object.
2. Otherwise, a ContainedProxy is created for the object and stored.

The object’s __parent__ and __name__ attributes are set to the container and the given name.

If the old parent was None, then an IObjectAddedEvent is generated, otherwise, an IObjectMovedEvent is generated. An IContainerModifiedEvent is generated for the container.

If the object replaces another object, then the old object is deleted before the new object is added, unless the container vetos the replacement by raising an exception.

If the object’s __parent__ and __name__ were already set to the container and the name, then no events are generated and no hooks. This allows advanced clients to take over event generation.

append(self, value)

Add given value to container

get_visible_paragraphs(self, names=None, anchors_only=False, factories=None)

Get visible paragraphs matching given arguments

interface pyams_content.component.paragraph.interfaces.IParagraphContainerTarget

Extends: zope.annotation.interfaces.IAttributeAnnotatable

Paragraphs container marker interface

interface pyams_content.component.paragraph.interfaces.IParagraphFactory

Paragraph factory utility interface

name

Factory name

content_type

Factory content type

custom_menu

Display factory in ‘custom’ paragraphs menu

interface pyams_content.component.paragraph.interfaces.IParagraphFactorySettings

Paragraph factory settings interface

This interface is used to defined default auto-created paragraphs for a given shared tool.

allowed_paragraphs

Allowed paragraphs

List of paragraphs allowed for this content type

Implementation:zope.schema.Set Read Only:False Required:False Default Value:None Allowed Type:set

Value Type

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:None

auto_created_paragraphs

Default paragraphs

List of paragraphs automatically added to a new content

Implementation:zope.schema.List Read Only:False Required:False Default Value:None Allowed Type:list

Value Type

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:None

interface pyams_content.component.paragraph.interfaces.IParagraphRenderer

Extends: zope.contentprovider.interfaces.IContentProvider

Paragraph renderer interface

language

Preview language

interface pyams_content.component.paragraph.interfaces.IParagraphTitle

Paragraph title adapter

pyams_content.component.paragraph.interfaces.audio

interface pyams_content.component.paragraph.interfaces.audio.IAudioParagraph

Extends: pyams_content.component.paragraph.interfaces.IBaseParagraph

Audio paragraph

data

Audio data

Audio file content

Implementation:pyams_file.schema.AudioField Read Only:False Required:True Default Value:None Allowed Type:bytes

title

Legend

Implementation:pyams_i18n.schema.I18nTextLineField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

author

Author

Name of document’s author

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

description

Description

File description displayed by front-office template

Implementation:pyams_i18n.schema.I18nTextField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.Text Read Only:False Required:False Default Value:None Allowed Type:str

renderer

Audio template

Presentation template used for this audio file

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:‘default’

pyams_content.component.paragraph.interfaces.contact

pyams_content.component.paragraph.interfaces.frame

interface pyams_content.component.paragraph.interfaces.frame.IFrameParagraph

Extends: pyams_content.component.paragraph.interfaces.IBaseParagraph

Framed text paragraph interface

body

Frame body

Implementation:pyams_i18n.schema.I18nHTMLField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:pyams_utils.schema.HTMLField Read Only:False Required:False Default Value:None Allowed Type:str

renderer

Text template

Presentation template used for this paragraph

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:‘default’

pyams_content.component.paragraph.interfaces.header

interface pyams_content.component.paragraph.interfaces.header.IHeaderParagraph

Extends: pyams_content.component.paragraph.interfaces.IBaseParagraph

Header paragraph

header

Header

Implementation:pyams_i18n.schema.I18nTextField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.Text Read Only:False Required:False Default Value:None Allowed Type:str

renderer

Header template

Presentation template used for this header

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:‘default’

pyams_content.component.paragraph.interfaces.html

interface pyams_content.component.paragraph.interfaces.html.IHTMLParagraph

Extends: pyams_content.component.paragraph.interfaces.IBaseParagraph

Rich text paragraph interface

body

Body

Implementation:pyams_i18n.schema.I18nHTMLField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:pyams_utils.schema.HTMLField Read Only:False Required:False Default Value:None Allowed Type:str

renderer

Body template

Presentation template used for this paragraph

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:‘default’

interface pyams_content.component.paragraph.interfaces.html.IRawParagraph

Extends: pyams_content.component.paragraph.interfaces.IBaseParagraph

Raw HTML paragraph interface

body

Source code

<span>This code will be used ‘as is’, without any transformation, if using the ‘raw’ renderer. Use with care!!<br />Press &lt;CTRL&gt;+&lt;,&gt; to display editor options…</span>

Implementation:pyams_i18n.schema.I18nTextField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.Text Read Only:False Required:False Default Value:None Allowed Type:str

renderer

Source code template

Presentation template used for this paragraph

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:‘default’

pyams_content.component.paragraph.interfaces.keypoint

interface pyams_content.component.paragraph.interfaces.keypoint.IKeypointsParagraph

Extends: pyams_content.component.paragraph.interfaces.IBaseParagraph

Key points paragraph

body

Key points

Enter one key point by line, without hyphen or prefix

Implementation:pyams_i18n.schema.I18nTextField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.Text Read Only:False Required:False Default Value:None Allowed Type:str

renderer

Presentation template

Presentation template used for this paragraph

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:‘default’

pyams_content.component.paragraph.interfaces.map

interface pyams_content.component.paragraph.interfaces.map.IMapParagraph

Extends: pyams_content.component.paragraph.interfaces.IBaseParagraph

Map paragraph interface

gps_location

GPS location

GPS coordinates used to locate map

Implementation:pyams_gis.schema.GeoPointField Read Only:False Required:False Default Value:None Must Provide:pyams_gis.interfaces.IGeoPoint

display_marker

Display location mark?

If ‘yes’, a location marker will be displayed on map

Implementation:zope.schema.Bool Read Only:False Required:True Default Value:True Allowed Type:bool

renderer

Map template

Presentation template used for this map

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:‘default’

pyams_content.component.paragraph.interfaces.milestone

pyams_content.component.paragraph.interfaces.pictogram

interface pyams_content.component.paragraph.interfaces.pictogram.IPictogramContainer

Extends: pyams_content.interfaces.container.IOrderedContainer

Pictogram items container interface

__setitem__(key, value)

Add the given object to the container under the given name.

Raises a TypeError if the key is not a unicode or ascii string.

Raises a ValueError if the key is empty, or if the key contains a character which is not allowed in an object name.

Raises a KeyError if the key violates a uniqueness constraint.

The container might choose to add a different object than the one passed to this method.

If the object doesn’t implement IContained, then one of two things must be done:

1. If the object implements ILocation, then the IContained interface must be declared for the object.
2. Otherwise, a ContainedProxy is created for the object and stored.

The object’s __parent__ and __name__ attributes are set to the container and the given name.

If the old parent was None, then an IObjectAddedEvent is generated, otherwise, an IObjectMovedEvent is generated. An IContainerModifiedEvent is generated for the container.

If the object replaces another object, then the old object is deleted before the new object is added, unless the container vetos the replacement by raising an exception.

If the object’s __parent__ and __name__ were already set to the container and the name, then no events are generated and no hooks. This allows advanced clients to take over event generation.

append(self, value, notify=True)

Append given pictogram item to container

get_visible_items(self)

Get list of visible pictogram items

interface pyams_content.component.paragraph.interfaces.pictogram.IPictogramContainerTarget

Pictogram container target interface

interface pyams_content.component.paragraph.interfaces.pictogram.IPictogramItem

Extends: zope.annotation.interfaces.IAttributeAnnotatable

Pictogram item interface

__parent__

Implementation:zope.schema.Field Read Only:False Required:True Default Value:None

visible

Visible?

Is this pictogram visible in front-office?

Implementation:zope.schema.Bool Read Only:False Required:True Default Value:True Allowed Type:bool

pictogram_name

Pictogram

Name of the pictogram to select

Implementation:zope.schema.Choice Read Only:False Required:False Default Value:None

pictogram

Select pictogram object

label

Alternate header

Alternate pictogram label; if not specified, the pictogram header will be used

Implementation:pyams_i18n.schema.I18nTextLineField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

body

Associated text

Additional text associated to this pictogram

Implementation:pyams_i18n.schema.I18nTextField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.Text Read Only:False Required:False Default Value:None Allowed Type:str

interface pyams_content.component.paragraph.interfaces.pictogram.IPictogramParagraph

Extends: pyams_content.component.paragraph.interfaces.pictogram.IPictogramContainerTarget, pyams_content.component.paragraph.interfaces.IBaseParagraph

Pictograms paragraph interface

renderer

Pictograms template

Presentation template used for pictograms

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:‘default’

pyams_content.component.paragraph.interfaces.verbatim

interface pyams_content.component.paragraph.interfaces.verbatim.IVerbatimParagraph

Extends: pyams_content.component.paragraph.interfaces.IBaseParagraph

Verbatim paragraph interface

quote

Quoted text

Quotation marks will be added automatically by presentation template

Implementation:pyams_i18n.schema.I18nTextField Read Only:False Required:True Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.Text Read Only:False Required:False Default Value:None Allowed Type:str

author

Author

Name of the quote author

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

charge

In charge of

Label of author function

Implementation:pyams_i18n.schema.I18nTextLineField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

renderer

Verbatim template

Presentation template used for this paragraph

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:‘default’

pyams_content.component.paragraph.interfaces.video

interface pyams_content.component.paragraph.interfaces.video.IVideoParagraph

Extends: pyams_content.component.paragraph.interfaces.IBaseParagraph

Video paragraph

data

Video data

Video file content

Implementation:pyams_file.schema.VideoField Read Only:False Required:True Default Value:None Allowed Type:bytes

title

Legend

Implementation:pyams_i18n.schema.I18nTextLineField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.TextLine Read Only:False Required:False Default Value:None Allowed Type:str

author

Author

Name of document’s author

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

description

Associated text

Video description displayed by front-office template

Implementation:pyams_i18n.schema.I18nTextField Read Only:False Required:False Default Value:None Allowed Type:dict

Key Type

Implementation:zope.schema.TextLine Read Only:False Required:True Default Value:None Allowed Type:str

Value Type

Implementation:zope.schema.Text Read Only:False Required:False Default Value:None Allowed Type:str

renderer

Video template

Presentation template used for this video

Implementation:zope.schema.Choice Read Only:False Required:True Default Value:‘default’