Download Read the Docs Template Documentation

Transcript
Read the Docs Template Documentation, Release 1.9.2
DisplayType
Scopes the contained Place tags to a specific display type.
You can define your own custom display types when developing content parts or fields, but Orchard uses standard
ones:
• Detail - Used when rendering a single item, e.g. a blog post
• Summary - Used when rendering a list of items
• SummaryAdmin - Used when rending a list of items in the admin panel
Some modules have registered their own such as:
• Layout - Added in v1.9 - Used by the Orchard.Layouts module when an element is rendering a shape like a
ContentField or ContentItem
• Design - Added in v1.9 - Used by the Orchard.Layouts module when showing an element in the admin panel
ContentType
Scopes the contained Place tags to a specific content type or stereotype.
• Content Type - Such as BlogPost or Page
• Stereotype - Added in v1.1 - Such as Widget
Path
The Path attribute was added in v1.1.
Scopes the contained Place tags to a specific path or to a path and its children.
• Specific Path - For example, Path="/About" enables changes that only affect the About page (assuming you
have one)
• Path and it’s Children - For example, Path="/MyBlog/*" affects everything that is under the path MyBlog,
such as Myblog or MyBlog/FirstPost.
Overriding Placement
A module should define default placements for the parts and fields it provides by having a placement.info file at
the root of the module’s directory.
Without a placement your parts and fields will not appear on the page. By supplying a default you take the burden away
from theme developers to configure your module and you make it easy for them to copy sections over to customise
them. Consider the various DisplayTypes your parts and fields may be viewed and provide sensible defaults.
That default placement can be overridden by any theme by placing a placement.info file in the root of the theme
directory.
The current theme’s placement will win over that of any module.
452
Chapter 3. Documentation